diff --git "a/saved_models/fine_tune/ruby/docstring_list.json" "b/saved_models/fine_tune/ruby/docstring_list.json"
new file mode 100644--- /dev/null
+++ "b/saved_models/fine_tune/ruby/docstring_list.json"
@@ -0,0 +1 @@
+["Render but returns a valid Rack body. If fibers are defined, we return\n a streaming body that renders the template piece by piece.\n\n Note that partials are not supported to be rendered with streaming,\n so in such cases, we just wrap them in an array.", "+attribute_missing+ is like +method_missing+, but for attributes. When\n +method_missing+ is called we check to see if there is a matching\n attribute method. If so, we tell +attribute_missing+ to dispatch the\n attribute. This method can be overloaded to customize the behavior.", "Returns a struct representing the matching attribute method.\n The struct's attributes are prefix, base and suffix.", "Removes the module part from the expression in the string.\n\n   demodulize('ActiveSupport::Inflector::Inflections') # => \"Inflections\"\n   demodulize('Inflections')                           # => \"Inflections\"\n   demodulize('::Inflections')                         # => \"Inflections\"\n   demodulize('')                                      # => \"\"\n\n See also #deconstantize.", "Mounts a regular expression, returned as a string to ease interpolation,\n that will match part by part the given constant.\n\n   const_regexp(\"Foo::Bar::Baz\") # => \"Foo(::Bar(::Baz)?)?\"\n   const_regexp(\"::\")            # => \"::\"", "Applies inflection rules for +singularize+ and +pluralize+.\n\n If passed an optional +locale+ parameter, the uncountables will be\n found for that locale.\n\n  apply_inflections('post', inflections.plurals, :en)    # => \"posts\"\n  apply_inflections('posts', inflections.singulars, :en) # => \"post\"", "Attempt to autoload the provided module name by searching for a directory\n matching the expected path suffix. If found, the module is created and\n assigned to +into+'s constants with the name +const_name+. Provided that\n the directory was loaded from a reloadable base path, it is added to the\n set of constants that are to be unloaded.", "Parse an XML Document string or IO into a simple hash.\n\n Same as XmlSimple::xml_in but doesn't shoot itself in the foot,\n and uses the defaults from Active Support.\n\n data::\n   XML Document string or IO to parse", "Connects a model to the databases specified. The +database+ keyword\n takes a hash consisting of a +role+ and a +database_key+.\n\n This will create a connection handler for switching between connections,\n look up the config hash using the +database_key+ and finally\n establishes a connection to that config.\n\n   class AnimalsModel < ApplicationRecord\n     self.abstract_class = true\n\n     connects_to database: { writing: :primary, reading: :primary_replica }\n   end\n\n Returns an array of established connections.", "Clears the query cache for all connections associated with the current thread.", "turns 20170404131909 into \"2017_04_04_131909\"", "Keep it for indexing materialized views", "Returns a formatted string of the offset from UTC, or an alternative\n string if the time zone is already UTC.\n\n   Time.zone = 'Eastern Time (US & Canada)'   # => \"Eastern Time (US & Canada)\"\n   Time.zone.now.formatted_offset(true)       # => \"-05:00\"\n   Time.zone.now.formatted_offset(false)      # => \"-0500\"\n   Time.zone = 'UTC'                          # => \"UTC\"\n   Time.zone.now.formatted_offset(true, \"0\")  # => \"0\"", "Uses Date to provide precise Time calculations for years, months, and days\n according to the proleptic Gregorian calendar. The result is returned as a\n new TimeWithZone object.\n\n The +options+ parameter takes a hash with any of these keys:\n <tt>:years</tt>, <tt>:months</tt>, <tt>:weeks</tt>, <tt>:days</tt>,\n <tt>:hours</tt>, <tt>:minutes</tt>, <tt>:seconds</tt>.\n\n If advancing by a value of variable length (i.e., years, weeks, months,\n days), move forward from #time, otherwise move forward from #utc, for\n accuracy when moving across DST boundaries.\n\n   Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'\n   now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28 EDT -04:00\n   now.advance(seconds: 1) # => Sun, 02 Nov 2014 01:26:29 EDT -04:00\n   now.advance(minutes: 1) # => Sun, 02 Nov 2014 01:27:28 EDT -04:00\n   now.advance(hours: 1)   # => Sun, 02 Nov 2014 01:26:28 EST -05:00\n   now.advance(days: 1)    # => Mon, 03 Nov 2014 01:26:28 EST -05:00\n   now.advance(weeks: 1)   # => Sun, 09 Nov 2014 01:26:28 EST -05:00\n   now.advance(months: 1)  # => Tue, 02 Dec 2014 01:26:28 EST -05:00\n   now.advance(years: 1)   # => Mon, 02 Nov 2015 01:26:28 EST -05:00", "Calls the action going through the entire action dispatch stack.\n\n The actual method that is called is determined by calling\n #method_for_action. If no method can handle the action, then an\n AbstractController::ActionNotFound error is raised.\n\n ==== Returns\n * <tt>self</tt>", "Passes each element of +candidates+ collection to ArrayInquirer collection.\n The method returns true if any element from the ArrayInquirer collection\n is equal to the stringified or symbolized form of any element in the +candidates+ collection.\n\n If +candidates+ collection is not given, method returns true.\n\n   variants = ActiveSupport::ArrayInquirer.new([:phone, :tablet])\n\n   variants.any?                      # => true\n   variants.any?(:phone, :tablet)     # => true\n   variants.any?('phone', 'desktop')  # => true\n   variants.any?(:desktop, :watch)    # => false", "Returns a stable cache key that can be used to identify this record.\n\n   Product.new.cache_key     # => \"products/new\"\n   Product.find(5).cache_key # => \"products/5\"\n\n If ActiveRecord::Base.cache_versioning is turned off, as it was in Rails 5.1 and earlier,\n the cache key will also include a version.\n\n   Product.cache_versioning = false\n   Product.find(5).cache_key  # => \"products/5-20071224150000\" (updated_at available)", "Returns +text+ wrapped at +len+ columns and indented +indent+ spaces.\n By default column length +len+ equals 72 characters and indent\n +indent+ equal two spaces.\n\n   my_text = 'Here is a sample text with more than 40 characters'\n\n   format_paragraph(my_text, 25, 4)\n   # => \"    Here is a sample text with\\n    more than 40 characters\"", "Yields each batch of records that was found by the find options as\n an array.\n\n   Person.where(\"age > 21\").find_in_batches do |group|\n     sleep(50) # Make sure it doesn't get too crowded in there!\n     group.each { |person| person.party_all_night! }\n   end\n\n If you do not provide a block to #find_in_batches, it will return an Enumerator\n for chaining with other methods:\n\n   Person.find_in_batches.with_index do |group, batch|\n     puts \"Processing group ##{batch}\"\n     group.each(&:recover_from_last_night!)\n   end\n\n To be yielded each record one by one, use #find_each instead.\n\n ==== Options\n * <tt>:batch_size</tt> - Specifies the size of the batch. Defaults to 1000.\n * <tt>:start</tt> - Specifies the primary key value to start from, inclusive of the value.\n * <tt>:finish</tt> - Specifies the primary key value to end at, inclusive of the value.\n * <tt>:error_on_ignore</tt> - Overrides the application config to specify if an error should be raised when\n   an order is present in the relation.\n\n Limits are honored, and if present there is no requirement for the batch\n size: it can be less than, equal to, or greater than the limit.\n\n The options +start+ and +finish+ are especially useful if you want\n multiple workers dealing with the same processing queue. You can make\n worker 1 handle all the records between id 1 and 9999 and worker 2\n handle from 10000 and beyond by setting the +:start+ and +:finish+\n option on each worker.\n\n   # Let's process from record 10_000 on.\n   Person.find_in_batches(start: 10_000) do |group|\n     group.each { |person| person.party_all_night! }\n   end\n\n NOTE: It's not possible to set the order. That is automatically set to\n ascending on the primary key (\"id ASC\") to make the batch ordering\n work. This also means that this method only works when the primary key is\n orderable (e.g. an integer or string).\n\n NOTE: By its nature, batch processing is subject to race conditions if\n other processes are modifying the database.", "See if error matches provided +attribute+, +type+ and +options+.", "`order_by` is an enumerable object containing keys of the cache,\n all keys are  passed in whether found already or not.\n\n `cached_partials` is a hash. If the value exists\n it represents the rendered partial from the cache\n otherwise `Hash#fetch` will take the value of its block.\n\n This method expects a block that will return the rendered\n partial. An example is to render all results\n for each element that was not found in the cache and store it as an array.\n Order it so that the first empty cache element in `cached_partials`\n corresponds to the first element in `rendered_partials`.\n\n If the partial is not already cached it will also be\n written back to the underlying cache store.", "Runs the callbacks for the given event.\n\n Calls the before and around callbacks in the order they were set, yields\n the block (if given one), and then runs the after callbacks in reverse\n order.\n\n If the callback chain was halted, returns +false+. Otherwise returns the\n result of the block, +nil+ if no callbacks have been set, or +true+\n if callbacks have been set but no block is given.\n\n   run_callbacks :save do\n     save\n   end\n\n--\n\n As this method is used in many places, and often wraps large portions of\n user code, it has an additional design goal of minimizing its impact on\n the visible call stack. An exception from inside a :before or :after\n callback can be as noisy as it likes -- but when control has passed\n smoothly through and into the supplied block, we want as little evidence\n as possible that we were here.", "If +file+ is the filename of a file that contains annotations this method returns\n a hash with a single entry that maps +file+ to an array of its annotations.\n Otherwise it returns an empty hash.", "Checks if we should perform parameters wrapping.", "create a new session. If a block is given, the new session will be yielded\n to the block before being returned.", "reloads the environment", "The DOM id convention is to use the singular form of an object or class with the id following an underscore.\n If no id is found, prefix with \"new_\" instead.\n\n   dom_id(Post.find(45))       # => \"post_45\"\n   dom_id(Post.new)            # => \"new_post\"\n\n If you need to address multiple instances of the same class in the same view, you can prefix the dom_id:\n\n   dom_id(Post.find(45), :edit) # => \"edit_post_45\"\n   dom_id(Post.new, :custom)    # => \"custom_post\"", "Evaluate given block in context of base class,\n so that you can write class macros here.\n When you define more than one +included+ block, it raises an exception.", "Define class methods from given block.\n You can define private class methods as well.\n\n   module Example\n     extend ActiveSupport::Concern\n\n     class_methods do\n       def foo; puts 'foo'; end\n\n       private\n         def bar; puts 'bar'; end\n     end\n   end\n\n   class Buzz\n     include Example\n   end\n\n   Buzz.foo # => \"foo\"\n   Buzz.bar # => private method 'bar' called for Buzz:Class(NoMethodError)", "Convenience accessor.", "Checks if a signed message could have been generated by signing an object\n with the +MessageVerifier+'s secret.\n\n   verifier = ActiveSupport::MessageVerifier.new 's3Krit'\n   signed_message = verifier.generate 'a private message'\n   verifier.valid_message?(signed_message) # => true\n\n   tampered_message = signed_message.chop # editing the message invalidates the signature\n   verifier.valid_message?(tampered_message) # => false", "Decodes the signed message using the +MessageVerifier+'s secret.\n\n   verifier = ActiveSupport::MessageVerifier.new 's3Krit'\n\n   signed_message = verifier.generate 'a private message'\n   verifier.verified(signed_message) # => 'a private message'\n\n Returns +nil+ if the message was not signed with the same secret.\n\n   other_verifier = ActiveSupport::MessageVerifier.new 'd1ff3r3nt-s3Krit'\n   other_verifier.verified(signed_message) # => nil\n\n Returns +nil+ if the message is not Base64-encoded.\n\n   invalid_message = \"f--46a0120593880c733a53b6dad75b42ddc1c8996d\"\n   verifier.verified(invalid_message) # => nil\n\n Raises any error raised while decoding the signed message.\n\n   incompatible_message = \"test--dad7b06c94abba8d46a15fafaef56c327665d5ff\"\n   verifier.verified(incompatible_message) # => TypeError: incompatible marshal file format", "Generates a signed message for the provided value.\n\n The message is signed with the +MessageVerifier+'s secret. Without knowing\n the secret, the original value cannot be extracted from the message.\n\n   verifier = ActiveSupport::MessageVerifier.new 's3Krit'\n   verifier.generate 'a private message' # => \"BAhJIhRwcml2YXRlLW1lc3NhZ2UGOgZFVA==--e2d724331ebdee96a10fb99b089508d1c72bd772\"", "Creates a new job instance. Takes the arguments that will be\n passed to the perform method.\n Returns a hash with the job data that can safely be passed to the\n queuing adapter.", "Attaches the stored job data to the current instance. Receives a hash\n returned from +serialize+\n\n ==== Examples\n\n    class DeliverWebhookJob < ActiveJob::Base\n      attr_writer :attempt_number\n\n      def attempt_number\n        @attempt_number ||= 0\n      end\n\n      def serialize\n        super.merge('attempt_number' => attempt_number + 1)\n      end\n\n      def deserialize(job_data)\n        super\n        self.attempt_number = job_data['attempt_number']\n      end\n\n      rescue_from(Timeout::Error) do |exception|\n        raise exception if attempt_number > 5\n        retry_job(wait: 10)\n      end\n    end", "Takes a path to a file. If the file is found, has valid encoding, and has\n correct read permissions, the return value is a URI-escaped string\n representing the filename. Otherwise, false is returned.\n\n Used by the +Static+ class to check the existence of a valid file\n in the server's +public/+ directory (see Static#call).", "Compares one Duration with another or a Numeric to this Duration.\n Numeric values are treated as seconds.\n Adds another Duration or a Numeric to this Duration. Numeric values\n are treated as seconds.", "Multiplies this Duration by a Numeric and returns a new Duration.", "Returns the modulo of this Duration by another Duration or Numeric.\n Numeric values are treated as seconds.", "Overload locale= to also set the I18n.locale. If the current I18n.config object responds\n to original_config, it means that it has a copy of the original I18n configuration and it's\n acting as proxy, which we need to skip.", "Normalizes the arguments and passes it on to find_templates.", "Handles templates caching. If a key is given and caching is on\n always check the cache before hitting the resolver. Otherwise,\n it always hits the resolver but if the key is present, check if the\n resolver is fresher before returning it.", "Extract handler, formats and variant from path. If a format cannot be found neither\n from the path, or the handler, we should return the array of formats given\n to the resolver.", "For streaming, instead of rendering a given a template, we return a Body\n object that responds to each. This object is initialized with a block\n that knows how to render the template.", "If the record is new or it has changed, returns true.", "Replaces non-ASCII characters with an ASCII approximation, or if none\n exists, a replacement character which defaults to \"?\".\n\n    transliterate('\u00c6r\u00f8sk\u00f8bing')\n    # => \"AEroskobing\"\n\n Default approximations are provided for Western/Latin characters,\n e.g, \"\u00f8\", \"\u00f1\", \"\u00e9\", \"\u00df\", etc.\n\n This method is I18n aware, so you can set up custom approximations for a\n locale. This can be useful, for example, to transliterate German's \"\u00fc\"\n and \"\u00f6\" to \"ue\" and \"oe\", or to add support for transliterating Russian\n to ASCII.\n\n In order to make your custom transliterations available, you must set\n them as the <tt>i18n.transliterate.rule</tt> i18n key:\n\n   # Store the transliterations in locales/de.yml\n   i18n:\n     transliterate:\n       rule:\n         \u00fc: \"ue\"\n         \u00f6: \"oe\"\n\n   # Or set them using Ruby\n   I18n.backend.store_translations(:de, i18n: {\n     transliterate: {\n       rule: {\n         '\u00fc' => 'ue',\n         '\u00f6' => 'oe'\n       }\n     }\n   })\n\n The value for <tt>i18n.transliterate.rule</tt> can be a simple Hash that\n maps characters to ASCII approximations as shown above, or, for more\n complex requirements, a Proc:\n\n   I18n.backend.store_translations(:de, i18n: {\n     transliterate: {\n       rule: ->(string) { MyTransliterator.transliterate(string) }\n     }\n   })\n\n Now you can have different transliterations for each locale:\n\n   transliterate('J\u00fcrgen', locale: :en)\n   # => \"Jurgen\"\n\n   transliterate('J\u00fcrgen', locale: :de)\n   # => \"Juergen\"", "Imports one error\n Imported errors are wrapped as a NestedError,\n providing access to original error object.\n If attribute or type needs to be overriden, use `override_options`.\n\n override_options - Hash\n @option override_options [Symbol] :attribute Override the attribute the error belongs to\n @option override_options [Symbol] :type Override type of the error.", "Removes all errors except the given keys. Returns a hash containing the removed errors.\n\n   person.errors.keys                  # => [:name, :age, :gender, :city]\n   person.errors.slice!(:age, :gender) # => { :name=>[\"cannot be nil\"], :city=>[\"cannot be nil\"] }\n   person.errors.keys                  # => [:age, :gender]", "Search for errors matching +attribute+, +type+ or +options+.\n\n Only supplied params will be matched.\n\n   person.errors.where(:name) # => all name errors.\n   person.errors.where(:name, :too_short) # => all name errors being too short\n   person.errors.where(:name, :too_short, minimum: 2) # => all name errors being too short and minimum is 2", "Delete messages for +key+. Returns the deleted messages.\n\n   person.errors[:name]        # => [\"cannot be nil\"]\n   person.errors.delete(:name) # => [\"cannot be nil\"]\n   person.errors[:name]        # => []", "Iterates through each error key, value pair in the error messages hash.\n Yields the attribute and the error for that attribute. If the attribute\n has more than one error message, yields once for each error message.\n\n   person.errors.add(:name, :blank, message: \"can't be blank\")\n   person.errors.each do |attribute, error|\n     # Will yield :name and \"can't be blank\"\n   end\n\n   person.errors.add(:name, :not_specified, message: \"must be specified\")\n   person.errors.each do |attribute, error|\n     # Will yield :name and \"can't be blank\"\n     # then yield :name and \"must be specified\"\n   end", "Returns an xml formatted representation of the Errors hash.\n\n   person.errors.add(:name, :blank, message: \"can't be blank\")\n   person.errors.add(:name, :not_specified, message: \"must be specified\")\n   person.errors.to_xml\n   # =>\n   #  <?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\n   #  <errors>\n   #    <error>name can't be blank</error>\n   #    <error>name must be specified</error>\n   #  </errors>", "Reverses the migration commands for the given block and\n the given migrations.\n\n The following migration will remove the table 'horses'\n and create the table 'apples' on the way up, and the reverse\n on the way down.\n\n   class FixTLMigration < ActiveRecord::Migration[5.0]\n     def change\n       revert do\n         create_table(:horses) do |t|\n           t.text :content\n           t.datetime :remind_at\n         end\n       end\n       create_table(:apples) do |t|\n         t.string :variety\n       end\n     end\n   end\n\n Or equivalently, if +TenderloveMigration+ is defined as in the\n documentation for Migration:\n\n   require_relative '20121212123456_tenderlove_migration'\n\n   class FixupTLMigration < ActiveRecord::Migration[5.0]\n     def change\n       revert TenderloveMigration\n\n       create_table(:apples) do |t|\n         t.string :variety\n       end\n     end\n   end\n\n This command can be nested.", "Outputs text along with how long it took to run its block.\n If the block returns an integer it assumes it is the number of rows affected.", "Determines the version number of the next migration.", "Used for running a specific migration.", "Used for running multiple migrations up to or down to a certain value.", "Sets the +permitted+ attribute to +true+. This can be used to pass\n mass assignment. Returns +self+.\n\n   class Person < ActiveRecord::Base\n   end\n\n   params = ActionController::Parameters.new(name: \"Francesco\")\n   params.permitted?  # => false\n   Person.new(params) # => ActiveModel::ForbiddenAttributesError\n   params.permit!\n   params.permitted?  # => true\n   Person.new(params) # => #<Person id: nil, name: \"Francesco\">", "This method accepts both a single key and an array of keys.\n\n When passed a single key, if it exists and its associated value is\n either present or the singleton +false+, returns said value:\n\n   ActionController::Parameters.new(person: { name: \"Francesco\" }).require(:person)\n   # => <ActionController::Parameters {\"name\"=>\"Francesco\"} permitted: false>\n\n Otherwise raises <tt>ActionController::ParameterMissing</tt>:\n\n   ActionController::Parameters.new.require(:person)\n   # ActionController::ParameterMissing: param is missing or the value is empty: person\n\n   ActionController::Parameters.new(person: nil).require(:person)\n   # ActionController::ParameterMissing: param is missing or the value is empty: person\n\n   ActionController::Parameters.new(person: \"\\t\").require(:person)\n   # ActionController::ParameterMissing: param is missing or the value is empty: person\n\n   ActionController::Parameters.new(person: {}).require(:person)\n   # ActionController::ParameterMissing: param is missing or the value is empty: person\n\n When given an array of keys, the method tries to require each one of them\n in order. If it succeeds, an array with the respective return values is\n returned:\n\n   params = ActionController::Parameters.new(user: { ... }, profile: { ... })\n   user_params, profile_params = params.require([:user, :profile])\n\n Otherwise, the method re-raises the first exception found:\n\n   params = ActionController::Parameters.new(user: {}, profile: {})\n   user_params, profile_params = params.require([:user, :profile])\n   # ActionController::ParameterMissing: param is missing or the value is empty: user\n\n Technically this method can be used to fetch terminal values:\n\n   # CAREFUL\n   params = ActionController::Parameters.new(person: { name: \"Finn\" })\n   name = params.require(:person).require(:name) # CAREFUL\n\n but take into account that at some point those ones have to be permitted:\n\n   def person_params\n     params.require(:person).permit(:name).tap do |person_params|\n       person_params.require(:name) # SAFER\n     end\n   end\n\n for example.", "Adds existing keys to the params if their values are scalar.\n\n For example:\n\n   puts self.keys #=> [\"zipcode(90210i)\"]\n   params = {}\n\n   permitted_scalar_filter(params, \"zipcode\")\n\n   puts params.keys # => [\"zipcode\"]", "Overwrite process to setup I18n proxy.", "Find and render a template based on the options given.", "Normalize options.", "Enqueues the job to be performed by the queue adapter.\n\n ==== Options\n * <tt>:wait</tt> - Enqueues the job with the specified delay\n * <tt>:wait_until</tt> - Enqueues the job at the time specified\n * <tt>:queue</tt> - Enqueues the job on the specified queue\n * <tt>:priority</tt> - Enqueues the job with the specified priority\n\n ==== Examples\n\n    my_job_instance.enqueue\n    my_job_instance.enqueue wait: 5.minutes\n    my_job_instance.enqueue queue: :important\n    my_job_instance.enqueue wait_until: Date.tomorrow.midnight\n    my_job_instance.enqueue priority: 10", "Returns a hash of rows to be inserted. The key is the table, the value is\n a list of rows to insert to that table.", "Loads the fixtures from the YAML file at +path+.\n If the file sets the +model_class+ and current instance value is not set,\n it uses the file value.", "Efficiently downloads blob data into the given file.", "Sets an HTTP 1.1 Cache-Control header. Defaults to issuing a +private+\n instruction, so that intermediate caches must not cache the response.\n\n   expires_in 20.minutes\n   expires_in 3.hours, public: true\n   expires_in 3.hours, public: true, must_revalidate: true\n\n This method will overwrite an existing Cache-Control header.\n See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.\n\n HTTP Cache-Control Extensions for Stale Content. See https://tools.ietf.org/html/rfc5861\n It helps to cache an asset and serve it while is being revalidated and/or returning with an error.\n\n   expires_in 3.hours, public: true, stale_while_revalidate: 60.seconds\n   expires_in 3.hours, public: true, stale_while_revalidate: 60.seconds, stale_if_error: 5.minutes\n\n The method will also ensure an HTTP Date header for client compatibility.", "Cache or yield the block. The cache is supposed to never expire.\n\n You can use this method when you have an HTTP response that never changes,\n and the browser and proxies should cache it indefinitely.\n\n * +public+: By default, HTTP responses are private, cached only on the\n   user's web browser. To allow proxies to cache the response, set +true+ to\n   indicate that they can serve the cached response to all users.", "Executes a system command, capturing its binary output in a tempfile. Yields the tempfile.\n\n Use this method to shell out to a system library (e.g. muPDF or FFmpeg) for preview image\n generation. The resulting tempfile can be used as the +:io+ value in an attachable Hash:\n\n   def preview\n     download_blob_to_tempfile do |input|\n       draw \"my-drawing-command\", input.path, \"--format\", \"png\", \"-\" do |output|\n         yield io: output, filename: \"#{blob.filename.base}.png\", content_type: \"image/png\"\n       end\n     end\n   end\n\n The output tempfile is opened in the directory returned by #tmpdir.", "Overwrite render_to_string because body can now be set to a Rack body.", "Normalize both text and status options.", "Process controller specific options, as status, content-type and location.", "Create a new +RemoteIp+ middleware instance.\n\n The +ip_spoofing_check+ option is on by default. When on, an exception\n is raised if it looks like the client is trying to lie about its own IP\n address. It makes sense to turn off this check on sites aimed at non-IP\n clients (like WAP devices), or behind proxies that set headers in an\n incorrect or confusing way (like AWS ELB).\n\n The +custom_proxies+ argument can take an Array of string, IPAddr, or\n Regexp objects which will be used instead of +TRUSTED_PROXIES+. If a\n single string, IPAddr, or Regexp object is provided, it will be used in\n addition to +TRUSTED_PROXIES+. Any proxy setup will put the value you\n want in the middle (or at the beginning) of the X-Forwarded-For list,\n with your proxy servers after it. If your proxies aren't removed, pass\n them in via the +custom_proxies+ parameter. That way, the middleware will\n ignore those IP addresses, and return the one that you want.\n Since the IP address may not be needed, we store the object here\n without calculating the IP to keep from slowing down the majority of\n requests. For those requests that do need to know the IP, the\n GetIp#calculate_ip method will calculate the memoized client IP address.", "Passes the record off to the class or classes specified and allows them\n to add errors based on more complex conditions.\n\n   class Person\n     include ActiveModel::Validations\n\n     validate :instance_validations\n\n     def instance_validations\n       validates_with MyValidator\n     end\n   end\n\n Please consult the class method documentation for more information on\n creating your own validator.\n\n You may also pass it multiple classes, like so:\n\n   class Person\n     include ActiveModel::Validations\n\n     validate :instance_validations, on: :create\n\n     def instance_validations\n       validates_with MyValidator, MyOtherValidator\n     end\n   end\n\n Standard configuration options (<tt>:on</tt>, <tt>:if</tt> and\n <tt>:unless</tt>), which are available on the class version of\n +validates_with+, should instead be placed on the +validates+ method\n as these are applied and tested in the callback.\n\n If you pass any additional configuration options, they will be passed\n to the class and available as +options+, please refer to the\n class version of this method for more information.", "Render a template. If the template was not compiled yet, it is done\n exactly before rendering.\n\n This method is instrumented as \"!render_template.action_view\". Notice that\n we use a bang in this instrumentation because you don't want to\n consume this in production. This is only slow if it's being listened to.", "Compile a template. This method ensures a template is compiled\n just once and removes the source after it is compiled.", "Reloads the record from the database.\n\n This method finds the record by its primary key (which could be assigned\n manually) and modifies the receiver in-place:\n\n   account = Account.new\n   # => #<Account id: nil, email: nil>\n   account.id = 1\n   account.reload\n   # Account Load (1.2ms)  SELECT \"accounts\".* FROM \"accounts\" WHERE \"accounts\".\"id\" = $1 LIMIT 1  [[\"id\", 1]]\n   # => #<Account id: 1, email: 'account@example.com'>\n\n Attributes are reloaded from the database, and caches busted, in\n particular the associations cache and the QueryCache.\n\n If the record no longer exists in the database ActiveRecord::RecordNotFound\n is raised. Otherwise, in addition to the in-place modification the method\n returns +self+ for convenience.\n\n The optional <tt>:lock</tt> flag option allows you to lock the reloaded record:\n\n   reload(lock: true) # reload with pessimistic locking\n\n Reloading is commonly used in test suites to test something is actually\n written to the database, or when some action modifies the corresponding\n row in the database but not the object in memory:\n\n   assert account.deposit!(25)\n   assert_equal 25, account.credit        # check it is updated in memory\n   assert_equal 25, account.reload.credit # check it is also persisted\n\n Another common use case is optimistic locking handling:\n\n   def with_optimistic_retry\n     begin\n       yield\n     rescue ActiveRecord::StaleObjectError\n       begin\n         # Reload lock_version in particular.\n         reload\n       rescue ActiveRecord::RecordNotFound\n         # If the record is gone there is nothing to do.\n       else\n         retry\n       end\n     end\n   end", "Creates a masked version of the authenticity token that varies\n on each request. The masking is used to mitigate SSL attacks\n like BREACH.", "Checks the client's masked token to see if it matches the\n session token. Essentially the inverse of\n +masked_authenticity_token+.", "Checks if the request originated from the same origin by looking at the\n Origin header.", "Save the new record state and id of a record so it can be restored later if a transaction fails.", "Updates the attributes on this particular Active Record object so that\n if it's associated with a transaction, then the state of the Active Record\n object will be updated to reflect the current state of the transaction.\n\n The <tt>@transaction_state</tt> variable stores the states of the associated\n transaction. This relies on the fact that a transaction can only be in\n one rollback or commit (otherwise a list of states would be required).\n Each Active Record object inside of a transaction carries that transaction's\n TransactionState.\n\n This method checks to see if the ActiveRecord object's state reflects\n the TransactionState, and rolls back or commits the Active Record object\n as appropriate.", "Constant time string comparison, for fixed length strings.\n\n The values compared should be of fixed length, such as strings\n that have already been processed by HMAC. Raises in case of length mismatch.", "Constant time string comparison, for variable length strings.\n\n The values are first processed by SHA256, so that we don't leak length info\n via timing attacks.", "Declares a block that will be executed when a Rails component is fully\n loaded.\n\n Options:\n\n * <tt>:yield</tt> - Yields the object that run_load_hooks to +block+.\n * <tt>:run_once</tt> - Given +block+ will run only once.", "This method should return a hash with assigns.\n You can overwrite this configuration per controller.", "Normalize args and options.", "Provides options for converting numbers into formatted strings.\n Options are provided for phone numbers, currency, percentage,\n precision, positional notation, file size and pretty printing.\n\n ==== Options\n\n For details on which formats use which options, see ActiveSupport::NumberHelper\n\n ==== Examples\n\n  Phone Numbers:\n  5551234.to_s(:phone)                                     # => \"555-1234\"\n  1235551234.to_s(:phone)                                  # => \"123-555-1234\"\n  1235551234.to_s(:phone, area_code: true)                 # => \"(123) 555-1234\"\n  1235551234.to_s(:phone, delimiter: ' ')                  # => \"123 555 1234\"\n  1235551234.to_s(:phone, area_code: true, extension: 555) # => \"(123) 555-1234 x 555\"\n  1235551234.to_s(:phone, country_code: 1)                 # => \"+1-123-555-1234\"\n  1235551234.to_s(:phone, country_code: 1, extension: 1343, delimiter: '.')\n  # => \"+1.123.555.1234 x 1343\"\n\n  Currency:\n  1234567890.50.to_s(:currency)                 # => \"$1,234,567,890.50\"\n  1234567890.506.to_s(:currency)                # => \"$1,234,567,890.51\"\n  1234567890.506.to_s(:currency, precision: 3)  # => \"$1,234,567,890.506\"\n  1234567890.506.to_s(:currency, locale: :fr)   # => \"1 234 567 890,51 \u20ac\"\n  -1234567890.50.to_s(:currency, negative_format: '(%u%n)')\n  # => \"($1,234,567,890.50)\"\n  1234567890.50.to_s(:currency, unit: '&pound;', separator: ',', delimiter: '')\n  # => \"&pound;1234567890,50\"\n  1234567890.50.to_s(:currency, unit: '&pound;', separator: ',', delimiter: '', format: '%n %u')\n  # => \"1234567890,50 &pound;\"\n\n  Percentage:\n  100.to_s(:percentage)                                  # => \"100.000%\"\n  100.to_s(:percentage, precision: 0)                    # => \"100%\"\n  1000.to_s(:percentage, delimiter: '.', separator: ',') # => \"1.000,000%\"\n  302.24398923423.to_s(:percentage, precision: 5)        # => \"302.24399%\"\n  1000.to_s(:percentage, locale: :fr)                    # => \"1 000,000%\"\n  100.to_s(:percentage, format: '%n  %')                 # => \"100.000  %\"\n\n  Delimited:\n  12345678.to_s(:delimited)                     # => \"12,345,678\"\n  12345678.05.to_s(:delimited)                  # => \"12,345,678.05\"\n  12345678.to_s(:delimited, delimiter: '.')     # => \"12.345.678\"\n  12345678.to_s(:delimited, delimiter: ',')     # => \"12,345,678\"\n  12345678.05.to_s(:delimited, separator: ' ')  # => \"12,345,678 05\"\n  12345678.05.to_s(:delimited, locale: :fr)     # => \"12 345 678,05\"\n  98765432.98.to_s(:delimited, delimiter: ' ', separator: ',')\n  # => \"98 765 432,98\"\n\n  Rounded:\n  111.2345.to_s(:rounded)                                      # => \"111.235\"\n  111.2345.to_s(:rounded, precision: 2)                        # => \"111.23\"\n  13.to_s(:rounded, precision: 5)                              # => \"13.00000\"\n  389.32314.to_s(:rounded, precision: 0)                       # => \"389\"\n  111.2345.to_s(:rounded, significant: true)                   # => \"111\"\n  111.2345.to_s(:rounded, precision: 1, significant: true)     # => \"100\"\n  13.to_s(:rounded, precision: 5, significant: true)           # => \"13.000\"\n  111.234.to_s(:rounded, locale: :fr)                          # => \"111,234\"\n  13.to_s(:rounded, precision: 5, significant: true, strip_insignificant_zeros: true)\n  # => \"13\"\n  389.32314.to_s(:rounded, precision: 4, significant: true)    # => \"389.3\"\n  1111.2345.to_s(:rounded, precision: 2, separator: ',', delimiter: '.')\n  # => \"1.111,23\"\n\n  Human-friendly size in Bytes:\n  123.to_s(:human_size)                                   # => \"123 Bytes\"\n  1234.to_s(:human_size)                                  # => \"1.21 KB\"\n  12345.to_s(:human_size)                                 # => \"12.1 KB\"\n  1234567.to_s(:human_size)                               # => \"1.18 MB\"\n  1234567890.to_s(:human_size)                            # => \"1.15 GB\"\n  1234567890123.to_s(:human_size)                         # => \"1.12 TB\"\n  1234567890123456.to_s(:human_size)                      # => \"1.1 PB\"\n  1234567890123456789.to_s(:human_size)                   # => \"1.07 EB\"\n  1234567.to_s(:human_size, precision: 2)                 # => \"1.2 MB\"\n  483989.to_s(:human_size, precision: 2)                  # => \"470 KB\"\n  1234567.to_s(:human_size, precision: 2, separator: ',') # => \"1,2 MB\"\n  1234567890123.to_s(:human_size, precision: 5)           # => \"1.1228 TB\"\n  524288000.to_s(:human_size, precision: 5)               # => \"500 MB\"\n\n  Human-friendly format:\n  123.to_s(:human)                                       # => \"123\"\n  1234.to_s(:human)                                      # => \"1.23 Thousand\"\n  12345.to_s(:human)                                     # => \"12.3 Thousand\"\n  1234567.to_s(:human)                                   # => \"1.23 Million\"\n  1234567890.to_s(:human)                                # => \"1.23 Billion\"\n  1234567890123.to_s(:human)                             # => \"1.23 Trillion\"\n  1234567890123456.to_s(:human)                          # => \"1.23 Quadrillion\"\n  1234567890123456789.to_s(:human)                       # => \"1230 Quadrillion\"\n  489939.to_s(:human, precision: 2)                      # => \"490 Thousand\"\n  489939.to_s(:human, precision: 4)                      # => \"489.9 Thousand\"\n  1234567.to_s(:human, precision: 4,\n                   significant: false)                   # => \"1.2346 Million\"\n  1234567.to_s(:human, precision: 1,\n                   separator: ',',\n                   significant: false)                   # => \"1,2 Million\"", "Returns the config hash that corresponds with the environment\n\n If the application has multiple databases +default_hash+ will\n return the first config hash for the environment.\n\n   { database: \"my_db\", adapter: \"mysql2\" }", "Returns a single DatabaseConfig object based on the requested environment.\n\n If the application has multiple databases +find_db_config+ will return\n the first DatabaseConfig for the environment.", "Returns the DatabaseConfigurations object as a Hash.", "An email was delivered.", "Returns the backtrace after all filters and silencers have been run\n against it. Filters run first, then silencers.", "Determine the template to be rendered using the given options.", "Renders the given template. A string representing the layout can be\n supplied as well.", "Set proper cache control and transfer encoding when streaming", "Call render_body if we are streaming instead of usual +render+.", "Determine the layout for a given name, taking into account the name type.\n\n ==== Parameters\n * <tt>name</tt> - The name of the template", "Returns the default layout for this controller.\n Optionally raises an exception if the layout could not be found.\n\n ==== Parameters\n * <tt>formats</tt> - The formats accepted to this layout\n * <tt>require_layout</tt> - If set to +true+ and layout is not found,\n   an +ArgumentError+ exception is raised (defaults to +false+)\n\n ==== Returns\n * <tt>template</tt> - The template object for the default layout (or +nil+)", "Runs all the specified validations and returns +true+ if no errors were\n added otherwise +false+.\n\n   class Person\n     include ActiveModel::Validations\n\n     attr_accessor :name\n     validates_presence_of :name\n   end\n\n   person = Person.new\n   person.name = ''\n   person.valid? # => false\n   person.name = 'david'\n   person.valid? # => true\n\n Context can optionally be supplied to define which callbacks to test\n against (the context is defined on the validations using <tt>:on</tt>).\n\n   class Person\n     include ActiveModel::Validations\n\n     attr_accessor :name\n     validates_presence_of :name, on: :new\n   end\n\n   person = Person.new\n   person.valid?       # => true\n   person.valid?(:new) # => false", "Returns a message verifier object.\n\n This verifier can be used to generate and verify signed messages in the application.\n\n It is recommended not to use the same verifier for different things, so you can get different\n verifiers passing the +verifier_name+ argument.\n\n ==== Parameters\n\n * +verifier_name+ - the name of the message verifier.\n\n ==== Examples\n\n     message = Rails.application.message_verifier('sensitive_data').generate('my sensible data')\n     Rails.application.message_verifier('sensitive_data').verify(message)\n     # => 'my sensible data'\n\n See the +ActiveSupport::MessageVerifier+ documentation for more information.", "Stores some of the Rails initial environment parameters which\n will be used by middlewares and engines to configure themselves.", "Shorthand to decrypt any encrypted configurations or files.\n\n For any file added with <tt>rails encrypted:edit</tt> call +read+ to decrypt\n the file with the master key.\n The master key is either stored in +config/master.key+ or <tt>ENV[\"RAILS_MASTER_KEY\"]</tt>.\n\n   Rails.application.encrypted(\"config/mystery_man.txt.enc\").read\n   # => \"We've met before, haven't we?\"\n\n It's also possible to interpret encrypted YAML files with +config+.\n\n   Rails.application.encrypted(\"config/credentials.yml.enc\").config\n   # => { next_guys_line: \"I don't think so. Where was it you think we met?\" }\n\n Any top-level configs are also accessible directly on the return value:\n\n   Rails.application.encrypted(\"config/credentials.yml.enc\").next_guys_line\n   # => \"I don't think so. Where was it you think we met?\"\n\n The files or configs can also be encrypted with a custom key. To decrypt with\n a key in the +ENV+, use:\n\n   Rails.application.encrypted(\"config/special_tokens.yml.enc\", env_key: \"SPECIAL_TOKENS\")\n\n Or to decrypt with a file, that should be version control ignored, relative to +Rails.root+:\n\n   Rails.application.encrypted(\"config/special_tokens.yml.enc\", key_path: \"config/special_tokens.key\")", "Returns the ordered railties for this application considering railties_order.", "Read the request \\body. This is useful for web services that need to\n work with raw requests directly.", "The request body is an IO input stream. If the RAW_POST_DATA environment\n variable is already set, wrap it in a StringIO.", "Override Rack's GET method to support indifferent access.", "Override Rack's POST method to support indifferent access.", "Sets up instance variables needed for rendering a partial. This method\n finds the options and details and extracts them. The method also contains\n logic that handles the type of object passed in as the partial.\n\n If +options[:partial]+ is a string, then the <tt>@path</tt> instance variable is\n set to that string. Otherwise, the +options[:partial]+ object must\n respond to +to_partial_path+ in order to setup the path.", "Obtains the path to where the object's partial is located. If the object\n responds to +to_partial_path+, then +to_partial_path+ will be called and\n will provide the path. If the object does not respond to +to_partial_path+,\n then an +ArgumentError+ is raised.\n\n If +prefix_partial_path_with_controller_namespace+ is true, then this\n method will prefix the partial paths with a namespace.", "Returns a serialized hash of your object.\n\n   class Person\n     include ActiveModel::Serialization\n\n     attr_accessor :name, :age\n\n     def attributes\n       {'name' => nil, 'age' => nil}\n     end\n\n     def capitalized_name\n       name.capitalize\n     end\n   end\n\n   person = Person.new\n   person.name = 'bob'\n   person.age  = 22\n   person.serializable_hash                # => {\"name\"=>\"bob\", \"age\"=>22}\n   person.serializable_hash(only: :name)   # => {\"name\"=>\"bob\"}\n   person.serializable_hash(except: :name) # => {\"age\"=>22}\n   person.serializable_hash(methods: :capitalized_name)\n   # => {\"name\"=>\"bob\", \"age\"=>22, \"capitalized_name\"=>\"Bob\"}\n\n Example with <tt>:include</tt> option\n\n   class User\n     include ActiveModel::Serializers::JSON\n     attr_accessor :name, :notes # Emulate has_many :notes\n     def attributes\n       {'name' => nil}\n     end\n   end\n\n   class Note\n     include ActiveModel::Serializers::JSON\n     attr_accessor :title, :text\n     def attributes\n       {'title' => nil, 'text' => nil}\n     end\n   end\n\n   note = Note.new\n   note.title = 'Battle of Austerlitz'\n   note.text = 'Some text here'\n\n   user = User.new\n   user.name = 'Napoleon'\n   user.notes = [note]\n\n   user.serializable_hash\n   # => {\"name\" => \"Napoleon\"}\n   user.serializable_hash(include: { notes: { only: 'title' }})\n   # => {\"name\" => \"Napoleon\", \"notes\" => [{\"title\"=>\"Battle of Austerlitz\"}]}", "Returns a module with all the helpers defined for the engine.", "Returns the underlying Rack application for this engine.", "Defines the routes for this engine. If a block is given to\n routes, it is appended to the engine.", "Attaches an +attachable+ to the record.\n\n If the record is persisted and unchanged, the attachment is saved to\n the database immediately. Otherwise, it'll be saved to the DB when the\n record is next saved.\n\n   person.avatar.attach(params[:avatar]) # ActionDispatch::Http::UploadedFile object\n   person.avatar.attach(params[:signed_blob_id]) # Signed reference to blob from direct upload\n   person.avatar.attach(io: File.open(\"/path/to/face.jpg\"), filename: \"face.jpg\", content_type: \"image/jpg\")\n   person.avatar.attach(avatar_blob) # ActiveStorage::Blob object", "Reads the file for the given key in chunks, yielding each to the block.", "It accepts two parameters on initialization. The first is an array\n of files and the second is an optional hash of directories. The hash must\n have directories as keys and the value is an array of extensions to be\n watched under that directory.\n\n This method must also receive a block that will be called once a path\n changes. The array of files and list of directories cannot be changed\n after FileUpdateChecker has been initialized.\n Check if any of the entries were updated. If so, the watched and/or\n updated_at values are cached until the block is executed via +execute+\n or +execute_if_updated+.", "This method returns the maximum mtime of the files in +paths+, or +nil+\n if the array is empty.\n\n Files with a mtime in the future are ignored. Such abnormal situation\n can happen for example if the user changes the clock by hand. It is\n healthy to consider this edge case because with mtimes in the future\n reloading is not triggered.", "Allows you to measure the execution time of a block in a template and\n records the result to the log. Wrap this block around expensive operations\n or possible bottlenecks to get a time reading for the operation. For\n example, let's say you thought your file processing method was taking too\n long; you could wrap it in a benchmark block.\n\n  <% benchmark 'Process data files' do %>\n    <%= expensive_files_operation %>\n  <% end %>\n\n That would add something like \"Process data files (345.2ms)\" to the log,\n which you can then use to compare timings when optimizing your code.\n\n You may give an optional logger level (<tt>:debug</tt>, <tt>:info</tt>,\n <tt>:warn</tt>, <tt>:error</tt>) as the <tt>:level</tt> option. The\n default logger level value is <tt>:info</tt>.\n\n  <% benchmark 'Low-level files', level: :debug do %>\n    <%= lowlevel_files_operation %>\n  <% end %>\n\n Finally, you can pass true as the third argument to silence all log\n activity (other than the timing information) from inside the block. This\n is great for boiling down a noisy block to just a single statement that\n produces one log line:\n\n  <% benchmark 'Process data files', level: :info, silence: true do %>\n    <%= expensive_and_chatty_files_operation %>\n  <% end %>", "Initializes new record from relation while maintaining the current\n scope.\n\n Expects arguments in the same format as {ActiveRecord::Base.new}[rdoc-ref:Core.new].\n\n   users = User.where(name: 'DHH')\n   user = users.new # => #<User id: nil, name: \"DHH\", created_at: nil, updated_at: nil>\n\n You can also pass a block to new with the new record as argument:\n\n   user = users.new { |user| user.name = 'Oscar' }\n   user.name # => Oscar", "Tries to create a new record with the same scoped attributes\n defined in the relation. Returns the initialized object if validation fails.\n\n Expects arguments in the same format as\n {ActiveRecord::Base.create}[rdoc-ref:Persistence::ClassMethods#create].\n\n ==== Examples\n\n   users = User.where(name: 'Oscar')\n   users.create # => #<User id: 3, name: \"Oscar\", ...>\n\n   users.create(name: 'fxn')\n   users.create # => #<User id: 4, name: \"fxn\", ...>\n\n   users.create { |user| user.name = 'tenderlove' }\n   # => #<User id: 5, name: \"tenderlove\", ...>\n\n   users.create(name: nil) # validation on name\n   # => #<User id: nil, name: nil, ...>", "Returns sql statement for the relation.\n\n   User.where(name: 'Oscar').to_sql\n   # => SELECT \"users\".* FROM \"users\"  WHERE \"users\".\"name\" = 'Oscar'", "Initialize an empty model object from +attributes+.\n +attributes+ should be an attributes object, and unlike the\n `initialize` method, no assignment calls are made per attribute.", "Returns the contents of the record as a nicely formatted string.", "The main method that creates the message and renders the email templates. There are\n two ways to call this method, with a block, or without a block.\n\n It accepts a headers hash. This hash allows you to specify\n the most used headers in an email message, these are:\n\n * +:subject+ - The subject of the message, if this is omitted, Action Mailer will\n   ask the Rails I18n class for a translated +:subject+ in the scope of\n   <tt>[mailer_scope, action_name]</tt> or if this is missing, will translate the\n   humanized version of the +action_name+\n * +:to+ - Who the message is destined for, can be a string of addresses, or an array\n   of addresses.\n * +:from+ - Who the message is from\n * +:cc+ - Who you would like to Carbon-Copy on this email, can be a string of addresses,\n   or an array of addresses.\n * +:bcc+ - Who you would like to Blind-Carbon-Copy on this email, can be a string of\n   addresses, or an array of addresses.\n * +:reply_to+ - Who to set the Reply-To header of the email to.\n * +:date+ - The date to say the email was sent on.\n\n You can set default values for any of the above headers (except +:date+)\n by using the ::default class method:\n\n  class Notifier < ActionMailer::Base\n    default from: 'no-reply@test.lindsaar.net',\n            bcc: 'email_logger@test.lindsaar.net',\n            reply_to: 'bounces@test.lindsaar.net'\n  end\n\n If you need other headers not listed above, you can either pass them in\n as part of the headers hash or use the <tt>headers['name'] = value</tt>\n method.\n\n When a +:return_path+ is specified as header, that value will be used as\n the 'envelope from' address for the Mail message. Setting this is useful\n when you want delivery notifications sent to a different address than the\n one in +:from+. Mail will actually use the +:return_path+ in preference\n to the +:sender+ in preference to the +:from+ field for the 'envelope\n from' value.\n\n If you do not pass a block to the +mail+ method, it will find all\n templates in the view paths using by default the mailer name and the\n method name that it is being called from, it will then create parts for\n each of these templates intelligently, making educated guesses on correct\n content type and sequence, and return a fully prepared <tt>Mail::Message</tt>\n ready to call <tt>:deliver</tt> on to send.\n\n For example:\n\n   class Notifier < ActionMailer::Base\n     default from: 'no-reply@test.lindsaar.net'\n\n     def welcome\n       mail(to: 'mikel@test.lindsaar.net')\n     end\n   end\n\n Will look for all templates at \"app/views/notifier\" with name \"welcome\".\n If no welcome template exists, it will raise an ActionView::MissingTemplate error.\n\n However, those can be customized:\n\n   mail(template_path: 'notifications', template_name: 'another')\n\n And now it will look for all templates at \"app/views/notifications\" with name \"another\".\n\n If you do pass a block, you can render specific templates of your choice:\n\n   mail(to: 'mikel@test.lindsaar.net') do |format|\n     format.text\n     format.html\n   end\n\n You can even render plain text directly without using a template:\n\n   mail(to: 'mikel@test.lindsaar.net') do |format|\n     format.text { render plain: \"Hello Mikel!\" }\n     format.html { render html: \"<h1>Hello Mikel!</h1>\".html_safe }\n   end\n\n Which will render a +multipart/alternative+ email with +text/plain+ and\n +text/html+ parts.\n\n The block syntax also allows you to customize the part headers if desired:\n\n   mail(to: 'mikel@test.lindsaar.net') do |format|\n     format.text(content_transfer_encoding: \"base64\")\n     format.html\n   end", "Attaches one or more +attachables+ to the record.\n\n If the record is persisted and unchanged, the attachments are saved to\n the database immediately. Otherwise, they'll be saved to the DB when the\n record is next saved.\n\n   document.images.attach(params[:images]) # Array of ActionDispatch::Http::UploadedFile objects\n   document.images.attach(params[:signed_blob_id]) # Signed reference to blob from direct upload\n   document.images.attach(io: File.open(\"/path/to/racecar.jpg\"), filename: \"racecar.jpg\", content_type: \"image/jpg\")\n   document.images.attach([ first_blob, second_blob ])", "Sets the HTTP character set. In case of +nil+ parameter\n it sets the charset to +default_charset+.\n\n   response.charset = 'utf-16' # => 'utf-16'\n   response.charset = nil      # => 'utf-8'", "Returns the number of days to the start of the week on the given day.\n Week is assumed to start on +start_day+, default is\n +Date.beginning_of_week+ or +config.beginning_of_week+ when set.", "remote_send sends a request to the remote endpoint.\n\n It blocks until the remote endpoint accepts the message.\n\n @param req [Object, String] the object to send or it's marshal form.\n @param marshalled [false, true] indicates if the object is already\n marshalled.", "send_status sends a status to the remote endpoint.\n\n @param code [int] the status code to send\n @param details [String] details\n @param assert_finished [true, false] when true(default), waits for\n FINISHED.\n @param metadata [Hash] metadata to send to the server. If a value is a\n list, mulitple metadata for its key are sent", "remote_read reads a response from the remote endpoint.\n\n It blocks until the remote endpoint replies with a message or status.\n On receiving a message, it returns the response after unmarshalling it.\n On receiving a status, it returns nil if the status is OK, otherwise\n raising BadStatus", "each_remote_read passes each response to the given block or returns an\n enumerator the responses if no block is given.\n Used to generate the request enumerable for\n server-side client-streaming RPC's.\n\n == Enumerator ==\n\n * #next blocks until the remote endpoint sends a READ or FINISHED\n * for each read, enumerator#next yields the response\n * on status\n    * if it's is OK, enumerator#next raises StopException\n    * if is not OK, enumerator#next raises RuntimeException\n\n == Block ==\n\n * if provided it is executed for each response\n * the call blocks until no more responses are provided\n\n @return [Enumerator] if no block was given", "each_remote_read_then_finish passes each response to the given block or\n returns an enumerator of the responses if no block is given.\n\n It is like each_remote_read, but it blocks on finishing on detecting\n the final message.\n\n == Enumerator ==\n\n * #next blocks until the remote endpoint sends a READ or FINISHED\n * for each read, enumerator#next yields the response\n * on status\n    * if it's is OK, enumerator#next raises StopException\n    * if is not OK, enumerator#next raises RuntimeException\n\n == Block ==\n\n * if provided it is executed for each response\n * the call blocks until no more responses are provided\n\n @return [Enumerator] if no block was given", "request_response sends a request to a GRPC server, and returns the\n response.\n\n @param req [Object] the request sent to the server\n @param metadata [Hash] metadata to be sent to the server. If a value is\n a list, multiple metadata for its key are sent\n @return [Object] the response received from the server", "client_streamer sends a stream of requests to a GRPC server, and\n returns a single response.\n\n requests provides an 'iterable' of Requests. I.e. it follows Ruby's\n #each enumeration protocol. In the simplest case, requests will be an\n array of marshallable objects; in typical case it will be an Enumerable\n that allows dynamic construction of the marshallable objects.\n\n @param requests [Object] an Enumerable of requests to send\n @param metadata [Hash] metadata to be sent to the server. If a value is\n a list, multiple metadata for its key are sent\n @return [Object] the response received from the server", "server_streamer sends one request to the GRPC server, which yields a\n stream of responses.\n\n responses provides an enumerator over the streamed responses, i.e. it\n follows Ruby's #each iteration protocol.  The enumerator blocks while\n waiting for each response, stops when the server signals that no\n further responses will be supplied.  If the implicit block is provided,\n it is executed with each response as the argument and no result is\n returned.\n\n @param req [Object] the request sent to the server\n @param metadata [Hash] metadata to be sent to the server. If a value is\n a list, multiple metadata for its key are sent\n @return [Enumerator|nil] a response Enumerator", "bidi_streamer sends a stream of requests to the GRPC server, and yields\n a stream of responses.\n\n This method takes an Enumerable of requests, and returns and enumerable\n of responses.\n\n == requests ==\n\n requests provides an 'iterable' of Requests. I.e. it follows Ruby's\n #each enumeration protocol. In the simplest case, requests will be an\n array of marshallable objects; in typical case it will be an\n Enumerable that allows dynamic construction of the marshallable\n objects.\n\n == responses ==\n\n This is an enumerator of responses.  I.e, its #next method blocks\n waiting for the next response.  Also, if at any point the block needs\n to consume all the remaining responses, this can be done using #each or\n #collect.  Calling #each or #collect should only be done if\n the_call#writes_done has been called, otherwise the block will loop\n forever.\n\n @param requests [Object] an Enumerable of requests to send\n @param metadata [Hash] metadata to be sent to the server. If a value is\n a list, multiple metadata for its key are sent\n @return [Enumerator, nil] a response Enumerator", "run_server_bidi orchestrates a BiDi stream processing on a server.\n\n N.B. gen_each_reply is a func(Enumerable<Requests>)\n\n It takes an enumerable of requests as an arg, in case there is a\n relationship between the stream of requests and the stream of replies.\n\n This does not mean that must necessarily be one.  E.g, the replies\n produced by gen_each_reply could ignore the received_msgs\n\n @param mth [Proc] generates the BiDi stream replies\n @param interception_ctx [InterceptionContext]", "Creates a BidiCall.\n\n BidiCall should only be created after a call is accepted.  That means\n different things on a client and a server.  On the client, the call is\n accepted after call.invoke. On the server, this is after call.accept.\n\n #initialize cannot determine if the call is accepted or not; so if a\n call that's not accepted is used here, the error won't be visible until\n the BidiCall#run is called.\n\n deadline is the absolute deadline for the call.\n\n @param call [Call] the call used by the ActiveCall\n @param marshal [Function] f(obj)->string that marshal requests\n @param unmarshal [Function] f(string)->obj that unmarshals responses\n @param metadata_received [true|false] indicates if metadata has already\n     been received. Should always be true for server calls\n Begins orchestration of the Bidi stream for a client sending requests.\n\n The method either returns an Enumerator of the responses, or accepts a\n block that can be invoked with each response.\n\n @param requests the Enumerable of requests to send\n @param set_input_stream_done [Proc] called back when we're done\n   reading the input stream\n @param set_output_stream_done [Proc] called back when we're done\n   sending data on the output stream\n @return an Enumerator of requests to yield", "Begins orchestration of the Bidi stream for a server generating replies.\n\n N.B. gen_each_reply is a func(Enumerable<Requests>)\n\n It takes an enumerable of requests as an arg, in case there is a\n relationship between the stream of requests and the stream of replies.\n\n This does not mean that must necessarily be one.  E.g, the replies\n produced by gen_each_reply could ignore the received_msgs\n\n @param [Proc] gen_each_reply generates the BiDi stream replies.\n @param [Enumerable] requests The enumerable of requests to run", "performs a read using @call.run_batch, ensures metadata is set up", "set_output_stream_done is relevant on client-side", "Provides an enumerator that yields results of remote reads", "Runs the given block on the queue with the provided args.\n\n @param args the args passed blk when it is called\n @param blk the block to call", "Starts running the jobs in the thread pool.", "Stops the jobs in the pool", "Forcibly shutdown any threads that are still alive.", "Creates a new RpcServer.\n\n The RPC server is configured using keyword arguments.\n\n There are some specific keyword args used to configure the RpcServer\n instance.\n\n * pool_size: the size of the thread pool the server uses to run its\n threads. No more concurrent requests can be made than the size\n of the thread pool\n\n * max_waiting_requests: Deprecated due to internal changes to the thread\n pool. This is still an argument for compatibility but is ignored.\n\n * poll_period: The amount of time in seconds to wait for\n currently-serviced RPC's to finish before cancelling them when shutting\n down the server.\n\n * pool_keep_alive: The amount of time in seconds to wait\n for currently busy thread-pool threads to finish before\n forcing an abrupt exit to each thread.\n\n * connect_md_proc:\n when non-nil is a proc for determining metadata to send back the client\n on receiving an invocation req.  The proc signature is:\n   {key: val, ..} func(method_name, {key: val, ...})\n\n * server_args:\n A server arguments hash to be passed down to the underlying core server\n\n * interceptors:\n Am array of GRPC::ServerInterceptor objects that will be used for\n intercepting server handlers to provide extra functionality.\n Interceptors are an EXPERIMENTAL API.\n\n stops a running server\n\n the call has no impact if the server is already stopped, otherwise\n server's current call loop is it's last.", "Can only be called while holding @run_mutex", "handle registration of classes\n\n service is either a class that includes GRPC::GenericService and whose\n #new function can be called without argument or any instance of such a\n class.\n\n E.g, after\n\n class Divider\n   include GRPC::GenericService\n   rpc :div DivArgs, DivReply    # single request, single response\n   def initialize(optional_arg='default option') # no args\n     ...\n   end\n\n srv = GRPC::RpcServer.new(...)\n\n # Either of these works\n\n srv.handle(Divider)\n\n # or\n\n srv.handle(Divider.new('replace optional arg'))\n\n It raises RuntimeError:\n - if service is not valid service class or object\n - its handler methods are already registered\n - if the server is already running\n\n @param service [Object|Class] a service class or object as described\n        above", "runs the server\n\n - if no rpc_descs are registered, this exits immediately, otherwise it\n   continues running permanently and does not return until program exit.\n\n - #running? returns true after this is called, until #stop cause the\n   the server to stop.", "runs the server with signal handlers\n @param signals\n     List of String, Integer or both representing signals that the user\n     would like to send to the server for graceful shutdown\n @param wait_interval (optional)\n     Integer seconds that user would like stop_server_thread to poll\n     stop_server", "Sends RESOURCE_EXHAUSTED if there are too many unprocessed jobs", "Sends UNIMPLEMENTED if the method is not implemented by this server", "handles calls to the server", "Creates a new ClientStub.\n\n Minimally, a stub is created with the just the host of the gRPC service\n it wishes to access, e.g.,\n\n   my_stub = ClientStub.new(example.host.com:50505,\n                            :this_channel_is_insecure)\n\n If a channel_override argument is passed, it will be used as the\n underlying channel. Otherwise, the channel_args argument will be used\n to construct a new underlying channel.\n\n There are some specific keyword args that are not used to configure the\n channel:\n\n - :channel_override\n when present, this must be a pre-created GRPC::Core::Channel.  If it's\n present the host and arbitrary keyword arg areignored, and the RPC\n connection uses this channel.\n\n - :timeout\n when present, this is the default timeout used for calls\n\n @param host [String] the host the stub connects to\n @param creds [Core::ChannelCredentials|Symbol] the channel credentials, or\n     :this_channel_is_insecure, which explicitly indicates that the client\n     should be created with an insecure connection. Note: this argument is\n     ignored if the channel_override argument is provided.\n @param channel_override [Core::Channel] a pre-created channel\n @param timeout [Number] the default timeout to use in requests\n @param propagate_mask [Number] A bitwise combination of flags in\n     GRPC::Core::PropagateMasks. Indicates how data should be propagated\n     from parent server calls to child client calls if this client is being\n     used within a gRPC server.\n @param channel_args [Hash] the channel arguments. Note: this argument is\n     ignored if the channel_override argument is provided.\n @param interceptors [Array<GRPC::ClientInterceptor>] An array of\n     GRPC::ClientInterceptor objects that will be used for\n     intercepting calls before they are executed\n     Interceptors are an EXPERIMENTAL API.\n request_response sends a request to a GRPC server, and returns the\n response.\n\n == Flow Control ==\n This is a blocking call.\n\n * it does not return until a response is received.\n\n * the requests is sent only when GRPC core's flow control allows it to\n   be sent.\n\n == Errors ==\n An RuntimeError is raised if\n\n * the server responds with a non-OK status\n\n * the deadline is exceeded\n\n == Return Value ==\n\n If return_op is false, the call returns the response\n\n If return_op is true, the call returns an Operation, calling execute\n on the Operation returns the response.\n\n @param method [String] the RPC method to call on the GRPC server\n @param req [Object] the request sent to the server\n @param marshal [Function] f(obj)->string that marshals requests\n @param unmarshal [Function] f(string)->obj that unmarshals responses\n @param deadline [Time] (optional) the time the request should complete\n @param return_op [true|false] return an Operation if true\n @param parent [Core::Call] a prior call whose reserved metadata\n   will be propagated by this one.\n @param credentials [Core::CallCredentials] credentials to use when making\n   the call\n @param metadata [Hash] metadata to be sent to the server\n @return [Object] the response received from the server", "Creates a new active stub\n\n @param method [string] the method being called.\n @param marshal [Function] f(obj)->string that marshals requests\n @param unmarshal [Function] f(string)->obj that unmarshals responses\n @param parent [Grpc::Call] a parent call, available when calls are\n   made from server\n @param credentials [Core::CallCredentials] credentials to use when making\n   the call", "Lookup a Liquid variable in the given context.\n\n context  - the Liquid context in question.\n variable - the variable name, as a string.\n\n Returns the value of the variable in the context\n   or the variable name if not found.", "Determine which converters to use based on this document's\n extension.\n\n Returns Array of Converter instances.", "Prepare payload and render the document\n\n Returns String rendered document output", "Render the document.\n\n Returns String rendered document output\n rubocop: disable AbcSize", "Render layouts and place document content inside.\n\n Returns String rendered content", "Checks if the layout specified in the document actually exists\n\n layout - the layout to check\n Returns nothing", "Render layout content into document.output\n\n Returns String rendered content", "Set page content to payload and assign pager if document has one.\n\n Returns nothing", "Read Site data from disk and load it into internal data structures.\n\n Returns nothing.", "Recursively traverse directories with the read_directories function.\n\n base - The String representing the site's base directory.\n dir - The String representing the directory to traverse down.\n dot_dirs - The Array of subdirectories in the dir.\n\n Returns nothing.", "Read the entries from a particular directory for processing\n\n dir - The String representing the relative path of the directory to read.\n subfolder - The String representing the directory to read.\n\n Returns the list of entries to process", "Write static files, pages, and posts.\n\n Returns nothing.", "Construct a Hash of Posts indexed by the specified Post attribute.\n\n post_attr - The String name of the Post attribute.\n\n Examples\n\n   post_attr_hash('categories')\n   # => { 'tech' => [<Post A>, <Post B>],\n   #      'ruby' => [<Post B>] }\n\n Returns the Hash: { attr => posts } where\n   attr  - One of the values for the requested attribute.\n   posts - The Array of Posts with the given attr value.", "Get the implementation class for the given Converter.\n Returns the Converter instance implementing the given Converter.\n klass - The Class of the Converter to fetch.", "klass - class or module containing the subclasses.\n Returns array of instances of subclasses of parameter.\n Create array of instances of the subclasses of the class or module\n passed in as argument.", "Get all the documents\n\n Returns an Array of all Documents", "Disable Marshaling cache to disk in Safe Mode", "Finds a default value for a given setting, filtered by path and type\n\n path - the path (relative to the source) of the page,\n post or :draft the default is used in\n type - a symbol indicating whether a :page,\n a :post or a :draft calls this method\n\n Returns the default value or nil if none was found", "Collects a hash with all default values for a page or post\n\n path - the relative path of the page or post\n type - a symbol indicating the type (:post, :page or :draft)\n\n Returns a hash with all default values (an empty hash if there are none)", "Returns a list of valid sets\n\n This is not cached to allow plugins to modify the configuration\n and have their changes take effect\n\n Returns an array of hashes", "Retrieve a cached item\n Raises if key does not exist in cache\n\n Returns cached value", "Add an item to cache\n\n Returns nothing.", "Remove one particular item from the cache\n\n Returns nothing.", "Check if `key` already exists in this cache\n\n Returns true if key exists in the cache, false otherwise", "Given a hashed key, return the path to where this item would be saved on disk.", "Render Liquid in the content\n\n content - the raw Liquid content to render\n payload - the payload for Liquid\n info    - the info for Liquid\n\n Returns the converted content", "Convert this Convertible's data to a Hash suitable for use by Liquid.\n\n Returns the Hash representation of this Convertible.", "Recursively render layouts\n\n layouts - a list of the layouts\n payload - the payload for Liquid\n info    - the info for Liquid\n\n Returns nothing", "Add any necessary layouts to this convertible document.\n\n payload - The site payload Drop or Hash.\n layouts - A Hash of {\"name\" => \"layout\"}.\n\n Returns nothing.", "Require each of the runtime_dependencies specified by the theme's gemspec.\n\n Returns false only if no dependencies have been specified, otherwise nothing.", "Require all .rb files if safe mode is off\n\n Returns nothing.", "Initialize a new StaticFile.\n\n site - The Site.\n base - The String path to the <source>.\n dir  - The String path between <source> and the file.\n name - The String filename of the file.\n rubocop: disable ParameterLists\n rubocop: enable ParameterLists\n Returns source file path.", "Merge some data in with this document's data.\n\n Returns the merged data.", "Merges a master hash with another hash, recursively.\n\n master_hash - the \"parent\" hash whose values will be overridden\n other_hash  - the other hash whose values will be persisted after the merge\n\n This code was lovingly stolen from some random gem:\n http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html\n\n Thanks to whoever made it.", "Read array from the supplied hash favouring the singular key\n and then the plural key, and handling any nil entries.\n\n hash - the hash to read from\n singular_key - the singular key\n plural_key - the plural key\n\n Returns an array", "Determine whether the given content string contains Liquid Tags or Vaiables\n\n Returns true is the string contains sequences of `{%` or `{{`", "Add an appropriate suffix to template so that it matches the specified\n permalink style.\n\n template - permalink template without trailing slash or file extension\n permalink_style - permalink style, either built-in or custom\n\n The returned permalink template will use the same ending style as\n specified in permalink_style.  For example, if permalink_style contains a\n trailing slash (or is :pretty, which indirectly has a trailing slash),\n then so will the returned template.  If permalink_style has a trailing\n \":output_ext\" (or is :none, :date, or :ordinal) then so will the returned\n template.  Otherwise, template will be returned without modification.\n\n Examples:\n   add_permalink_suffix(\"/:basename\", :pretty)\n   # => \"/:basename/\"\n\n   add_permalink_suffix(\"/:basename\", :date)\n   # => \"/:basename:output_ext\"\n\n   add_permalink_suffix(\"/:basename\", \"/:year/:month/:title/\")\n   # => \"/:basename/\"\n\n   add_permalink_suffix(\"/:basename\", \"/:year/:month/:title\")\n   # => \"/:basename\"\n\n Returns the updated permalink template", "Replace each character sequence with a hyphen.\n\n See Utils#slugify for a description of the character sequence specified\n by each mode.", "Extract information from the page filename.\n\n name - The String filename of the page file.\n\n NOTE: `String#gsub` removes all trailing periods (in comparison to `String#chomp`)\n Returns nothing.", "Add any necessary layouts to this post\n\n layouts      - The Hash of {\"name\" => \"layout\"}.\n site_payload - The site payload Hash.\n\n Returns String rendered page.", "Filters an array of objects against an expression\n\n input - the object array\n variable - the variable to assign each item to in the expression\n expression - a Liquid comparison expression passed in as a string\n\n Returns the filtered array of objects", "Sort an array of objects\n\n input - the object array\n property - property within each object to filter by\n nils ('first' | 'last') - nils appear before or after non-nil values\n\n Returns the filtered array of objects", "Sort the input Enumerable by the given property.\n If the property doesn't exist, return the sort order respective of\n which item doesn't have the property.\n We also utilize the Schwartzian transform to make this more efficient.", "`where` filter helper", "All the entries in this collection.\n\n Returns an Array of file paths to the documents in this collection\n   relative to the collection's directory", "The full path to the directory containing the collection, with\n   optional subpaths.\n\n *files - (optional) any other path pieces relative to the\n           directory to append to the path\n\n Returns a String containing th directory name where the collection\n   is stored on the filesystem.", "Add a path to the metadata\n\n Returns true, also on failure.", "Add a dependency of a path\n\n Returns nothing.", "Write the metadata to disk\n\n Returns nothing.", "Fetches the finished configuration for a given path. This will try to look for a specific value\n and fallback to a default value if nothing was found", "Use absolute paths instead of relative", "this endpoint is used by Xcode to fetch provisioning profiles.\n The response is an xml plist but has the added benefit of containing the appId of each provisioning profile.\n\n Use this method over `provisioning_profiles` if possible because no secondary API calls are necessary to populate the ProvisioningProfile data model.", "Ensures that there are csrf tokens for the appropriate entity type\n Relies on store_csrf_tokens to set csrf_tokens to the appropriate value\n then stores that in the correct place in cache\n This method also takes a block, if you want to send a custom request, instead of\n calling `.all` on the given klass. This is used for provisioning profiles.", "puts the screenshot into the frame", "Everything below is related to title, background, etc. and is not used in the easy mode\n\n this is used to correct the 1:1 offset information\n the offset information is stored to work for the template images\n since we resize the template images to have higher quality screenshots\n we need to modify the offset information by a certain factor", "Horizontal adding around the frames", "Minimum height for the title", "Returns a correctly sized background image", "Resize the frame as it's too low quality by default", "Add the title above or below the device", "This will build up to 2 individual images with the title and optional keyword, which will then be added to the real image", "Fetches the title + keyword for this particular screenshot", "The font we want to use", "If itc_provider was explicitly specified, use it.\n If there are multiple teams, infer the provider from the selected team name.\n If there are fewer than two teams, don't infer the provider.", "Responsible for setting all required header attributes for the requests\n to succeed", "Uploads the modified package back to App Store Connect\n @param app_id [Integer] The unique App ID\n @param dir [String] the path in which the package file is located\n @return (Bool) True if everything worked fine\n @raise [Deliver::TransporterTransferError] when something went wrong\n   when transferring", "Returns the password to be used with the transporter", "Tells the user how to get an application specific password", "Used when creating a new certificate or profile", "Helpers\n Every installation setup that needs an Xcode project should\n call this method", "Set a new team ID which will be used from now on", "Returns preferred path for storing cookie\n for two step verification.", "Handles the paging for you... for free\n Just pass a block and use the parameter as page number", "Authenticates with Apple's web services. This method has to be called once\n to generate a valid session. The session will automatically be used from then\n on.\n\n This method will automatically use the username from the Appfile (if available)\n and fetch the password from the Keychain (if available)\n\n @param user (String) (optional): The username (usually the email address)\n @param password (String) (optional): The password\n\n @raise InvalidUserCredentialsError: raised if authentication failed\n\n @return (Spaceship::Client) The client the login method was called for", "This method is used for both the Apple Dev Portal and App Store Connect\n This will also handle 2 step verification and 2 factor authentication\n\n It is called in `send_login_request` of sub classes (which the method `login`, above, transferred over to via `do_login`)", "Get contract messages from App Store Connect's \"olympus\" endpoint", "This also gets called from subclasses", "Actually sends the request to the remote server\n Automatically retries the request up to 3 times if something goes wrong", "Returns a path relative to FastlaneFolder.path\n This is needed as the Preview.html file is located inside FastlaneFolder.path", "Renders all data available to quickly see if everything was correctly generated.\n @param export_path (String) The path to a folder where the resulting HTML file should be stored.", "Execute shell command", "pass an array of device types", "Append a lane to the current Fastfile template we're generating", "This method is responsible for ensuring there is a working\n Gemfile, and that `fastlane` is defined as a dependency\n while also having `rubygems` as a gem source", "Parses command options and executes actions", "Add entry to Apple Keychain using AccountManager", "This method takes care of creating a new 'deliver' folder, containing the app metadata\n and screenshots folders", "Checks if the gem name is still free on RubyGems", "Applies a series of replacement rules to turn the requested plugin name into one\n that is acceptable, returning that suggestion", "Hash of available signing identities", "Initializes the listing to use the given api client, language, and fills it with the current listing if available\n Updates the listing in the current edit", "Call this method to ask the user to re-enter the credentials\n @param force: if false, the user is asked before it gets deleted\n @return: Did the user decide to remove the old entry and enter a new password?", "Use env variables from this method to augment internet password item with additional data.\n These variables are used by Xamarin Studio to authenticate Apple developers.", "Called just as the investigation has begun.", "Called once the inspector has received a report with more than one issue.", "Shows a team selection for the user in the terminal. This should not be\n called on CI systems\n\n @param team_id (String) (optional): The ID of an App Store Connect team\n @param team_name (String) (optional): The name of an App Store Connect team", "Sometimes we get errors or info nested in our data\n This method allows you to pass in a set of keys to check for\n along with the name of the sub_section of your original data\n where we should check\n Returns a mapping of keys to data array if we find anything, otherwise, empty map", "Creates a new application on App Store Connect\n @param name (String): The name of your app as it will appear on the App Store.\n   This can't be longer than 255 characters.\n @param primary_language (String): If localized app information isn't available in an\n   App Store territory, the information from your primary language will be used instead.\n @param version *DEPRECATED: Use `Spaceship::Tunes::Application.ensure_version!` method instead*\n   (String): The version number is shown on the App Store and should match the one you used in Xcode.\n @param sku (String): A unique ID for your app that is not visible on the App Store.\n @param bundle_id (String): The bundle ID must match the one you used in Xcode. It\n   can't be changed after you submit your first build.", "Returns an array of all available pricing tiers\n\n @note Although this information is publicly available, the current spaceship implementation requires you to have a logged in client to access it\n\n @return [Array] the PricingTier objects (Spaceship::Tunes::PricingTier)\n [{\n   \"tierStem\": \"0\",\n   \"tierName\": \"Free\",\n   \"pricingInfo\": [{\n       \"country\": \"United States\",\n       \"countryCode\": \"US\",\n       \"currencySymbol\": \"$\",\n       \"currencyCode\": \"USD\",\n       \"wholesalePrice\": 0.0,\n       \"retailPrice\": 0.0,\n       \"fRetailPrice\": \"$0.00\",\n       \"fWholesalePrice\": \"$0.00\"\n     }, {\n     ...\n }, {\n ...", "Returns an array of all supported territories\n\n @note Although this information is publicly available, the current spaceship implementation requires you to have a logged in client to access it\n\n @return [Array] the Territory objects (Spaceship::Tunes::Territory)", "Uploads a watch icon\n @param app_version (AppVersion): The version of your app\n @param upload_image (UploadFile): The icon to upload\n @return [JSON] the response", "Uploads an In-App-Purchase Review screenshot\n @param app_id (AppId): The id of the app\n @param upload_image (UploadFile): The icon to upload\n @return [JSON] the screenshot data, ready to be added to an In-App-Purchase", "Uploads a screenshot\n @param app_version (AppVersion): The version of your app\n @param upload_image (UploadFile): The image to upload\n @param device (string): The target device\n @param is_messages (Bool): True if the screenshot is for iMessage\n @return [JSON] the response", "Uploads an iMessage screenshot\n @param app_version (AppVersion): The version of your app\n @param upload_image (UploadFile): The image to upload\n @param device (string): The target device\n @return [JSON] the response", "Uploads the trailer preview\n @param app_version (AppVersion): The version of your app\n @param upload_trailer_preview (UploadFile): The trailer preview to upload\n @param device (string): The target device\n @return [JSON] the response", "Fetches the App Version Reference information from ITC\n @return [AppVersionRef] the response", "All build trains, even if there is no TestFlight", "updates an In-App-Purchases-Family", "updates an In-App-Purchases", "Creates an In-App-Purchases", "generates group hash used in the analytics time_series API.\n Using rank=DESCENDING and limit=3 as this is what the App Store Connect analytics dashboard uses.", "This is its own method so that it can re-try if the tests fail randomly\n @return true/false depending on if the tests succeeded", "Returns true if it succeeded", "Verifies the default value is also valid", "This method takes care of parsing and using the configuration file as values\n Call this once you know where the config file might be located\n Take a look at how `gym` uses this method\n\n @param config_file_name [String] The name of the configuration file to use (optional)\n @param block_for_missing [Block] A ruby block that is called when there is an unknown method\n   in the configuration file", "Allows the user to call an action from an action", "Makes sure to get the value for the language\n Instead of using the user's value `UK English` spaceship should send\n `English_UK` to the server", "lookup if an alias exists", "This is being called from `method_missing` from the Fastfile\n It's also used when an action is called from another action\n @param from_action Indicates if this action is being trigged by another action.\n                    If so, it won't show up in summary.", "Called internally to setup the runner object\n\n @param lane [Lane] A lane object", "Makes sure a Fastfile is available\n Shows an appropriate message to the user\n if that's not the case\n return true if the Fastfile is available", "Make sure the version on App Store Connect matches the one in the ipa\n If not, the new version will automatically be created", "Upload all metadata, screenshots, pricing information, etc. to App Store Connect", "Upload the binary to App Store Connect", "Upload binary apk and obb and corresponding change logs with client\n\n @param [String] apk_path\n    Path of the apk file to upload.\n\n @return [Integer] The apk version code returned after uploading, or nil if there was a problem", "returns only language directories from metadata_path", "searches for obbs in the directory where the apk is located and\n upload at most one main and one patch file. Do nothing if it finds\n more than one of either of them.", "Calls the appropriate methods for commander to show the available parameters", "Intialize with values from Scan.config matching these param names", "Aborts the current edit deleting all pending changes", "Commits the current edit saving all pending changes on Google Play", "Returns the listing for the given language filled with the current values if it already exists", "Get a list of all APK version codes - returns the list of version codes", "Get a list of all AAB version codes - returns the list of version codes", "Get list of version codes for track", "Returns an array of gems that are added to the Gemfile or Pluginfile", "Check if a plugin is added as dependency to either the\n Gemfile or the Pluginfile", "Modify the user's Gemfile to load the plugins", "Prints a table all the plugins that were loaded", "Some device commands fail if executed against a device path that does not exist, so this helper method\n provides a way to conditionally execute a block only if the provided path exists on the device.", "Return an array of packages that are installed on the device", "Fetches a profile matching the user's search requirements", "Create a new profile and return it", "Certificate to use based on the current distribution mode", "Downloads and stores the provisioning profile", "Makes sure the current App ID exists. If not, it will show an appropriate error message", "Download all valid provisioning profiles", "we got a server control command from the client to do something like shutdown", "send json back to client", "execute fastlane action command", "Get all available schemes in an array", "Let the user select a scheme\n Use a scheme containing the preferred_to_include string when multiple schemes were found", "Get all available configurations in an array", "Returns the build settings and sets the default scheme to the options hash", "Print tables to ask the user", "Make sure to call `load_from_filesystem` before calling upload", "Uploads metadata individually by language to help identify exactly which items have issues", "Makes sure all languages we need are actually created", "Loads the metadata files and stores them into the options object", "Normalizes languages keys from symbols to strings", "Identifies the resolution of a video or an image.\n Supports all video and images required by DU-UTC right now\n @param path (String) the path to the file", "Some actions have special handling in fast_file.rb, that means we can't directly call the action\n but we have to use the same logic that is in fast_file.rb instead.\n That's where this switch statement comes into play", "Builds the app and prepares the archive", "Post-processing of build_app", "Moves over the binary and dsym file to the output directory\n @return (String) The path to the resulting ipa file", "Copies the .app from the archive into the output directory", "Move the manifest.plist if exists into the output directory", "Move the app-thinning.plist file into the output directory", "Move the App Thinning Size Report.txt file into the output directory", "Move the Apps folder to the output directory", "compares the new file content to the old and figures out what api_version the new content should be", "expects format to be \"X.Y.Z\" where each value is a number", "Override Appfile configuration for a specific lane.\n\n lane_name  - Symbol representing a lane name. (Can be either :name, 'name' or 'platform name')\n block - Block to execute to override configuration values.\n\n Discussion If received lane name does not match the lane name available as environment variable, no changes will\n             be applied.", "compares source file against the target file's FastlaneRunnerAPIVersion and returned `true` if there is a difference", "currently just copies file, even if not needed.", "exceptions that happen in worker threads simply cause that thread\n to die and another to be spawned in its place.", "Write the character ch as part of a JSON string, escaping as appropriate.", "Write out the contents of the string str as a JSON string, escaping characters as appropriate.", "Write out the contents of the string as JSON string, base64-encoding\n the string's contents, and escaping as appropriate", "Convert the given double to a JSON string, which is either the number,\n \"NaN\" or \"Infinity\" or \"-Infinity\".", "Decodes the four hex parts of a JSON escaped string character and returns\n the character via out.\n\n Note - this only supports Unicode characters in the BMP (U+0000 to U+FFFF);\n characters above the BMP are encoded as two escape sequences (surrogate pairs),\n which is not yet implemented", "Decodes a JSON string, including unescaping, and returns the string via str", "Reads a block of base64 characters, decoding it, and returns via str", "Reads a sequence of characters, stopping at the first one that is not\n a valid JSON numeric character.", "Reads a sequence of characters and assembles them into a number,\n returning them via num", "Reads a JSON number or string and interprets it as a double.", "Writes a field based on the field information, field ID and value.\n\n field_info - A Hash containing the definition of the field:\n              :name   - The name of the field.\n              :type   - The type of the field, which must be a Thrift::Types constant.\n              :binary - A Boolean flag that indicates if Thrift::Types::STRING is a binary string (string without encoding).\n fid        - The ID of the field.\n value      - The field's value to write; object type varies based on :type.\n\n Returns nothing.", "Writes a field value based on the field information.\n\n field_info - A Hash containing the definition of the field:\n              :type   - The Thrift::Types constant that determines how the value is written.\n              :binary - A Boolean flag that indicates if Thrift::Types::STRING is a binary string (string without encoding).\n value      - The field's value to write; object type varies based on field_info[:type].\n\n Returns nothing.", "Reads a field value based on the field information.\n\n field_info - A Hash containing the pertinent data to write:\n              :type   - The Thrift::Types constant that determines how the value is written.\n              :binary - A flag that indicates if Thrift::Types::STRING is a binary string (string without encoding).\n\n Returns the value read; object type varies based on field_info[:type].", "The workhorse of writeFieldBegin. It has the option of doing a\n 'type override' of the type header. This is used specifically in the\n boolean field case.", "Abstract method for writing the start of lists and sets. List and sets on\n the wire differ only by the type indicator.", "Reads a number of bytes from the transport into the buffer passed.\n\n buffer - The String (byte buffer) to write data to; this is assumed to have a BINARY encoding.\n size   - The number of bytes to read from the transport and write to the buffer.\n\n Returns the number of bytes read.", "1-based index into the fibonacci sequence", "Writes the output buffer to the stream in the format of a 4-byte length\n followed by the actual data.", "Parse an input into a URI object, optionally resolving it\n against a base URI if given.\n\n A URI object will have the following properties: scheme,\n userinfo, host, port, registry, path, opaque, query, and\n fragment.", "Escape a string for use in XPath expression", "This method returns true if the result should be stored as a new event.\n If mode is set to 'on_change', this method may return false and update an existing\n event to expire further in the future.", "Run all the queued up actions, parallelizing if possible.\n\n This will parallelize if and only if the provider of every machine\n supports parallelization and parallelization is possible from\n initialization of the class.", "Get a value by the given key.\n\n This will evaluate the block given to `register` and return the\n resulting value.", "Merge one registry with another and return a completely new\n registry. Note that the result cache is completely busted, so\n any gets on the new registry will result in a cache miss.", "Initializes Bundler and the various gem paths so that we can begin\n loading gems.", "Update updates the given plugins, or every plugin if none is given.\n\n @param [Hash] plugins\n @param [Array<String>] specific Specific plugin names to update. If\n   empty or nil, all plugins will be updated.", "Clean removes any unused gems.", "Iterates each configured RubyGem source to validate that it is properly\n available. If source is unavailable an exception is raised.", "Generate the builtin resolver set", "Activate a given solution", "Initializes a MachineIndex at the given file location.\n\n @param [Pathname] data_dir Path to the directory where data for the\n   index can be stored. This folder should exist and must be writable.\n Deletes a machine by UUID.\n\n The machine being deleted with this UUID must either be locked\n by this index or must be unlocked.\n\n @param [Entry] entry The entry to delete.\n @return [Boolean] true if delete is successful", "Finds a machine where the UUID is prefixed by the given string.\n\n @return [Hash]", "Locks a machine exclusively to us, returning the file handle\n that holds the lock.\n\n If the lock cannot be acquired, then nil is returned.\n\n This should be called within an index lock.\n\n @return [File]", "Releases a local lock on a machine. This does not acquire any locks\n so make sure to lock around it.\n\n @param [String] id", "This will reload the data without locking the index. It is assumed\n the caller with lock the index outside of this call.\n\n @param [File] f", "This will hold a lock to the index so it can be read or updated.", "Loads the metadata associated with the box from the given\n IO.\n\n @param [IO] io An IO object to read the metadata from.\n Returns data about a single version that is included in this\n metadata.\n\n @param [String] version The version to return, this can also\n   be a constraint.\n @return [Version] The matching version or nil if a matching\n   version was not found.", "This prints out the help for the CLI.", "Action runner for executing actions in the context of this environment.\n\n @return [Action::Runner]", "Returns a list of machines that this environment is currently\n managing that physically have been created.\n\n An \"active\" machine is a machine that Vagrant manages that has\n been created. The machine itself may be in any state such as running,\n suspended, etc. but if a machine is \"active\" then it exists.\n\n Note that the machines in this array may no longer be present in\n the Vagrantfile of this environment. In this case the machine can\n be considered an \"orphan.\" Determining which machines are orphan\n and which aren't is not currently a supported feature, but will\n be in a future version.\n\n @return [Array<String, Symbol>]", "This creates a new batch action, yielding it, and then running it\n once the block is called.\n\n This handles the case where batch actions are disabled by the\n VAGRANT_NO_PARALLEL environmental variable.", "This defines a hook point where plugin action hooks that are registered\n against the given name will be run in the context of this environment.\n\n @param [Symbol] name Name of the hook.\n @param [Action::Runner] action_runner A custom action runner for running hooks.", "Returns the host object associated with this environment.\n\n @return [Class]", "This acquires a process-level lock with the given name.\n\n The lock file is held within the data directory of this environment,\n so make sure that all environments that are locking are sharing\n the same data directory.\n\n This will raise Errors::EnvironmentLockedError if the lock can't\n be obtained.\n\n @param [String] name Name of the lock, since multiple locks can\n   be held at one time.", "This executes the push with the given name, raising any exceptions that\n occur.\n\n Precondition: the push is not nil and exists.", "This returns a machine with the proper provider for this environment.\n The machine named by `name` must be in this environment.\n\n @param [Symbol] name Name of the machine (as configured in the\n   Vagrantfile).\n @param [Symbol] provider The provider that this machine should be\n   backed by.\n @param [Boolean] refresh If true, then if there is a cached version\n   it is reloaded.\n @return [Machine]", "This creates the local data directory and show an error if it\n couldn't properly be created.", "Check for any local plugins defined within the Vagrantfile. If\n found, validate they are available. If they are not available,\n request to install them, or raise an exception\n\n @return [Hash] plugin list for loading", "This method copies the private key into the home directory if it\n doesn't already exist.\n\n This must be done because `ssh` requires that the key is chmod\n 0600, but if Vagrant is installed as a separate user, then the\n effective uid won't be able to read the key. So the key is copied\n to the home directory and chmod 0600.", "Finds the Vagrantfile in the given directory.\n\n @param [Pathname] path Path to search in.\n @return [Pathname]", "This upgrades a home directory that was in the v1.1 format to the\n v1.5 format. It will raise exceptions if anything fails.", "This upgrades a Vagrant 1.0.x \"dotfile\" to the new V2 format.\n\n This is a destructive process. Once the upgrade is complete, the\n old dotfile is removed, and the environment becomes incompatible for\n Vagrant 1.0 environments.\n\n @param [Pathname] path The path to the dotfile", "This will detect the proper guest OS for the machine and set up\n the class to actually execute capabilities.", "Initializes by loading a Vagrantfile.\n\n @param [Config::Loader] loader Configuration loader that should\n   already be configured with the proper Vagrantfile locations.\n   This usually comes from {Vagrant::Environment}\n @param [Array<Symbol>] keys The Vagrantfiles to load and the\n   order to load them in (keys within the loader).\n Returns a {Machine} for the given name and provider that\n is represented by this Vagrantfile.\n\n @param [Symbol] name Name of the machine.\n @param [Symbol] provider The provider the machine should\n   be backed by (required for provider overrides).\n @param [BoxCollection] boxes BoxCollection to look up the\n   box Vagrantfile.\n @param [Pathname] data_path Path where local machine data\n   can be stored.\n @param [Environment] env The environment running this machine\n @return [Machine]", "Returns a list of the machine names as well as the options that\n were specified for that machine.\n\n @return [Hash<Symbol, Hash>]", "Returns the name of the machine that is designated as the\n \"primary.\"\n\n In the case of a single-machine environment, this is just the\n single machine name. In the case of a multi-machine environment,\n then this is the machine that is marked as primary, or nil if\n no primary machine was specified.\n\n @return [Symbol]", "Initialize a new machine.\n\n @param [String] name Name of the virtual machine.\n @param [Class] provider The provider backing this machine. This is\n   currently expected to be a V1 `provider` plugin.\n @param [Object] provider_config The provider-specific configuration for\n   this machine.\n @param [Hash] provider_options The provider-specific options from the\n   plugin definition.\n @param [Object] config The configuration for this machine.\n @param [Pathname] data_dir The directory where machine-specific data\n   can be stored. This directory is ensured to exist.\n @param [Box] box The box that is backing this virtual machine.\n @param [Environment] env The environment that this machine is a\n   part of.\n This calls an action on the provider. The provider may or may not\n actually implement the action.\n\n @param [Symbol] name Name of the action to run.\n @param [Hash] extra_env This data will be passed into the action runner\n   as extra data set on the environment hash for the middleware\n   runner.", "This calls a raw callable in the proper context of the machine using\n the middleware stack.\n\n @param [Symbol] name Name of the action\n @param [Proc] callable\n @param [Hash] extra_env Extra env for the action env.\n @return [Hash] The resulting env", "This sets the unique ID associated with this machine. This will\n persist this ID so that in the future Vagrant will be able to find\n this machine again. The unique ID must be absolutely unique to the\n virtual machine, and can be used by providers for finding the\n actual machine associated with this instance.\n\n **WARNING:** Only providers should ever use this method.\n\n @param [String] value The ID.", "This reloads the ID of the underlying machine.", "Returns the state of this machine. The state is queried from the\n backing provider, so it can be any arbitrary symbol.\n\n @return [MachineState]", "Checks the current directory for a given machine\n and displays a warning if that machine has moved\n from its previous location on disk. If the machine\n has moved, it prints a warning to the user.", "This returns an array of all the boxes on the system, given by\n their name and their provider.\n\n @return [Array] Array of `[name, version, provider]` of the boxes\n   installed on this system.", "Find a box in the collection with the given name and provider.\n\n @param [String] name Name of the box (logical name).\n @param [Array] providers Providers that the box implements.\n @param [String] version Version constraints to adhere to. Example:\n   \"~> 1.0\" or \"= 1.0, ~> 1.1\"\n @return [Box] The box found, or `nil` if not found.", "This upgrades a v1.1 - v1.4 box directory structure up to a v1.5\n directory structure. This will raise exceptions if it fails in any\n way.", "Cleans the directory for a box by removing the folders that are\n empty.", "Returns the directory name for the box of the given name.\n\n @param [String] name\n @return [String]", "Returns the directory name for the box cleaned up", "This upgrades the V1 box contained unpacked in the given directory\n and returns the directory of the upgraded version. This is\n _destructive_ to the contents of the old directory. That is, the\n contents of the old V1 box will be destroyed or moved.\n\n Preconditions:\n * `dir` is a valid V1 box. Verify with {#v1_box?}\n\n @param [Pathname] dir Directory where the V1 box is unpacked.\n @return [Pathname] Path to the unpackaged V2 box.", "This is a helper that makes sure that our temporary directories\n are cleaned up no matter what.\n\n @param [String] dir Path to a temporary directory\n @return [Object] The result of whatever the yield is", "Initializes the capability system by detecting the proper capability\n host to execute on and building the chain of capabilities to execute.\n\n @param [Symbol] host The host to use for the capabilities, or nil if\n   we should auto-detect it.\n @param [Hash<Symbol, Array<Class, Symbol>>] hosts Potential capability\n   hosts. The key is the name of the host, value[0] is a class that\n   implements `#detect?` and value[1] is a parent host (if any).\n @param [Hash<Symbol, Hash<Symbol, Class>>] capabilities The capabilities\n   that are supported. The key is the host of the capability. Within that\n   is a hash where the key is the name of the capability and the value\n   is the class/module implementing it.", "Executes the capability with the given name, optionally passing more\n arguments onwards to the capability. If the capability returns a value,\n it will be returned.\n\n @param [Symbol] cap_name Name of the capability", "Returns the registered module for a capability with the given name.\n\n @param [Symbol] cap_name\n @return [Module]", "Checks if this box is in use according to the given machine\n index and returns the entries that appear to be using the box.\n\n The entries returned, if any, are not tested for validity\n with {MachineIndex::Entry#valid?}, so the caller should do that\n if the caller cares.\n\n @param [MachineIndex] index\n @return [Array<MachineIndex::Entry>]", "Loads the metadata URL and returns the latest metadata associated\n with this box.\n\n @param [Hash] download_options Options to pass to the downloader.\n @return [BoxMetadata]", "Checks if the box has an update and returns the metadata, version,\n and provider. If the box doesn't have an update that satisfies the\n constraints, it will return nil.\n\n This will potentially make a network call if it has to load the\n metadata from the network.\n\n @param [String] version Version constraints the update must\n   satisfy. If nil, the version constrain defaults to being a\n   larger version than this box.\n @return [Array]", "Check if a box update check is allowed. Uses a file\n in the box data directory to track when the last auto\n update check was performed and returns true if the\n BOX_UPDATE_CHECK_INTERVAL has passed.\n\n @return [Boolean]", "This repackages this box and outputs it to the given path.\n\n @param [Pathname] path The full path (filename included) of where\n   to output this box.\n @return [Boolean] true if this succeeds.", "This interprets a raw line from the aliases file.", "This registers an alias.", "Halt processing and redirect to the URI provided.", "Generates the absolute URI for a given path in the app.\n Takes Rack routers and reverse proxies into account.", "Set the Content-Type of the response body given a media type or file\n extension.", "Allows to start sending data to the client even though later parts of\n the response body have not yet been generated.\n\n The close parameter specifies whether Stream#close should be called\n after the block has been executed. This is only relevant for evented\n servers like Thin or Rainbows.", "Helper method checking if a ETag value list includes the current ETag.", "logic shared between builder and nokogiri", "Run filters defined on the class and all superclasses.", "Run routes defined on the class and all superclasses.", "Creates a Hash with indifferent access.", "reduce 21 omitted", "Set Engine's dry_run_mode true to override all target_id of worker sections", "This method returns MultiEventStream, because there are no reason\n to surve binary serialized by msgpack.", "return chunk id to be committed", "to include TimeParseError", "search a plugin by plugin_id", "This method returns an array because\n multiple plugins could have the same type", "get monitor info from the plugin `pe` and return a hash object", "Sanitize the parameters for a specific +action+.\n\n === Arguments\n\n * +action+ - A +Symbol+ with the action that the controller is\n   performing, like +sign_up+, +sign_in+, etc.\n\n === Examples\n\n    # Inside the `RegistrationsController#create` action.\n    resource = build_resource(devise_parameter_sanitizer.sanitize(:sign_up))\n    resource.save\n\n Returns an +ActiveSupport::HashWithIndifferentAccess+ with the permitted\n attributes.", "Add or remove new parameters to the permitted list of an +action+.\n\n === Arguments\n\n * +action+ - A +Symbol+ with the action that the controller is\n   performing, like +sign_up+, +sign_in+, etc.\n * +keys:+     - An +Array+ of keys that also should be permitted.\n * +except:+   - An +Array+ of keys that shouldn't be permitted.\n * +block+     - A block that should be used to permit the action\n   parameters instead of the +Array+ based approach. The block will be\n   called with an +ActionController::Parameters+ instance.\n\n === Examples\n\n   # Adding new parameters to be permitted in the `sign_up` action.\n   devise_parameter_sanitizer.permit(:sign_up, keys: [:subscribe_newsletter])\n\n   # Removing the `password` parameter from the `account_update` action.\n   devise_parameter_sanitizer.permit(:account_update, except: [:password])\n\n   # Using the block form to completely override how we permit the\n   # parameters for the `sign_up` action.\n   devise_parameter_sanitizer.permit(:sign_up) do |user|\n     user.permit(:email, :password, :password_confirmation)\n   end\n\n\n Returns nothing.", "Force keys to be string to avoid injection on mongoid related database.", "Parse source code.\n Returns self for easy chaining", "Render takes a hash with local variables.\n\n if you use the same filters over and over again consider registering them globally\n with <tt>Template.register_filter</tt>\n\n if profiling was enabled in <tt>Template#parse</tt> then the resulting profiling information\n will be available via <tt>Template#profiler</tt>\n\n Following options can be passed:\n\n  * <tt>filters</tt> : array with local filters\n  * <tt>registers</tt> : hash with register variables. Those can be accessed from\n    filters and tags and might be useful to integrate liquid more with its host application", "Truncate a string down to x characters", "Sort elements of the array\n provide optional property with which to sort an array of hashes or drops", "Filter the elements of an array to those with a certain property value.\n By default the target is any truthy value.", "Remove duplicate elements from an array\n provide optional property with which to determine uniqueness", "Replace occurrences of a string with another", "Replace the first occurrences of a string with another", "Pushes a new local scope on the stack, pops it at the end of the block\n\n Example:\n   context.stack do\n      context['var'] = 'hi'\n   end\n\n   context['var]  #=> nil", "Fetches an object starting at the local scope and then moving up the hierachy", "Restore an offense object loaded from a JSON file.", "Checks if there is whitespace before token", "Sets a value in the @options hash, based on the given long option and its\n value, in addition to calling the block if a block is given.", "Returns true if there's a chance that an Include pattern matches hidden\n files, false if that's definitely not possible.", "Check whether a run created source identical to a previous run, which\n means that we definitely have an infinite loop.", "Finds all Ruby source files under the current or other supplied\n directory. A Ruby source file is defined as a file with the `.rb`\n extension or a file with no extension that has a ruby shebang line\n as its first line.\n It is possible to specify includes and excludes using the config file,\n so you can include other Ruby files like Rakefiles and gemspecs.\n @param base_dir Root directory under which to search for\n   ruby source files\n @return [Array] Array of filenames", "The checksum of the rubocop program running the inspection.", "Return a hash of the options given at invocation, minus the ones that have\n no effect on which offenses and disabled line ranges are found, and thus\n don't affect caching.", "Return a recursive merge of two hashes. That is, a normal hash merge,\n with the addition that any value that is a hash, and occurs in both\n arguments, will also be merged. And so on.\n\n rubocop:disable Metrics/AbcSize", "DoppelGanger implementation of build_node. preserves as many of the node's\n attributes, and does not save updates to the server", "paper over inconsistencies in the model classes APIs, and return the objects\n the user wanted instead of the URI=>object stuff", "Apply default configuration values for workstation-style tools.\n\n Global defaults should go in {ChefConfig::Config} instead, this is only\n for things like `knife` and `chef`.\n\n @api private\n @since 14.3\n @return [void]", "Look for a default key file.\n\n This searches for any of a list of possible default keys, checking both\n the local `.chef/` folder and the home directory `~/.chef/`. Returns `nil`\n if no matching file is found.\n\n @api private\n @since 14.3\n @param key_names [Array<String>] A list of possible filenames to check for.\n   The first one found will be returned.\n @return [String, nil]", "Set or retrieve the response status code.", "Loads the configuration from the YAML files whose +paths+ are passed as\n arguments, filtering the settings for the current environment.  Note that\n these +paths+ can actually be globs.", "Returns true if supplied with a hash that has any recognized\n +environments+ in its root keys.", "Sets Link HTTP header and returns HTML tags for using stylesheets.", "Sets Link HTTP header and returns corresponding HTML tags.\n\n Example:\n\n   # Sets header:\n   #   Link: </foo>; rel=\"next\"\n   # Returns String:\n   #   '<link href=\"/foo\" rel=\"next\" />'\n   link '/foo', :rel => :next\n\n   # Multiple URLs\n   link :stylesheet, '/a.css', '/b.css'", "Parse a file of run definitions and yield each run.\n\n @params [ String ] file The YAML file containing the matrix of test run definitions.\n\n @yieldparam [ Hash ] A test run definition.\n\n @since 7.0.0", "Adds an attribute to the factory.\n The attribute value will be generated \"lazily\"\n by calling the block whenever an instance is generated.\n The block will not be called if the\n attribute is overridden for a specific instance.\n\n Arguments:\n * name: +Symbol+ or +String+\n   The name of this attribute. This will be assigned using \"name=\" for\n   generated instances.", "Adds an attribute that will have unique values generated by a sequence with\n a specified format.\n\n The result of:\n   factory :user do\n     sequence(:email) { |n| \"person#{n}@example.com\" }\n   end\n\n Is equal to:\n   sequence(:email) { |n| \"person#{n}@example.com\" }\n\n   factory :user do\n     email { FactoryBot.generate(:email) }\n   end\n\n Except that no globally available sequence will be defined.", "Adds an attribute that builds an association. The associated instance will\n be built using the same build strategy as the parent instance.\n\n Example:\n   factory :user do\n     name 'Joey'\n   end\n\n   factory :post do\n     association :author, factory: :user\n   end\n\n Arguments:\n * name: +Symbol+\n   The name of this attribute.\n * options: +Hash+\n\n Options:\n * factory: +Symbol+ or +String+\n    The name of the factory to use when building the associated instance.\n    If no name is given, the name of the attribute is assumed to be the\n    name of the factory. For example, a \"user\" association will by\n    default use the \"user\" factory.", "A lookahead for the root selections of this query\n @return [GraphQL::Execution::Lookahead]", "Get the result for this query, executing it once\n @return [Hash] A GraphQL response, with `\"data\"` and/or `\"errors\"` keys", "Declare that this object implements this interface.\n This declaration will be validated when the schema is defined.\n @param interfaces [Array<GraphQL::Interface>] add a new interface that this type implements\n @param inherits [Boolean] If true, copy the interfaces' field definitions to this type", "Given a callable whose API used to take `from` arguments,\n check its arity, and if needed, apply a wrapper so that\n it can be called with `to` arguments.\n If a wrapper is applied, warn the application with `name`.\n\n If `last`, then use the last arguments to call the function.", "`event` was triggered on `object`, and `subscription_id` was subscribed,\n so it should be updated.\n\n Load `subscription_id`'s GraphQL data, re-evaluate the query, and deliver the result.\n\n This is where a queue may be inserted to push updates in the background.\n\n @param subscription_id [String]\n @param event [GraphQL::Subscriptions::Event] The event which was triggered\n @param object [Object] The value for the subscription field\n @return [void]", "Event `event` occurred on `object`,\n Update all subscribers.\n @param event [Subscriptions::Event]\n @param object [Object]\n @return [void]", "Return a GraphQL string for the type definition\n @param schema [GraphQL::Schema]\n @param printer [GraphQL::Schema::Printer]\n @see {GraphQL::Schema::Printer#initialize for additional options}\n @return [String] type definition", "Use the provided `method_name` to generate a string from the specified schema\n then write it to `file`.", "Use the Rake DSL to add tasks", "Prepare a lazy value for this field. It may be `then`-ed and resolved later.\n @return [GraphQL::Execution::Lazy] A lazy wrapper around `obj` and its registered method name", "Returns true if `member, ctx` passes this filter", "Visit `query`'s internal representation, calling `analyzers` along the way.\n\n - First, query analyzers are filtered down by calling `.analyze?(query)`, if they respond to that method\n - Then, query analyzers are initialized by calling `.initial_value(query)`, if they respond to that method.\n - Then, they receive `.call(memo, visit_type, irep_node)`, where visit type is `:enter` or `:leave`.\n - Last, they receive `.final_value(memo)`, if they respond to that method.\n\n It returns an array of final `memo` values in the order that `analyzers` were passed in.\n\n @param query [GraphQL::Query]\n @param analyzers [Array<#call>] Objects that respond to `#call(memo, visit_type, irep_node)`\n @return [Array<Any>] Results from those analyzers", "Enter the node, visit its children, then leave the node.", "Validate a query string according to this schema.\n @param string_or_document [String, GraphQL::Language::Nodes::Document]\n @return [Array<GraphQL::StaticValidation::Error >]", "Execute a query on itself. Raises an error if the schema definition is invalid.\n @see {Query#initialize} for arguments.\n @return [Hash] query result, ready to be serialized as JSON", "This is a compatibility hack so that instance-level and class-level\n methods can get correctness checks without calling one another\n @api private", "Get a unique identifier from this object\n @param object [Any] An application object\n @param type [GraphQL::BaseType] The current type definition\n @param ctx [GraphQL::Query::Context] the context for the current query\n @return [String] a unique identifier for `object` which clients can use to refetch it", "Return the GraphQL IDL for the schema\n @param context [Hash]\n @param only [<#call(member, ctx)>]\n @param except [<#call(member, ctx)>]\n @return [String]", "Get the underlying value for this enum value\n\n @example get episode value from Enum\n   episode = EpisodeEnum.coerce(\"NEWHOPE\")\n   episode # => 6\n\n @param value_name [String] the string representation of this enum value\n @return [Object] the underlying value for this enum value", "This is for testing input object behavior", "Customize the JSON serialization for Elasticsearch", "Text representation of the client, masking tokens and passwords\n\n @return [String]", "Hypermedia agent for the GitHub API\n\n @return [Sawyer::Agent]", "Executes the request, checking if it was successful\n\n @return [Boolean] True on success, false otherwise", "Adds the `aria-selected` attribute to a link when it's pointing to the\n current path. The API is the same than the `link_to` one, and uses this\n helper internally.\n\n text - a String with the link text\n link - Where the link should point to. Accepts the same value than\n   `link_to` helper.\n options - An options Hash that will be passed to `link_to`.", "Renders all form attributes defined by the handler.\n\n Returns a String.", "Renders a single attribute from the form handlers.\n\n name - The String name of the attribute.\n options - An optional Hash, accepted options are:\n           :as - A String name with the type the field to render\n           :input - An optional Hash to pass to the field method.\n\n Returns a String.", "All the resource types that are eligible to be included as an activity.", "Creates a ew authorization form in a view, accepts the same arguments as\n `form_for`.\n\n record  - The record to use in the form, it shoulde be a descendant of\n AuthorizationHandler.\n options - An optional hash with options to pass wo the form builder.\n block   - A block with the content of the form.\n\n Returns a String.", "Stores the url where the user will be redirected after login.\n\n Uses the `redirect_url` param or the current url if there's no param.\n In Devise controllers we only store the URL if it's from the params, we don't\n want to overwrite the stored URL for a Devise one.", "Checks if the resource should show its scope or not.\n resource - the resource to analize\n\n Returns boolean.", "Renders a scopes picker field in a form, not linked to a specific model.\n name - name for the input\n value - value for the input\n\n Returns nothing.", "Renders the emendations of an amendable resource\n\n Returns Html grid of CardM.", "Checks if the user can accept and reject the emendation", "Checks if the user can promote the emendation", "Checks if the unique ActionLog created in the promote command exists.", "Renders a UserGroup select field in a form.", "Return the edited field value or presents the original attribute value in a form.", "Renders a link to openstreetmaps with the resource latitude and longitude.\n The link's content is a static map image.\n\n resource - A geolocalizable resource\n options - An optional hash of options (default: { zoom: 17 })\n           * zoom: A number to represent the zoom value of the map", "Renders the attachment's title.\n Checks if the attachment's title is translated or not and use\n the correct render method.\n\n attachment - An Attachment object\n\n Returns String.", "Overrides the submit tags to always be buttons instead of inputs.\n Buttons are much more stylable and less prone to bugs.\n\n value   - The text of the button\n options - Options to provide to the actual tag.\n\n Returns a SafeString with the tag.", "Calls the `create` method to the given class and sets the author of the version.\n\n klass - An ActiveRecord class that implements `Decidim::Traceable`\n author - An object that implements `to_gid` or a String\n params - a Hash with the attributes of the new resource\n extra_log_info - a Hash with extra info that will be saved to the log\n\n Returns an instance of `klass`.", "Calls the `create!` method to the given class and sets the author of the version.\n\n klass - An ActiveRecord class that implements `Decidim::Traceable`\n author - An object that implements `to_gid` or a String\n params - a Hash with the attributes of the new resource\n extra_log_info - a Hash with extra info that will be saved to the log\n\n Returns an instance of `klass`.", "Performs the given block and sets the author of the action.\n It also logs the action with the given `action` parameter.\n The action and the logging are run inside a transaction.\n\n action - a String or Symbol representing the action performed\n resource - An ActiveRecord instance that implements `Decidim::Traceable`\n author - An object that implements `to_gid` or a String\n extra_log_info - a Hash with extra info that will be saved to the log\n\n Returns whatever the given block returns.", "Updates the `resource` with `update!` and sets the author of the version.\n\n resource - An ActiveRecord instance that implements `Decidim::Traceable`\n author - An object that implements `to_gid` or a String\n params - a Hash with the attributes to update to the resource\n extra_log_info - a Hash with extra info that will be saved to the log\n\n Returns the updated `resource`.", "Truncates a given text respecting its HTML tags.\n\n text    - The String text to be truncated.\n options - A Hash with the options to truncate the text (default: {}):\n           :length - An Integer number with the max length of the text.\n           :separator - A String to append to the text when it's being\n           truncated. See `truncato` gem for more options.\n\n Returns a String.", "Generates a link to be added to the global Edit link so admins\n can easily manage data without having to look for it at the admin\n panel when they're at a public page.\n\n link          - The String with the URL.\n action        - The Symbol action to check the permissions for.\n subject       - The Symbol subject to perform the action to.\n extra_context - An optional Hash to check the permissions.\n\n Returns nothing.", "A context used to set the layout and behavior of a participatory space. Full documentation can\n be found looking at the `ParticipatorySpaceContextManifest` class.\n\n Example:\n\n     context(:public) do |context|\n       context.layout \"layouts/decidim/some_layout\"\n     end\n\n     context(:public).layout\n     # => \"layouts/decidim/some_layout\"\n\n Returns Nothing.", "Returns the creation date in a friendly relative format.", "Search for all Participatory Space manifests and then all records available\n Limited to ParticipatoryProcesses only", "Converts a given array of strings to an array of Objects representing\n locales.\n\n collection - an Array of Strings. By default it uses all the available\n   locales in Decidim, but you can passa nother collection of locales (for\n   example, the available locales for an organization)", "Initializes the Rack Middleware.\n\n app - The Rack application\n Main entry point for a Rack Middleware.\n\n env - A Hash.", "Destroy a user's account.\n\n user - The user to be updated.\n form - The form with the data.", "Initializes the ActionAuthorizer.\n\n user      - The user to authorize against.\n action    - The action to authenticate.\n component - The component to authenticate against.\n resource  - The resource to authenticate against. Can be nil.\n\n\n Authorize user to perform an action in the context of a component.\n\n Returns:\n   :ok an empty hash                      - When there is no authorization handler related to the action.\n   result of authorization handler check  - When there is an authorization handler related to the action. Check Decidim::Verifications::DefaultActionAuthorizer class docs.", "Updates a user's account.\n\n user - The user to be updated.\n form - The form with the data.", "Renders a collection of linked resources for a resource.\n\n resource  - The resource to get the links from.\n type      - The String type fo the resources we want to render.\n link_name - The String name of the link between the resources.\n\n Example to render the proposals in a meeting view:\n\n  linked_resources_for(:meeting, :proposals, \"proposals_from_meeting\")\n\n Returns nothing.", "Returns a descriptive title for the resource", "Displays pagination links for the given collection, setting the correct\n theme. This mostly acts as a proxy for the underlying pagination engine.\n\n collection - a collection of elements that need to be paginated\n paginate_params - a Hash with options to delegate to the pagination helper.", "Lazy loads the `participatory_space` association through BatchLoader, can be used\n as a regular object.", "Handles the scope_id filter. When we want to show only those that do not\n have a scope_id set, we cannot pass an empty String or nil because Searchlight\n will automatically filter out these params, so the method will not be used.\n Instead, we need to pass a fake ID and then convert it inside. In this case,\n in order to select those elements that do not have a scope_id set we use\n `\"global\"` as parameter, and in the method we do the needed changes to search\n properly.", "this method is used to generate the root link on mail with the utm_codes\n If the newsletter_id is nil, it returns the root_url", "Outputs an SVG-based icon.\n\n name    - The String with the icon name.\n options - The Hash options used to customize the icon (default {}):\n             :width  - The Number of width in pixels (optional).\n             :height - The Number of height in pixels (optional).\n             :aria_label - The String to set as aria label (optional).\n             :aria_hidden - The Truthy value to enable aria_hidden (optional).\n             :role - The String to set as the role (optional).\n             :class - The String to add as a CSS class (optional).\n\n Returns a String.", "Outputs a SVG icon from an external file. It apparently renders an image\n tag, but then a JS script kicks in and replaces it with an inlined SVG\n version.\n\n path    - The asset's path\n\n Returns an <img /> tag with the SVG icon.", "Initializes the class with a polymorphic subject\n\n subject - A in instance of a subclass of ActiveRecord::Base to be tracked\n\n Public: Tracks the past activity of a user to update the continuity badge's\n score. It will set it to the amount of consecutive days a user has logged into\n the system.\n\n date - The date of the last user's activity. Usually `Time.zone.today`.\n\n Returns nothing.", "Sends an email with the invitation instructions to a new user.\n\n user  - The User that has been invited.\n token - The String to be sent as a token to verify the invitation.\n opts  - A Hash with options to send the email (optional).", "Since we're rendering each activity separatedly we need to trigger\n BatchLoader in order to accumulate all the ids to be found later.", "Returns the defined root path for a given component.\n\n component - the Component we want to find the root path for.\n\n Returns a relative url.", "Returns the defined root url for a given component.\n\n component - the Component we want to find the root path for.\n\n Returns an absolute url.", "Returns the defined admin root path for a given component.\n\n component - the Component we want to find the root path for.\n\n Returns a relative url.", "Renders the human name of the given class name.\n\n klass_name - a String representing the class name of the resource to render\n count - (optional) the number of resources so that the I18n backend\n         can decide to translate into singluar or plural form.", "Generates a link to filter the current search by the given type. If no\n type is given, it generates a link to the main results page.\n\n resource_type - An optional String with the name of the model class to filter\n space_state - An optional String with the name of the state of the space", "Generates the path and link to filter by space state, taking into account\n the other filters applied.", "A custom form for that injects client side validations with Abide.\n\n record - The object to build the form for.\n options - A Hash of options to pass to the form builder.\n &block - The block to execute as content of the form.\n\n Returns a String.", "A custom helper to include an editor field without requiring a form object\n\n name - The input name\n value - The input value\n options - The set of options to send to the field\n           :label   - The Boolean value to create or not the input label (optional) (default: true)\n           :toolbar - The String value to configure WYSIWYG toolbar. It should be 'basic' or\n                      or 'full' (optional) (default: 'basic')\n           :lines   - The Integer to indicate how many lines should editor have (optional)\n\n Returns a rich editor to be included in an html template.", "A custom helper to include a scope picker field without requiring a form\n object\n\n name - The input name\n value - The input value as a scope id\n options - The set of options to send to the field\n           :id - The id to generate for the element (optional)\n\n Returns a scopes picker tag to be included in an html template.", "A custom helper to include a translated field without requiring a form object.\n\n type        - The type of the translated input field.\n object_name - The object name used to identify the Foundation tabs.\n name        - The name of the input which will be suffixed with the corresponding locales.\n value       - A hash containing the value for each locale.\n options     - An optional hash of options.\n             * enable_tabs: Adds the data-tabs attribute so Foundation picks up automatically.\n             * tabs_id: The id to identify the Foundation tabs element.\n             * label: The label used for the field.\n\n Returns a Foundation tabs element with the translated input field.", "Helper method to show how slugs will look like. Intended to be used in forms\n together with some JavaScript code. More precisely, this will most probably\n show in help texts in forms. The space slug is surrounded with a `span` so\n the slug can be updated via JavaScript with the input value.\n\n prepend_path - a path to prepend to the slug, without final slash\n value - the initial value of the slug field, so that edit forms have a value\n\n Returns an HTML-safe String.", "Renders the avatar and author name of the author of the last version of the given\n resource.\n\n resource - an object implementing `Decidim::Traceable`\n\n Returns an HTML-safe String representing the HTML to render the author.", "Renders the avatar and author name of the author of the given version.\n\n version - an object that responds to `whodunnit` and returns a String.\n\n Returns an HTML-safe String representing the HTML to render the author.", "Caches a DiffRenderer instance for the `current_version`.", "Renders the given value in a user-friendly way based on the value class.\n\n value - an object to be rendered\n\n Returns an HTML-ready String.", "The title to show at the card.\n\n The card will also be displayed OK if there's no title.", "The description to show at the card.\n\n The card will also be displayed OK if there's no description.", "Renders the Call To Action button. Link and text can be configured\n per organization.", "Finds the CTA button path to reuse it in other places.", "Returns a String with the absolute file_path to be read or generate.", "This method wraps everything in a div with class filters and calls\n the form_for helper with a custom builder\n\n filter - A filter object\n url    - A String with the URL to post the from. Self URL by default.\n block  - A block to be called with the form builder\n\n Returns the filter resource form wrapped in a div", "Checks if the file is an image based on the content type. We need this so\n we only create different versions of the file when it's an image.\n\n new_file - The uploaded file.\n\n Returns a Boolean.", "Copies the content type and file size to the model where this is mounted.\n\n Returns nothing.", "Wrap the radio buttons collection in a custom fieldset.\n It also renders the inputs inside its labels.", "Wrap the check_boxes collection in a custom fieldset.\n It also renders the inputs inside its labels.", "Catch common beginner mistake and give a helpful error message on stderr", "Loop through all methods for each class and makes special prewarm call to each method.", "The user must at least pass in an SQL statement", "Accounts for inherited class_properties", "Properties managed by Jets with merged with finality.", "only process policy_document once", "1. Convert API Gateway event event to Rack env\n 2. Process using full Rack middleware stack\n 3. Convert back to API gateway response structure payload", "Validate routes that deployable", "resources macro expands to all the routes", "Useful for creating API Gateway Resources", "Useful for RouterMatcher\n\n Precedence:\n 1. Routes with no captures get highest precedence: posts/new\n 2. Then consider the routes with captures: post/:id\n 3. Last consider the routes with wildcards: *catchall\n\n Within these 2 groups we consider the routes with the longest path first\n since posts/:id and posts/:id/edit can both match.", "Show pretty route table for user to help with debugging in non-production mode", "Always the pre-flight headers in this case", "Runs in the child process", "blocks until rack server is up", "Only need to override the add method as the other calls all lead to it.", "Use command's long description as main description", "Use for both jets.gemspec and rake rdoc task", "Written as method to easily not include webpacker for case when either\n webpacker not installed at all or disabled upon `jets deploy`.", "aws sts get-caller-identity", "Checks that all routes are validate and have corresponding lambda functions", "Checks for a few things before deciding to delete the parent stack\n\n   * Parent stack status status is ROLLBACK_COMPLETE\n   * Parent resources are in the DELETE_COMPLETE state", "Class heirachry in top to down order", "For anonymous classes method_added during task registration contains \"\"\n for the class name.  We adjust it here.", "Returns the content of a section.\n\n @return [String] Generate section content", "Parse issue and generate single line formatted issue line.\n\n Example output:\n - Add coveralls integration [\\#223](https://github.com/github-changelog-generator/github-changelog-generator/pull/223) (@github-changelog-generator)\n\n @param [Hash] issue Fetched issue from GitHub\n @return [String] Markdown-formatted single issue", "Encapsulate characters to make Markdown look as expected.\n\n @param [String] string\n @return [String] encapsulated input string", "Async fetching of all tags dates", "Find correct closed dates, if issues was closed by commits", "Adds a key \"first_occurring_tag\" to each PR with a value of the oldest\n tag that a PR's merge commit occurs in in the git history. This should\n indicate the release of each PR by git's history regardless of dates and\n divergent branches.\n\n @param [Array] tags The tags sorted by time, newest to oldest.\n @param [Array] prs The PRs to discover the tags of.\n @return [Nil] No return; PRs are updated in-place.", "Associate merged PRs by the merge SHA contained in each tag. If the\n merge_commit_sha is not found in any tag's history, skip association.\n\n @param [Array] tags The tags sorted by time, newest to oldest.\n @param [Array] prs The PRs to associate.\n @return [Array] PRs without their merge_commit_sha in a tag.", "Set closed date from this issue\n\n @param [Hash] event\n @param [Hash] issue", "Returns the number of pages for a API call\n\n @return [Integer] number of pages for this API call in total", "Fill input array with tags\n\n @return [Array <Hash>] array of tags in repo", "Fetch event for all issues and add them to 'events'\n\n @param [Array] issues\n @return [Void]", "Fetch comments for PRs and add them to \"comments\"\n\n @param [Array] prs The array of PRs.\n @return [Void] No return; PRs are updated in-place.", "Fetch tag time from repo\n\n @param [Hash] tag GitHub data item about a Tag\n\n @return [Time] time of specified tag", "Fetch and cache comparison between two github refs\n\n @param [String] older The older sha/tag/branch.\n @param [String] newer The newer sha/tag/branch.\n @return [Hash] Github api response for comparison.", "Fetch commit for specified event\n\n @param [String] commit_id the SHA of a commit to fetch\n @return [Hash]", "Fetch all SHAs occurring in or before a given tag and add them to\n \"shas_in_tag\"\n\n @param [Array] tags The array of tags.\n @return [Nil] No return; tags are updated in-place.", "This is wrapper with rescue block\n\n @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block", "fetch, filter tags, fetch dates and sort them in time order", "Returns date for given GitHub Tag hash\n\n Memoize the date by tag name.\n\n @param [Hash] tag_name\n\n @return [Time] time of specified tag", "Detect link, name and time for specified tag.\n\n @param [Hash] newer_tag newer tag. Can be nil, if it's Unreleased section.\n @return [Array] link, name and time of the tag", "Parse a single heading and return a Hash\n\n The following heading structures are currently valid:\n - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1) (2015-03-24)\n - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1)\n - ## v1.0.2 (2015-03-24)\n - ## v1.0.2\n\n @param [String] heading Heading from the ChangeLog File\n @return [Hash] Returns a structured Hash with version, url and date", "Parse the given ChangeLog data into a list of Hashes\n\n @param [String] data File data from the ChangeLog.md\n @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]", "Add all issues, that should be in that tag, according milestone\n\n @param [Array] all_issues\n @param [String] tag_name\n @return [Array] issues with milestone #tag_name", "General filtered function\n\n @param [Array] all_issues PRs or issues\n @return [Array] filtered issues", "Generates log entry with header and body\n\n @param [Array] pull_requests List or PR's in new section\n @param [Array] issues List of issues in new section\n @param [String] newer_tag_name Name of the newer tag. Could be nil for `Unreleased` section.\n @param [String] newer_tag_link Name of the newer tag. Could be \"HEAD\" for `Unreleased` section.\n @param [Time] newer_tag_time Time of the newer tag\n @param [Hash, nil] older_tag_name Older tag, used for the links. Could be nil for last tag.\n @return [String] Ready and parsed section content.", "Generates header text for an entry.\n\n @param [String] newer_tag_name The name of a newer tag\n @param [String] newer_tag_link Used for URL generation. Could be same as #newer_tag_name or some specific value, like HEAD\n @param [Time] newer_tag_time Time when the newer tag was created\n @param [String] older_tag_name The name of an older tag; used for URLs.\n @param [String] project_url URL for the current project.\n @return [String] Header text content.", "Sorts issues and PRs into entry sections by labels and lack of labels.\n\n @param [Array] pull_requests\n @param [Array] issues\n @return [Nil]", "Iterates through sections and sorts labeled issues into them based on\n the label mapping. Returns any unmapped or unlabeled issues.\n\n @param [Array] issues Issues or pull requests.\n @return [Array] Issues that were not mapped into any sections.", "Returns a the option name as a symbol and its string value sans newlines.\n\n @param line [String] unparsed line from config file\n @return [Array<Symbol, String>]", "Class, responsible for whole changelog generation cycle\n @return initialised instance of ChangelogGenerator\n The entry point of this script to generate changelog\n @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.", "Generate log only between 2 specified tags\n @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag\n @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section", "Filters issues and pull requests based on, respectively, `actual_date`\n and `merged_at` timestamp fields. `actual_date` is the detected form of\n `closed_at` based on merge event SHA commit times.\n\n @return [Array] filtered issues and pull requests", "The full cycle of generation for whole project\n @return [String] All entries in the changelog", "Serialize the most relevant settings into a Hash\n\n @return [::Hash]\n\n @since 0.1.0\n @api private", "The root of the application\n\n By default it returns the current directory, for this reason, **all the\n commands must be executed from the top level directory of the project**.\n\n If for some reason, that constraint above cannot be satisfied, please\n configure the root directory, so that commands can be executed from\n everywhere.\n\n This is part of a DSL, for this reason when this method is called with\n an argument, it will set the corresponding instance variable. When\n called without, it will return the already set value, or the default.\n\n @overload root(value)\n   Sets the given value\n   @param value [String,Pathname,#to_pathname] The root directory of the app\n\n @overload root\n   Gets the value\n   @return [Pathname]\n   @raise [Errno::ENOENT] if the path cannot be found\n\n @since 0.1.0\n\n @see http://www.ruby-doc.org/core/Dir.html#method-c-pwd\n\n @example Getting the value\n   require 'hanami'\n\n   module Bookshelf\n     class Application < Hanami::Application\n     end\n   end\n\n   Bookshelf::Application.configuration.root # => #<Pathname:/path/to/root>\n\n @example Setting the value\n   require 'hanami'\n\n   module Bookshelf\n     class Application < Hanami::Application\n       configure do\n         root '/path/to/another/root'\n       end\n     end\n   end", "Application routes.\n\n Specify a set of routes for the application, by passing a block, or a\n relative path where to find the file that describes them.\n\n By default it's `nil`.\n\n This is part of a DSL, for this reason when this method is called with\n an argument, it will set the corresponding instance variable. When\n called without, it will return the already set value, or the default.\n\n @overload routes(blk)\n   Specify a set of routes in the given block\n   @param blk [Proc] the routes definitions\n\n @overload routes(path)\n   Specify a relative path where to find the routes file\n   @param path [String] the relative path\n\n @overload routes\n   Gets the value\n   @return [Hanami::Config::Routes] the set of routes\n\n @since 0.1.0\n\n @see http://rdoc.info/gems/hanami-router/Hanami/Router\n\n @example Getting the value\n   require 'hanami'\n\n   module Bookshelf\n     class Application < Hanami::Application\n     end\n   end\n\n   Bookshelf::Application.configuration.routes\n     # => nil\n\n @example Setting the value, by passing a block\n   require 'hanami'\n\n   module Bookshelf\n     class Application < Hanami::Application\n       configure do\n         routes do\n           get '/', to: 'dashboard#index'\n           resources :books\n         end\n       end\n     end\n   end\n\n   Bookshelf::Application.configuration.routes\n     # => #<Hanami::Config::Routes:0x007ff50a991388 @blk=#<Proc:0x007ff50a991338@(irb):4>, @path=#<Pathname:.>>\n\n @example Setting the value, by passing a relative path\n   require 'hanami'\n\n   module Bookshelf\n     class Application < Hanami::Application\n       configure do\n         routes 'config/routes'\n       end\n     end\n   end\n\n   Bookshelf::Application.configuration.routes\n     # => #<Hanami::Config::Routes:0x007ff50a991388 @blk=nil, @path=#<Pathname:config/routes.rb>>", "The URI port for this application.\n This is used by the router helpers to generate absolute URLs.\n\n By default this value is `2300`.\n\n This is part of a DSL, for this reason when this method is called with\n an argument, it will set the corresponding instance variable. When\n called without, it will return the already set value, or the default.\n\n @overload port(value)\n   Sets the given value\n   @param value [#to_int] the URI port\n   @raise [TypeError] if the given value cannot be coerced to Integer\n\n @overload scheme\n   Gets the value\n   @return [String]\n\n @since 0.1.0\n\n @see http://en.wikipedia.org/wiki/URI_scheme\n\n @example Getting the value\n   require 'hanami'\n\n   module Bookshelf\n     class Application < Hanami::Application\n     end\n   end\n\n   Bookshelf::Application.configuration.port # => 2300\n\n @example Setting the value\n   require 'hanami'\n\n   module Bookshelf\n     class Application < Hanami::Application\n       configure do\n         port 8080\n       end\n     end\n   end\n\n   Bookshelf::Application.configuration.port # => 8080", "Loads a dotenv file and updates self\n\n @param path [String, Pathname] the path to the dotenv file\n\n @return void\n\n @since 0.9.0\n @api private", "Default values for writing the hanamirc file\n\n @since 0.5.1\n @api private\n\n @see Hanami::Hanamirc#options", "Read hanamirc file and parse it's values\n\n @since 0.8.0\n @api private\n\n @return [Hash] hanamirc parsed values", "Instantiate a middleware stack\n\n @param configuration [Hanami::ApplicationConfiguration] the application's configuration\n\n @return [Hanami::MiddlewareStack] the new stack\n\n @since 0.1.0\n @api private\n\n @see Hanami::ApplicationConfiguration\n Load the middleware stack\n\n @return [Hanami::MiddlewareStack] the loaded middleware stack\n\n @since 0.2.0\n @api private\n\n @see http://rdoc.info/gems/rack/Rack/Builder", "Append a middleware to the stack.\n\n @param middleware [Object] a Rack middleware\n @param args [Array] optional arguments to pass to the Rack middleware\n @param blk [Proc] an optional block to pass to the Rack middleware\n\n @return [Array] the middleware that was added\n\n @since 0.2.0\n\n @see Hanami::MiddlewareStack#prepend\n\n @example\n   # apps/web/application.rb\n   module Web\n     class Application < Hanami::Application\n       configure do\n         # ...\n         use MyRackMiddleware, foo: 'bar'\n       end\n     end\n   end", "Prepend a middleware to the stack.\n\n @param middleware [Object] a Rack middleware\n @param args [Array] optional arguments to pass to the Rack middleware\n @param blk [Proc] an optional block to pass to the Rack middleware\n\n @return [Array] the middleware that was added\n\n @since 0.6.0\n\n @see Hanami::MiddlewareStack#use\n\n @example\n   # apps/web/application.rb\n   module Web\n     class Application < Hanami::Application\n       configure do\n         # ...\n         prepend MyRackMiddleware, foo: 'bar'\n       end\n     end\n   end", "Initialize the factory\n\n @param routes [Hanami::Router] a routes set\n\n @return [Hanami::Routes] the factory\n\n @since 0.1.0\n @api private\n Return a relative path for the given route name\n\n @param name [Symbol] the route name\n @param args [Array,nil] an optional set of arguments that is passed down\n   to the wrapped route set.\n\n @return [Hanami::Utils::Escape::SafeString] the corresponding relative URL\n\n @raise Hanami::Routing::InvalidRouteException\n\n @since 0.1.0\n\n @see http://rdoc.info/gems/hanami-router/Hanami/Router#path-instance_method\n\n @example Basic example\n   require 'hanami'\n\n   module Web\n     class Application < Hanami::Application\n       configure do\n         routes do\n           get '/login', to: 'sessions#new', as: :login\n         end\n       end\n     end\n   end\n\n   Web.routes.path(:login)\n     # => '/login'\n\n   Web.routes.path(:login, return_to: '/dashboard')\n     # => '/login?return_to=%2Fdashboard'\n\n @example Dynamic finders\n   require 'hanami'\n\n   module Web\n     class Application < Hanami::Application\n       configure do\n         routes do\n           get '/login', to: 'sessions#new', as: :login\n         end\n       end\n     end\n   end\n\n   Web.routes.login_path\n     # => '/login'\n\n   Web.routes.login_path(return_to: '/dashboard')\n     # => '/login?return_to=%2Fdashboard'", "Return an absolute path for the given route name\n\n @param name [Symbol] the route name\n @param args [Array,nil] an optional set of arguments that is passed down\n   to the wrapped route set.\n\n @return [Hanami::Utils::Escape::SafeString] the corresponding absolute URL\n\n @raise Hanami::Routing::InvalidRouteException\n\n @since 0.1.0\n\n @see http://rdoc.info/gems/hanami-router/Hanami/Router#url-instance_method\n\n @example Basic example\n   require 'hanami'\n\n   module Web\n     class Application < Hanami::Application\n       configure do\n         routes do\n           scheme 'https'\n           host   'bookshelf.org'\n\n           get '/login', to: 'sessions#new', as: :login\n         end\n       end\n     end\n   end\n\n   Web.routes.url(:login)\n     # => 'https://bookshelf.org/login'\n\n   Web.routes.url(:login, return_to: '/dashboard')\n     # => 'https://bookshelf.org/login?return_to=%2Fdashboard'\n\n @example Dynamic finders\n   require 'hanami'\n\n   module Web\n     class Application < Hanami::Application\n       configure do\n         routes do\n           scheme 'https'\n           host   'bookshelf.org'\n\n           get '/login', to: 'sessions#new', as: :login\n         end\n       end\n     end\n   end\n\n   Web.routes.login_url\n     # => 'https://bookshelf.org/login'\n\n   Web.routes.login_url(return_to: '/dashboard')\n     # => 'https://bookshelf.org/login?return_to=%2Fdashboard'", "Returns true if the service exists, false otherwise.\n\n @param [String] service_name name of the service", "Start a windows service\n\n @param [String] service_name name of the service to start\n @param optional [Integer] timeout the minumum number of seconds to wait before timing out", "Stop a windows service\n\n @param [String] service_name name of the service to stop\n @param optional [Integer] timeout the minumum number of seconds to wait before timing out", "Resume a paused windows service\n\n @param [String] service_name name of the service to resume\n @param optional [Integer] :timeout the minumum number of seconds to wait before timing out", "Query the state of a service using QueryServiceStatusEx\n\n @param [string] service_name name of the service to query\n @return [string] the status of the service", "Query the configuration of a service using QueryServiceConfigW\n\n @param [String] service_name name of the service to query\n @return [QUERY_SERVICE_CONFIGW.struct] the configuration of the service", "Change the startup mode of a windows service\n\n @param [string] service_name the name of the service to modify\n @param [Int] startup_type a code corresponding to a start type for\n  windows service, see the \"Service start type codes\" section in the\n  Puppet::Util::Windows::Service file for the list of available codes", "enumerate over all services in all states and return them as a hash\n\n @return [Hash] a hash containing services:\n   { 'service name' => {\n                         'display_name' => 'display name',\n                         'service_status_process' => SERVICE_STATUS_PROCESS struct\n                       }\n   }", "generate all the subdirectories, modules, classes and files", "generate a top index", "generate the all classes index file and the combo index", "returns the initial_page url", "return the relative file name to store this class in,\n which is also its url", "Checks whether all feature predicate methods are available.\n @param obj [Object, Class] the object or class to check if feature predicates are available or not.\n @return [Boolean] Returns whether all of the required methods are available or not in the given object.", "Merges the current set of metadata with another metadata hash.  This\n method also handles the validation of module names and versions, in an\n effort to be proactive about module publishing constraints.", "Validates the name and version_requirement for a dependency, then creates\n the Dependency and adds it.\n Returns the Dependency that was added.", "Do basic validation and parsing of the name parameter.", "Do basic parsing of the source parameter.  If the source is hosted on\n GitHub, we can predict sensible defaults for both project_page and\n issues_url.", "Validates and parses the dependencies.", "Validates that the given module name is both namespaced and well-formed.", "Validates that the version string can be parsed as per SemVer.", "Validates that the given _value_ is a symbolic name that starts with a letter\n and then contains only letters, digits, or underscore. Will raise an ArgumentError\n if that's not the case.\n\n @param value [Object] The value to be tested", "Validates that the version range can be parsed by Semantic.", "force regular ACLs to be present", "Common helper for set_userflags and unset_userflags.\n\n @api private", "Iterate through the list of records for this service\n and yield each server and port pair. Records are only fetched\n via DNS query the first time and cached for the duration of their\n service's TTL thereafter.\n @param [String] domain the domain to search for\n @param [Symbol] service_name the key of the service we are querying\n @yields [String, Integer] server and port of selected record", "Given a list of records of the same priority, chooses a random one\n from among them, favoring those with higher weights.\n @param [[Resolv::DNS::Resource::IN::SRV]] records a list of records\n        of the same priority\n @return [Resolv::DNS::Resource::IN:SRV] the chosen record", "Checks if the cached entry for the given service has expired.\n @param [String] service_name the name of the service to check\n @return [Boolean] true if the entry has expired, false otherwise.\n                  Always returns true if the record had no TTL.", "Removes all environment variables\n @param mode [Symbol] Which operating system mode to use e.g. :posix or :windows.  Use nil to autodetect\n @api private", "Resolve a path for an executable to the absolute path. This tries to behave\n in the same manner as the unix `which` command and uses the `PATH`\n environment variable.\n\n @api public\n @param bin [String] the name of the executable to find.\n @return [String] the absolute path to the found executable.", "Convert a path to a file URI", "Get the path component of a URI", "Executes a block of code, wrapped with some special exception handling.  Causes the ruby interpreter to\n  exit if the block throws an exception.\n\n @api public\n @param [String] message a message to log if the block fails\n @param [Integer] code the exit code that the ruby interpreter should return if the block fails\n @yield", "Converts 4x supported values to a 3x values.\n\n @param args [Array] Array of values to convert\n @param scope [Puppet::Parser::Scope] The scope to use when converting\n @param undef_value [Object] The value that nil is converted to\n @return [Array] The converted values", "Removes an attribute from the object; useful in testing or in cleanup\n when an error has been encountered\n @todo Don't know what the attr is (name or Property/Parameter?). Guessing it is a String name...\n @todo Is it possible to delete a meta-parameter?\n @todo What does delete mean? Is it deleted from the type or is its value state 'is'/'should' deleted?\n @param attr [String] the attribute to delete from this object. WHAT IS THE TYPE?\n @raise [Puppet::DecError] when an attempt is made to delete an attribute that does not exists.", "Returns true if the instance is a managed instance.\n A 'yes' here means that the instance was created from the language, vs. being created\n in order resolve other questions, such as finding a package in a list.\n @note An object that is managed always stays managed, but an object that is not managed\n   may become managed later in its lifecycle.\n @return [Boolean] true if the object is managed", "Retrieves the current value of all contained properties.\n Parameters and meta-parameters are not included in the result.\n @todo As opposed to all non contained properties? How is this different than any of the other\n   methods that also \"gets\" properties/parameters/etc. ?\n @return [Puppet::Resource] array of all property values (mix of types)\n @raise [fail???] if there is a provider and it is not suitable for the host this is evaluated for.", "Builds the dependencies associated with this resource.\n\n @return [Array<Puppet::Relationship>] list of relationships to other resources", "Mark parameters associated with this type as sensitive, based on the associated resource.\n\n Currently, only instances of `Puppet::Property` can be easily marked for sensitive data handling\n and information redaction is limited to redacting events generated while synchronizing\n properties. While support for redaction will be broadened in the future we can't automatically\n deduce how to redact arbitrary parameters, so if a parameter is marked for redaction the best\n we can do is warn that we can't handle treating that parameter as sensitive and move on.\n\n In some unusual cases a given parameter will be marked as sensitive but that sensitive context\n needs to be transferred to another parameter. In this case resource types may need to override\n this method in order to copy the sensitive context from one parameter to another (and in the\n process force the early generation of a parameter that might otherwise be lazily generated.)\n See `Puppet::Type.type(:file)#set_sensitive_parameters` for an example of this.\n\n @note This method visibility is protected since it should only be called by #initialize, but is\n   marked as public as subclasses may need to override this method.\n\n @api public\n\n @param sensitive_parameters [Array<Symbol>] A list of parameters to mark as sensitive.\n\n @return [void]", "Finishes any outstanding processing.\n This method should be called as a final step in setup,\n to allow the parameters that have associated auto-require needs to be processed.\n\n @todo what is the expected sequence here - who is responsible for calling this? When?\n   Is the returned type correct?\n @return [Array<Puppet::Parameter>] the validated list/set of attributes", "Create an anonymous environment.\n\n @param module_path [String] A list of module directories separated by the\n   PATH_SEPARATOR\n @param manifest [String] The path to the manifest\n @return A new environment with the `name` `:anonymous`\n\n @api private", "Returns a basic environment configuration object tied to the environment's\n implementation values.  Will not interpolate.\n\n @!macro loader_get_conf", "Adds a cache entry to the cache", "Clears all environments that have expired, either by exceeding their time to live, or\n through an explicit eviction determined by the cache expiration service.", "Creates a suitable cache entry given the time to live for one environment", "Evicts the entry if it has expired\n Also clears caches in Settings that may prevent the entry from being updated", "Return checksums for object's +Pathname+, generate if it's needed.\n Result is a hash of path strings to checksum strings.", "Create a Route containing information for querying the given API,\n hosted at a server determined either by SRV service or by the\n fallback server on the fallback port.\n @param [String] api the path leading to the root of the API. Must\n                 contain a trailing slash for proper endpoint path\n                 construction\n @param [Symbol] server_setting the setting to check for special\n                 server configuration\n @param [Symbol] port_setting the setting to check for speical\n                  port configuration\n @param [Symbol] srv_service the name of the service when using SRV\n                 records\n Select a server and port to create a base URL for the API specified by this\n route. If the connection fails and SRV records are in use, the next suitable\n server will be tried. If SRV records are not in use or no successful connection\n could be made, fall back to the configured server and port for this API, taking\n into account failover settings.\n @parma [Puppet::Network::Resolver] dns_resolver the DNS resolver to use to check\n                                    SRV records\n @yield [URI] supply a base URL to make a request with\n @raise [Puppet::Error] if connection to selected server and port fails, and SRV\n                        records are not in use", "Execute the application.\n @api public\n @return [void]", "Output basic information about the runtime environment for debugging\n purposes.\n\n @api public\n\n @param extra_info [Hash{String => #to_s}] a flat hash of extra information\n   to log. Intended to be passed to super by subclasses.\n @return [void]", "Defines a repeated positional parameter with _type_ and _name_ that may occur 1 to \"infinite\" number of times.\n It may only appear last or just before a block parameter.\n\n @param type [String] The type specification for the parameter.\n @param name [Symbol] The name of the parameter. This is primarily used\n   for error message output and does not have to match an implementation\n   method parameter.\n @return [Void]\n\n @api public", "Defines one required block parameter that may appear last. If type and name is missing the\n default type is \"Callable\", and the name is \"block\". If only one\n parameter is given, then that is the name and the type is \"Callable\".\n\n @api public", "Defines a local type alias, the given string should be a Puppet Language type alias expression\n in string form without the leading 'type' keyword.\n Calls to local_type must be made before the first parameter definition or an error will\n be raised.\n\n @param assignment_string [String] a string on the form 'AliasType = ExistingType'\n @api public", "Merges the result of yielding the given _lookup_variants_ to a given block.\n\n @param lookup_variants [Array] The variants to pass as second argument to the given block\n @return [Object] the merged value.\n @yield [} ]\n @yieldparam variant [Object] each variant given in the _lookup_variants_ array.\n @yieldreturn [Object] the value to merge with other values\n @throws :no_such_key if the lookup was unsuccessful\n\n Merges the result of yielding the given _lookup_variants_ to a given block.\n\n @param lookup_variants [Array] The variants to pass as second argument to the given block\n @return [Object] the merged value.\n @yield [} ]\n @yieldparam variant [Object] each variant given in the _lookup_variants_ array.\n @yieldreturn [Object] the value to merge with other values\n @throws :no_such_key if the lookup was unsuccessful", "return an uncompressed body if the response has been\n compressed", "Define a new right to which access can be provided.", "Is a given combination of name and ip address allowed?  If either input\n is non-nil, then both inputs must be provided.  If neither input\n is provided, then the authstore is considered local and defaults to \"true\".", "Returns a Type instance by name.\n This will load the type if not already defined.\n @param [String, Symbol] name of the wanted Type\n @return [Puppet::Type, nil] the type or nil if the type was not defined and could not be loaded", "Lookup a loader by its unique name.\n\n @param [String] loader_name the name of the loader to lookup\n @return [Loader] the found loader\n @raise [Puppet::ParserError] if no loader is found", "Finds the appropriate loader for the given `module_name`, or for the environment in case `module_name`\n is `nil` or empty.\n\n @param module_name [String,nil] the name of the module\n @return [Loader::Loader] the found loader\n @raise [Puppet::ParseError] if no loader can be found\n @api private", "Load the main manifest for the given environment\n\n There are two sources that can be used for the initial parse:\n\n   1. The value of `Puppet[:code]`: Puppet can take a string from\n     its settings and parse that as a manifest. This is used by various\n     Puppet applications to read in a manifest and pass it to the\n     environment as a side effect. This is attempted first.\n   2. The contents of the environment's +manifest+ attribute: Puppet will\n     try to load the environment manifest. The manifest must be a file.\n\n @return [Model::Program] The manifest parsed into a model object", "Add 4.x definitions found in the given program to the given loader.", "Add given 4.x definition to the given loader.", "Set the entry 'key=value'. If no entry with the\n given key exists, one is appended to the end of the section", "Format the section as text in the way it should be\n written to file", "Read and parse the on-disk file associated with this object", "Create a new section and store it in the file contents\n\n @api private\n @param name [String] The name of the section to create\n @return [Puppet::Util::IniConfig::Section]", "May be called with 3 arguments for message, file, line, and exception, or\n 4 args including the position on the line.", "Handles the Retry-After header of a HTTPResponse\n\n This method checks the response for a Retry-After header and handles\n it by sleeping for the indicated number of seconds. The response is\n returned unmodified if no Retry-After header is present.\n\n @param response [Net::HTTPResponse] A response received from the\n   HTTP client.\n\n @return [nil] Sleeps and returns nil if the response contained a\n   Retry-After header that indicated the request should be retried.\n @return [Net::HTTPResponse] Returns the `response` unmodified if\n   no Retry-After header was present or the Retry-After header could\n   not be parsed as an integer or RFC 2822 date.", "Parse the value of a Retry-After header\n\n Parses a string containing an Integer or RFC 2822 datestamp and returns\n an integer number of seconds before a request can be retried.\n\n @param header_value [String] The value of the Retry-After header.\n\n @return [Integer] Number of seconds to wait before retrying the\n   request. Will be equal to 0 for the case of date that has already\n   passed.\n @return [nil] Returns `nil` when the `header_value` can't be\n   parsed as an Integer or RFC 2822 date.", "Retrieve a set of values from a registry key given their names\n Value names listed but not found in the registry will not be added to the\n resultant Hashtable\n\n @param key [RegistryKey] An open handle to a Registry Key\n @param names [String[]] An array of names of registry values to return if they exist\n @return [Hashtable<String, Object>] A hashtable of all of the found values in the registry key", "Customize this so we can do a bit of validation.", "Convert a record into a line by joining the fields together appropriately.\n This is pulled into a separate method so it can be called by the hooks.", "Assign the topic partitions to the group members.\n\n @param members [Array<String>] member ids\n @param topics [Array<String>] topics\n @return [Hash<String, Protocol::MemberAssignment>] a hash mapping member\n   ids to assignments.", "Clears buffered messages for the given topic and partition.\n\n @param topic [String] the name of the topic.\n @param partition [Integer] the partition id.\n\n @return [nil]", "Initializes a new Kafka client.\n\n @param seed_brokers [Array<String>, String] the list of brokers used to initialize\n   the client. Either an Array of connections, or a comma separated string of connections.\n   A connection can either be a string of \"host:port\" or a full URI with a scheme.\n   If there's a scheme it's ignored and only host/port are used.\n\n @param client_id [String] the identifier for this application.\n\n @param logger [Logger] the logger that should be used by the client.\n\n @param connect_timeout [Integer, nil] the timeout setting for connecting\n   to brokers. See {BrokerPool#initialize}.\n\n @param socket_timeout [Integer, nil] the timeout setting for socket\n   connections. See {BrokerPool#initialize}.\n\n @param ssl_ca_cert [String, Array<String>, nil] a PEM encoded CA cert, or an Array of\n   PEM encoded CA certs, to use with an SSL connection.\n\n @param ssl_ca_cert_file_path [String, nil] a path on the filesystem to a PEM encoded CA cert\n   to use with an SSL connection.\n\n @param ssl_client_cert [String, nil] a PEM encoded client cert to use with an\n   SSL connection. Must be used in combination with ssl_client_cert_key.\n\n @param ssl_client_cert_key [String, nil] a PEM encoded client cert key to use with an\n   SSL connection. Must be used in combination with ssl_client_cert.\n\n @param ssl_client_cert_key_password [String, nil] the password required to read the\n   ssl_client_cert_key. Must be used in combination with ssl_client_cert_key.\n\n @param sasl_gssapi_principal [String, nil] a KRB5 principal\n\n @param sasl_gssapi_keytab [String, nil] a KRB5 keytab filepath\n\n @param sasl_scram_username [String, nil] SCRAM username\n\n @param sasl_scram_password [String, nil] SCRAM password\n\n @param sasl_scram_mechanism [String, nil] Scram mechanism, either \"sha256\" or \"sha512\"\n\n @param sasl_over_ssl [Boolean] whether to enforce SSL with SASL\n\n @param sasl_oauth_token_provider [Object, nil] OAuthBearer Token Provider instance that\n   implements method token. See {Sasl::OAuth#initialize}\n\n @return [Client]\n Delivers a single message to the Kafka cluster.\n\n **Note:** Only use this API for low-throughput scenarios. If you want to deliver\n many messages at a high rate, or if you want to configure the way messages are\n sent, use the {#producer} or {#async_producer} APIs instead.\n\n @param value [String, nil] the message value.\n @param key [String, nil] the message key.\n @param headers [Hash<String, String>] the headers for the message.\n @param topic [String] the topic that the message should be written to.\n @param partition [Integer, nil] the partition that the message should be written\n   to, or `nil` if either `partition_key` is passed or the partition should be\n   chosen at random.\n @param partition_key [String] a value used to deterministically choose a\n   partition to write to.\n @param retries [Integer] the number of times to retry the delivery before giving\n   up.\n @return [nil]", "Initializes a new Kafka producer.\n\n @param ack_timeout [Integer] The number of seconds a broker can wait for\n   replicas to acknowledge a write before responding with a timeout.\n\n @param required_acks [Integer, Symbol] The number of replicas that must acknowledge\n   a write, or `:all` if all in-sync replicas must acknowledge.\n\n @param max_retries [Integer] the number of retries that should be attempted\n   before giving up sending messages to the cluster. Does not include the\n   original attempt.\n\n @param retry_backoff [Integer] the number of seconds to wait between retries.\n\n @param max_buffer_size [Integer] the number of messages allowed in the buffer\n   before new writes will raise {BufferOverflow} exceptions.\n\n @param max_buffer_bytesize [Integer] the maximum size of the buffer in bytes.\n   attempting to produce messages when the buffer reaches this size will\n   result in {BufferOverflow} being raised.\n\n @param compression_codec [Symbol, nil] the name of the compression codec to\n   use, or nil if no compression should be performed. Valid codecs: `:snappy`,\n   `:gzip`, `:lz4`, `:zstd`\n\n @param compression_threshold [Integer] the number of messages that needs to\n   be in a message set before it should be compressed. Note that message sets\n   are per-partition rather than per-topic or per-producer.\n\n @return [Kafka::Producer] the Kafka producer.", "Creates a new AsyncProducer instance.\n\n All parameters allowed by {#producer} can be passed. In addition to this,\n a few extra parameters can be passed when creating an async producer.\n\n @param max_queue_size [Integer] the maximum number of messages allowed in\n   the queue.\n @param delivery_threshold [Integer] if greater than zero, the number of\n   buffered messages that will automatically trigger a delivery.\n @param delivery_interval [Integer] if greater than zero, the number of\n   seconds between automatic message deliveries.\n\n @see AsyncProducer\n @return [AsyncProducer]", "Creates a new Kafka consumer.\n\n @param group_id [String] the id of the group that the consumer should join.\n @param session_timeout [Integer] the number of seconds after which, if a client\n   hasn't contacted the Kafka cluster, it will be kicked out of the group.\n @param offset_commit_interval [Integer] the interval between offset commits,\n   in seconds.\n @param offset_commit_threshold [Integer] the number of messages that can be\n   processed before their offsets are committed. If zero, offset commits are\n   not triggered by message processing.\n @param heartbeat_interval [Integer] the interval between heartbeats; must be less\n   than the session window.\n @param offset_retention_time [Integer] the time period that committed\n   offsets will be retained, in seconds. Defaults to the broker setting.\n @param fetcher_max_queue_size [Integer] max number of items in the fetch queue that\n   are stored for further processing. Note, that each item in the queue represents a\n   response from a single broker.\n @return [Consumer]", "Fetches a batch of messages from a single partition. Note that it's possible\n to get back empty batches.\n\n The starting point for the fetch can be configured with the `:offset` argument.\n If you pass a number, the fetch will start at that offset. However, there are\n two special Symbol values that can be passed instead:\n\n * `:earliest` \u2014 the first offset in the partition.\n * `:latest` \u2014 the next offset that will be written to, effectively making the\n   call block until there is a new message in the partition.\n\n The Kafka protocol specifies the numeric values of these two options: -2 and -1,\n respectively. You can also pass in these numbers directly.\n\n ## Example\n\n When enumerating the messages in a partition, you typically fetch batches\n sequentially.\n\n     offset = :earliest\n\n     loop do\n       messages = kafka.fetch_messages(\n         topic: \"my-topic\",\n         partition: 42,\n         offset: offset,\n       )\n\n       messages.each do |message|\n         puts message.offset, message.key, message.value\n\n         # Set the next offset that should be read to be the subsequent\n         # offset.\n         offset = message.offset + 1\n       end\n     end\n\n See a working example in `examples/simple-consumer.rb`.\n\n @param topic [String] the topic that messages should be fetched from.\n\n @param partition [Integer] the partition that messages should be fetched from.\n\n @param offset [Integer, Symbol] the offset to start reading from. Default is\n   the latest offset.\n\n @param max_wait_time [Integer] the maximum amount of time to wait before\n   the server responds, in seconds.\n\n @param min_bytes [Integer] the minimum number of bytes to wait for. If set to\n   zero, the broker will respond immediately, but the response may be empty.\n   The default is 1 byte, which means that the broker will respond as soon as\n   a message is written to the partition.\n\n @param max_bytes [Integer] the maximum number of bytes to include in the\n   response message set. Default is 1 MB. You need to set this higher if you\n   expect messages to be larger than this.\n\n @return [Array<Kafka::FetchedMessage>] the messages returned from the broker.", "Enumerate all messages in a topic.\n\n @param topic [String] the topic to consume messages from.\n\n @param start_from_beginning [Boolean] whether to start from the beginning\n   of the topic or just subscribe to new messages being produced.\n\n @param max_wait_time [Integer] the maximum amount of time to wait before\n   the server responds, in seconds.\n\n @param min_bytes [Integer] the minimum number of bytes to wait for. If set to\n   zero, the broker will respond immediately, but the response may be empty.\n   The default is 1 byte, which means that the broker will respond as soon as\n   a message is written to the partition.\n\n @param max_bytes [Integer] the maximum number of bytes to include in the\n   response message set. Default is 1 MB. You need to set this higher if you\n   expect messages to be larger than this.\n\n @return [nil]", "Creates a topic in the cluster.\n\n @example Creating a topic with log compaction\n   # Enable log compaction:\n   config = { \"cleanup.policy\" => \"compact\" }\n\n   # Create the topic:\n   kafka.create_topic(\"dns-mappings\", config: config)\n\n @param name [String] the name of the topic.\n @param num_partitions [Integer] the number of partitions that should be created\n   in the topic.\n @param replication_factor [Integer] the replication factor of the topic.\n @param timeout [Integer] a duration of time to wait for the topic to be\n   completely created.\n @param config [Hash] topic configuration entries. See\n   [the Kafka documentation](https://kafka.apache.org/documentation/#topicconfigs)\n   for more information.\n @raise [Kafka::TopicAlreadyExists] if the topic already exists.\n @return [nil]", "Create partitions for a topic.\n\n @param name [String] the name of the topic.\n @param num_partitions [Integer] the number of desired partitions for\n the topic\n @param timeout [Integer] a duration of time to wait for the new\n partitions to be added.\n @return [nil]", "Retrieve the offset of the last message in each partition of the specified topics.\n\n @param topics [Array<String>] topic names.\n @return [Hash<String, Hash<Integer, Integer>>]\n @example\n   last_offsets_for('topic-1', 'topic-2') # =>\n   # {\n   #   'topic-1' => { 0 => 100, 1 => 100 },\n   #   'topic-2' => { 0 => 100, 1 => 100 }\n   # }", "Initializes a Cluster with a set of seed brokers.\n\n The cluster will try to fetch cluster metadata from one of the brokers.\n\n @param seed_brokers [Array<URI>]\n @param broker_pool [Kafka::BrokerPool]\n @param logger [Logger]\n Adds a list of topics to the target list. Only the topics on this list will\n be queried for metadata.\n\n @param topics [Array<String>]\n @return [nil]", "Finds the broker acting as the coordinator of the given transaction.\n\n @param transactional_id: [String]\n @return [Broker] the broker that's currently coordinator.", "Lists all topics in the cluster.", "Fetches the cluster metadata.\n\n This is used to update the partition leadership information, among other things.\n The methods will go through each node listed in `seed_brokers`, connecting to the\n first one that is available. This node will be queried for the cluster metadata.\n\n @raise [ConnectionError] if none of the nodes in `seed_brokers` are available.\n @return [Protocol::MetadataResponse] the cluster metadata.", "Initializes a new AsyncProducer.\n\n @param sync_producer [Kafka::Producer] the synchronous producer that should\n   be used in the background.\n @param max_queue_size [Integer] the maximum number of messages allowed in\n   the queue.\n @param delivery_threshold [Integer] if greater than zero, the number of\n   buffered messages that will automatically trigger a delivery.\n @param delivery_interval [Integer] if greater than zero, the number of\n   seconds between automatic message deliveries.\n\n Produces a message to the specified topic.\n\n @see Kafka::Producer#produce\n @param (see Kafka::Producer#produce)\n @raise [BufferOverflow] if the message queue is full.\n @return [nil]", "Writes bytes to the socket, possible with a timeout.\n\n @param bytes [String] the data that should be written to the socket.\n @raise [Errno::ETIMEDOUT] if the timeout is exceeded.\n @return [Integer] the number of bytes written.", "Subscribes the consumer to a topic.\n\n Typically you either want to start reading messages from the very\n beginning of the topic's partitions or you simply want to wait for new\n messages to be written. In the former case, set `start_from_beginning`\n to true (the default); in the latter, set it to false.\n\n @param topic_or_regex [String, Regexp] subscribe to single topic with a string\n   or multiple topics matching a regex.\n @param default_offset [Symbol] whether to start from the beginning or the\n   end of the topic's partitions. Deprecated.\n @param start_from_beginning [Boolean] whether to start from the beginning\n   of the topic or just subscribe to new messages being produced. This\n   only applies when first consuming a topic partition \u2013 once the consumer\n   has checkpointed its progress, it will always resume from the last\n   checkpoint.\n @param max_bytes_per_partition [Integer] the maximum amount of data fetched\n   from a single partition at a time.\n @return [nil]", "Pause processing of a specific topic partition.\n\n When a specific message causes the processor code to fail, it can be a good\n idea to simply pause the partition until the error can be resolved, allowing\n the rest of the partitions to continue being processed.\n\n If the `timeout` argument is passed, the partition will automatically be\n resumed when the timeout expires. If `exponential_backoff` is enabled, each\n subsequent pause will cause the timeout to double until a message from the\n partition has been successfully processed.\n\n @param topic [String]\n @param partition [Integer]\n @param timeout [nil, Integer] the number of seconds to pause the partition for,\n   or `nil` if the partition should not be automatically resumed.\n @param max_timeout [nil, Integer] the maximum number of seconds to pause for,\n   or `nil` if no maximum should be enforced.\n @param exponential_backoff [Boolean] whether to enable exponential backoff.\n @return [nil]", "Resume processing of a topic partition.\n\n @see #pause\n @param topic [String]\n @param partition [Integer]\n @return [nil]", "Whether the topic partition is currently paused.\n\n @see #pause\n @param topic [String]\n @param partition [Integer]\n @return [Boolean] true if the partition is paused, false otherwise.", "Move the consumer's position in the partition back to the configured default\n offset, either the first or latest in the partition.\n\n @param topic [String] the name of the topic.\n @param partition [Integer] the partition number.\n @return [nil]", "Move the consumer's position in the partition to the specified offset.\n\n @param topic [String] the name of the topic.\n @param partition [Integer] the partition number.\n @param offset [Integer] the offset that the consumer position should be moved to.\n @return [nil]", "Return the next offset that should be fetched for the specified partition.\n\n @param topic [String] the name of the topic.\n @param partition [Integer] the partition number.\n @return [Integer] the next offset that should be fetched.", "Commit offsets of messages that have been marked as processed.\n\n If `recommit` is set to true, we will also commit the existing positions\n even if no messages have been processed on a partition. This is done\n in order to avoid the offset information expiring in cases where messages\n are very rare -- it's essentially a keep-alive.\n\n @param recommit [Boolean] whether to recommit offsets that have already been\n   committed.\n @return [nil]", "Clear stored offset information for all partitions except those specified\n in `excluded`.\n\n     offset_manager.clear_offsets_excluding(\"my-topic\" => [1, 2, 3])\n\n @return [nil]", "Sends a request over the connection.\n\n @param request [#encode, #response_class] the request that should be\n   encoded and written.\n\n @return [Object] the response.", "Writes a request over the connection.\n\n @param request [#encode] the request that should be encoded and written.\n\n @return [nil]", "Reads a response from the connection.\n\n @param response_class [#decode] an object that can decode the response from\n   a given Decoder.\n\n @return [nil]", "Sends all buffered messages to the Kafka brokers.\n\n Depending on the value of `required_acks` used when initializing the producer,\n this call may block until the specified number of replicas have acknowledged\n the writes. The `ack_timeout` setting places an upper bound on the amount of\n time the call will block before failing.\n\n @raise [DeliveryFailed] if not all messages could be successfully sent.\n @return [nil]", "Sends batch last offset to the consumer group coordinator, and also marks\n this offset as part of the current transaction. This offset will be considered\n committed only if the transaction is committed successfully.\n\n This method should be used when you need to batch consumed and produced messages\n together, typically in a consume-transform-produce pattern. Thus, the specified\n group_id should be the same as config parameter group_id of the used\n consumer.\n\n @return [nil]", "Syntactic sugar to enable easier transaction usage. Do the following steps\n\n - Start the transaction (with Producer#begin_transaction)\n - Yield the given block\n - Commit the transaction (with Producer#commit_transaction)\n\n If the block raises exception, the transaction is automatically aborted\n *before* bubble up the exception.\n\n If the block raises Kafka::Producer::AbortTransaction indicator exception,\n it aborts the transaction silently, without throwing up that exception.\n\n @return [nil]", "Open new window.\n Current window doesn't change as the result of this call.\n It should be switched to explicitly.\n\n @return [Capybara::Window]   window that has been opened", "Registers the constants to be auto loaded.\n\n @param prefix [String] The require prefix. If the path is inside Faraday,\n           then it will be prefixed with the root path of this loaded\n           Faraday version.\n @param options [{ Symbol => String }] library names.\n\n @example\n\n   Faraday.autoload_all 'faraday/foo',\n     Bar: 'bar'\n\n   # requires faraday/foo/bar to load Faraday::Bar.\n   Faraday::Bar\n\n @return [void]", "Filters the module's contents with those that have been already\n autoloaded.\n\n @return [Array<Class, Module>]", "parse a multipart MIME message, returning a hash of any multipart errors", "Executes a block which should try to require and reference dependent\n libraries", "Check if the adapter is parallel-capable.\n\n @yield if the adapter isn't parallel-capable, or if no adapter is set yet.\n\n @return [Object, nil] a parallel manager or nil if yielded\n @api private", "Parses the given URL with URI and stores the individual\n components in this connection. These components serve as defaults for\n requests made by this connection.\n\n @param url [String, URI]\n @param encoder [Object]\n\n @example\n\n   conn = Faraday::Connection.new { ... }\n   conn.url_prefix = \"https://sushi.com/api\"\n   conn.scheme      # => https\n   conn.path_prefix # => \"/api\"\n\n   conn.get(\"nigiri?page=2\") # accesses https://sushi.com/api/nigiri", "Takes a relative url for a request and combines it with the defaults\n set on the connection instance.\n\n @param url [String]\n @param extra_params [Hash]\n\n @example\n   conn = Faraday::Connection.new { ... }\n   conn.url_prefix = \"https://sushi.com/api?token=abc\"\n   conn.scheme      # => https\n   conn.path_prefix # => \"/api\"\n\n   conn.build_url(\"nigiri?page=2\")\n   # => https://sushi.com/api/nigiri?token=abc&page=2\n\n   conn.build_url(\"nigiri\", page: 2)\n   # => https://sushi.com/api/nigiri?token=abc&page=2", "Creates and configures the request object.\n\n @param method [Symbol]\n\n @yield [Faraday::Request] if block given\n @return [Faraday::Request]", "Build an absolute URL based on url_prefix.\n\n @param url [String, URI]\n @param params [Faraday::Utils::ParamsHash] A Faraday::Utils::ParamsHash to\n               replace the query values\n          of the resulting url (default: nil).\n\n @return [URI]", "Receives a String or URI and returns just\n the path with the query string sorted.", "Recursive hash update", "Update path and params.\n\n @param path [URI, String]\n @param params [Hash, nil]\n @return [void]", "Marshal serialization support.\n\n @return [Hash] the hash ready to be serialized in Marshal.", "Marshal serialization support.\n Restores the instance variables according to the +serialised+.\n @param serialised [Hash] the serialised object.", "Returns the policy of a specified bucket.\n\n @option params [required, String] :bucket\n\n @return [Types::GetBucketPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:\n\n   * {Types::GetBucketPolicyOutput#policy #policy} => IO\n\n\n @example Example: To get bucket policy\n\n   # The following example returns bucket policy associated with a bucket.\n\n   resp = client.get_bucket_policy({\n     bucket: \"examplebucket\",\n   })\n\n   resp.to_h outputs the following:\n   {\n     policy: \"{\\\"Version\\\":\\\"2008-10-17\\\",\\\"Id\\\":\\\"LogPolicy\\\",\\\"Statement\\\":[{\\\"Sid\\\":\\\"Enables the log delivery group to publish logs to your bucket \\\",\\\"Effect\\\":\\\"Allow\\\",\\\"Principal\\\":{\\\"AWS\\\":\\\"111122223333\\\"},\\\"Action\\\":[\\\"s3:GetBucketAcl\\\",\\\"s3:GetObjectAcl\\\",\\\"s3:PutObject\\\"],\\\"Resource\\\":[\\\"arn:aws:s3:::policytest1/*\\\",\\\"arn:aws:s3:::policytest1\\\"]}]}\",\n   }\n\n @example Request syntax with placeholder values\n\n   resp = client.get_bucket_policy({\n     bucket: \"BucketName\", # required\n   })\n\n @example Response structure\n\n   resp.policy #=> String\n\n @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy AWS API Documentation\n\n @overload get_bucket_policy(params = {})\n @param [Hash] params ({})", "Retrieves objects from Amazon S3.\n\n @option params [String, IO] :response_target\n   Where to write response data, file path, or IO object.\n\n @option params [required, String] :bucket\n\n @option params [String] :if_match\n   Return the object only if its entity tag (ETag) is the same as the one\n   specified, otherwise return a 412 (precondition failed).\n\n @option params [Time,DateTime,Date,Integer,String] :if_modified_since\n   Return the object only if it has been modified since the specified\n   time, otherwise return a 304 (not modified).\n\n @option params [String] :if_none_match\n   Return the object only if its entity tag (ETag) is different from the\n   one specified, otherwise return a 304 (not modified).\n\n @option params [Time,DateTime,Date,Integer,String] :if_unmodified_since\n   Return the object only if it has not been modified since the specified\n   time, otherwise return a 412 (precondition failed).\n\n @option params [required, String] :key\n\n @option params [String] :range\n   Downloads the specified range bytes of an object. For more information\n   about the HTTP Range header, go to\n   http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.\n\n @option params [String] :response_cache_control\n   Sets the Cache-Control header of the response.\n\n @option params [String] :response_content_disposition\n   Sets the Content-Disposition header of the response\n\n @option params [String] :response_content_encoding\n   Sets the Content-Encoding header of the response.\n\n @option params [String] :response_content_language\n   Sets the Content-Language header of the response.\n\n @option params [String] :response_content_type\n   Sets the Content-Type header of the response.\n\n @option params [Time,DateTime,Date,Integer,String] :response_expires\n   Sets the Expires header of the response.\n\n @option params [String] :version_id\n   VersionId used to reference a specific version of the object.\n\n @option params [String] :sse_customer_algorithm\n   Specifies the algorithm to use to when encrypting the object (e.g.,\n   AES256).\n\n @option params [String] :sse_customer_key\n   Specifies the customer-provided encryption key for Amazon S3 to use in\n   encrypting data. This value is used to store the object and then it is\n   discarded; Amazon does not store the encryption key. The key must be\n   appropriate for use with the algorithm specified in the\n   x-amz-server-side\u200b-encryption\u200b-customer-algorithm header.\n\n @option params [String] :sse_customer_key_md5\n   Specifies the 128-bit MD5 digest of the encryption key according to\n   RFC 1321. Amazon S3 uses this header for a message integrity check to\n   ensure the encryption key was transmitted without error.\n\n @option params [String] :request_payer\n   Confirms that the requester knows that she or he will be charged for\n   the request. Bucket owners need not specify this parameter in their\n   requests. Documentation on downloading objects from requester pays\n   buckets can be found at\n   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html\n\n @option params [Integer] :part_number\n   Part number of the object being read. This is a positive integer\n   between 1 and 10,000. Effectively performs a 'ranged' GET request\n   for the part specified. Useful for downloading just a part of an\n   object.\n\n @return [Types::GetObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:\n\n   * {Types::GetObjectOutput#body #body} => IO\n   * {Types::GetObjectOutput#delete_marker #delete_marker} => Boolean\n   * {Types::GetObjectOutput#accept_ranges #accept_ranges} => String\n   * {Types::GetObjectOutput#expiration #expiration} => String\n   * {Types::GetObjectOutput#restore #restore} => String\n   * {Types::GetObjectOutput#last_modified #last_modified} => Time\n   * {Types::GetObjectOutput#content_length #content_length} => Integer\n   * {Types::GetObjectOutput#etag #etag} => String\n   * {Types::GetObjectOutput#missing_meta #missing_meta} => Integer\n   * {Types::GetObjectOutput#version_id #version_id} => String\n   * {Types::GetObjectOutput#cache_control #cache_control} => String\n   * {Types::GetObjectOutput#content_disposition #content_disposition} => String\n   * {Types::GetObjectOutput#content_encoding #content_encoding} => String\n   * {Types::GetObjectOutput#content_language #content_language} => String\n   * {Types::GetObjectOutput#content_range #content_range} => String\n   * {Types::GetObjectOutput#content_type #content_type} => String\n   * {Types::GetObjectOutput#expires #expires} => Time\n   * {Types::GetObjectOutput#expires_string #expires_string} => String\n   * {Types::GetObjectOutput#website_redirect_location #website_redirect_location} => String\n   * {Types::GetObjectOutput#server_side_encryption #server_side_encryption} => String\n   * {Types::GetObjectOutput#metadata #metadata} => Hash&lt;String,String&gt;\n   * {Types::GetObjectOutput#sse_customer_algorithm #sse_customer_algorithm} => String\n   * {Types::GetObjectOutput#sse_customer_key_md5 #sse_customer_key_md5} => String\n   * {Types::GetObjectOutput#ssekms_key_id #ssekms_key_id} => String\n   * {Types::GetObjectOutput#storage_class #storage_class} => String\n   * {Types::GetObjectOutput#request_charged #request_charged} => String\n   * {Types::GetObjectOutput#replication_status #replication_status} => String\n   * {Types::GetObjectOutput#parts_count #parts_count} => Integer\n   * {Types::GetObjectOutput#tag_count #tag_count} => Integer\n   * {Types::GetObjectOutput#object_lock_mode #object_lock_mode} => String\n   * {Types::GetObjectOutput#object_lock_retain_until_date #object_lock_retain_until_date} => Time\n   * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String\n\n\n @example Example: To retrieve an object\n\n   # The following example retrieves an object for an S3 bucket.\n\n   resp = client.get_object({\n     bucket: \"examplebucket\",\n     key: \"HappyFace.jpg\",\n   })\n\n   resp.to_h outputs the following:\n   {\n     accept_ranges: \"bytes\",\n     content_length: 3191,\n     content_type: \"image/jpeg\",\n     etag: \"\\\"6805f2cfc46c0f04559748bb039d69ae\\\"\",\n     last_modified: Time.parse(\"Thu, 15 Dec 2016 01:19:41 GMT\"),\n     metadata: {\n     },\n     tag_count: 2,\n     version_id: \"null\",\n   }\n\n @example Example: To retrieve a byte range of an object\n\n   # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a\n   # specific byte range.\n\n   resp = client.get_object({\n     bucket: \"examplebucket\",\n     key: \"SampleFile.txt\",\n     range: \"bytes=0-9\",\n   })\n\n   resp.to_h outputs the following:\n   {\n     accept_ranges: \"bytes\",\n     content_length: 10,\n     content_range: \"bytes 0-9/43\",\n     content_type: \"text/plain\",\n     etag: \"\\\"0d94420ffd0bc68cd3d152506b97a9cc\\\"\",\n     last_modified: Time.parse(\"Thu, 09 Oct 2014 22:57:28 GMT\"),\n     metadata: {\n     },\n     version_id: \"null\",\n   }\n\n @example Download an object to disk\n   # stream object directly to disk\n   resp = s3.get_object(\n     response_target: '/path/to/file',\n     bucket: 'bucket-name',\n     key: 'object-key')\n\n   # you can still access other response data\n   resp.metadata #=> { ... }\n   resp.etag #=> \"...\"\n\n @example Download object into memory\n   # omit :response_target to download to a StringIO in memory\n   resp = s3.get_object(bucket: 'bucket-name', key: 'object-key')\n\n   # call #read or #string on the response body\n   resp.body.read\n   #=> '...'\n\n @example Streaming data to a block\n   # WARNING: yielding data to a block disables retries of networking errors\n   File.open('/path/to/file', 'wb') do |file|\n     s3.get_object(bucket: 'bucket-name', key: 'object-key') do |chunk|\n       file.write(chunk)\n     end\n   end\n\n @example Request syntax with placeholder values\n\n   resp = client.get_object({\n     bucket: \"BucketName\", # required\n     if_match: \"IfMatch\",\n     if_modified_since: Time.now,\n     if_none_match: \"IfNoneMatch\",\n     if_unmodified_since: Time.now,\n     key: \"ObjectKey\", # required\n     range: \"Range\",\n     response_cache_control: \"ResponseCacheControl\",\n     response_content_disposition: \"ResponseContentDisposition\",\n     response_content_encoding: \"ResponseContentEncoding\",\n     response_content_language: \"ResponseContentLanguage\",\n     response_content_type: \"ResponseContentType\",\n     response_expires: Time.now,\n     version_id: \"ObjectVersionId\",\n     sse_customer_algorithm: \"SSECustomerAlgorithm\",\n     sse_customer_key: \"SSECustomerKey\",\n     sse_customer_key_md5: \"SSECustomerKeyMD5\",\n     request_payer: \"requester\", # accepts requester\n     part_number: 1,\n   })\n\n @example Response structure\n\n   resp.body #=> IO\n   resp.delete_marker #=> Boolean\n   resp.accept_ranges #=> String\n   resp.expiration #=> String\n   resp.restore #=> String\n   resp.last_modified #=> Time\n   resp.content_length #=> Integer\n   resp.etag #=> String\n   resp.missing_meta #=> Integer\n   resp.version_id #=> String\n   resp.cache_control #=> String\n   resp.content_disposition #=> String\n   resp.content_encoding #=> String\n   resp.content_language #=> String\n   resp.content_range #=> String\n   resp.content_type #=> String\n   resp.expires #=> Time\n   resp.expires_string #=> String\n   resp.website_redirect_location #=> String\n   resp.server_side_encryption #=> String, one of \"AES256\", \"aws:kms\"\n   resp.metadata #=> Hash\n   resp.metadata[\"MetadataKey\"] #=> String\n   resp.sse_customer_algorithm #=> String\n   resp.sse_customer_key_md5 #=> String\n   resp.ssekms_key_id #=> String\n   resp.storage_class #=> String, one of \"STANDARD\", \"REDUCED_REDUNDANCY\", \"STANDARD_IA\", \"ONEZONE_IA\", \"INTELLIGENT_TIERING\", \"GLACIER\", \"DEEP_ARCHIVE\"\n   resp.request_charged #=> String, one of \"requester\"\n   resp.replication_status #=> String, one of \"COMPLETE\", \"PENDING\", \"FAILED\", \"REPLICA\"\n   resp.parts_count #=> Integer\n   resp.tag_count #=> Integer\n   resp.object_lock_mode #=> String, one of \"GOVERNANCE\", \"COMPLIANCE\"\n   resp.object_lock_retain_until_date #=> Time\n   resp.object_lock_legal_hold_status #=> String, one of \"ON\", \"OFF\"\n\n @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject AWS API Documentation\n\n @overload get_object(params = {})\n @param [Hash] params ({})", "Return torrent files from a bucket.\n\n @option params [String, IO] :response_target\n   Where to write response data, file path, or IO object.\n\n @option params [required, String] :bucket\n\n @option params [required, String] :key\n\n @option params [String] :request_payer\n   Confirms that the requester knows that she or he will be charged for\n   the request. Bucket owners need not specify this parameter in their\n   requests. Documentation on downloading objects from requester pays\n   buckets can be found at\n   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html\n\n @return [Types::GetObjectTorrentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:\n\n   * {Types::GetObjectTorrentOutput#body #body} => IO\n   * {Types::GetObjectTorrentOutput#request_charged #request_charged} => String\n\n\n @example Example: To retrieve torrent files for an object\n\n   # The following example retrieves torrent files of an object.\n\n   resp = client.get_object_torrent({\n     bucket: \"examplebucket\",\n     key: \"HappyFace.jpg\",\n   })\n\n   resp.to_h outputs the following:\n   {\n   }\n\n @example Request syntax with placeholder values\n\n   resp = client.get_object_torrent({\n     bucket: \"BucketName\", # required\n     key: \"ObjectKey\", # required\n     request_payer: \"requester\", # accepts requester\n   })\n\n @example Response structure\n\n   resp.body #=> IO\n   resp.request_charged #=> String, one of \"requester\"\n\n @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent AWS API Documentation\n\n @overload get_object_torrent(params = {})\n @param [Hash] params ({})", "Polls an API operation until a resource enters a desired state.\n\n ## Basic Usage\n\n A waiter will call an API operation until:\n\n * It is successful\n * It enters a terminal state\n * It makes the maximum number of attempts\n\n In between attempts, the waiter will sleep.\n\n     # polls in a loop, sleeping between attempts\n     client.wait_until(waiter_name, params)\n\n ## Configuration\n\n You can configure the maximum number of polling attempts, and the\n delay (in seconds) between each polling attempt. You can pass\n configuration as the final arguments hash.\n\n     # poll for ~25 seconds\n     client.wait_until(waiter_name, params, {\n       max_attempts: 5,\n       delay: 5,\n     })\n\n ## Callbacks\n\n You can be notified before each polling attempt and before each\n delay. If you throw `:success` or `:failure` from these callbacks,\n it will terminate the waiter.\n\n     started_at = Time.now\n     client.wait_until(waiter_name, params, {\n\n       # disable max attempts\n       max_attempts: nil,\n\n       # poll for 1 hour, instead of a number of attempts\n       before_wait: -> (attempts, response) do\n         throw :failure if Time.now - started_at > 3600\n       end\n     })\n\n ## Handling Errors\n\n When a waiter is unsuccessful, it will raise an error.\n All of the failure errors extend from\n {Aws::Waiters::Errors::WaiterFailed}.\n\n     begin\n       client.wait_until(...)\n     rescue Aws::Waiters::Errors::WaiterFailed\n       # resource did not enter the desired state in time\n     end\n\n ## Valid Waiters\n\n The following table lists the valid waiter names, the operations they call,\n and the default `:delay` and `:max_attempts` values.\n\n | waiter_name       | params         | :delay   | :max_attempts |\n | ----------------- | -------------- | -------- | ------------- |\n | bucket_exists     | {#head_bucket} | 5        | 20            |\n | bucket_not_exists | {#head_bucket} | 5        | 20            |\n | object_exists     | {#head_object} | 5        | 20            |\n | object_not_exists | {#head_object} | 5        | 20            |\n\n @raise [Errors::FailureStateError] Raised when the waiter terminates\n   because the waiter has entered a state that it will not transition\n   out of, preventing success.\n\n @raise [Errors::TooManyAttemptsError] Raised when the configured\n   maximum number of attempts have been made, and the waiter is not\n   yet successful.\n\n @raise [Errors::UnexpectedError] Raised when an error is encounted\n   while polling for a resource that is not expected.\n\n @raise [Errors::NoSuchWaiterError] Raised when you request to wait\n   for an unknown state.\n\n @return [Boolean] Returns `true` if the waiter was successful.\n @param [Symbol] waiter_name\n @param [Hash] params ({})\n @param [Hash] options ({})\n @option options [Integer] :max_attempts\n @option options [Integer] :delay\n @option options [Proc] :before_attempt\n @option options [Proc] :before_wait", "Constructs a new SharedConfig provider object. This will load the shared\n credentials file, and optionally the shared configuration file, as ini\n files which support profiles.\n\n By default, the shared credential file (the default path for which is\n `~/.aws/credentials`) and the shared config file (the default path for\n which is `~/.aws/config`) are loaded. However, if you set the\n `ENV['AWS_SDK_CONFIG_OPT_OUT']` environment variable, only the shared\n credential file will be loaded. You can specify the shared credential\n file path with the `ENV['AWS_SHARED_CREDENTIALS_FILE']` environment\n variable or with the `:credentials_path` option. Similarly, you can\n specify the shared config file path with the `ENV['AWS_CONFIG_FILE']`\n environment variable or with the `:config_path` option.\n\n The default profile name is 'default'. You can specify the profile name\n with the `ENV['AWS_PROFILE']` environment variable or with the\n `:profile_name` option.\n\n @param [Hash] options\n @option options [String] :credentials_path Path to the shared credentials\n   file. If not specified, will check `ENV['AWS_SHARED_CREDENTIALS_FILE']`\n   before using the default value of \"#{Dir.home}/.aws/credentials\".\n @option options [String] :config_path Path to the shared config file.\n   If not specified, will check `ENV['AWS_CONFIG_FILE']` before using the\n   default value of \"#{Dir.home}/.aws/config\".\n @option options [String] :profile_name The credential/config profile name\n   to use. If not specified, will check `ENV['AWS_PROFILE']` before using\n   the fixed default value of 'default'.\n @option options [Boolean] :config_enabled If true, loads the shared config\n   file and enables new config values outside of the old shared credential\n   spec.\n @api private", "Attempts to assume a role from shared config or shared credentials file.\n Will always attempt first to assume a role from the shared credentials\n file, if present.", "Deeply converts the Structure into a hash.  Structure members that\n are `nil` are omitted from the resultant hash.\n\n You can call #orig_to_h to get vanilla #to_h behavior as defined\n in stdlib Struct.\n\n @return [Hash]", "Allows you to access all of the requests that the stubbed client has made\n\n @params [Boolean] exclude_presign Setting to true for filtering out not sent requests from\n                 generating presigned urls. Default to false.\n @return [Array] Returns an array of the api requests made, each request object contains the\n                 :operation_name, :params, and :context of the request.\n @raise [NotImplementedError] Raises `NotImplementedError` when the client is not stubbed", "Generates and returns stubbed response data from the named operation.\n\n     s3 = Aws::S3::Client.new\n     s3.stub_data(:list_buckets)\n     #=> #<struct Aws::S3::Types::ListBucketsOutput buckets=[], owner=#<struct Aws::S3::Types::Owner display_name=\"DisplayName\", id=\"ID\">>\n\n In addition to generating default stubs, you can provide data to\n apply to the response stub.\n\n     s3.stub_data(:list_buckets, buckets:[{name:'aws-sdk'}])\n     #=> #<struct Aws::S3::Types::ListBucketsOutput\n       buckets=[#<struct Aws::S3::Types::Bucket name=\"aws-sdk\", creation_date=nil>],\n       owner=#<struct Aws::S3::Types::Owner display_name=\"DisplayName\", id=\"ID\">>\n\n @param [Symbol] operation_name\n @param [Hash] data\n @return [Structure] Returns a stubbed response data structure. The\n   actual class returned will depend on the given `operation_name`.", "Yields the current and each following response to the given block.\n @yieldparam [Response] response\n @return [Enumerable,nil] Returns a new Enumerable if no block is given.", "This operation downloads the output of the job you initiated using\n InitiateJob. Depending on the job type you specified when you\n initiated the job, the output will be either the content of an archive\n or a vault inventory.\n\n You can download all the job output or download a portion of the\n output by specifying a byte range. In the case of an archive retrieval\n job, depending on the byte range you specify, Amazon Glacier returns\n the checksum for the portion of the data. You can compute the checksum\n on the client and verify that the values match to ensure the portion\n you downloaded is the correct data.\n\n A job ID will not expire for at least 24 hours after Amazon Glacier\n completes the job. That a byte range. For both archive and inventory\n retrieval jobs, you should verify the downloaded size against the size\n returned in the headers from the **Get Job Output** response.\n\n For archive retrieval jobs, you should also verify that the size is\n what you expected. If you download a portion of the output, the\n expected size is based on the range of bytes you specified. For\n example, if you specify a range of `bytes=0-1048575`, you should\n verify your download size is 1,048,576 bytes. If you download an\n entire archive, the expected size is the size of the archive when you\n uploaded it to Amazon Glacier The expected size is also returned in\n the headers from the **Get Job Output** response.\n\n In the case of an archive retrieval job, depending on the byte range\n you specify, Amazon Glacier returns the checksum for the portion of\n the data. To ensure the portion you downloaded is the correct data,\n compute the checksum on the client, verify that the values match, and\n verify that the size is what you expected.\n\n A job ID does not expire for at least 24 hours after Amazon Glacier\n completes the job. That is, you can download the job output within the\n 24 hours period after Amazon Glacier completes the job.\n\n An AWS account has full permission to perform all operations\n (actions). However, AWS Identity and Access Management (IAM) users\n don't have any permissions by default. You must grant them explicit\n permission to perform specific actions. For more information, see\n [Access Control Using AWS Identity and Access Management (IAM)][1].\n\n For conceptual information and the underlying REST API, see\n [Downloading a Vault Inventory][2], [Downloading an Archive][3], and\n [Get Job Output ][4]\n\n\n\n [1]: http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\n [2]: http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\n [3]: http://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html\n [4]: http://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html\n\n @option params [required, String] :account_id\n   The `AccountId` value is the AWS account ID of the account that owns\n   the vault. You can either specify an AWS account ID or optionally a\n   single '`-`' (hyphen), in which case Amazon Glacier uses the AWS\n   account ID associated with the credentials used to sign the request.\n   If you use an account ID, do not include any hyphens ('-') in the\n   ID.\n\n @option params [required, String] :vault_name\n   The name of the vault.\n\n @option params [required, String] :job_id\n   The job ID whose data is downloaded.\n\n @option params [String] :range\n   The range of bytes to retrieve from the output. For example, if you\n   want to download the first 1,048,576 bytes, specify the range as\n   `bytes=0-1048575`. By default, this operation downloads the entire\n   output.\n\n   If the job output is large, then you can use a range to retrieve a\n   portion of the output. This allows you to download the entire output\n   in smaller chunks of bytes. For example, suppose you have 1 GB of job\n   output you want to download and you decide to download 128 MB chunks\n   of data at a time, which is a total of eight Get Job Output requests.\n   You use the following process to download the job output:\n\n   1.  Download a 128 MB chunk of output by specifying the appropriate\n       byte range. Verify that all 128 MB of data was received.\n\n   2.  Along with the data, the response includes a SHA256 tree hash of\n       the payload. You compute the checksum of the payload on the client\n       and compare it with the checksum you received in the response to\n       ensure you received all the expected data.\n\n   3.  Repeat steps 1 and 2 for all the eight 128 MB chunks of output\n       data, each time specifying the appropriate byte range.\n\n   4.  After downloading all the parts of the job output, you have a list\n       of eight checksum values. Compute the tree hash of these values to\n       find the checksum of the entire output. Using the DescribeJob API,\n       obtain job information of the job that provided you the output.\n       The response includes the checksum of the entire archive stored in\n       Amazon Glacier. You compare this value with the checksum you\n       computed to ensure you have downloaded the entire archive content\n       with no errors.\n\n @return [Types::GetJobOutputOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:\n\n   * {Types::GetJobOutputOutput#body #body} => IO\n   * {Types::GetJobOutputOutput#checksum #checksum} => String\n   * {Types::GetJobOutputOutput#status #status} => Integer\n   * {Types::GetJobOutputOutput#content_range #content_range} => String\n   * {Types::GetJobOutputOutput#accept_ranges #accept_ranges} => String\n   * {Types::GetJobOutputOutput#content_type #content_type} => String\n   * {Types::GetJobOutputOutput#archive_description #archive_description} => String\n\n\n @example Example: To get the output of a previously initiated job\n\n   # The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.\n\n   resp = client.get_job_output({\n     account_id: \"-\",\n     job_id: \"zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW\",\n     range: \"\",\n     vault_name: \"my-vaul\",\n   })\n\n   resp.to_h outputs the following:\n   {\n     accept_ranges: \"bytes\",\n     body: \"inventory-data\",\n     content_type: \"application/json\",\n     status: 200,\n   }\n\n @example Request syntax with placeholder values\n\n   resp = client.get_job_output({\n     account_id: \"string\", # required\n     vault_name: \"string\", # required\n     job_id: \"string\", # required\n     range: \"string\",\n   })\n\n @example Response structure\n\n   resp.body #=> IO\n   resp.checksum #=> String\n   resp.status #=> Integer\n   resp.content_range #=> String\n   resp.accept_ranges #=> String\n   resp.content_type #=> String\n   resp.archive_description #=> String\n\n @overload get_job_output(params = {})\n @param [Hash] params ({})", "checking whether an unexpired endpoint key exists in cache\n @param [String] key\n @return [Boolean]", "extract the key to be used in the cache from request context\n @param [RequestContext] ctx\n @return [String]", "Create a ruby hash from a string passed by the jekyll tag", "Ensure that your plugin conforms to good hook naming conventions.\n\n   Resque::Plugin.lint(MyResquePlugin)", "DEPRECATED. Processes a single job. If none is given, it will\n try to produce one. Usually run in the child.", "Reports the exception and marks the job as failed", "Processes a given job in the child.", "Attempts to grab a job off one of the provided queues. Returns\n nil if no job can be found.", "Reconnect to Redis to avoid sharing a connection with the parent,\n retry up to 3 times with increasing delay before giving up.", "Kill the child and shutdown immediately.\n If not forking, abort this process.", "Runs a named hook, passing along any arguments.", "Unregisters ourself as a worker. Useful when shutting down.", "Given a job, tells Redis we're working on it. Useful for seeing\n what workers are doing and when.", "Returns an Array of string pids of all the other workers on this\n machine. Useful when pruning dead workers on startup.", "Given an exception object, hands off the needed parameters to\n the Failure module.", "Create a new endpoint.\n @param new_settings [InheritableSetting] settings to determine the params,\n   validations, and other properties from.\n @param options [Hash] attributes of this endpoint\n @option options path [String or Array] the path to this endpoint, within\n   the current scope.\n @option options method [String or Array] which HTTP method(s) can be used\n   to reach this endpoint.\n @option options route_options [Hash]\n @note This happens at the time of API definition, so in this context the\n endpoint does not know if it will be mounted under a different endpoint.\n @yield a block defining what your API should do when this endpoint is hit\n Update our settings from a given set of stackable parameters. Used when\n the endpoint's API is mounted under another one.", "Prior to version 4.1 of rails double quotes were inadventently removed in json_escape.\n This adds the correct json_escape functionality to rails versions < 4.1", "Register a resource into this namespace. The preffered method to access this is to\n use the global registration ActiveAdmin.register which delegates to the proper\n namespace instance.", "Add a callback to be ran when we build the menu\n\n @param [Symbol] name The name of the menu. Default: :default\n @yield [ActiveAdmin::Menu] The block to be ran when the menu is built\n\n @return [void]", "The default logout menu item\n\n @param [ActiveAdmin::MenuItem] menu The menu to add the logout link to\n @param [Fixnum] priority The numeric priority for the order in which it appears\n @param [Hash] html_options An options hash to pass along to link_to", "The default user session menu item\n\n @param [ActiveAdmin::MenuItem] menu The menu to add the logout link to\n @param [Fixnum] priority The numeric priority for the order in which it appears\n @param [Hash] html_options An options hash to pass along to link_to", "Page content.\n\n The block should define the view using Arbre.\n\n Example:\n\n   ActiveAdmin.register \"My Page\" do\n     content do\n       para \"Sweet!\"\n     end\n   end", "Finds a resource based on the resource name, resource class, or base class.", "Registers a brand new configuration for the given resource.", "Creates a namespace for the given name\n\n Yields the namespace if a block is given\n\n @return [Namespace] the new or existing namespace", "Register a page\n\n @param name [String] The page name\n @option [Hash] Accepts option :namespace.\n @&block The registration block.", "Loads all ruby files that are within the load_paths setting.\n To reload everything simply call `ActiveAdmin.unload!`", "Creates all the necessary routes for the ActiveAdmin configurations\n\n Use this within the routes.rb file:\n\n   Application.routes.draw do |map|\n     ActiveAdmin.routes(self)\n   end\n\n @param rails_router [ActionDispatch::Routing::Mapper]", "Hook into the Rails code reloading mechanism so that things are reloaded\n properly in development mode.\n\n If any of the app files (e.g. models) has changed, we need to reload all\n the admin files. If the admin files themselves has changed, we need to\n regenerate the routes as well.", "remove options that should not render as attributes", "Renders the Formtastic inputs then appends ActiveAdmin delete and sort actions.", "Capture the ADD JS", "Defines the routes for each resource", "Defines member and collection actions", "Simple callback system. Implements before and after callbacks for\n use within the controllers.\n\n We didn't use the ActiveSupport callbacks because they do not support\n passing in any arbitrary object into the callback method (which we\n need to do)", "Keys included in the `permitted_params` setting are automatically whitelisted.\n\n Either\n\n   permit_params :title, :author, :body, tags: []\n\n Or\n\n   permit_params do\n     defaults = [:title, :body]\n     if current_user.admin?\n       defaults + [:author]\n     else\n       defaults\n     end\n   end", "Configure the index page for the resource", "Configure the show page for the resource", "Configure the CSV format\n\n For example:\n\n   csv do\n     column :name\n     column(\"Author\") { |post| post.author.full_name }\n   end\n\n   csv col_sep: \";\", force_quotes: true do\n     column :name\n   end", "Member Actions give you the functionality of defining both the\n action and the route directly from your ActiveAdmin registration\n block.\n\n For example:\n\n   ActiveAdmin.register Post do\n     member_action :comments do\n       @post = Post.find(params[:id])\n       @comments = @post.comments\n     end\n   end\n\n Will create a new controller action comments and will hook it up to\n the named route (comments_admin_post_path) /admin/posts/:id/comments\n\n You can treat everything within the block as a standard Rails controller\n action.", "compute the price range", "Loads a configuration, ensuring it extends the default configuration.", "Filter out directories. This could happen when changing a symlink to a\n directory as part of an amendment, since the symlink will still appear as\n a file, but the actual working tree will have a directory.", "Check the yard coverage\n\n Return a :pass if the coverage is enough, :warn if it couldn't be read,\n otherwise, it has been read successfully.", "Create the error messages", "Get a list of files that were added, copied, or modified in the merge\n commit. Renames and deletions are ignored, since there should be nothing\n to check.", "Get a list of files that have been added or modified as part of a\n rewritten commit. Renames and deletions are ignored, since there should be\n nothing to check.", "Returns status and output for messages assuming no special treatment of\n messages occurring on unmodified lines.", "Runs the hook and transforms the status returned based on the hook's\n configuration.\n\n Poorly named because we already have a bunch of hooks in the wild that\n implement `#run`, and we needed a wrapper step to transform the status\n based on any custom configuration.", "If the hook defines required library paths that it wants to load, attempt\n to load them.", "Stash unstaged contents of files so hooks don't see changes that aren't\n about to be committed.", "Restore unstaged changes and reset file modification times so it appears\n as if nothing ever changed.\n\n We want to restore the modification times for each of the files after\n every step to ensure as little time as possible has passed while the\n modification time on the file was newer. This helps us play more nicely\n with file watchers.", "Get a list of added, copied, or modified files that have been staged.\n Renames and deletions are ignored, since there should be nothing to check.", "Clears the working tree so that the stash can be applied.", "Applies the stash to the working tree to restore the user's state.", "Stores the modification times for all modified files to make it appear like\n they never changed.\n\n This prevents (some) editors from complaining about files changing when we\n stash changes before running the hooks.", "Restores the file modification times for all modified files to make it\n appear like they never changed.", "Validates hash for any invalid options, normalizing where possible.\n\n @param config [Overcommit::Configuration]\n @param hash [Hash] hash representation of YAML config\n @param options[Hash]\n @option default [Boolean] whether hash represents the default built-in config\n @option logger [Overcommit::Logger] logger to output warnings to\n @return [Hash] validated hash (potentially modified)", "Normalizes `nil` values to empty hashes.\n\n This is useful for when we want to merge two configuration hashes\n together, since it's easier to merge two hashes than to have to check if\n one of the values is nil.", "Prints an error message and raises an exception if a hook has an\n invalid name, since this can result in strange errors elsewhere.", "Prints a warning if there are any hooks listed in the configuration\n without `enabled` explicitly set.", "Prints a warning if any hook has a number of processors larger than the\n global `concurrency` setting.", "Returns configuration for all built-in hooks in each hook type.\n\n @return [Hash]", "Returns configuration for all plugin hooks in each hook type.\n\n @return [Hash]", "Returns the built-in hooks that have been enabled for a hook type.", "Returns the ad hoc hooks that have been enabled for a hook type.", "Returns a non-modifiable configuration for a hook.", "Applies additional configuration settings based on the provided\n environment variables.", "Returns the stored signature of this repo's Overcommit configuration.\n\n This is intended to be compared against the current signature of this\n configuration object.\n\n @return [String]", "Returns the names of all files that are tracked by git.\n\n @return [Array<String>] list of absolute file paths", "Restore any relevant files that were present when repo was in the middle\n of a merge.", "Restore any relevant files that were present when repo was in the middle\n of a cherry-pick.", "Update the current stored signature for this hook.", "Calculates a hash of a hook using a combination of its configuration and\n file contents.\n\n This way, if either the plugin code changes or its configuration changes,\n the hash will change and we can alert the user to this change.", "Executed at the end of an individual hook run.", "Process one logical line of makefile data.", "Invoke the task if it is needed.  Prerequisites are invoked first.", "Transform the list of comments as specified by the block and\n join with the separator.", "Merge the given options with the default values.", "Check that the options do not contain options not listed in\n +optdecl+.  An ArgumentError exception is thrown if non-declared\n options are found.", "Trim +n+ innermost scope levels from the scope. In no case will\n this trim beyond the toplevel scope.", "Initialize the command line parameters and app name.", "True if one of the files in RAKEFILES is in the current directory.\n If a match is found, it is copied into @rakefile.", "Return a new FileList with the results of running +sub+ against each\n element of the original list.\n\n Example:\n   FileList['a.c', 'b.c'].sub(/\\.c$/, '.o')  => ['a.o', 'b.o']", "Return a new FileList with the results of running +gsub+ against each\n element of the original list.\n\n Example:\n   FileList['lib/test/file', 'x/y'].gsub(/\\//, \"\\\\\")\n      => ['lib\\\\test\\\\file', 'x\\\\y']", "Same as +sub+ except that the original file list is modified.", "Same as +gsub+ except that the original file list is modified.", "Create the tasks defined by this task library.", "Waits until the queue of futures is empty and all threads have exited.", "processes one item on the queue. Returns true if there was an\n item to process, false if there was no item", "Resolve task arguments for a task or rule when there are no\n dependencies declared.\n\n The patterns recognized by this argument resolving function are:\n\n   task :t\n   task :t, [:a]", "If a rule can be found that matches the task name, enhance the\n task with the prerequisites and actions from the rule.  Set the\n source attribute of the task appropriately for the rule.  Return\n the enhanced task or nil of no rule was found.", "Find the location that called into the dsl layer.", "Attempt to create a rule given the list of prerequisites.", "Are there any prerequisites with a later time than the given time stamp?", "Create a new argument scope using the prerequisite argument\n names.", "If no one else is working this promise, go ahead and do the chore.", "Loops until the block returns a true value", "Purge cached DNS records", "vm always returns a vm", "Processes VM data from BOSH Director,\n extracts relevant agent data, wraps it into Agent object\n and adds it to a list of managed agents.", "subscribe to an inbox, if not already subscribed", "This call only makes sense if all dependencies have already been compiled,\n otherwise it raises an exception\n @return [Hash] Hash representation of all package dependencies. Agent uses\n   that to download package dependencies before compiling the package on a\n   compilation VM.", "Returns formatted exception information\n @param [Hash|#to_s] exception Serialized exception\n @return [String]", "the blob is removed from the blobstore once we have fetched it,\n but if there is a crash before it is injected into the response\n and then logged, there is a chance that we lose it", "Downloads a remote file\n @param [String] resource Resource name to be logged\n @param [String] remote_file Remote file to download\n @param [String] local_file Local file to store the downloaded file\n @raise [Bosh::Director::ResourceNotFound] If remote file is not found\n @raise [Bosh::Director::ResourceError] If there's a network problem", "Updates instance settings\n @param [String] instance_id instance id (instance record\n        will be created in DB if it doesn't already exist)\n @param [String] settings New settings for the instance", "Reads instance settings\n @param [String] instance_id instance id\n @param [optional, String] remote_ip If this IP is provided,\n        check will be performed to see if it instance id\n        actually has this IP address according to the IaaS.", "Used by provider, not using alias because want to update existing provider intent when alias changes", "A consumer which is within the same deployment", "Do not add retries_left default value", "Creates new lock with the given name.\n\n @param name lock name\n @option opts [Number] timeout how long to wait before giving up\n @option opts [Number] expiration how long to wait before expiring an old\n   lock\n Acquire a lock.\n\n @yield [void] optional block to do work before automatically releasing\n   the lock.\n @return [void]", "Release a lock that was not auto released by the lock method.\n\n @return [void]", "returns a list of orphaned networks", "Instantiates and performs director job.\n @param [Array] args Opaque list of job arguments that will be used to\n   instantiate the new job object.\n @return [void]", "Spawns a thread that periodically updates task checkpoint time.\n There is no need to kill this thread as job execution lifetime is the\n same as worker process lifetime.\n @return [Thread] Checkpoint thread", "Truncates string to fit task result length\n @param [String] string The original string\n @param [Integer] len Desired string length\n @return [String] Truncated string", "Marks task completion\n @param [Symbol] state Task completion state\n @param [#to_s] result", "Logs the exception in the event log\n @param [Exception] exception", "The rquirements hash passed in by the caller will be populated with CompiledPackageRequirement objects", "Binds template models for each release spec in the deployment plan\n @return [void]", "Ensures the given value is properly double quoted.\n This also ensures we don't have conflicts with reversed keywords.\n\n IE: `user` is a reserved keyword in PG. But `\"user\"` is allowed and works the same\n     when used as an column/tbl alias.", "Ensures the key is properly single quoted and treated as a actual PG key reference.", "Converts a potential subquery into a compatible Arel SQL node.\n\n Note:\n We convert relations to SQL to maintain compatibility with Rails 5.[0/1].\n Only Rails 5.2+ maintains bound attributes in Arel, so its better to be safe then sorry.\n When we drop support for Rails 5.[0/1], we then can then drop the '.to_sql' conversation", "Finds Records that contains a nested set elements\n\n Array Column Type:\n   User.where.contains(tags: [1, 3])\n   # SELECT user.* FROM user WHERE user.tags @> {1,3}\n\n HStore Column Type:\n   User.where.contains(data: { nickname: 'chainer' })\n   # SELECT user.* FROM user WHERE user.data @> 'nickname' => 'chainer'\n\n JSONB Column Type:\n   User.where.contains(data: { nickname: 'chainer' })\n   # SELECT user.* FROM user WHERE user.data @> {'nickname': 'chainer'}\n\n This can also be used along side joined tables\n\n JSONB Column Type Example:\n   Tag.joins(:user).where.contains(user: { data: { nickname: 'chainer' } })\n   # SELECT tags.* FROM tags INNER JOIN user on user.id = tags.user_id WHERE user.data @> { nickname: 'chainer' }", "Absolute URL to the API representation of this resource", "Returns a hash suitable for use as an API response.\n\n For Documents and Pages:\n\n 1. Adds the file's raw content to the `raw_content` field\n 2. Adds the file's raw YAML front matter to the `front_matter` field\n\n For Static Files it addes the Base64 `encoded_content` field\n\n Options:\n\n include_content - if true, includes the content in the respond, false by default\n                   to support mapping on indexes where we only want metadata\n\n\n Returns a hash (which can then be to_json'd)", "Returns a hash of content fields for inclusion in the API output", "Returns the path to the requested file's containing directory", "Write a file to disk with the given content", "Delete the file at the given path", "verbose 'null' values in front matter", "Return whether this rule set occupies a single line.\n\n Note that this allows:\n   a,\n   b,\n   i { margin: 0; padding: 0; }\n\n and:\n\n   p { margin: 0; padding: 0; }\n\n In other words, the line of the opening curly brace is the line that the\n rule set is considered to occupy.", "Compare each property against the next property to see if they are on\n the same line.\n\n @param properties [Array<Sass::Tree::PropNode>]", "Executed before a node has been visited.\n\n @param node [Sass::Tree::Node]", "Gets the child of the node that resides on the lowest line in the file.\n\n This is necessary due to the fact that our monkey patching of the parse\n tree's {#children} method does not return nodes sorted by their line\n number.\n\n Returns `nil` if node has no children or no children with associated line\n numbers.\n\n @param node [Sass::Tree::Node, Sass::Script::Tree::Node]\n @return [Sass::Tree::Node, Sass::Script::Tree::Node]", "Checks if a simple sequence contains a\n simple selector of a certain class.\n\n @param seq [Sass::Selector::SimpleSequence]\n @param selector_class [Sass::Selector::Simple]\n @returns [Boolean]", "Find the maximum depth of all sequences in a comma sequence.", "Allow rulesets to be indented any amount when the indent is zero, as long\n as it's a multiple of the indent width", "Returns whether node is indented exactly one indent width greater than its\n parent.\n\n @param node [Sass::Tree::Node]\n @return [true,false]", "An expression enclosed in parens will include or not include each paren, depending\n on whitespace. Here we feel out for enclosing parens, and return them as the new\n source for the node.", "In cases where the previous node is not a block declaration, we won't\n have run any checks against it, so we need to check here if the previous\n line is an empty line", "Offset of value for property", "Friendly description that shows the full command that will be executed.", "Create a CLI that outputs to the specified logger.\n\n @param logger [SCSSLint::Logger]", "Return the path of the configuration file that should be loaded.\n\n @param options [Hash]\n @return [String]", "The Sass parser sometimes doesn't assign line numbers in cases where it\n should. This is a helper to easily correct that.", "Create a linter.\n Run this linter against a parsed document with the given configuration,\n returning the lints that were found.\n\n @param engine [Engine]\n @param config [Config]\n @return [Array<Lint>]", "Helper for creating lint from a parse tree node\n\n @param node_or_line_or_location [Sass::Script::Tree::Node, Fixnum,\n                                  SCSSLint::Location, Sass::Source::Position]\n @param message [String]", "Extracts the original source code given a range.\n\n @param source_range [Sass::Source::Range]\n @return [String] the original source code", "Returns whether a given node spans only a single line.\n\n @param node [Sass::Tree::Node]\n @return [true,false] whether the node spans a single line", "Modified so we can also visit selectors in linters\n\n @param node [Sass::Tree::Node, Sass::Script::Tree::Node,\n   Sass::Script::Value::Base]", "Redefine so we can set the `node_parent` of each node\n\n @param parent [Sass::Tree::Node, Sass::Script::Tree::Node,\n   Sass::Script::Value::Base]", "Since keyword arguments are not guaranteed to be in order, use the source\n range to order arguments so we check them in the order they were declared.", "Find the comma following this argument.\n\n The Sass parser is unpredictable in where it marks the end of the\n source range. Thus we need to start at the indicated range, and check\n left and right of that range, gradually moving further outward until\n we find the comma.", "For stubbing in tests.", "Returns a key identifying the bucket this property and value correspond to\n for purposes of uniqueness.", "Check if, starting from the end of a string\n and moving backwards, towards the beginning,\n we find a new line before any non-whitespace characters", "Checks if an individual sequence is split over multiple lines", "Checks if a property value's units are allowed.\n\n @param node [Sass::Tree::Node]\n @param property [String]\n @param units [String]", "Find the child that is out of place", "Return nth-ancestor of a node, where 1 is the parent, 2 is grandparent,\n etc.\n\n @param node [Sass::Tree::Node, Sass::Script::Tree::Node]\n @param level [Integer]\n @return [Sass::Tree::Node, Sass::Script::Tree::Node, nil]", "Return whether to ignore a property in the sort order.\n\n This includes:\n - properties containing interpolation\n - properties not explicitly defined in the sort order (if ignore_unspecified is set)", "Matches the block or conditions hash", "Check if the user has permission to perform a given action on an object.\n\n   can? :destroy, @project\n\n You can also pass the class instead of an instance (if you don't have one handy).\n\n   can? :create, Project\n\n Nested resources can be passed through a hash, this way conditions which are\n dependent upon the association will work when using a class.\n\n   can? :create, @category => Project\n\n You can also pass multiple objects to check. You only need to pass a hash\n following the pattern { :any => [many subjects] }. The behaviour is check if\n there is a permission on any of the given objects.\n\n   can? :create, {:any => [Project, Rule]}\n\n\n Any additional arguments will be passed into the \"can\" block definition. This\n can be used to pass more information about the user's request for example.\n\n   can? :create, Project, request.remote_ip\n\n   can :create, Project do |project, remote_ip|\n     # ...\n   end\n\n Not only can you use the can? method in the controller and view (see ControllerAdditions),\n but you can also call it directly on an ability instance.\n\n   ability.can? :destroy, @project\n\n This makes testing a user's abilities very easy.\n\n   def test \"user can only destroy projects which he owns\"\n     user = User.new\n     ability = Ability.new(user)\n     assert ability.can?(:destroy, Project.new(:user => user))\n     assert ability.cannot?(:destroy, Project.new)\n   end\n\n Also see the RSpec Matchers to aid in testing.", "Defines which abilities are allowed using two arguments. The first one is the action\n you're setting the permission for, the second one is the class of object you're setting it on.\n\n   can :update, Article\n\n You can pass an array for either of these parameters to match any one.\n Here the user has the ability to update or destroy both articles and comments.\n\n   can [:update, :destroy], [Article, Comment]\n\n You can pass :all to match any object and :manage to match any action. Here are some examples.\n\n   can :manage, :all\n   can :update, :all\n   can :manage, Project\n\n You can pass a hash of conditions as the third argument. Here the user can only see active projects which he owns.\n\n   can :read, Project, :active => true, :user_id => user.id\n\n See ActiveRecordAdditions#accessible_by for how to use this in database queries. These conditions\n are also used for initial attributes when building a record in ControllerAdditions#load_resource.\n\n If the conditions hash does not give you enough control over defining abilities, you can use a block\n along with any Ruby code you want.\n\n   can :update, Project do |project|\n     project.groups.include?(user.group)\n   end\n\n If the block returns true then the user has that :update ability for that project, otherwise he\n will be denied access. The downside to using a block is that it cannot be used to generate\n conditions for database queries.\n\n You can pass custom objects into this \"can\" method, this is usually done with a symbol\n and is useful if a class isn't available to define permissions on.\n\n   can :read, :stats\n   can? :read, :stats # => true\n\n IMPORTANT: Neither a hash of conditions nor a block will be used when checking permission on a class.\n\n   can :update, Project, :priority => 3\n   can? :update, Project # => true\n\n If you pass no arguments to +can+, the action, class, and object will be passed to the block and the\n block will always be executed. This allows you to override the full behavior if the permissions are\n defined in an external source such as the database.\n\n   can do |action, object_class, object|\n     # check the database and return true/false\n   end", "Defines an ability which cannot be done. Accepts the same arguments as \"can\".\n\n   can :read, :all\n   cannot :read, Comment\n\n A block can be passed just like \"can\", however if the logic is complex it is recommended\n to use the \"can\" method.\n\n   cannot :read, Product do |product|\n     product.invisible?\n   end", "User shouldn't specify targets with names of real actions or it will cause Seg fault", "Adds a new Archive to a Backup Model.\n\n     Backup::Model.new(:my_backup, 'My Backup') do\n       archive :my_archive do |archive|\n         archive.add 'path/to/archive'\n         archive.add '/another/path/to/archive'\n         archive.exclude 'path/to/exclude'\n         archive.exclude '/another/path/to/exclude'\n       end\n     end\n\n All paths added using `add` or `exclude` will be expanded to their\n full paths from the root of the filesystem. Files will be added to\n the tar archive using these full paths, and their leading `/` will\n be preserved (using tar's `-P` option).\n\n     /path/to/pwd/path/to/archive/...\n     /another/path/to/archive/...\n\n When a `root` path is given, paths to add/exclude are taken as\n relative to the `root` path, unless given as absolute paths.\n\n     Backup::Model.new(:my_backup, 'My Backup') do\n       archive :my_archive do |archive|\n         archive.root '~/my_data'\n         archive.add 'path/to/archive'\n         archive.add '/another/path/to/archive'\n         archive.exclude 'path/to/exclude'\n         archive.exclude '/another/path/to/exclude'\n       end\n     end\n\n This directs `tar` to change directories to the `root` path to create\n the archive. Unless paths were given as absolute, the paths within the\n archive will be relative to the `root` path.\n\n     path/to/archive/...\n     /another/path/to/archive/...\n\n For absolute paths added to this archive, the leading `/` will be\n preserved. Take note that when archives are extracted, leading `/` are\n stripped by default, so care must be taken when extracting archives with\n mixed relative/absolute paths.", "Adds an Database. Multiple Databases may be added to the model.", "Adds an Storage. Multiple Storages may be added to the model.", "Adds an Syncer. Multiple Syncers may be added to the model.", "Adds a Splitter to split the final backup package into multiple files.\n\n +chunk_size+ is specified in MiB and must be given as an Integer.\n +suffix_length+ controls the number of characters used in the suffix\n (and the maximum number of chunks possible).\n ie. 1 (-a, -b), 2 (-aa, -ab), 3 (-aaa, -aab)", "Performs the backup process\n\n Once complete, #exit_status will indicate the result of this process.\n\n If any errors occur during the backup process, all temporary files will\n be left in place. If the error occurs before Packaging, then the\n temporary folder (tmp_path/trigger) will remain and may contain all or\n some of the configured Archives and/or Database dumps. If the error\n occurs after Packaging, but before the Storages complete, then the final\n packaged files (located in the root of tmp_path) will remain.\n\n *** Important ***\n If an error occurs and any of the above mentioned temporary files remain,\n those files *** will be removed *** before the next scheduled backup for\n the same trigger.", "Returns an array of procedures that will be performed if any\n Archives or Databases are configured for the model.", "Attempts to use all configured Storages, even if some of them result in exceptions.\n Returns true or raises first encountered exception.", "Logs messages when the model starts and finishes.\n\n #exception will be set here if #exit_status is > 1,\n since log(:finished) is called before the +after+ hook.", "Finds the resulting files from the packaging procedure\n and stores an Array of suffixes used in @package.chunk_suffixes.\n If the @chunk_size was never reached and only one file\n was written, that file will be suffixed with '-aa' (or -a; -aaa; etc\n depending upon suffix_length). In which case, it will simply\n remove the suffix from the filename.", "includes required submodules into the model class,\n which usually is called User.", "add virtual password accessor and ORM callbacks.", "Comparation with other query or collection\n If other is collection - search request is executed and\n result is used for comparation\n\n @example\n   UsersIndex.filter(term: {name: 'Johny'}) == UsersIndex.filter(term: {name: 'Johny'}) # => true\n   UsersIndex.filter(term: {name: 'Johny'}) == UsersIndex.filter(term: {name: 'Johny'}).to_a # => true\n   UsersIndex.filter(term: {name: 'Johny'}) == UsersIndex.filter(term: {name: 'Winnie'}) # => false\n\n Adds `explain` parameter to search request.\n\n @example\n   UsersIndex.filter(term: {name: 'Johny'}).explain\n   UsersIndex.filter(term: {name: 'Johny'}).explain(true)\n   UsersIndex.filter(term: {name: 'Johny'}).explain(false)\n\n Calling explain without any arguments sets explanation flag to true.\n With `explain: true`, every result object has `_explanation`\n method\n\n @example\n   UsersIndex::User.filter(term: {name: 'Johny'}).explain.first._explanation # => {...}", "Sets elasticsearch `size` search request param\n Default value is set in the elasticsearch and is 10.\n\n @example\n  UsersIndex.filter{ name == 'Johny' }.limit(100)\n     # => {body: {\n            query: {...},\n            size: 100\n          }}", "Sets elasticsearch `from` search request param\n\n @example\n  UsersIndex.filter{ name == 'Johny' }.offset(300)\n     # => {body: {\n            query: {...},\n            from: 300\n          }}", "Adds facets section to the search request.\n All the chained facets a merged and added to the\n search request\n\n @example\n   UsersIndex.facets(tags: {terms: {field: 'tags'}}).facets(ages: {terms: {field: 'age'}})\n     # => {body: {\n            query: {...},\n            facets: {tags: {terms: {field: 'tags'}}, ages: {terms: {field: 'age'}}}\n          }}\n\n If called parameterless - returns result facets from ES performing request.\n Returns empty hash if no facets was requested or resulted.", "Adds a script function to score the search request. All scores are\n added to the search request and combinded according to\n `boost_mode` and `score_mode`\n\n @example\n   UsersIndex.script_score(\"doc['boost'].value\", params: { modifier: 2 })\n       # => {body:\n              query: {\n                function_score: {\n                  query: { ...},\n                  functions: [{\n                    script_score: {\n                       script: \"doc['boost'].value * modifier\",\n                       params: { modifier: 2 }\n                     }\n                    }\n                  }]\n                } } }", "Adds a boost factor to the search request. All scores are\n added to the search request and combinded according to\n `boost_mode` and `score_mode`\n\n This probably only makes sense if you specify a filter\n for the boost factor as well\n\n @example\n   UsersIndex.boost_factor(23, filter: { term: { foo: :bar} })\n       # => {body:\n              query: {\n                function_score: {\n                  query: { ...},\n                  functions: [{\n                    boost_factor: 23,\n                    filter: { term: { foo: :bar } }\n                  }]\n                } } }", "Adds a random score to the search request. All scores are\n added to the search request and combinded according to\n `boost_mode` and `score_mode`\n\n This probably only makes sense if you specify a filter\n for the random score as well.\n\n If you do not pass in a seed value, Time.now will be used\n\n @example\n   UsersIndex.random_score(23, filter: { foo: :bar})\n       # => {body:\n              query: {\n                function_score: {\n                  query: { ...},\n                  functions: [{\n                    random_score: { seed: 23 },\n                    filter: { foo: :bar }\n                  }]\n                } } }", "Add a field value scoring to the search. All scores are\n added to the search request and combinded according to\n `boost_mode` and `score_mode`\n\n This function is only available in Elasticsearch 1.2 and\n greater\n\n @example\n   UsersIndex.field_value_factor(\n                {\n                  field: :boost,\n                  factor: 1.2,\n                  modifier: :sqrt\n                }, filter: { foo: :bar})\n       # => {body:\n              query: {\n                function_score: {\n                  query: { ...},\n                  functions: [{\n                    field_value_factor: {\n                      field: :boost,\n                      factor: 1.2,\n                      modifier: :sqrt\n                    },\n                    filter: { foo: :bar }\n                  }]\n                } } }", "Add a decay scoring to the search. All scores are\n added to the search request and combinded according to\n `boost_mode` and `score_mode`\n\n The parameters have default values, but those may not\n be very useful for most applications.\n\n @example\n   UsersIndex.decay(\n                :gauss,\n                :field,\n                origin: '11, 12',\n                scale: '2km',\n                offset: '5km',\n                decay: 0.4,\n                filter: { foo: :bar})\n       # => {body:\n              query: {\n                gauss: {\n                  query: { ...},\n                  functions: [{\n                    gauss: {\n                      field: {\n                        origin: '11, 12',\n                        scale: '2km',\n                        offset: '5km',\n                        decay: 0.4\n                      }\n                    },\n                    filter: { foo: :bar }\n                  }]\n                } } }", "Sets elasticsearch `aggregations` search request param\n\n @example\n  UsersIndex.filter{ name == 'Johny' }.aggregations(category_id: {terms: {field: 'category_ids'}})\n     # => {body: {\n            query: {...},\n            aggregations: {\n              terms: {\n                field: 'category_ids'\n              }\n            }\n          }}", "In this simplest of implementations each named aggregation must be uniquely named", "Deletes all documents matching a query.\n\n @example\n   UsersIndex.delete_all\n   UsersIndex.filter{ age <= 42 }.delete_all\n   UsersIndex::User.delete_all\n   UsersIndex::User.filter{ age <= 42 }.delete_all", "Find all documents matching a query.\n\n @example\n   UsersIndex.find(42)\n   UsersIndex.filter{ age <= 42 }.find(42)\n   UsersIndex::User.find(42)\n   UsersIndex::User.filter{ age <= 42 }.find(42)\n\n In all the previous examples find will return a single object.\n To get a collection - pass an array of ids.\n\n @example\n    UsersIndex::User.find(42, 7, 3) # array of objects with ids in [42, 7, 3]\n    UsersIndex::User.find([8, 13])  # array of objects with ids in [8, 13]\n    UsersIndex::User.find([42])     # array of the object with id == 42", "A helper to build a bolt command used in acceptance testing\n @param [Beaker::Host] host the host to execute the command on\n @param [String] command the command to execute on the bolt SUT\n @param [Hash] flags the command flags to append to the command\n @option flags [String] '--nodes' the nodes to run on\n @option flags [String] '--user' the user to run the command as\n @option flags [String] '--password' the password for the user\n @option flags [nil] '--no-host-key-check' specify nil to use\n @option flags [nil] '--no-ssl' specify nil to use\n @param [Hash] opts the options hash for this method", "Count the number of top-level statements in the AST.", "Create a cache dir if necessary and update it's last write time. Returns the dir.\n Acquires @cache_dir_mutex to ensure we don't try to purge the directory at the same time.\n Uses the directory mtime because it's simpler to ensure the directory exists and update\n mtime in a single place than with a file in a directory that may not exist.", "If the file doesn't exist or is invalid redownload it\n This downloads, validates and moves into place", "This handles running the job, catching errors, and turning the result\n into a result set", "Starts executing the given block on a list of nodes in parallel, one thread per \"batch\".\n\n This is the main driver of execution on a list of targets. It first\n groups targets by transport, then divides each group into batches as\n defined by the transport. Yields each batch, along with the corresponding\n transport, to the block in turn and returns an array of result promises.", "Parses a snippet of Puppet manifest code and returns the AST represented\n in JSON.", "This converts a plan signature object into a format used by the outputter.\n Must be called from within bolt compiler to pickup type aliases used in the plan signature.", "Returns a mapping of all modules available to the Bolt compiler\n\n @return [Hash{String => Array<Hash{Symbol => String,nil}>}]\n   A hash that associates each directory on the module path with an array\n   containing a hash of information for each module in that directory.\n   The information hash provides the name, version, and a string\n   indicating whether the module belongs to an internal module group.", "URI can be passes as nil", "Override in your tests", "Convert an r10k log level to a bolt log level. These correspond 1-to-1\n except that r10k has debug, debug1, and debug2. The log event has the log\n level as an integer that we need to look up.", "Pass a target to get_targets for a public version of this\n Should this reconfigure configured targets?", "Prints all information associated to the breakpoint", "Main byebug's REPL", "Run permanent commands.", "Executes the received input\n\n Instantiates a command matching the input and runs it. If a matching\n command is not found, it evaluates the unknown input.", "Restores history from disk.", "Saves history to disk.", "Prints the requested numbers of history entries.", "Whether a specific command should not be stored in history.\n\n For now, empty lines and consecutive duplicates.", "Delegates to subcommands or prints help if no subcommand specified.", "Gets local variables for the frame.", "Builds a string containing all available args in the frame number, in a\n verbose or non verbose way according to the value of the +callstyle+\n setting", "Context's stack size", "Line range to be printed by `list`.\n\n If <input> is set, range is parsed from it.\n\n Otherwise it's automatically chosen.", "Set line range to be printed by list\n\n @return first line number to list\n @return last line number to list", "Show a range of lines in the current file.\n\n @param min [Integer] Lower bound\n @param max [Integer] Upper bound", "Starts byebug to debug a program.", "Processes options passed from the command line.", "Reads a new line from the interface's input stream, parses it into\n commands and saves it to history.\n\n @return [String] Representing something to be run by the debugger.", "Raw content of license file, including YAML front matter", "Given another license or project file, calculates the similarity\n as a percentage of words in common", "Content with the title and version removed\n The first time should normally be the attribution line\n Used to dry up `content_normalized` but we need the case sensitive\n content with attribution first to detect attribuion in LicenseFile", "this is where users arrive after visiting the password reset confirmation link", "this action is responsible for generating unlock tokens and\n sending emails", "intermediary route for successful omniauth authentication. omniauth does\n not support multiple models, so we must resort to this terrible hack.", "this will be determined differently depending on the action that calls\n it. redirect_callbacks is called upon returning from successful omniauth\n authentication, and the target params live in an omniauth-specific\n request.env variable. this variable is then persisted thru the redirect\n using our own dta.omniauth.params session var. the omniauth_success\n method will access that session var and then destroy it immediately\n after use.  In the failure case, finally, the omniauth params\n are added as query params in our monkey patch to OmniAuth in engine.rb", "break out provider attribute assignment for easy method extension", "derive allowed params from the standard devise parameter sanitizer", "This is a little hacky, because Bitbucket doesn't provide us a PR id", "The paths are relative to dir.", "Could we determine that the CI source is inside a PR?", "Prints a summary of the errors and warnings.", "Rules that apply to a class", "Rules that apply to individual methods, and attributes", "Generates a link to see an example of said rule", "Takes an array of files, gems or nothing, then resolves them into\n paths that should be sent into the documentation parser\n When given existing paths, map to absolute & existing paths\n When given a list of gems, resolve for list of gems\n When empty, imply you want to test the current lib folder as a plugin", "Determine if there's a PR attached to this commit,\n and return the url if so", "Ask the API if the commit is inside a PR", "Make the API call, and parse the JSON", "Raises an error when the given block does not register a plugin.", "Iterates through the DSL's attributes, and table's the output", "The message of the exception reports the content of podspec for the\n line that generated the original exception.\n\n @example Output\n\n   Invalid podspec at `RestKit.podspec` - undefined method\n   `exclude_header_search_paths=' for #<Pod::Specification for\n   `RestKit/Network (0.9.3)`>\n\n       from spec-repos/master/RestKit/0.9.3/RestKit.podspec:36\n       -------------------------------------------\n           # because it would break: #import <CoreData/CoreData.h>\n    >      ns.exclude_header_search_paths = 'Code/RestKit.h'\n         end\n       -------------------------------------------\n\n @return [String] the message of the exception.", "start all the watchers and enable haproxy configuration", "if we don't have a visit, let's try to create one first", "can't use keyword arguments here", "replace % \\ to \\% \\\\", "This method is both a getter and a setter", "added for rails < 3.0.3 compatibility", "this is the entry point for all state and event definitions", "a neutered version of fire - it doesn't actually fire the event, it just\n executes the transition guards to determine if a transition is even\n an option given current conditions.", "Load the Encryption Configuration from a YAML file.\n\n See: `.load!` for parameters.\n Returns [Hash] the configuration for the supplied environment.", "Encrypt data before writing to the supplied stream\n Close the IO Stream.\n\n Notes:\n * Flushes any unwritten data.\n * Once an EncryptionWriter has been closed a new instance must be\n   created before writing again.\n * Closes the passed in io stream or file.\n * `close` must be called _before_ the supplied stream is closed.\n\n It is recommended to call Symmetric::EncryptedStream.open\n rather than creating an instance of Symmetric::Writer directly to\n ensure that the encrypted stream is closed before the stream itself is closed.", "Encrypt and then encode a string\n\n Returns data encrypted and then encoded according to the encoding setting\n         of this cipher\n Returns nil if str is nil\n Returns \"\" str is empty\n\n Parameters\n\n   str [String]\n     String to be encrypted. If str is not a string, #to_s will be called on it\n     to convert it to a string\n\n   random_iv [true|false]\n     Whether the encypted value should use a random IV every time the\n     field is encrypted.\n     Notes:\n     * Setting random_iv to true will result in a different encrypted output for\n       the same input string.\n     * It is recommended to set this to true, except if it will be used as a lookup key.\n     * Only set to true if the field will never be used as a lookup key, since\n       the encrypted value needs to be same every time in this case.\n     * When random_iv is true it adds the random IV string to the header.\n     Default: false\n     Highly Recommended where feasible: true\n\n   compress [true|false]\n     Whether to compress str before encryption.\n     Default: false\n     Notes:\n     * Should only be used for large strings since compression overhead and\n       the overhead of adding the encryption header may exceed any benefits of\n       compression", "Decode and Decrypt string\n   Returns a decrypted string after decoding it first according to the\n           encoding setting of this cipher\n   Returns nil if encrypted_string is nil\n   Returns '' if encrypted_string == ''\n\n Parameters\n   encrypted_string [String]\n     Binary encrypted string to decrypt\n\n Reads the header if present for key, iv, cipher_name and compression\n\n encrypted_string must be in raw binary form when calling this method\n\n Creates a new OpenSSL::Cipher with every call so that this call\n is thread-safe and can be called concurrently by multiple threads with\n the same instance of Cipher", "Advanced use only\n\n Returns a Binary encrypted string without applying Base64, or any other encoding.\n\n   str [String]\n     String to be encrypted. If str is not a string, #to_s will be called on it\n     to convert it to a string\n\n   random_iv [true|false]\n     Whether the encypted value should use a random IV every time the\n     field is encrypted.\n     Notes:\n     * Setting random_iv to true will result in a different encrypted output for\n       the same input string.\n     * It is recommended to set this to true, except if it will be used as a lookup key.\n     * Only set to true if the field will never be used as a lookup key, since\n       the encrypted value needs to be same every time in this case.\n     * When random_iv is true it adds the random IV string to the header.\n     Default: false\n     Highly Recommended where feasible: true\n\n   compress [true|false]\n     Whether to compress str before encryption.\n     Default: false\n     Notes:\n     * Should only be used for large strings since compression overhead and\n       the overhead of adding the encryption header may exceed any benefits of\n       compression\n\n   header [true|false]\n     Whether to add a header to the encrypted string.\n     Default: `always_add_header`\n\n See #encrypt to encrypt and encode the result as a string.", "Extracts a string from the supplied buffer.\n The buffer starts with a 2 byte length indicator in little endian format.\n\n Parameters\n   buffer [String]\n   offset [Integer]\n     Start position within the buffer.\n\n Returns [string, offset]\n   string [String]\n     The string copied from the buffer.\n   offset [Integer]\n     The new offset within the buffer.", "Reads a single decrypted line from the file up to and including the optional sep_string.\n A sep_string of nil reads the entire contents of the file\n Returns nil on eof\n The stream must be opened for reading or an IOError will be raised.", "Read the header from the file if present", "Yields each item", "Return an instance of what the object looked like at this revision. If\n the object has been destroyed, this will be a new record.", "Returns a hash of the changed attributes with the new values", "Returns a hash of the changed attributes with the old values", "Allows user to undo changes", "Allows user to be set to either a string or an ActiveRecord object\n @private", "Renders an existing named table or builds and renders a custom table if a block is provided.\n\n name    - The (optional) name of the table to render (as a Symbol), or the actual Trestle::Table instance itself.\n options - Hash of options that will be passed to the table builder (default: {}):\n           :collection - The collection that should be rendered within the table. It should be an\n                         Array-like object, but will most likely be an ActiveRecord scope. It can\n                         also be a callable object (i.e. a Proc) in which case the result of calling\n                         the block will be used as the collection.\n           See Trestle::Table::Builder for additional options.\n block   - An optional block that is passed to Trestle::Table::Builder to define a custom table.\n           One of either the name or block must be provided, but not both.\n\n Examples\n\n   <%= table collection: -> { Account.all }, admin: :accounts do %>\n     <% column(:name) %>\n     <% column(:balance) { |account| account.balance.format } %>\n     <% column(:created_at, align: :center)\n   <% end %>\n\n   <%= table :accounts %>\n\n Returns the HTML representation of the table as a HTML-safe String.", "Custom version of Kaminari's page_entries_info helper to use a\n Trestle-scoped I18n key and add a delimiter to the total count.", "Register an extension hook", "Rolls the stack back to this deploy", "Go from a full Swift version like 4.2.1 to\n something valid for SWIFT_VERSION.", "Gets the related Resource Id Tree for a relationship, and creates it first if it does not exist\n\n @param relationship [JSONAPI::Relationship]\n\n @return [JSONAPI::RelatedResourceIdTree] the new or existing resource id tree for the requested relationship", "Adds a Resource Fragment to the Resources hash\n\n @param fragment [JSONAPI::ResourceFragment]\n @param include_related [Hash]\n\n @return [null]", "Adds a Resource Fragment to the fragments hash\n\n @param fragment [JSONAPI::ResourceFragment]\n @param include_related [Hash]\n\n @return [null]", "Create a new object for connecting to the Stackdriver Error Reporting\n service. Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/cloud-platform`\n\n @param [Integer] timeout Default timeout to use in requests. Optional.\n @param [Hash] client_config A hash of values to override the default\n   behavior of the API client. Optional.\n\n @return [Google::Cloud::ErrorReporting::Project]\n\n @example\n   require \"google/cloud/error_reporting\"\n\n   gcloud = Google::Cloud.new \"GCP_Project_ID\",\n                              \"/path/to/gcp/secretkey.json\"\n   error_reporting = gcloud.error_reporting\n\n   error_event = error_reporting.error_event \"Error with Backtrace\",\n                                             event_time: Time.now,\n                                             service_name: \"my_app_name\",\n                                             service_version: \"v8\"\n   error_reporting.report error_event", "Creates a new object for connecting to the DNS service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`\n @param [Integer] retries Number of times to retry requests on server\n   error. The default value is `3`. Optional.\n @param [Integer] timeout Default timeout to use in requests. Optional.\n\n @return [Google::Cloud::Dns::Project]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   dns = gcloud.dns\n   zone = dns.zone \"example-com\"\n   zone.records.each do |record|\n     puts record.name\n   end\n\n @example The default scope can be overridden with the `scope` option:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   dns_readonly = \"https://www.googleapis.com/auth/ndev.clouddns.readonly\"\n   dns = gcloud.dns scope: dns_readonly", "Creates a new object for connecting to the Spanner service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scopes are:\n\n   * `https://www.googleapis.com/auth/spanner`\n   * `https://www.googleapis.com/auth/spanner.data`\n @param [Integer] timeout Default timeout to use in requests. Optional.\n @param [Hash] client_config A hash of values to override the default\n   behavior of the API client. Optional.\n\n @return [Google::Cloud::Spanner::Project]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   spanner = gcloud.spanner\n\n @example The default scope can be overridden with the `scope` option:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   platform_scope = \"https://www.googleapis.com/auth/cloud-platform\"\n   spanner = gcloud.spanner scope: platform_scope", "Creates a new object for connecting to the Stackdriver Logging service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/logging.admin`\n\n @param [Integer] timeout Default timeout to use in requests. Optional.\n @param [Hash] client_config A hash of values to override the default\n   behavior of the API client. Optional.\n\n @return [Google::Cloud::Logging::Project]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   logging = gcloud.logging\n\n   entries = logging.entries\n   entries.each do |e|\n     puts \"[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}\"\n   end\n\n @example The default scope can be overridden with the `scope` option:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   platform_scope = \"https://www.googleapis.com/auth/cloud-platform\"\n   logging = gcloud.logging scope: platform_scope", "Creates a new object for connecting to the BigQuery service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/bigquery`\n @param [Integer] retries Number of times to retry requests on server\n   error. The default value is `5`. Optional.\n @param [Integer] timeout Default request timeout in seconds. Optional.\n\n @return [Google::Cloud::Bigquery::Project]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   bigquery = gcloud.bigquery\n   dataset = bigquery.dataset \"my_dataset\"\n   table = dataset.table \"my_table\"\n   table.data.each do |row|\n     puts row\n   end\n\n @example The default scope can be overridden with the `scope` option:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   platform_scope = \"https://www.googleapis.com/auth/cloud-platform\"\n   bigquery = gcloud.bigquery scope: platform_scope", "Creates a new debugger object for instrumenting Stackdriver Debugger for\n an application. Each call creates a new debugger agent with independent\n connection service.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String] service_name Name for the debuggee application. Optional.\n @param [String] service_version Version identifier for the debuggee\n   application. Optional.\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/cloud_debugger`\n   * `https://www.googleapis.com/auth/logging.admin`\n\n @param [Integer] timeout Default timeout to use in requests. Optional.\n @param [Hash] client_config A hash of values to override the default\n   behavior of the API client. Optional.\n\n @return [Google::Cloud::Debugger::Project]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   debugger = gcloud.debugger\n\n   debugger.start\n\n @example The default scope can be overridden with the `scope` option:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   platform_scope = \"https://www.googleapis.com/auth/cloud-platform\"\n   debugger = gcloud.debugger scope: platform_scope", "Creates a new object for connecting to the Datastore service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/datastore`\n @param [Integer] timeout Default timeout to use in requests. Optional.\n @param [Hash] client_config A hash of values to override the default\n   behavior of the API client. See Google::Gax::CallSettings. Optional.\n\n @return [Google::Cloud::Datastore::Dataset]\n\n @example\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   datastore = gcloud.datastore\n\n   task = datastore.entity \"Task\" do |t|\n     t[\"type\"] = \"Personal\"\n     t[\"done\"] = false\n     t[\"priority\"] = 4\n     t[\"description\"] = \"Learn Cloud Datastore\"\n   end\n\n   datastore.save task\n\n @example You shouldn't need to override the default scope, but you can:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   platform_scope = \"https://www.googleapis.com/auth/cloud-platform\"\n   datastore = gcloud.datastore scope: platform_scope", "Creates a new object for connecting to the Resource Manager service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/cloud-platform`\n @param [Integer] retries Number of times to retry requests on server\n   error. The default value is `3`. Optional.\n @param [Integer] timeout Default timeout to use in requests. Optional.\n\n @return [Google::Cloud::ResourceManager::Manager]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   resource_manager = gcloud.resource_manager\n   resource_manager.projects.each do |project|\n     puts projects.project_id\n   end\n\n @example The default scope can be overridden with the `scope` option:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   readonly_scope = \\\n     \"https://www.googleapis.com/auth/cloudresourcemanager.readonly\"\n   resource_manager = gcloud.resource_manager scope: readonly_scope", "Creates a new object for connecting to the Storage service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @see https://cloud.google.com/storage/docs/authentication#oauth Storage\n   OAuth 2.0 Authentication\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/devstorage.full_control`\n @param [Integer] retries Number of times to retry requests on server\n   error. The default value is `3`. Optional.\n @param [Integer] timeout Default timeout to use in requests. Optional.\n\n @return [Google::Cloud::Storage::Project]\n\n @example\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   storage = gcloud.storage\n   bucket = storage.bucket \"my-bucket\"\n   file = bucket.file \"path/to/my-file.ext\"\n\n @example The default scope can be overridden with the `scope` option:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   readonly_scope = \"https://www.googleapis.com/auth/devstorage.read_only\"\n   readonly_storage = gcloud.storage scope: readonly_scope", "Creates a new object for connecting to the Cloud Translation API. Each\n call creates a new connection.\n\n Like other Cloud Platform services, Google Cloud Translation API supports\n authentication using a project ID and OAuth 2.0 credentials. In addition,\n it supports authentication using a public API access key. (If both the API\n key and the project and OAuth 2.0 credentials are provided, the API key\n will be used.) Instructions and configuration options are covered in the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String] key a public API access key (not an OAuth 2.0 token)\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/cloud-platform`\n @param [Integer] retries Number of times to retry requests on server\n   error. The default value is `3`. Optional.\n @param [Integer] timeout Default timeout to use in requests. Optional.\n\n @return [Google::Cloud::Translate::Api]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   translate = gcloud.translate \"api-key-abc123XYZ789\"\n\n   translation = translate.translate \"Hello world!\", to: \"la\"\n   translation.text #=> \"Salve mundi!\"\n\n @example Using API Key from the environment variable.\n   require \"google/cloud\"\n\n   ENV[\"TRANSLATE_KEY\"] = \"api-key-abc123XYZ789\"\n\n   gcloud = Google::Cloud.new\n   translate = gcloud.translate\n\n   translation = translate.translate \"Hello world!\", to: \"la\"\n   translation.text #=> \"Salve mundi!\"", "Creates a new object for connecting to the Firestore service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/datastore`\n @param [Integer] timeout Default timeout to use in requests. Optional.\n @param [Hash] client_config A hash of values to override the default\n   behavior of the API client. Optional.\n\n @return [Google::Cloud::Firestore::Client]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   firestore = gcloud.firestore\n\n @example The default scope can be overridden with the `scope` option:\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n   platform_scope = \"https://www.googleapis.com/auth/cloud-platform\"\n   firestore = gcloud.firestore scope: platform_scope", "Creates a new object for connecting to the Stackdriver Trace service.\n Each call creates a new connection.\n\n For more information on connecting to Google Cloud see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the\n   set of resources and operations that the connection can access. See\n   [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n\n   The default scope is:\n\n   * `https://www.googleapis.com/auth/cloud-platform`\n\n @param [Integer] timeout Default timeout to use in requests. Optional.\n\n @return [Google::Cloud::Trace::Project]\n\n @example\n   require \"google/cloud\"\n\n   gcloud = Google::Cloud.new\n   trace_client = gcloud.trace\n\n   traces = trace_client.list_traces Time.now - 3600, Time.now\n   traces.each do |trace|\n     puts \"Retrieved trace ID: #{trace.trace_id}\"\n   end", "Creates a new object for connecting to the Cloud Bigtable service.\n\n For more information on connecting to Google Cloud Platform, see the\n {file:AUTHENTICATION.md Authentication Guide}.\n\n @param scope [Array<String>]\n   The OAuth 2.0 scopes controlling the set of resources and operations\n   that the connection can access. See [Using OAuth 2.0 to Access Google\n   APIs](https://developers.google.com/identity/protocols/OAuth2).\n   The OAuth scopes for this service. This parameter is ignored if an\n   updater_proc is supplied.\n @param timeout [Integer]\n   The default timeout, in seconds, for calls made through this client.\n @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]\n   Provides the means for authenticating requests made by the client. This parameter can\n   be one of the following types.\n   `Google::Auth::Credentials` uses the properties of its represented keyfile for\n   authenticating requests made by this client.\n   `String` will be treated as the path to the keyfile to use to construct\n   credentials for this client.\n   `Hash` will be treated as the contents of a keyfile to use to construct\n   credentials for this client.\n   `GRPC::Core::Channel` will be used to make calls through.\n   `GRPC::Core::ChannelCredentials` will be used to set up the gRPC client. The channel credentials\n   should already be composed with a `GRPC::Core::CallCredentials` object.\n   `Proc` will be used as an updater_proc for the gRPC channel. The proc transforms the\n   metadata for requests, generally, to give OAuth credentials.\n @param client_config [Hash]\n   A hash for call options for each method.\n   See Google::Gax#construct_settings for the structure of\n   this data. Falls back to the default config if not specified\n   or the specified config is missing data points.\n @return [Google::Cloud::Bigtable::Project]\n\n @example\n   require \"google/cloud\"\n\n   gcloud  = Google::Cloud.new\n\n   bigtable = gcloud.bigtable", "Compare two hashes for equality\n\n For two hashes to match they must have the same length and all\n values must match when compared using `#===`.\n\n The following hashes are examples of matches:\n\n     {a: /\\d+/} and {a: '123'}\n\n     {a: '123'} and {a: '123'}\n\n     {a: {b: /\\d+/}} and {a: {b: '123'}}\n\n     {a: {b: 'wow'}} and {a: {b: 'wow'}}\n\n @param [Hash] query_parameters typically the result of parsing\n   JSON, XML or URL encoded parameters.\n\n @param [Hash] pattern which contains keys with a string, hash or\n   regular expression value to use for comparison.\n\n @return [Boolean] true if the paramaters match the comparison\n   hash, false if not.", "Apply all filters in the pipeline to the given HTML.\n\n html    - A String containing HTML or a DocumentFragment object.\n context - The context hash passed to each filter. See the Filter docs\n           for more info on possible values. This object MUST NOT be modified\n           in place by filters.  Use the Result for passing state back.\n result  - The result Hash passed to each filter for modification.  This\n           is where Filters store extracted information from the content.\n\n Returns the result Hash after being filtered by this Pipeline.  Contains an\n :output key with the DocumentFragment or String HTML markup based on the\n output of the last filter in the pipeline.", "Like call but guarantee the value returned is a DocumentFragment.\n Pipelines may return a DocumentFragment or a String. Callers that need a\n DocumentFragment should use this method.", "Like call but guarantee the value returned is a string of HTML markup.", "Total number of pages", "Current page number", "Used for page_entry_info", "Executes a watcher action.\n\n @param [String, MatchData] matches the matched path or the match from the\n   Regex\n @return [String] the final paths", "Start Guard by initializing the defined Guard plugins and watch the file\n system.\n\n This is the default task, so calling `guard` is the same as calling\n `guard start`.\n\n @see Guard.start", "List the Notifiers for use in your system.\n\n @see Guard::DslDescriber.notifiers", "Initializes the templates of all installed Guard plugins and adds them\n to the `Guardfile` when no Guard name is passed. When passing\n Guard plugin names it does the same but only for those Guard plugins.\n\n @see Guard::Guardfile.initialize_template\n @see Guard::Guardfile.initialize_all_templates\n\n @param [Array<String>] plugin_names the name of the Guard plugins to\n initialize", "Shows all Guard plugins and their options that are defined in\n the `Guardfile`\n\n @see Guard::DslDescriber.show", "Adds a plugin's template to the Guardfile.", "Returns the constant for the current plugin.\n\n @example Returns the constant for a plugin\n   > Guard::PluginUtil.new('rspec').send(:_plugin_constant)\n   => Guard::RSpec", "Sets the interactor options or disable the interactor.\n\n @example Pass options to the interactor\n   interactor option1: 'value1', option2: 'value2'\n\n @example Turn off interactions\n   interactor :off\n\n @param [Symbol, Hash] options either `:off` or a Hash with interactor\n   options", "Declares a Guard plugin to be used when running `guard start`.\n\n The name parameter is usually the name of the gem without\n the 'guard-' prefix.\n\n The available options are different for each Guard implementation.\n\n @example Declare a Guard without `watch` patterns\n   guard :rspec\n\n @example Declare a Guard with a `watch` pattern\n   guard :rspec do\n     watch %r{.*_spec.rb}\n   end\n\n @param [String] name the Guard plugin name\n @param [Hash] options the options accepted by the Guard plugin\n @yield a block where you can declare several watch patterns and actions\n\n @see Plugin\n @see Guard.add_plugin\n @see #watch\n @see #group", "Defines a pattern to be watched in order to run actions on file\n modification.\n\n @example Declare watchers for a Guard\n   guard :rspec do\n     watch('spec/spec_helper.rb')\n     watch(%r{^.+_spec.rb})\n     watch(%r{^app/controllers/(.+).rb}) do |m|\n       'spec/acceptance/#{m[1]}s_spec.rb'\n     end\n   end\n\n @example Declare global watchers outside of a Guard\n   watch(%r{^(.+)$}) { |m| puts \"#{m[1]} changed.\" }\n\n @param [String, Regexp] pattern the pattern that Guard must watch for\n modification\n\n @yield a block to be run when the pattern is matched\n @yieldparam [MatchData] m matches of the pattern\n @yieldreturn a directory, a filename, an array of\n   directories / filenames, or nothing (can be an arbitrary command)\n\n @see Guard::Watcher\n @see #guard", "Defines a callback to execute arbitrary code before or after any of\n the `start`, `stop`, `reload`, `run_all`, `run_on_changes`,\n `run_on_additions`, `run_on_modifications` and `run_on_removals` plugin\n method.\n\n @example Add callback before the `reload` action.\n   callback(:reload_begin) { puts \"Let's reload!\" }\n\n @example Add callback before the `start` and `stop` actions.\n\n   my_lambda = lambda do |plugin, event, *args|\n     puts \"Let's #{event} #{plugin} with #{args}!\"\n   end\n\n   callback(my_lambda, [:start_begin, :start_end])\n\n @param [Array] args the callback arguments\n @yield a callback block", "Configures the Guard logger.\n\n * Log level must be either `:debug`, `:info`, `:warn` or `:error`.\n * Template supports the following placeholders: `:time`, `:severity`,\n   `:progname`, `:pid`, `:unit_of_work_id` and `:message`.\n * Time format directives are the same as `Time#strftime` or\n   `:milliseconds`.\n * The `:only` and `:except` options must be a `RegExp`.\n\n @example Set the log level\n   logger level: :warn\n\n @example Set a custom log template\n   logger template: '[Guard - :severity - :progname - :time] :message'\n\n @example Set a custom time format\n   logger time_format: '%h'\n\n @example Limit logging to a Guard plugin\n   logger only: :jasmine\n\n @example Log all but not the messages from a specific Guard plugin\n   logger except: :jasmine\n\n @param [Hash] options the log options\n @option options [String, Symbol] level the log level\n @option options [String] template the logger template\n @option options [String, Symbol] time_format the time format\n @option options [Regexp] only show only messages from the matching Guard\n   plugin\n @option options [Regexp] except does not show messages from the matching\n   Guard plugin", "Sets the directories to pass to Listen\n\n @example watch only given directories\n   directories %w(lib specs)\n\n @param [Array] directories directories for Listen to watch", "Start Guard by evaluating the `Guardfile`, initializing declared Guard\n plugins and starting the available file change listener.\n Main method for Guard that is called from the CLI when Guard starts.\n\n - Setup Guard internals\n - Evaluate the `Guardfile`\n - Configure Notifiers\n - Initialize the declared Guard plugins\n - Start the available file change listener\n\n @option options [Boolean] clear if auto clear the UI should be done\n @option options [Boolean] notify if system notifications should be shown\n @option options [Boolean] debug if debug output should be shown\n @option options [Array<String>] group the list of groups to start\n @option options [String] watchdir the director to watch\n @option options [String] guardfile the path to the Guardfile\n @see CLI#start", "Trigger `run_all` on all Guard plugins currently enabled.\n\n @param [Hash] scopes hash with a Guard plugin or a group scope", "Pause Guard listening to file changes.", "Shows all Guard plugins and their options that are defined in\n the `Guardfile`.\n\n @see CLI#show", "Shows all notifiers and their options that are defined in\n the `Guardfile`.\n\n @see CLI#show", "Runs a Guard-task on all registered plugins.\n\n @param [Symbol] task the task to run\n\n @param [Hash] scope_hash either the Guard plugin or the group to run the task\n on", "Runs the appropriate tasks on all registered plugins\n based on the passed changes.\n\n @param [Array<String>] modified the modified paths.\n @param [Array<String>] added the added paths.\n @param [Array<String>] removed the removed paths.", "Run a Guard plugin task, but remove the Guard plugin when his work leads\n to a system failure.\n\n When the Group has `:halt_on_fail` disabled, we've to catch\n `:task_has_failed` here in order to avoid an uncaught throw error.\n\n @param [Guard::Plugin] plugin guard the Guard to execute\n @param [Symbol] task the task to run\n @param [Array] args the arguments for the task\n @raise [:task_has_failed] when task has failed", "Value of the Content-Length header.\n\n @return [nil] if Content-Length was not given, or it's value was invalid\n   (not an integer, e.g. empty string or string with non-digits).\n @return [Integer] otherwise", "Read a chunk of the body\n\n @return [String] data chunk\n @return [nil] when no more data left", "Sets up SSL context and starts TLS if needed.\n @param (see #initialize)\n @return [void]", "Open tunnel through proxy", "Store whether the connection should be kept alive.\n Once we reset the parser, we lose all of this state.\n @return [void]", "Feeds some more data into parser\n @return [void]", "Make a request through an HTTP proxy\n @param [Array] proxy\n @raise [Request::Error] if HTTP proxy is invalid", "Make a request with the given Basic authorization header\n @see http://tools.ietf.org/html/rfc2617\n @param [#fetch] opts\n @option opts [#to_s] :user\n @option opts [#to_s] :pass", "Make an HTTP request", "Prepare an HTTP request", "Verify our request isn't going to be made against another URI", "Merges query params if needed\n\n @param [#to_s] uri\n @return [URI]", "Create the request body object to send", "Removes header.\n\n @param [#to_s] name header name\n @return [void]", "Appends header.\n\n @param [#to_s] name header name\n @param [Array<#to_s>, #to_s] value header value(s) to be appended\n @return [void]", "Returns list of header values if any.\n\n @return [Array<String>]", "Tells whenever header with given `name` is set or not.\n\n @return [Boolean]", "Merges `other` headers into `self`.\n\n @see #merge\n @return [void]", "Transforms `name` to canonical HTTP header capitalization\n\n @param [String] name\n @raise [HeaderError] if normalized name does not\n   match {HEADER_NAME_RE}\n @return [String] canonical HTTP header name", "Ensures there is no new line character in the header value\n\n @param [String] value\n @raise [HeaderError] if value includes new line character\n @return [String] stringified header value", "Redirect policy for follow\n @return [Request]", "Stream the request to a socket", "Headers to send with proxy connect request", "returns all values in this column as an array\n column numbers are 1,2,3,... like in the spreadsheet", "returns the internal format of an excel cell", "Extracts all needed files from the zip file", "If the ODS file has an encryption-data element, then try to decrypt.\n If successful, the temporary content.xml will be overwritten with\n decrypted contents.", "Process the ODS encryption manifest and perform the decryption", "Create a cipher key based on an ODS algorithm string from manifest.xml", "Block decrypt raw bytes from the zip file based on the cipher", "helper function to set the internal representation of cells", "Compute upper bound for cells in a given cell range.", "Catalog a bundle.\n\n @param bundle [Bundle]\n @return [self]", "Get a clip by filename and position.\n\n @param filename [String]\n @param position [Position, Array(Integer, Integer)]\n @return [SourceMap::Clip]", "Get suggestions for constants in the specified namespace. The result\n may contain both constant and namespace pins.\n\n @param namespace [String] The namespace\n @param context [String] The context\n @return [Array<Solargraph::Pin::Base>]", "Get a fully qualified namespace name. This method will start the search\n in the specified context until it finds a match for the name.\n\n @param namespace [String, nil] The namespace to match\n @param context [String] The context to search\n @return [String]", "Get an array of instance variable pins defined in specified namespace\n and scope.\n\n @param namespace [String] A fully qualified namespace\n @param scope [Symbol] :instance or :class\n @return [Array<Solargraph::Pin::InstanceVariable>]", "Get an array of methods available in a particular context.\n\n @param fqns [String] The fully qualified namespace to search for methods\n @param scope [Symbol] :class or :instance\n @param visibility [Array<Symbol>] :public, :protected, and/or :private\n @param deep [Boolean] True to include superclasses, mixins, etc.\n @return [Array<Solargraph::Pin::Base>]", "Get an array of method pins for a complex type.\n\n The type's namespace and the context should be fully qualified. If the\n context matches the namespace type or is a subclass of the type,\n protected methods are included in the results. If protected methods are\n included and internal is true, private methods are also included.\n\n @example\n   api_map = Solargraph::ApiMap.new\n   type = Solargraph::ComplexType.parse('String')\n   api_map.get_complex_type_methods(type)\n\n @param type [Solargraph::ComplexType] The complex type of the namespace\n @param context [String] The context from which the type is referenced\n @param internal [Boolean] True to include private methods\n @return [Array<Solargraph::Pin::Base>]", "Get a stack of method pins for a method name in a namespace. The order\n of the pins corresponds to the ancestry chain, with highest precedence\n first.\n\n @example\n   api_map.get_method_stack('Subclass', 'method_name')\n     #=> [ <Subclass#method_name pin>, <Superclass#method_name pin> ]\n\n @param fqns [String]\n @param name [String]\n @param scope [Symbol] :instance or :class\n @return [Array<Solargraph::Pin::Base>]", "Get an array of all suggestions that match the specified path.\n\n @deprecated Use #get_path_pins instead.\n\n @param path [String] The path to find\n @return [Array<Solargraph::Pin::Base>]", "Get a list of documented paths that match the query.\n\n @example\n   api_map.query('str') # Results will include `String` and `Struct`\n\n @param query [String] The text to match\n @return [Array<String>]", "Get YARD documentation for the specified path.\n\n @example\n   api_map.document('String#split')\n\n @param path [String] The path to find\n @return [Array<YARD::CodeObject::Base>]", "Get an array of all symbols in the workspace that match the query.\n\n @param query [String]\n @return [Array<Pin::Base>]", "Require extensions for the experimental plugin architecture. Any\n installed gem with a name that starts with \"solargraph-\" is considered\n an extension.\n\n @return [void]", "Sort an array of pins to put nil or undefined variables last.\n\n @param pins [Array<Solargraph::Pin::Base>]\n @return [Array<Solargraph::Pin::Base>]", "Check if a class is a superclass of another class.\n\n @param sup [String] The superclass\n @param sub [String] The subclass\n @return [Boolean]", "True if the specified position is inside the range.\n\n @param position [Position, Array(Integer, Integer)]\n @return [Boolean]", "True if the range contains the specified position and the position does not precede it.\n\n @param position [Position, Array(Integer, Integer)]\n @return [Boolean]", "Get an array of nodes containing the specified index, starting with the\n nearest node and ending with the root.\n\n @param line [Integer]\n @param column [Integer]\n @return [Array<AST::Node>]", "Synchronize the Source with an update. This method applies changes to the\n code, parses the new code's AST, and returns the resulting Source object.\n\n @param updater [Source::Updater]\n @return [Source]", "A location representing the file in its entirety.\n\n @return [Location]", "Get a hash of comments grouped by the line numbers of the associated code.\n\n @return [Hash{Integer => Array<Parser::Source::Comment>}]", "Get a string representation of an array of comments.\n\n @param comments [Array<Parser::Source::Comment>]\n @return [String]", "Get an array of foldable comment block ranges. Blocks are excluded if\n they are less than 3 lines long.\n\n @return [Array<Range>]", "Merge the source. A merge will update the existing source for the file\n or add it to the sources if the workspace is configured to include it.\n The source is ignored if the configuration excludes it.\n\n @param source [Solargraph::Source]\n @return [Boolean] True if the source was added to the workspace", "Determine whether a file would be merged into the workspace.\n\n @param filename [String]\n @return [Boolean]", "Remove a source from the workspace. The source will not be removed if\n its file exists and the workspace is configured to include it.\n\n @param filename [String]\n @return [Boolean] True if the source was removed from the workspace", "True if the path resolves to a file in the workspace's require paths.\n\n @param path [String]\n @return [Boolean]", "Synchronize the workspace from the provided updater.\n\n @param updater [Source::Updater]\n @return [void]", "Generate require paths from gemspecs if they exist or assume the default\n lib directory.\n\n @return [Array<String>]", "Get additional require paths defined in the configuration.\n\n @return [Array<String>]", "Create a source to be added to the workspace. The file is ignored if it is\n neither open in the library nor included in the workspace.\n\n @param filename [String]\n @param text [String] The contents of the file\n @return [Boolean] True if the file was added to the workspace.", "Create a file source from a file on disk. The file is ignored if it is\n neither open in the library nor included in the workspace.\n\n @param filename [String]\n @return [Boolean] True if the file was added to the workspace.", "Delete a file from the library. Deleting a file will make it unavailable\n for checkout and optionally remove it from the workspace unless the\n workspace configuration determines that it should still exist.\n\n @param filename [String]\n @return [Boolean] True if the file was deleted", "Get completion suggestions at the specified file and location.\n\n @param filename [String] The file to analyze\n @param line [Integer] The zero-based line number\n @param column [Integer] The zero-based column number\n @return [SourceMap::Completion]\n @todo Take a Location instead of filename/line/column", "Get definition suggestions for the expression at the specified file and\n location.\n\n @param filename [String] The file to analyze\n @param line [Integer] The zero-based line number\n @param column [Integer] The zero-based column number\n @return [Array<Solargraph::Pin::Base>]\n @todo Take filename/position instead of filename/line/column", "Get signature suggestions for the method at the specified file and\n location.\n\n @param filename [String] The file to analyze\n @param line [Integer] The zero-based line number\n @param column [Integer] The zero-based column number\n @return [Array<Solargraph::Pin::Base>]\n @todo Take filename/position instead of filename/line/column", "Get diagnostics about a file.\n\n @param filename [String]\n @return [Array<Hash>]", "Update the ApiMap from the library's workspace and open files.\n\n @return [void]", "Try to merge a source into the library's workspace. If the workspace is\n not configured to include the source, it gets ignored.\n\n @param source [Source]\n @return [Boolean] True if the source was merged into the workspace.", "Get the source for an open file or create a new source if the file\n exists on disk. Sources created from disk are not added to the open\n workspace files, i.e., the version on disk remains the authoritative\n version.\n\n @raise [FileNotFoundError] if the file does not exist\n @param filename [String]\n @return [Solargraph::Source]", "Removes the given header fields from options and returns the result. This\n modifies the given options in place.\n\n @param [Hash] options\n\n @return [Hash]", "Unseal the vault with the given shard.\n\n @example\n   Vault.sys.unseal(\"abcd-1234\") #=> #<Vault::SealStatus sealed=true, t=3, n=5, progress=1>\n\n @param [String] shard\n   the key to use\n\n @return [SealStatus]", "List the secrets at the given path, if the path supports listing. If the\n the path does not exist, an exception will be raised.\n\n @example\n   Vault.logical.list(\"secret\") #=> [#<Vault::Secret>, #<Vault::Secret>, ...]\n\n @param [String] path\n   the path to list\n\n @return [Array<String>]", "Read the secret at the given path. If the secret does not exist, +nil+\n will be returned.\n\n @example\n   Vault.logical.read(\"secret/password\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] path\n   the path to read\n\n @return [Secret, nil]", "Unwrap the data stored against the given token. If the secret does not\n exist, `nil` will be returned.\n\n @example\n   Vault.logical.unwrap(\"f363dba8-25a7-08c5-430c-00b2367124e6\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] wrapper\n   the token to use when unwrapping the value\n\n @return [Secret, nil]", "Unwrap a token in a wrapped response given the temporary token.\n\n @example\n   Vault.logical.unwrap(\"f363dba8-25a7-08c5-430c-00b2367124e6\") #=> \"0f0f40fd-06ce-4af1-61cb-cdc12796f42b\"\n\n @param [String, Secret] wrapper\n   the token to unwrap\n\n @return [String, nil]", "List all auths in Vault.\n\n @example\n   Vault.sys.auths #=> {:token => #<Vault::Auth type=\"token\", description=\"token based credentials\">}\n\n @return [Hash<Symbol, Auth>]", "Enable a particular authentication at the given path.\n\n @example\n   Vault.sys.enable_auth(\"github\", \"github\") #=> true\n\n @param [String] path\n   the path to mount the auth\n @param [String] type\n   the type of authentication\n @param [String] description\n   a human-friendly description (optional)\n\n @return [true]", "Read the given auth path's configuration.\n\n @example\n   Vault.sys.auth_tune(\"github\") #=> #<Vault::AuthConfig \"default_lease_ttl\"=3600, \"max_lease_ttl\"=7200>\n\n @param [String] path\n   the path to retrieve configuration for\n\n @return [AuthConfig]\n   configuration of the given auth path", "Write the given auth path's configuration.\n\n @example\n   Vault.sys.auth_tune(\"github\", \"default_lease_ttl\" => 600, \"max_lease_ttl\" => 1200 ) #=>  true\n\n @param [String] path\n   the path to retrieve configuration for\n\n @return [AuthConfig]\n   configuration of the given auth path", "Returns true if the connection should be reset due to an idle timeout, or\n maximum request count, false otherwise.", "Is +req+ idempotent according to RFC 2616?", "Pipelines +requests+ to the HTTP server at +uri+ yielding responses if a\n block is given.  Returns all responses recieved.\n\n See\n Net::HTTP::Pipeline[http://docs.seattlerb.org/net-http-pipeline/Net/HTTP/Pipeline.html]\n for further details.\n\n Only if <tt>net-http-pipeline</tt> was required before\n <tt>net-http-persistent</tt> #pipeline will be present.", "Creates a URI for an HTTP proxy server from ENV variables.\n\n If +HTTP_PROXY+ is set a proxy will be returned.\n\n If +HTTP_PROXY_USER+ or +HTTP_PROXY_PASS+ are set the URI is given the\n indicated user and password unless HTTP_PROXY contains either of these in\n the URI.\n\n The +NO_PROXY+ ENV variable can be used to specify hosts which shouldn't\n be reached via proxy; if set it should be a comma separated list of\n hostname suffixes, optionally with +:port+ appended, for example\n <tt>example.com,some.host:8080</tt>. When set to <tt>*</tt> no proxy will\n be returned.\n\n For Windows users, lowercase ENV variables are preferred over uppercase ENV\n variables.", "Returns true when proxy should by bypassed for host.", "Raises an Error for +exception+ which resulted from attempting the request\n +req+ on the +connection+.\n\n Finishes the +connection+.", "Creates a GET request if +req_or_uri+ is a URI and adds headers to the\n request.\n\n Returns the request.", "Authenticate via the \"token\" authentication method. This authentication\n method is a bit bizarre because you already have a token, but hey,\n whatever floats your boat.\n\n This method hits the `/v1/auth/token/lookup-self` endpoint after setting\n the Vault client's token to the given token parameter. If the self lookup\n succeeds, the token is persisted onto the client for future requests. If\n the lookup fails, the old token (which could be unset) is restored on the\n client.\n\n @example\n   Vault.auth.token(\"6440e1bd-ba22-716a-887d-e133944d22bd\") #=> #<Vault::Secret lease_id=\"\">\n   Vault.token #=> \"6440e1bd-ba22-716a-887d-e133944d22bd\"\n\n @param [String] new_token\n   the new token to try to authenticate and store on the client\n\n @return [Secret]", "Authenticate via the \"app-id\" authentication method. If authentication is\n successful, the resulting token will be stored on the client and used for\n future requests.\n\n @example\n   Vault.auth.app_id(\n     \"aeece56e-3f9b-40c3-8f85-781d3e9a8f68\",\n     \"3b87be76-95cf-493a-a61b-7d5fc70870ad\",\n   ) #=> #<Vault::Secret lease_id=\"\">\n\n @example with a custom mount point\n   Vault.auth.app_id(\n     \"aeece56e-3f9b-40c3-8f85-781d3e9a8f68\",\n     \"3b87be76-95cf-493a-a61b-7d5fc70870ad\",\n     mount: \"new-app-id\",\n   )\n\n @param [String] app_id\n @param [String] user_id\n @param [Hash] options\n   additional options to pass to the authentication call, such as a custom\n   mount point\n\n @return [Secret]", "Authenticate via the \"approle\" authentication method. If authentication is\n successful, the resulting token will be stored on the client and used for\n future requests.\n\n @example\n   Vault.auth.approle(\n     \"db02de05-fa39-4855-059b-67221c5c2f63\",\n     \"6a174c20-f6de-a53c-74d2-6018fcceff64\",\n   ) #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] role_id\n @param [String] secret_id (default: nil)\n   It is required when `bind_secret_id` is enabled for the specified role_id\n\n @return [Secret]", "Authenticate via the \"userpass\" authentication method. If authentication\n is successful, the resulting token will be stored on the client and used\n for future requests.\n\n @example\n   Vault.auth.userpass(\"sethvargo\", \"s3kr3t\") #=> #<Vault::Secret lease_id=\"\">\n\n @example with a custom mount point\n   Vault.auth.userpass(\"sethvargo\", \"s3kr3t\", mount: \"admin-login\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] username\n @param [String] password\n @param [Hash] options\n   additional options to pass to the authentication call, such as a custom\n   mount point\n\n @return [Secret]", "Authenticate via the GitHub authentication method. If authentication is\n successful, the resulting token will be stored on the client and used\n for future requests.\n\n @example\n   Vault.auth.github(\"mypersonalgithubtoken\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] github_token\n\n @return [Secret]", "Authenticate via the AWS EC2 authentication method. If authentication is\n successful, the resulting token will be stored on the client and used\n for future requests.\n\n @example\n   Vault.auth.aws_ec2(\"read-only\", \"pkcs7\", \"vault-nonce\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] role\n @param [String] pkcs7\n   pkcs7 returned by the instance identity document (with line breaks removed)\n @param [String] nonce optional\n @param [String] route optional\n\n @return [Secret]", "Authenticate via the GCP authentication method. If authentication is\n successful, the resulting token will be stored on the client and used\n for future requests.\n\n @example\n   Vault.auth.gcp(\"read-only\", \"jwt\", \"gcp\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] role\n @param [String] jwt\n   jwt returned by the instance identity metadata, or iam api\n @param [String] path optional\n   the path were the gcp auth backend is mounted\n\n @return [Secret]", "Authenticate via a TLS authentication method. If authentication is\n successful, the resulting token will be stored on the client and used\n for future requests.\n\n @example Sending raw pem contents\n   Vault.auth.tls(pem_contents) #=> #<Vault::Secret lease_id=\"\">\n\n @example Reading a pem from disk\n   Vault.auth.tls(File.read(\"/path/to/my/certificate.pem\")) #=> #<Vault::Secret lease_id=\"\">\n\n @example Sending to a cert authentication backend mounted at a custom location\n   Vault.auth.tls(pem_contents, 'custom/location') #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] pem (default: the configured SSL pem file or contents)\n   The raw pem contents to use for the login procedure.\n\n @param [String] path (default: 'cert')\n   The path to the auth backend to use for the login procedure.\n\n @return [Secret]", "Get the policy by the given name. If a policy does not exist by that name,\n +nil+ is returned.\n\n @example\n   Vault.sys.policy(\"root\") #=> #<Vault::Policy rules=\"\">\n\n @return [Policy, nil]", "Create a new policy with the given name and rules.\n\n @example\n   policy = <<-EOH\n     path \"sys\" {\n       policy = \"deny\"\n     }\n   EOH\n   Vault.sys.put_policy(\"dev\", policy) #=> true\n\n It is recommend that you load policy rules from a file:\n\n @example\n   policy = File.read(\"/path/to/my/policy.hcl\")\n   Vault.sys.put_policy(\"dev\", policy)\n\n @param [String] name\n   the name of the policy\n @param [String] rules\n   the policy rules\n\n @return [true]", "List all audits for the vault.\n\n @example\n   Vault.sys.audits #=> { :file => #<Audit> }\n\n @return [Hash<Symbol, Audit>]", "Generates a HMAC verifier for a given input.\n\n @example\n   Vault.sys.audit_hash(\"file-audit\", \"my input\") #=> \"hmac-sha256:30aa7de18a5e90bbc1063db91e7c387b32b9fa895977eb8c177bbc91e7d7c542\"\n\n @param [String] path\n   the path of the audit backend\n @param [String] input\n   the input to generate a HMAC for\n\n @return [String]", "Lists all token accessors.\n\n @example Listing token accessors\n   result = Vault.auth_token.accessors #=> #<Vault::Secret>\n   result.data[:keys] #=> [\"476ea048-ded5-4d07-eeea-938c6b4e43ec\", \"bb00c093-b7d3-b0e9-69cc-c4d85081165b\"]\n\n @return [Array<Secret>]", "Create an authentication token. Note that the parameters specified below\n are not validated and passed directly to the Vault server. Depending on\n the version of Vault in operation, some of these options may not work, and\n newer options may be available that are not listed here.\n\n @example Creating a token\n   Vault.auth_token.create #=> #<Vault::Secret lease_id=\"\">\n\n @example Creating a token assigned to policies with a wrap TTL\n   Vault.auth_token.create(\n     policies: [\"myapp\"],\n     wrap_ttl: 500,\n   )\n\n @param [Hash] options\n @option options [String] :id\n   The ID of the client token - this can only be specified for root tokens\n @option options [Array<String>] :policies\n   List of policies to apply to the token\n @option options [Fixnum, String] :wrap_ttl\n   The number of seconds or a golang-formatted timestamp like \"5s\" or \"10m\"\n   for the TTL on the wrapped response\n @option options [Hash<String, String>] :meta\n   A map of metadata that is passed to audit backends\n @option options [Boolean] :no_parent\n   Create a token without a parent - see also {#create_orphan}\n @option options [Boolean] :no_default_policy\n   Create a token without the default policy attached\n @option options [Boolean] :renewable\n   Set whether this token is renewable or not\n @option options [String] :display_name\n   Name of the token\n @option options [Fixnum] :num_uses\n   Maximum number of uses for the token\n\n @return [Secret]", "Create an orphaned authentication token.\n\n @example\n   Vault.auth_token.create_with_role(\"developer\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [Hash] options\n\n @return [Secret]", "Lookup information about the current token.\n\n @example\n   Vault.auth_token.lookup(\"abcd-...\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] token\n @param [Hash] options\n\n @return [Secret]", "Lookup information about the given token accessor.\n\n @example\n   Vault.auth_token.lookup_accessor(\"acbd-...\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] accessor\n @param [Hash] options", "Renew the given authentication token.\n\n @example\n   Vault.auth_token.renew(\"abcd-1234\") #=> #<Vault::Secret lease_id=\"\">\n\n @param [String] token\n   the auth token\n @param [Fixnum] increment\n\n @return [Secret]", "Renews a lease associated with the calling token.\n\n @example\n   Vault.auth_token.renew_self #=> #<Vault::Secret lease_id=\"\">\n\n @param [Fixnum] increment\n\n @return [Secret]", "Create a new Client with the given options. Any options given take\n precedence over the default options.\n\n @return [Vault::Client]", "Perform a LIST request.\n @see Client#request", "Renew a lease with the given ID.\n\n @example\n   Vault.sys.renew(\"aws/username\") #=> #<Vault::Secret ...>\n\n @param [String] id\n   the lease ID\n @param [Fixnum] increment\n\n @return [Secret]", "Create a hash-bashed representation of this response.\n\n @return [Hash]", "Initialize a new vault.\n\n @example\n   Vault.sys.init #=> #<Vault::InitResponse keys=[\"...\"] root_token=\"...\">\n\n @param [Hash] options\n   the list of init options\n\n @option options [String] :root_token_pgp_key\n   optional base64-encoded PGP public key used to encrypt the initial root\n   token.\n @option options [Fixnum] :secret_shares\n   the number of shares\n @option options [Fixnum] :secret_threshold\n   the number of keys needed to unlock\n @option options [Array<String>] :pgp_keys\n   an optional Array of base64-encoded PGP public keys to encrypt sharees\n @option options [Fixnum] :stored_shares\n   the number of shares that should be encrypted by the HSM for\n   auto-unsealing\n @option options [Fixnum] :recovery_shares\n   the number of shares to split the recovery key into\n @option options [Fixnum] :recovery_threshold\n   the number of shares required to reconstruct the recovery key\n @option options [Array<String>] :recovery_pgp_keys\n   an array of PGP public keys used to encrypt the output for the recovery\n   keys\n\n @return [InitResponse]", "Creates a new AppRole or update an existing AppRole with the given name\n and attributes.\n\n @example\n   Vault.approle.set_role(\"testrole\", {\n     secret_id_ttl: \"10m\",\n     token_ttl:     \"20m\",\n     policies:      \"default\",\n     period:        3600,\n   }) #=> true\n\n @param [String] name\n   The name of the AppRole\n @param [Hash] options\n @option options [Boolean] :bind_secret_id\n   Require secret_id to be presented when logging in using this AppRole.\n @option options [String] :bound_cidr_list\n   Comma-separated list of CIDR blocks. Specifies blocks of IP addresses\n   which can perform the login operation.\n @option options [String] :policies\n   Comma-separated list of policies set on tokens issued via this AppRole.\n @option options [String] :secret_id_num_uses\n   Number of times any particular SecretID can be used to fetch a token\n   from this AppRole, after which the SecretID will expire.\n @option options [Fixnum, String] :secret_id_ttl\n   The number of seconds or a golang-formatted timestamp like \"60m\" after\n   which any SecretID expires.\n @option options [Fixnum, String] :token_ttl\n   The number of seconds or a golang-formatted timestamp like \"60m\" to set\n   as the TTL for issued tokens and at renewal time.\n @option options [Fixnum, String] :token_max_ttl\n   The number of seconds or a golang-formatted timestamp like \"60m\" after\n   which the issued token can no longer be renewed.\n @option options [Fixnum, String] :period\n   The number of seconds or a golang-formatted timestamp like \"60m\".\n   If set, the token generated using this AppRole is a periodic token.\n   So long as it is renewed it never expires, but the TTL set on the token\n   at each renewal is fixed to the value specified here. If this value is\n   modified, the token will pick up the new value at its next renewal.\n\n @return [true]", "Gets the AppRole by the given name. If an AppRole does not exist by that\n name, +nil+ is returned.\n\n @example\n   Vault.approle.role(\"testrole\") #=> #<Vault::Secret lease_id=\"...\">\n\n @return [Secret, nil]", "Reads the RoleID of an existing AppRole. If an AppRole does not exist by\n that name, +nil+ is returned.\n\n @example\n   Vault.approle.role_id(\"testrole\") #=> #<Vault::Secret lease_id=\"...\">\n\n @return [Secret, nil]", "Updates the RoleID of an existing AppRole to a custom value.\n\n @example\n   Vault.approle.set_role_id(\"testrole\") #=> true\n\n @return [true]", "Generates and issues a new SecretID on an existing AppRole.\n\n @example Generate a new SecretID\n   result = Vault.approle.create_secret_id(\"testrole\") #=> #<Vault::Secret lease_id=\"...\">\n   result.data[:secret_id] #=> \"841771dc-11c9-bbc7-bcac-6a3945a69cd9\"\n\n @example Assign a custom SecretID\n   result = Vault.approle.create_secret_id(\"testrole\", {\n     secret_id: \"testsecretid\"\n   }) #=> #<Vault::Secret lease_id=\"...\">\n   result.data[:secret_id] #=> \"testsecretid\"\n\n @param [String] role_name\n   The name of the AppRole\n @param [Hash] options\n @option options [String] :secret_id\n   SecretID to be attached to the Role. If not set, then the new SecretID\n   will be generated\n @option options [Hash<String, String>] :metadata\n   Metadata to be tied to the SecretID. This should be a JSON-formatted\n   string containing the metadata in key-value pairs. It will be set on\n   tokens issued with this SecretID, and is logged in audit logs in\n   plaintext.\n\n @return [true]", "Reads out the properties of a SecretID assigned to an AppRole.\n If the specified SecretID don't exist, +nil+ is returned.\n\n @example\n   Vault.approle.role(\"testrole\", \"841771dc-11c9-...\") #=> #<Vault::Secret lease_id=\"...\">\n\n @param [String] role_name\n   The name of the AppRole\n @param [String] secret_id\n   SecretID belonging to AppRole\n\n @return [Secret, nil]", "Lists the accessors of all the SecretIDs issued against the AppRole.\n This includes the accessors for \"custom\" SecretIDs as well. If there are\n no SecretIDs against this role, an empty array will be returned.\n\n @example\n   Vault.approle.secret_ids(\"testrole\") #=> [\"ce102d2a-...\", \"a1c8dee4-...\"]\n\n @return [Array<String>]", "Encodes a string according to the rules for URL paths. This is\n used as opposed to CGI.escape because in a URL path, space\n needs to be escaped as %20 and CGI.escapes a space as +.\n\n @param [String]\n\n @return [String]", "List all mounts in the vault.\n\n @example\n   Vault.sys.mounts #=> { :secret => #<struct Vault::Mount type=\"generic\", description=\"generic secret storage\"> }\n\n @return [Hash<Symbol, Mount>]", "Tune a mount at the given path.\n\n @example\n   Vault.sys.mount_tune(\"pki\", max_lease_ttl: '87600h') #=> true\n\n @param [String] path\n   the path to write\n @param [Hash] data\n   the data to write", "Change the name of the mount\n\n @example\n   Vault.sys.remount(\"pg\", \"postgres\") #=> true\n\n @param [String] from\n   the origin mount path\n @param [String] to\n   the new mount path\n\n @return [true]", "Returns the full path to the output directory using SimpleCov.root\n and SimpleCov.coverage_dir, so you can adjust this by configuring those\n values. Will create the directory if it's missing", "Gets or sets the behavior to process coverage results.\n\n By default, it will call SimpleCov.result.format!\n\n Configure with:\n\n     SimpleCov.at_exit do\n       puts \"Coverage done\"\n       SimpleCov.result.format!\n     end", "Returns the project name - currently assuming the last dirname in\n the SimpleCov.root is this.", "The actual filter processor. Not meant for direct use", "Merges two Coverage.result hashes", "Applies the profile of given name on SimpleCov.configure", "Build link to the documentation about the given subject for the current\n version of Reek. The subject can be either a smell type like\n 'FeatureEnvy' or a general subject like 'Rake Task'.\n\n @param subject [String]\n @return [String] the full URL for the relevant documentation", "Attempts to load pre-generated code returning true if it succeeds.", "Registers C type-casts +r2c+ and +c2r+ for +type+.", "Adds a C function to the source, including performing automatic\n type conversion to arguments and the return value. The Ruby\n method name can be overridden by providing method_name. Unknown\n type conversions can be extended by using +add_type_converter+.", "Same as +c+, but adds a class function.", "Same as +c_raw+, but adds a class function.", "Checks the target source code for instances of \"smell type\"\n and returns true only if it can find one of them that matches.\n\n You can pass the smell type you want to check for as String or as Symbol:\n\n   - :UtilityFunction\n   - \"UtilityFunction\"\n\n It is recommended to pass this as a symbol like :UtilityFunction. However we don't\n enforce this.\n\n Additionally you can be more specific and pass in \"smell_details\" you\n want to check for as well e.g. \"name\" or \"count\" (see the examples below).\n The parameters you can check for are depending on the smell you are checking for.\n For instance \"count\" doesn't make sense everywhere whereas \"name\" does in most cases.\n If you pass in a parameter that doesn't exist (e.g. you make a typo like \"namme\") Reek will\n raise an ArgumentError to give you a hint that you passed something that doesn't make\n much sense.\n\n @param smell_type [Symbol, String] The \"smell type\" to check for.\n @param smell_details [Hash] A hash containing \"smell warning\" parameters\n\n @example Without smell_details\n\n   reek_of(:FeatureEnvy)\n   reek_of(:UtilityFunction)\n\n @example With smell_details\n\n   reek_of(:UncommunicativeParameterName, name: 'x2')\n   reek_of(:DataClump, count: 3)\n\n @example From a real spec\n\n   expect(src).to reek_of(:DuplicateMethodCall, name: '@other.thing')\n\n @public\n\n @quality :reek:UtilityFunction", "See the documentaton for \"reek_of\".\n\n Notable differences to reek_of:\n   1.) \"reek_of\" doesn't mind if there are other smells of a different type.\n       \"reek_only_of\" will fail in that case.\n   2.) \"reek_only_of\" doesn't support the additional smell_details hash.\n\n @param smell_type [Symbol, String] The \"smell type\" to check for.\n\n @public\n\n @quality :reek:UtilityFunction", "Processes the given AST, memoizes it and returns a tree of nested\n contexts.\n\n For example this ruby code:\n\n   class Car; def drive; end; end\n\n would get compiled into this AST:\n\n   (class\n     (const nil :Car) nil\n     (def :drive\n       (args) nil))\n\n Processing this AST would result in a context tree where each node\n contains the outer context, the AST and the child contexts. The top\n node is always Reek::Context::RootContext. Using the example above,\n the tree would look like this:\n\n RootContext -> children: 1 ModuleContext -> children: 1 MethodContext\n\n @return [Reek::Context::RootContext] tree of nested contexts", "Handles every node for which we have no context_processor.", "Handles `def` nodes.\n\n An input example that would trigger this method would be:\n\n   def call_me; foo = 2; bar = 5; end\n\n Given the above example we would count 2 statements overall.", "Handles `send` nodes a.k.a. method calls.\n\n An input example that would trigger this method would be:\n\n   call_me()\n\n Besides checking if it's a visibility modifier or an attribute writer\n we also record to what the method call is referring to\n which we later use for smell detectors like FeatureEnvy.", "Handles `if` nodes.\n\n An input example that would trigger this method would be:\n\n if a > 5 && b < 3\n   puts 'bingo'\n else\n   3\n end\n\n Counts the `if` body as one statement and the `else` body as another statement.\n\n At the end we subtract one statement because the surrounding context was already counted\n as one (e.g. via `process_def`).\n\n `children[1]` refers to the `if` body (so `puts 'bingo'` from above) and\n `children[2]` to the `else` body (so `3` from above), which might be nil.", "Handles `rescue` nodes.\n\n An input example that would trigger this method would be:\n\n def simple\n   raise ArgumentError, 'raising...'\n rescue => e\n   puts 'rescued!'\n end\n\n Counts everything before the `rescue` body as one statement.\n\n At the end we subtract one statement because the surrounding context was already counted\n as one (e.g. via `process_def`).\n\n `exp.children.first` below refers to everything before the actual `rescue`\n which would be the\n\n raise ArgumentError, 'raising...'\n\n in the example above.\n `exp` would be the whole method body wrapped under a `rescue` node.\n See `process_resbody` for additional reference.", "Stores a reference to the current context, creates a nested new one,\n yields to the given block and then restores the previous context.\n\n @param klass [Context::*Context] context class\n @param args arguments for the class initializer\n @yield block", "Appends a new child context to the current context but does not change\n the current context.\n\n @param klass [Context::*Context] context class\n @param args arguments for the class initializer\n\n @return [Context::*Context] the context that was appended", "Retrieves the value, if any, for the given +key+ in the given +context+.\n\n Raises an error if neither the context nor this config have a value for\n the key.", "Find any overrides that match the supplied context", "Recursively enhance an AST with type-dependent mixins, and comments.\n\n See {file:docs/How-reek-works-internally.md} for the big picture of how this works.\n Example:\n This\n   class Klazz; def meth(argument); argument.call_me; end; end\n corresponds to this sexp:\n   (class\n     (const nil :Klazz) nil\n     (def :meth\n       (args\n         (arg :argument))\n       (send\n         (lvar :argument) :call_me)))\n where every node is of type Parser::AST::Node.\n Passing this into `dress` will return the exact same structure, but this\n time the nodes will contain type-dependent mixins, e.g. this:\n   (const nil :Klazz)\n  will be of type Reek::AST::Node with  Reek::AST::SexpExtensions::ConstNode mixed in.\n\n @param sexp [Parser::AST::Node] the given sexp\n @param comment_map [Hash] see the documentation for SourceCode#syntax_tree\n\n @return an instance of Reek::AST::Node with type-dependent sexp extensions mixed in.\n\n @quality :reek:FeatureEnvy\n @quality :reek:TooManyStatements { max_statements: 6 }", "append_record_to_messages adds a record to the bulk message\n payload to be submitted to Elasticsearch.  Records that do\n not include '_id' field are skipped when 'write_operation'\n is configured for 'create' or 'update'\n\n returns 'true' if record was appended to the bulk message\n         and 'false' otherwise", "send_bulk given a specific bulk request, the original tag,\n chunk, and bulk_message_count", "Adds the given responders to the current controller's responder, allowing you to cherry-pick\n which responders you want per controller.\n\n   class InvitationsController < ApplicationController\n     responders :flash, :http_cache\n   end\n\n Takes symbols and strings and translates them to VariableResponder (eg. :flash becomes FlashResponder).\n Also allows passing in the responders modules in directly, so you could do:\n\n    responders FlashResponder, HttpCacheResponder\n\n Or a mix of both methods:\n\n    responders :flash, MyCustomResponder", "For a given controller action, respond_with generates an appropriate\n response based on the mime-type requested by the client.\n\n If the method is called with just a resource, as in this example -\n\n   class PeopleController < ApplicationController\n     respond_to :html, :xml, :json\n\n     def index\n       @people = Person.all\n       respond_with @people\n     end\n   end\n\n then the mime-type of the response is typically selected based on the\n request's Accept header and the set of available formats declared\n by previous calls to the controller's class method +respond_to+. Alternatively\n the mime-type can be selected by explicitly setting <tt>request.format</tt> in\n the controller.\n\n If an acceptable format is not identified, the application returns a\n '406 - not acceptable' status. Otherwise, the default response is to render\n a template named after the current action and the selected format,\n e.g. <tt>index.html.erb</tt>. If no template is available, the behavior\n depends on the selected format:\n\n * for an html response - if the request method is +get+, an exception\n   is raised but for other requests such as +post+ the response\n   depends on whether the resource has any validation errors (i.e.\n   assuming that an attempt has been made to save the resource,\n   e.g. by a +create+ action) -\n   1. If there are no errors, i.e. the resource\n      was saved successfully, the response +redirect+'s to the resource\n      i.e. its +show+ action.\n   2. If there are validation errors, the response\n      renders a default action, which is <tt>:new</tt> for a\n      +post+ request or <tt>:edit</tt> for +patch+ or +put+.\n   Thus an example like this -\n\n     respond_to :html, :xml\n\n     def create\n       @user = User.new(params[:user])\n       flash[:notice] = 'User was successfully created.' if @user.save\n       respond_with(@user)\n     end\n\n   is equivalent, in the absence of <tt>create.html.erb</tt>, to -\n\n     def create\n       @user = User.new(params[:user])\n       respond_to do |format|\n         if @user.save\n           flash[:notice] = 'User was successfully created.'\n           format.html { redirect_to(@user) }\n           format.xml { render xml: @user }\n         else\n           format.html { render action: \"new\" }\n           format.xml { render xml: @user }\n         end\n       end\n     end\n\n * for a JavaScript request - if the template isn't found, an exception is\n   raised.\n * for other requests - i.e. data formats such as xml, json, csv etc, if\n   the resource passed to +respond_with+ responds to <code>to_<format></code>,\n   the method attempts to render the resource in the requested format\n   directly, e.g. for an xml request, the response is equivalent to calling\n   <code>render xml: resource</code>.\n\n === Nested resources\n\n As outlined above, the +resources+ argument passed to +respond_with+\n can play two roles. It can be used to generate the redirect url\n for successful html requests (e.g. for +create+ actions when\n no template exists), while for formats other than html and JavaScript\n it is the object that gets rendered, by being converted directly to the\n required format (again assuming no template exists).\n\n For redirecting successful html requests, +respond_with+ also supports\n the use of nested resources, which are supplied in the same way as\n in <code>form_for</code> and <code>polymorphic_url</code>. For example -\n\n   def create\n     @project = Project.find(params[:project_id])\n     @task = @project.comments.build(params[:task])\n     flash[:notice] = 'Task was successfully created.' if @task.save\n     respond_with(@project, @task)\n   end\n\n This would cause +respond_with+ to redirect to <code>project_task_url</code>\n instead of <code>task_url</code>. For request formats other than html or\n JavaScript, if multiple resources are passed in this way, it is the last\n one specified that is rendered.\n\n === Customizing response behavior\n\n Like +respond_to+, +respond_with+ may also be called with a block that\n can be used to overwrite any of the default responses, e.g. -\n\n   def create\n     @user = User.new(params[:user])\n     flash[:notice] = \"User was successfully created.\" if @user.save\n\n     respond_with(@user) do |format|\n       format.html { render }\n     end\n   end\n\n The argument passed to the block is an ActionController::MimeResponds::Collector\n object which stores the responses for the formats defined within the\n block. Note that formats with responses defined explicitly in this way\n do not have to first be declared using the class method +respond_to+.\n\n Also, a hash passed to +respond_with+ immediately after the specified\n resource(s) is interpreted as a set of options relevant to all\n formats. Any option accepted by +render+ can be used, e.g.\n\n   respond_with @people, status: 200\n\n However, note that these options are ignored after an unsuccessful attempt\n to save a resource, e.g. when automatically rendering <tt>:new</tt>\n after a post request.\n\n Three additional options are relevant specifically to +respond_with+ -\n 1. <tt>:location</tt> - overwrites the default redirect location used after\n    a successful html +post+ request.\n 2. <tt>:action</tt> - overwrites the default render action used after an\n    unsuccessful html +post+ request.\n 3. <tt>:render</tt> - allows to pass any options directly to the <tt>:render<tt/>\n    call after unsuccessful html +post+ request. Usefull if for example you\n    need to render a template which is outside of controller's path or you\n    want to override the default http <tt>:status</tt> code, e.g.\n\n    respond_with(resource, render: { template: 'path/to/template', status: 422 })", "Collect mimes declared in the class method respond_to valid for the\n current action.", "reindex whole database using a extra temporary index + move operation", "special handling of get_settings to avoid raising errors on 404", "Defines attr accessors for each available_filter on self and assigns\n values based on fp.\n @param fp [Hash] filterrific_params with stringified keys", "Computes filterrific params using a number of strategies. Limits params\n to 'available_filters' if given via opts.\n @param model_class [ActiveRecord::Base]\n @param filterrific_params [ActionController::Params, Hash]\n @param opts [Hash]\n @option opts [Boolean, optional] \"sanitize_params\"\n   if true, sanitizes all filterrific params to prevent reflected (or stored) XSS attacks.\n   Defaults to true.\n @param persistence_id [String, nil]", "Sets all options on form_for to defaults that work with Filterrific\n @param record [Filterrific] the @filterrific object\n @param options [Hash] standard options for form_for\n @param block [Proc] the form body", "Renders HTML to reverse sort order on currently sorted column.\n @param filterrific [Filterrific::ParamSet]\n @param new_sort_key [String]\n @param opts [Hash]\n @return [String] an HTML fragment", "explicit hash, to get symbols in hash keys", "Executes a task on a specific VM.\n\n @param vm [Vagrant::VM]\n @param options [Hash] Parsed options from the command line", "shows a link that will allow to dynamically add a new associated object.\n\n - *name* :         the text to show in the link\n - *f* :            the form this should come in (the formtastic form)\n - *association* :  the associated objects, e.g. :tasks, this should be the name of the <tt>has_many</tt> relation.\n - *html_options*:  html options to be passed to <tt>link_to</tt> (see <tt>link_to</tt>)\n          - *:render_options* : options passed to `simple_fields_for, semantic_fields_for or fields_for`\n              - *:locals*     : the locals hash in the :render_options is handed to the partial\n          - *:partial*        : explicitly override the default partial name\n          - *:wrap_object*    : a proc that will allow to wrap your object, especially suited when using\n                                decorators, or if you want special initialisation\n          - *:form_name*      : the parameter for the form in the nested form partial. Default `f`.\n          - *:count*          : Count of how many objects will be added on a single click. Default `1`.\n - *&block*:        see <tt>link_to</tt>", "Capture and process any exceptions from the given block.\n\n @example\n   Raven.capture do\n     MyApp.run\n   end", "Provides extra context to the exception prior to it being handled by\n Raven. An exception can have multiple annotations, which are merged\n together.\n\n The options (annotation) is treated the same as the ``options``\n parameter to ``capture_exception`` or ``Event.from_exception``, and\n can contain the same ``:user``, ``:tags``, etc. options as these\n methods.\n\n These will be merged with the ``options`` parameter to\n ``Event.from_exception`` at the top of execution.\n\n @example\n   begin\n     raise \"Hello\"\n   rescue => exc\n     Raven.annotate_exception(exc, :user => { 'id' => 1,\n                              'email' => 'foo@example.com' })\n   end", "Once an ActiveJob is queued, ActiveRecord references get serialized into\n some internal reserved keys, such as _aj_globalid.\n\n The problem is, if this job in turn gets queued back into ActiveJob with\n these magic reserved keys, ActiveJob will throw up and error. We want to\n capture these and mutate the keys so we can sanely report it.", "run all plugins or those that match the attribute filter is provided\n\n @param safe [Boolean]\n @param [Array<String>] attribute_filter the attributes to run. All will be run if not specified\n\n @return [Mash]", "Pretty Print this object as JSON", "gather plugins providing exactly the attributes listed", "This function is used to fetch the plugins for the attributes specified\n in the CLI options to Ohai.\n It first attempts to find the plugins for the attributes\n or the sub attributes given.\n If it can't find any, it looks for plugins that might\n provide the parents of a given attribute and returns the\n first parent found.", "This function is used to fetch the plugins from\n 'depends \"languages\"' statements in plugins.\n It gathers plugins providing each of the attributes listed, or the\n plugins providing the closest parent attribute", "Takes a section of the map, recursively searches for a `_plugins` key\n to find all the plugins in that section of the map. If given the whole\n map, it will find all of the plugins that have at least one provided\n attribute.", "Searches all plugin paths and returns an Array of file paths to plugins\n\n @param dir [Array, String] directory/directories to load plugins from\n @return [Array<String>]", "load additional plugins classes from a given directory\n @param from [String] path to a directory with additional plugins to load", "Load a specified file as an ohai plugin and creates an instance of it.\n Not used by ohai itself, but is used in the specs to load plugins for testing\n\n @private\n @param plugin_path [String]", "Given a list of plugins and the first plugin in the cycle,\n returns the list of plugin source files responsible for the\n cycle. Does not include plugins that aren't a part of the cycle", "A point is inside a triangle if the area of 3 triangles, constructed from\n triangle sides and the given point, is equal to the area of triangle.", "Play an animation", "Set the position of the clipping retangle based on the current frame", "Calculate the distance between two points", "Set a window attribute", "Add an object to the window", "Remove an object from the window", "Set an event handler", "Key callback method, called by the native and web extentions", "Mouse callback method, called by the native and web extentions", "Controller callback method, called by the native and web extentions", "Update callback method, called by the native and web extentions", "An an object to the window, used by the public `add` method", "Create a new database view.\n\n @param name [String, Symbol] The name of the database view.\n @param version [Fixnum] The version number of the view, used to find the\n   definition file in `db/views`. This defaults to `1` if not provided.\n @param sql_definition [String] The SQL query for the view schema. An error\n   will be raised if `sql_definition` and `version` are both set,\n   as they are mutually exclusive.\n @param materialized [Boolean, Hash] Set to true to create a materialized\n   view. Set to { no_data: true } to create materialized view without\n   loading data. Defaults to false.\n @return The database response from executing the create statement.\n\n @example Create from `db/views/searches_v02.sql`\n   create_view(:searches, version: 2)\n\n @example Create from provided SQL string\n   create_view(:active_users, sql_definition: <<-SQL)\n     SELECT * FROM users WHERE users.active = 't'\n   SQL", "Drop a database view by name.\n\n @param name [String, Symbol] The name of the database view.\n @param revert_to_version [Fixnum] Used to reverse the `drop_view` command\n   on `rake db:rollback`. The provided version will be passed as the\n   `version` argument to {#create_view}.\n @param materialized [Boolean] Set to true if dropping a meterialized view.\n   defaults to false.\n @return The database response from executing the drop statement.\n\n @example Drop a view, rolling back to version 3 on rollback\n   drop_view(:users_who_recently_logged_in, revert_to_version: 3)", "Update a database view to a new version.\n\n The existing view is dropped and recreated using the supplied `version`\n parameter.\n\n @param name [String, Symbol] The name of the database view.\n @param version [Fixnum] The version number of the view.\n @param sql_definition [String] The SQL query for the view schema. An error\n   will be raised if `sql_definition` and `version` are both set,\n   as they are mutually exclusive.\n @param revert_to_version [Fixnum] The version number to rollback to on\n   `rake db rollback`\n @param materialized [Boolean, Hash] True if updating a materialized view.\n   Set to { no_data: true } to update materialized view without loading\n   data. Defaults to false.\n @return The database response from executing the create statement.\n\n @example\n   update_view :engagement_reports, version: 3, revert_to_version: 2", "Update a database view to a new version using `CREATE OR REPLACE VIEW`.\n\n The existing view is replaced using the supplied `version`\n parameter.\n\n Does not work with materialized views due to lack of database support.\n\n @param name [String, Symbol] The name of the database view.\n @param version [Fixnum] The version number of the view.\n @param revert_to_version [Fixnum] The version number to rollback to on\n   `rake db rollback`\n @return The database response from executing the create statement.\n\n @example\n   replace_view :engagement_reports, version: 3, revert_to_version: 2", "Returns a hash representation of the event.\n\n Metadata is converted to hash as well\n\n @return [Hash] with :event_id, :metadata, :data, :type keys", "Persists events and notifies subscribed handlers about them\n\n @param events [Array<Event, Proto>, Event, Proto] event(s)\n @param stream_name [String] name of the stream for persisting events.\n @param expected_version [:any, :auto, :none, Integer] controls optimistic locking strategy. {http://railseventstore.org/docs/expected_version/ Read more}\n @return [self]", "merges the hash of headers into the current header set.", "disable Secure cookies for non-https requests", "when configuring with booleans, only one enforcement is permitted", "validate exclusive use of only or except but not both at the same time", "validate exclusivity of only and except members within strict and lax", "Discard any 'none' values if more directives are supplied since none may override values.", "Removes duplicates and sources that already match an existing wild card.\n\n e.g. *.github.com asdf.github.com becomes *.github.com", "Invisible reCAPTCHA implementation", "Your private API can be specified in the +options+ hash or preferably\n using the Configuration.", "Compares this configuration with another.\n\n @param other [HamlLint::Configuration]\n @return [true,false] whether the given configuration is equivalent\n Returns a non-modifiable configuration for the specified linter.\n\n @param linter [HamlLint::Linter,Class]", "Merge two hashes such that nested hashes are merged rather than replaced.\n\n @param parent [Hash]\n @param child [Hash]\n @return [Hash]", "Prints the standard progress reporter output and writes the new config file.\n\n @param report [HamlLint::Report]\n @return [void]", "Prints the standard progress report marks and tracks files with lint.\n\n @param file [String]\n @param lints [Array<HamlLint::Lint>]\n @return [void]", "The contents of the generated configuration file based on captured lint.\n\n @return [String] a Yaml-formatted configuration file's contents", "Constructs the configuration for excluding a linter in some files.\n\n @param linter [String] the name of the linter to exclude\n @param files [Array<String>] the files in which the linter is excluded\n @return [String] a Yaml-formatted configuration", "Returns the class of the specified Reporter.\n\n @param reporter_name [String]\n @raise [HamlLint::Exceptions::InvalidCLIOption] if reporter doesn't exist\n @return [Class]", "Enables the linter if the tree is for the right file type.\n\n @param [HamlLint::Tree::RootNode] the root of a syntax tree\n @return [true, false] whether the linter is enabled for the tree", "Checks for instance variables in tag nodes when the linter is enabled.\n\n @param [HamlLint::Tree:TagNode]\n @return [void]", "Runs the appropriate linters against the desired files given the specified\n options.\n\n @param [Hash] options\n @option options :config_file [String] path of configuration file to load\n @option options :config [HamlLint::Configuration] configuration to use\n @option options :excluded_files [Array<String>]\n @option options :included_linters [Array<String>]\n @option options :excluded_linters [Array<String>]\n @option options :fail_fast [true, false] flag for failing after first failure\n @option options :fail_level\n @option options :reporter [HamlLint::Reporter]\n @return [HamlLint::Report] a summary of all lints found", "Runs all provided linters using the specified config against the given\n file.\n\n @param file [String] path to file to lint\n @param linter_selector [HamlLint::LinterSelector]\n @param config [HamlLint::Configuration]", "Returns the list of files that should be linted given the specified\n configuration and options.\n\n @param config [HamlLint::Configuration]\n @param options [Hash]\n @return [Array<String>]", "Process the files and add them to the given report.\n\n @param report [HamlLint::Report]\n @return [void]", "Process a file and add it to the given report.\n\n @param file [String] the name of the file to process\n @param report [HamlLint::Report]\n @return [void]", "Generates a report based on the given options.\n\n @param options [Hash]\n @option options :reporter [HamlLint::Reporter] the reporter to report with\n @return [HamlLint::Report]", "Create a file finder using the specified configuration.\n\n @param config [HamlLint::Configuration]\n Return list of files to lint given the specified set of paths and glob\n patterns.\n @param patterns [Array<String>]\n @param excluded_patterns [Array<String>]\n @raise [HamlLint::Exceptions::InvalidFilePath]\n @return [Array<String>] list of actual files", "Extract the list of matching files given the list of glob patterns, file\n paths, and directories.\n\n @param patterns [Array<String>]\n @return [Array<String>]", "Whether the given file should be treated as a Haml file.\n\n @param file [String]\n @return [Boolean]", "Returns whether a string starts with a character that would otherwise be\n given special treatment, thus making enclosing it in a string necessary.", "Initializes a linter with the specified configuration.\n\n @param config [Hash] configuration for this linter\n Runs the linter against the given Haml document.\n\n @param document [HamlLint::Document]", "Returns whether the inline content for a node is a string.\n\n For example, the following node has a literal string:\n\n   %tag= \"A literal #{string}\"\n\n whereas this one does not:\n\n   %tag A literal #{string}\n\n @param node [HamlLint::Tree::Node]\n @return [true,false]", "Get the inline content for this node.\n\n Inline content is the content that appears inline right after the\n tag/script. For example, in the code below...\n\n   %tag Some inline content\n\n ...\"Some inline content\" would be the inline content.\n\n @param node [HamlLint::Tree::Node]\n @return [String]", "Gets the next node following this node, ascending up the ancestor chain\n recursively if this node has no siblings.\n\n @param node [HamlLint::Tree::Node]\n @return [HamlLint::Tree::Node,nil]", "Creates a reusable parser.\n Parse the given Ruby source into an abstract syntax tree.\n\n @param source [String] Ruby source code\n @return [Array] syntax tree in the form returned by Parser gem", "Given the provided options, execute the appropriate command.\n\n @return [Integer] exit status code", "Given the provided options, configure the logger.\n\n @return [void]", "Outputs a message and returns an appropriate error code for the specified\n exception.", "Instantiates a new reporter based on the options.\n\n @param options [HamlLint::Configuration]\n @option options [true, nil] :auto_gen_config whether to use the config\n   generating reporter\n @option options [Class] :reporter the class of reporter to use\n @return [HamlLint::Reporter]", "Scans the files specified by the given options for lints.\n\n @return [Integer] exit status code", "Outputs a list of all currently available linters.", "Outputs a list of currently available reporters.", "Outputs the application name and version.", "Outputs the backtrace of an exception with instructions on how to report\n the issue.", "Removes YAML frontmatter", "Checks whether a visitor is disabled due to comment configuration.\n\n @param [HamlLint::HamlVisitor]\n @return [true, false]", "Implements the Enumerable interface to walk through an entire tree.\n\n @return [Enumerator, HamlLint::Tree::Node]", "The line numbers that are contained within the node.\n\n @api public\n @return [Range]", "Discovers the end line of the node when there are no lines.\n\n @return [Integer] the end line of the node", "Gets the node of the syntax tree for a given line number.\n\n @param line [Integer] the line number of the node\n @return [HamlLint::Node]", "Returns a list of linters that are enabled given the specified\n configuration and additional options.\n\n @param config [HamlLint::Configuration]\n @param options [Hash]\n @return [Array<HamlLint::Linter>]", "Whether to run the given linter against the specified file.\n\n @param config [HamlLint::Configuration]\n @param linter [HamlLint::Linter]\n @param file [String]\n @return [Boolean]", "Returns the source code for the static and dynamic attributes\n of a tag.\n\n @example For `%tag.class{ id: 'hello' }(lang=en)`, this returns:\n   { :static => '.class', :hash => \" id: 'hello' \", :html => \"lang=en\" }\n\n @return [Hash]", "Executes RuboCop against the given Ruby code and records the offenses as\n lints.\n\n @param ruby [String] Ruby code\n @param source_map [Hash] map of Ruby code line numbers to original line\n   numbers in the template", "Overrides the global stdin to allow RuboCop to read Ruby code from it.\n\n @param ruby [String] the Ruby code to write to the overridden stdin\n @param _block [Block] the block to perform with the overridden stdin\n @return [void]", "Returns an array of two items, the first being the absolute path, the second\n the relative path.\n\n The relative path is relative to the current working dir. The path passed can\n be either relative or absolute.\n\n @param path [String] Path to get absolute and relative path of\n @return [Array<String>] Absolute and relative path", "Yields interpolated values within a block of text.\n\n @param text [String]\n @yield Passes interpolated code and line number that code appears on in\n   the text.\n @yieldparam interpolated_code [String] code that was interpolated\n @yieldparam line [Integer] line number code appears on in text", "Find all consecutive items satisfying the given block of a minimum size,\n yielding each group of consecutive items to the provided block.\n\n @param items [Array]\n @param satisfies [Proc] function that takes an item and returns true/false\n @param min_consecutive [Fixnum] minimum number of consecutive items before\n   yielding the group\n @yield Passes list of consecutive items all matching the criteria defined\n   by the `satisfies` {Proc} to the provided block\n @yieldparam group [Array] List of consecutive items\n @yieldreturn [Boolean] block should return whether item matches criteria\n   for inclusion", "Calls a block of code with a modified set of environment variables,\n restoring them once the code has executed.\n\n @param env [Hash] environment variables to set", "Executes the CLI given the specified task arguments.\n\n @param task_args [Rake::TaskArguments]", "Returns the list of files that should be linted given the specified task\n arguments.\n\n @param task_args [Rake::TaskArguments]", "Log setting or extension loading notices, sensitive information\n is redacted.\n\n @param notices [Array] to be logged.\n @param level [Symbol] to log the notices at.", "Set up Sensu spawn, creating a worker to create, control, and\n limit spawned child processes. This method adjusts the\n EventMachine thread pool size to accommodate the concurrent\n process spawn limit and other Sensu process operations.\n\n https://github.com/sensu/sensu-spawn", "Retry a code block until it retures true. The first attempt and\n following retries are delayed.\n\n @param wait [Numeric] time to delay block calls.\n @param block [Proc] to call that needs to return true.", "Deep merge two hashes. Nested hashes are deep merged, arrays are\n concatenated and duplicate array items are removed.\n\n @param hash_one [Hash]\n @param hash_two [Hash]\n @return [Hash] deep merged hash.", "Creates a deep dup of basic ruby objects with support for walking\n hashes and arrays.\n\n @param obj [Object]\n @return [obj] a dup of the original object.", "Retrieve the system IP address. If a valid non-loopback\n IPv4 address cannot be found and an error is thrown,\n `nil` will be returned.\n\n @return [String] system ip address", "Traverse a hash for an attribute value, with a fallback default\n value if nil.\n\n @param tree [Hash] to traverse.\n @param path [Array] of attribute keys.\n @param default [Object] value if attribute value is nil.\n @return [Object] attribute or fallback default value.", "Determine the next check cron time.\n\n @param check [Hash] definition.", "Execute the given block, and retry the current restartable transaction if a\n MySQL deadlock occurs.", "Get the current or historic balance of an account.\n\n @param account [DoubleEntry::Account:Instance]\n @option args :from [Time]\n @option args :to [Time]\n @option args :at [Time]\n @option args :code [Symbol]\n @option args :codes [Array<Symbol>]\n @return [Money]", "This method will populate all matched page TextFields,\n TextAreas, SelectLists, FileFields, Checkboxes, and Radio Buttons from the\n Hash passed as an argument.  The way it find an element is by\n matching the Hash key to the name you provided when declaring\n the element on your page.\n\n Checkbox and Radio Button values must be true or false.\n\n @example\n   class ExamplePage\n     include PageObject\n\n     text_field(:username, :id => 'username_id')\n     checkbox(:active, :id => 'active_id')\n   end\n\n   ...\n\n   @browser = Watir::Browser.new :firefox\n   example_page = ExamplePage.new(@browser)\n   example_page.populate_page_with :username => 'a name', :active => true\n\n @param data [Hash] the data to use to populate this page.  The key\n can be either a string or a symbol.  The value must be a string\n for TextField, TextArea, SelectList, and FileField and must be true or\n false for a Checkbox or RadioButton.", "Specify the url for the page.  A call to this method will generate a\n 'goto' method to take you to the page.\n\n @param [String] the url for the page.\n @param [Symbol] a method name to call to get the url", "Identify an element as existing within a frame .  A frame parameter\n is passed to the block and must be passed to the other calls to PageObject.\n You can nest calls to in_frame by passing the frame to the next level.\n\n @example\n   in_frame(:id => 'frame_id') do |frame|\n     text_field(:first_name, :id => 'fname', :frame => frame)\n   end\n\n @param [Hash] identifier how we find the frame.  The valid keys are:\n   * :id\n   * :index\n   * :name\n   * :regexp\n @param frame passed from a previous call to in_frame.  Used to nest calls\n @param block that contains the calls to elements that exist inside the frame.", "Identify an element as existing within an iframe.  A frame parameter\n is passed to the block and must be passed to the other calls to PageObject.\n You can nest calls to in_frame by passing the frame to the next level.\n\n @example\n   in_iframe(:id => 'frame_id') do |frame|\n     text_field(:first_name, :id => 'fname', :frame => frame)\n   end\n\n @param [Hash] identifier how we find the frame.  The valid keys are:\n   * :id\n   * :index\n   * :name\n   * :regexp\n @param frame passed from a previous call to in_iframe.  Used to nest calls\n @param block that contains the calls to elements that exist inside the iframe.", "adds four methods to the page object - one to set text in a text field,\n another to retrieve text from a text field, another to return the text\n field element, another to check the text field's existence.\n\n @example\n   text_field(:first_name, :id => \"first_name\")\n   # will generate 'first_name', 'first_name=', 'first_name_element',\n   # 'first_name?' methods\n\n @param  [String] the name used for the generated methods\n @param [Hash] identifier how we find a text field.\n @param optional block to be invoked when element method is called", "adds three methods to the page object - one to get the text from a hidden field,\n another to retrieve the hidden field element, and another to check the hidden\n field's existence.\n\n @example\n   hidden_field(:user_id, :id => \"user_identity\")\n   # will generate 'user_id', 'user_id_element' and 'user_id?' methods\n\n @param [String] the name used for the generated methods\n @param [Hash] identifier how we find a hidden field.\n @param optional block to be invoked when element method is called", "adds four methods to the page object - one to set text in a text area,\n another to retrieve text from a text area, another to return the text\n area element, and another to check the text area's existence.\n\n @example\n   text_area(:address, :id => \"address\")\n   # will generate 'address', 'address=', 'address_element',\n   # 'address?' methods\n\n @param  [String] the name used for the generated methods\n @param [Hash] identifier how we find a text area.\n @param optional block to be invoked when element method is called", "adds five methods - one to select an item in a drop-down,\n another to fetch the currently selected item text, another\n to retrieve the select list element, another to check the\n drop down's existence and another to get all the available options\n to select from.\n\n @example\n   select_list(:state, :id => \"state\")\n   # will generate 'state', 'state=', 'state_element', 'state?', \"state_options\" methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a select list.\n @param optional block to be invoked when element method is called", "adds three methods - one to click a button, another to\n return the button element, and another to check the button's existence.\n\n @example\n   button(:purchase, :id => 'purchase')\n   # will generate 'purchase', 'purchase_element', and 'purchase?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a button.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text from a div,\n another to return the div element, and another to check the div's existence.\n\n @example\n   div(:message, :id => 'message')\n   # will generate 'message', 'message_element', and 'message?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a div.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text from a span,\n another to return the span element, and another to check the span's existence.\n\n @example\n   span(:alert, :id => 'alert')\n   # will generate 'alert', 'alert_element', and 'alert?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a span.\n @param optional block to be invoked when element method is called", "adds three methods - one to return the text for the table, one\n to  retrieve the table element, and another to\n check the table's existence.\n\n @example\n   table(:cart, :id => 'shopping_cart')\n   # will generate a 'cart', 'cart_element' and 'cart?' method\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a table.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text from a table cell,\n another to return the table cell element, and another to check the cell's\n existence.\n\n @example\n   cell(:total, :id => 'total_cell')\n   # will generate 'total', 'total_element', and 'total?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a cell.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text from a table row,\n another to return the table row element, and another to check the row's\n existence.\n\n @example\n   row(:sums, :id => 'sum_row')\n   # will generate 'sums', 'sums_element', and 'sums?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a cell.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the image element, another to\n check the load status of the image, and another to check the\n image's existence.\n\n @example\n   image(:logo, :id => 'logo')\n   # will generate 'logo_element', 'logo_loaded?', and 'logo?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find an image.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text from a list item,\n another to return the list item element, and another to check the list item's\n existence.\n\n @example\n   list_item(:item_one, :id => 'one')\n   # will generate 'item_one', 'item_one_element', and 'item_one?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a list item.\n @param optional block to be invoked when element method is called", "adds three methods - one to return the text within the unordered\n list, one to retrieve the unordered list element, and another to\n check it's existence.\n\n @example\n   unordered_list(:menu, :id => 'main_menu')\n   # will generate 'menu', 'menu_element' and 'menu?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find an unordered list.\n @param optional block to be invoked when element method is called", "adds three methods - one to return the text within the ordered\n list, one to retrieve the ordered list element, and another to\n test it's existence.\n\n @example\n   ordered_list(:top_five, :id => 'top')\n   # will generate 'top_five', 'top_five_element' and 'top_five?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find an ordered list.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a h1 element, another to\n retrieve a h1 element, and another to check for it's existence.\n\n @example\n   h1(:title, :id => 'title')\n   # will generate 'title', 'title_element', and 'title?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a H1.  You can use a multiple parameters\n   by combining of any of the following except xpath.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a h2 element, another\n to retrieve a h2 element, and another to check for it's existence.\n\n @example\n   h2(:title, :id => 'title')\n   # will generate 'title', 'title_element', and 'title?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a H2.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a h3 element,\n another to return a h3 element, and another to check for it's existence.\n\n @example\n   h3(:title, :id => 'title')\n   # will generate 'title', 'title_element', and 'title?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a H3.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a h4 element,\n another to return a h4 element, and another to check for it's existence.\n\n @example\n   h4(:title, :id => 'title')\n   # will generate 'title', 'title_element', and 'title?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a H4.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a h5 element,\n another to return a h5 element, and another to check for it's existence.\n\n @example\n   h5(:title, :id => 'title')\n   # will generate 'title', 'title_element', and 'title?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a H5.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a h6 element,\n another to return a h6 element, and another to check for it's existence.\n\n @example\n   h6(:title, :id => 'title')\n   # will generate 'title', 'title_element', and 'title?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a H6.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a paragraph, another\n to retrieve a paragraph element, and another to check the paragraph's existence.\n\n @example\n   paragraph(:title, :id => 'title')\n   # will generate 'title', 'title_element', and 'title?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a paragraph.\n @param optional block to be invoked when element method is called", "adds three methods - one to set the file for a file field, another to retrieve\n the file field element, and another to check it's existence.\n\n @example\n   file_field(:the_file, :id => 'file_to_upload')\n   # will generate 'the_file=', 'the_file_element', and 'the_file?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a file_field.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text from a label,\n another to return the label element, and another to check the label's existence.\n\n @example\n   label(:message, :id => 'message')\n   # will generate 'message', 'message_element', and 'message?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a label.\n @param optional block to be invoked when element method is called", "adds three methods - one to click the area,\n another to return the area element, and another to check the area's existence.\n\n @example\n   area(:message, :id => 'message')\n   # will generate 'message', 'message_element', and 'message?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find an area.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a b element, another to\n retrieve a b element, and another to check for it's existence.\n\n @example\n   b(:bold, :id => 'title')\n   # will generate 'bold', 'bold_element', and 'bold?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a b.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of a i element, another to\n retrieve a i element, and another to check for it's existence.\n\n @example\n   i(:italic, :id => 'title')\n   # will generate 'italic', 'italic_element', and 'italic?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Hash] identifier how we find a i.\n @param optional block to be invoked when element method is called", "adds three methods - one to retrieve the text of an element, another\n to retrieve an element, and another to check the element's existence.\n\n @example\n   element(:title, :header, :id => 'title')\n   # will generate 'title', 'title_element', and 'title?' methods\n\n @param [Symbol] the name used for the generated methods\n @param [Symbol] the name of the tag for the element\n @param [Hash] identifier how we find an element.\n @param optional block to be invoked when element method is called", "adds a method to return a collection of generic Element objects\n for a specific tag.\n\n @example\n   elements(:title, :header, :id => 'title')\n   # will generate ''title_elements'\n\n @param [Symbol] the name used for the generated methods\n @param [Symbol] the name of the tag for the element\n @param [Hash] identifier how we find an element.\n @param optional block to be invoked when element method is called", "adds a method to return a page object rooted at an element\n\n @example\n   page_section(:navigation_bar, NavigationBar, :id => 'nav-bar')\n   # will generate 'navigation_bar'\n\n @param [Symbol] the name used for the generated methods\n @param [Class] the class to instantiate for the element\n @param [Hash] identifier how we find an element.", "adds a method to return a collection of page objects rooted at elements\n\n @example\n   page_sections(:articles, Article, :class => 'article')\n   # will generate 'articles'\n\n @param [Symbol] the name used for the generated method\n @param [Class] the class to instantiate for each element\n @param [Hash] identifier how we find an element.", "Create a page object.\n\n @param [PageObject, String]  a class that has included the PageObject module or a string containing the name of the class\n @param Hash values that is pass through to page class a\n available in the @params instance variable.\n @param [Boolean]  a boolean indicating if the page should be visited?  default is false.\n @param [block]  an optional block to be called\n @return [PageObject] the newly created page object", "Create a page object if and only if the current page is the same page to be created\n\n @param [PageObject, String]  a class that has included the PageObject module or a string containing the name of the class\n @param Hash values that is pass through to page class a\n available in the @params instance variable.\n @param [block]  an optional block to be called\n @return [PageObject] the newly created page object", "Handles requests for Hash values. Others cause an Exception to be raised.\n @param [Symbol|String] m method symbol\n @return [Boolean] the value of the specified instance variable.\n @raise [ArgumentError] if an argument is given. Zero arguments expected.\n @raise [NoMethodError] if the instance variable is not defined.", "Process `css` and return result.\n\n Options can be:\n * `from` with input CSS file name. Will be used in error messages.\n * `to` with output CSS file name.\n * `map` with true to generate new source map or with previous map.", "Parse Browserslist config", "Convert ruby_options to jsOptions", "Try to find Browserslist config", "Lazy load for JS library", "Cache autoprefixer.js content", "Construct a new record\n\n licenses - a string, or array of strings, representing the content of each license\n notices - a string, or array of strings, representing the content of each legal notice\n metadata - a Hash of the metadata for the package\n Save the metadata and text to a file\n\n filename - The destination file to save record contents at", "Returns the license text content from all matched sources\n except the package file, which doesn't contain license text.", "Returns legal notices found at the dependency path", "Returns the sources for a group of license file contents\n\n Sources are returned as a single string with sources separated by \", \"", "Returns an array of enabled app sources", "Returns whether a source type is enabled", "Authenticate a record using cookies. Looks for a cookie corresponding to\n the _authenticatable_class_. If found try to find it in the database.\n @param authenticatable_class [ActiveRecord::Base] any Model connected to\n   passwordless. (e.g - _User_ or _Admin_).\n @return [ActiveRecord::Base|nil] an instance of Model found by id stored\n   in cookies.encrypted or nil if nothing is found.\n @see ModelHelpers#passwordless_with", "Signs in user by assigning their id to a permanent cookie.\n @param authenticatable [ActiveRecord::Base] Instance of Model to sign in\n   (e.g - @user when @user = User.find(id: some_id)).\n @return [ActiveRecord::Base] the record that is passed in.", "Signs out user by deleting their encrypted cookie.\n @param (see #authenticate_by_cookie)\n @return [boolean] Always true", "Sends an arbitrary count for the given stat to the statsd server.\n\n @param [String] stat stat name\n @param [Integer] count count\n @param [Hash] opts the options to create the metric with\n @option opts [Numeric] :sample_rate sample rate, 1 for always\n @option opts [Array<String>] :tags An array of tags", "Sends an arbitary gauge value for the given stat to the statsd server.\n\n This is useful for recording things like available disk space,\n memory usage, and the like, which have different semantics than\n counters.\n\n @param [String] stat stat name.\n @param [Numeric] value gauge value.\n @param [Hash] opts the options to create the metric with\n @option opts [Numeric] :sample_rate sample rate, 1 for always\n @option opts [Array<String>] :tags An array of tags\n @example Report the current user count:\n   $statsd.gauge('user.count', User.count)", "Sends a value to be tracked as a histogram to the statsd server.\n\n @param [String] stat stat name.\n @param [Numeric] value histogram value.\n @param [Hash] opts the options to create the metric with\n @option opts [Numeric] :sample_rate sample rate, 1 for always\n @option opts [Array<String>] :tags An array of tags\n @example Report the current user count:\n   $statsd.histogram('user.count', User.count)", "Sends a value to be tracked as a set to the statsd server.\n\n @param [String] stat stat name.\n @param [Numeric] value set value.\n @param [Hash] opts the options to create the metric with\n @option opts [Numeric] :sample_rate sample rate, 1 for always\n @option opts [Array<String>] :tags An array of tags\n @example Record a unique visitory by id:\n   $statsd.set('visitors.uniques', User.id)", "This method allows you to send custom service check statuses.\n\n @param [String] name Service check name\n @param [String] status Service check status.\n @param [Hash] opts the additional data about the service check\n @option opts [Integer, nil] :timestamp (nil) Assign a timestamp to the event. Default is now when none\n @option opts [String, nil] :hostname (nil) Assign a hostname to the event.\n @option opts [Array<String>, nil] :tags (nil) An array of tags\n @option opts [String, nil] :message (nil) A message to associate with this service check status\n @example Report a critical service check status\n   $statsd.service_check('my.service.check', Statsd::CRITICAL, :tags=>['urgent'])", "This end point allows you to post events to the stream. You can tag them, set priority and even aggregate them with other events.\n\n Aggregation in the stream is made on hostname/event_type/source_type/aggregation_key.\n If there's no event type, for example, then that won't matter;\n it will be grouped with other events that don't have an event type.\n\n @param [String] title Event title\n @param [String] text Event text. Supports newlines (+\\n+)\n @param [Hash] opts the additional data about the event\n @option opts [Integer, nil] :date_happened (nil) Assign a timestamp to the event. Default is now when none\n @option opts [String, nil] :hostname (nil) Assign a hostname to the event.\n @option opts [String, nil] :aggregation_key (nil) Assign an aggregation key to the event, to group it with some others\n @option opts [String, nil] :priority ('normal') Can be \"normal\" or \"low\"\n @option opts [String, nil] :source_type_name (nil) Assign a source type to the event\n @option opts [String, nil] :alert_type ('info') Can be \"error\", \"warning\", \"info\" or \"success\".\n @option opts [Array<String>] :tags tags to be added to every metric\n @example Report an awful event:\n   $statsd.event('Something terrible happened', 'The end is near if we do nothing', :alert_type=>'warning', :tags=>['end_of_times','urgent'])", "For every `redirect_from` entry, generate a redirect page", "Helper function to set the appropriate path metadata\n\n from - the relative path to the redirect page\n to   - the relative path or absolute URL to the redirect target", "Compile some ruby code to a string.\n\n @return [String] javascript code", "Used to generate a unique id name per file. These are used\n mainly to name method bodies for methods that use blocks.", "Process the given sexp by creating a node instance, based on its type,\n and compiling it to fragments.", "The last sexps in method bodies, for example, need to be returned\n in the compiled javascript. Due to syntax differences between\n javascript any ruby, some sexps need to be handled specially. For\n example, `if` statemented cannot be returned in javascript, so\n instead the \"truthy\" and \"falsy\" parts of the if statement both\n need to be returned instead.\n\n Sexps that need to be returned are passed to this method, and the\n alterned/new sexps are returned and should be used instead. Most\n sexps can just be added into a `s(:return) sexp`, so that is the\n default action if no special case is required.", "This method is called when a parse error is found.\n\n ERROR_TOKEN_ID is an internal ID of token which caused error.\n You can get string representation of this ID by calling\n #token_to_str.\n\n ERROR_VALUE is a value of error token.\n\n value_stack is a stack of symbol values.\n DO NOT MODIFY this object.\n\n This method raises ParseError by default.\n\n If this method returns, parsers enter \"error recovering mode\".", "For debugging output", "Returns a new Tms object obtained by memberwise operation +op+\n of the individual times for this Tms object with those of the other\n Tms object.\n\n +op+ can be a mathematical operation such as <tt>+</tt>, <tt>-</tt>,\n <tt>*</tt>, <tt>/</tt>", "Defines a new configuration option\n\n @param [String] name the option name\n @param [Object] default_value the option's default value\n @!macro [attach] property\n   @!attribute [rw] $1", "Reads and returns Float from an input stream\n\n @example\n   123.456\n Is encoded as\n   'f', '123.456'", "Reads and returns Bignum from an input stream", "Reads and returns Regexp from an input stream\n\n @example\n   r = /regexp/mix\n is encoded as\n   '/', 'regexp', r.options.chr", "Reads and returns a Struct from an input stream\n\n @example\n   Point = Struct.new(:x, :y)\n   Point.new(100, 200)\n is encoded as\n   'S', :Point, {:x => 100, :y => 200}", "Reads and returns a Class from an input stream\n\n @example\n   String\n is encoded as\n   'c', 'String'", "Reads and returns a Module from an input stream\n\n @example\n   Kernel\n is encoded as\n   'm', 'Kernel'", "Reads and returns an abstract object from an input stream\n\n @example\n   obj = Object.new\n   obj.instance_variable_set(:@ivar, 100)\n   obj\n is encoded as\n   'o', :Object, {:@ivar => 100}\n\n The only exception is a Range class (and its subclasses)\n For some reason in MRI isntances of this class have instance variables\n - begin\n - end\n - excl\n without '@' perfix.", "Reads an object that was dynamically extended before marshaling like\n\n @example\n   M1 = Module.new\n   M2 = Module.new\n   obj = Object.new\n   obj.extend(M1)\n   obj.extend(M2)\n   obj\n is encoded as\n   'e', :M2, :M1, obj", "Collects object allocation and memory of ruby code inside of passed block.", "Iterates through objects in memory of a given generation.\n Stores results along with meta data of objects collected.", "Output the results of the report\n @param [Hash] options the options for output\n @option opts [String] :to_file a path to your log file\n @option opts [Boolean] :color_output a flag for whether to colorize output\n @option opts [Integer] :retained_strings how many retained strings to print\n @option opts [Integer] :allocated_strings how many allocated strings to print\n @option opts [Boolean] :detailed_report should report include detailed information\n @option opts [Boolean] :scale_bytes calculates unit prefixes for the numbers of bytes", "Copy from origin to destination in chunks of size `stride`.\n Use the `throttler` class to sleep between each stride.", "Rename an existing column.\n\n @example\n\n   Lhm.change_table(:users) do |m|\n     m.rename_column(:login, :username)\n   end\n\n @param [String] old Name of the column to change\n @param [String] nu New name to use for the column", "Remove an index from a table\n\n @example\n\n   Lhm.change_table(:users) do |m|\n     m.remove_index(:comment)\n     m.remove_index([:username, :created_at])\n   end\n\n @param [String, Symbol, Array<String, Symbol>] columns\n   A column name given as String or Symbol. An Array of Strings or Symbols\n   for compound indexes.\n @param [String, Symbol] index_name\n   Optional name of the index to be removed", "Set up the queues for each of the worker's consumers.", "Bind a consumer's routing keys to its queue, and set up a subscription to\n receive messages sent to the queue.", "Called internally when a new messages comes in from RabbitMQ. Responsible\n for wrapping up the message and passing it to the consumer.", "Set up the connection to the RabbitMQ management API. Unfortunately, this\n is necessary to do a few things that are impossible over AMQP. E.g.\n listing queues and bindings.", "Return a mapping of queue names to the routing keys they're bound to.", "Find the existing bindings, and unbind any redundant bindings", "Bind a queue to the broker's exchange on the routing keys provided. Any\n existing bindings on the queue that aren't present in the array of\n routing keys will be unbound.", "Run a Hutch worker with the command line interface.", "Returns true if the bounds contain the passed point.\n allows for bounds which cross the meridian", "Returns a comma-delimited string consisting of the street address, city,\n state, zip, and country code.  Only includes those attributes that are\n non-blank.", "Builds nested hash structure using the scope returned from the passed in scope", "Find or create a descendant node whose +ancestry_path+ will be ```self.ancestry_path + path```", "Uses Rails auto_link to add links to fields\n\n @param field [String,Hash] string to format and escape, or a hash as per helper_method\n @option field [SolrDocument] :document\n @option field [String] :field name of the solr field\n @option field [Blacklight::Configuration::IndexField, Blacklight::Configuration::ShowField] :config\n @option field [Array] :value array of values for the field\n @param show_link [Boolean]\n @return [ActiveSupport::SafeBuffer]\n @todo stop being a helper_method, start being part of the Blacklight render stack?", "Returns an array of users sorted by the date of their last stats update. Users that have not been recently updated\n will be at the top of the array.", "This method never fails. It tries multiple times and finally logs the exception", "Removes a single lease", "Compute the sum of each file in the collection using Solr to\n avoid having to access Fedora\n\n @return [Fixnum] size of collection in bytes\n @raise [RuntimeError] unsaved record does not exist in solr", "Calculate the size of all the files in the work\n @param work_id [String] identifer for a work\n @return [Integer] the size in bytes", "This performs a two pass query, first getting the AdminSets\n and then getting the work and file counts\n @param [Symbol] access :read or :edit\n @param join_field [String] how are we joining the admin_set ids (by default \"isPartOf_ssim\")\n @return [Array<Hyrax::AdminSetService::SearchResultForWorkCount>] a list with document, then work and file count", "Count number of files from admin set works\n @param [Array] AdminSets to count files in\n @return [Hash] admin set id keys and file count values", "Registers the given curation concern model in the configuration\n @param [Array<Symbol>,Symbol] curation_concern_types", "Return AdminSet selectbox options based on access type\n @param [Symbol] access :deposit, :read, or :edit", "Create a hash of HTML5 'data' attributes. These attributes are added to select_options and\n later utilized by Javascript to limit new Work options based on AdminSet selected", "Does the workflow for the currently selected permission template allow sharing?", "Handle the HTTP show request", "render an HTTP Range response", "Creates an admin set, setting the creator and the default access controls.\n @return [TrueClass, FalseClass] true if it was successful", "Gives deposit access to registered users to default AdminSet", "Given a deeply nested hash, return a single hash", "These are the file sets that belong to this work, but not necessarily\n in order.\n Arbitrarily maxed at 10 thousand; had to specify rows due to solr's default of 10", "Namespaces routes appropriately\n @example namespaced_resources(\"hyrax/my_work\") is equivalent to\n   namespace \"hyrax\", path: :concern do\n     resources \"my_work\", except: [:index]\n   end", "IIIF metadata for inclusion in the manifest\n  Called by the `iiif_manifest` gem to add metadata\n\n @return [Array] array of metadata hashes", "list of item ids to display is based on ordered_ids", "Uses kaminari to paginate an array to avoid need for solr documents for items here", "add hidden fields to a form for performing an action on a single document on a collection", "Finds a solr document matching the id and sets @presenter\n @raise CanCan::AccessDenied if the document is not found or the user doesn't have access to it.", "Only returns unsuppressed documents the user has read access to", "Add uploaded_files to the parameters received by the actor.", "Build a rendering hash\n\n @return [Hash] rendering", "For use with javascript user selector that allows for searching for an existing user\n and granting them permission to an object.\n @param [User] user to select\n @param [String] role granting the user permission (e.g. 'Manager' | 'Depositor' | 'Viewer')", "For use with javascript collection selector that allows for searching for an existing collection from works relationship tab.\n Adds the collection and validates that the collection is listed in the Collection Relationship table once added.\n @param [Collection] collection to select", "For use with javascript collection selector that allows for searching for an existing collection from add to collection modal.\n Does not save the selection.  The calling test is expected to click Save and validate the collection membership was added to the work.\n @param [Collection] collection to select", "Creates a display image only where FileSet is an image.\n\n @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.", "Retrieve or generate the fixity check for a specific version of a file\n @param [String] file_id used to find the file within its parent object (usually \"original_file\")\n @param [String] version_uri the version to be fixity checked (or the file uri for non-versioned files)", "Check if time since the last fixity check is greater than the maximum days allowed between fixity checks\n @param [ChecksumAuditLog] latest_fixity_check the most recent fixity check", "Removes a single embargo", "Updates a batch of embargos", "Write the workflow roles and state so one can see where the document moves to next\n @param [Hash] solr_document the solr document to add the field to", "Give workflow responsibilites to the provided agents for the given role\n @param [Sipity::Role] role\n @param [Array<Sipity::Agent>] agents", "Find any workflow_responsibilities held by agents not in the allowed_agents\n and remove them\n @param [Sipity::Role] role\n @param [Array<Sipity::Agent>] allowed_agents", "Present the attribute as an HTML table row or dl row.\n\n @param [Hash] options\n @option options [Symbol] :render_as use an alternate renderer\n   (e.g., :linked or :linked_attribute to use LinkedAttributeRenderer)\n @option options [String] :search_field If the method_name of the attribute is different than\n   how the attribute name should appear on the search URL,\n   you can explicitly set the URL's search field name\n @option options [String] :label The default label for the field if no translation is found\n @option options [TrueClass, FalseClass] :include_empty should we display a row if there are no values?\n @option options [String] :work_type name of work type class (e.g., \"GenericWork\")", "We're overiding the default indexer in order to index the RDF labels. In order\n for this to be called, you must specify at least one default indexer on the property.\n @param [Hash] solr_doc\n @param [String] solr_field_key\n @param [Hash] field_info\n @param [ActiveTriples::Resource, String] val", "Grab the labels for controlled properties from the remote sources", "Use this method to append a string value from a controlled vocabulary field\n to the solr document. It just puts a copy into the corresponding label field\n @param [Hash] solr_doc\n @param [String] solr_field_key\n @param [Hash] field_info\n @param [String] val", "includes the depositor_facet to get information on deposits.\n use caution when combining this with other searches as it sets the rows to\n zero to just get the facet information\n @param solr_parameters the current solr parameters", "Display user profile", "Query solr using POST so that the query doesn't get too large for a URI", "Adds a value to the end of a list identified by key", "Roll up messages for an operation and all of its children", "Mark this operation as a FAILURE. If this is a child operation, roll up to\n the parent any failures.\n\n @param [String, nil] message record any failure message\n @see Hyrax::Operation::FAILURE\n @see #rollup_status\n @note This will run any registered :failure callbacks\n @todo Where are these callbacks defined? Document this", "Sets the operation status to PENDING\n @param [#class, #job_id] job - The job associated with this operation\n @see Hyrax::Operation::PENDING", "Renders a JSON response with a list of files in this admin set.\n This is used by the edit form to populate the thumbnail_id dropdown", "In the context of a Valkyrie resource, prefer to use the id if it\n is provided and fallback to the first of the alternate_ids. If all else fails\n then the id hasn't been minted and shouldn't yet be set.\n @return [String]", "Add attributes from resource which aren't AF properties into af_object", "For the Managed Collections tab, determine the label to use for the level of access the user has for this admin set.\n Checks from most permissive to most restrictive.\n @return String the access label (e.g. Manage, Deposit, View)", "Return the Global Identifier for this collection type.\n @return [String] Global Identifier (gid) for this collection_type (e.g. gid://internal/hyrax-collectiontype/3)", "Override release_date getter to return a dynamically calculated date of release\n based one release requirements. Returns embargo date when release_max_embargo?==true.\n Returns today's date when release_no_delay?==true.\n @see Hyrax::AdminSetService for usage", "Grant all users with read or edit access permission to download", "We check based on the depositor, because the depositor may not have edit\n access to the work if it went through a mediated deposit workflow that\n removes edit access for the depositor.", "Returns true if the current user is the depositor of the specified work\n @param document_id [String] the id of the document.", "Returns an array of characterization values truncated to 250 characters limited\n to the maximum number of configured values.\n @param [Symbol] term found in the characterization_metadata hash\n @return [Array] of truncated values", "Returns an array of characterization values truncated to 250 characters that are in\n excess of the maximum number of configured values.\n @param [Symbol] term found in the characterization_metadata hash\n @return [Array] of truncated values", "Retrieve search results of the given object type\n\n Permissions: (for people search only) r_network\n\n @note People Search API is a part of the Vetted API Access Program. You\n   must apply and get approval before using this API\n\n @see http://developer.linkedin.com/documents/people-search-api People Search\n @see http://developer.linkedin.com/documents/job-search-api Job Search\n @see http://developer.linkedin.com/documents/company-search Company Search\n\n @param [Hash] options search input fields\n @param [String] type type of object to return ('people', 'job' or 'company')\n @return [LinkedIn::Mash]", "Convert the 'timestamp' field from a string to a Time object\n\n @return [Time]", "this skips manifests sometimes because it doesn't look at file\n contents and can't establish from only regexes that the thing\n is a manifest. We exclude rather than include ambiguous filenames\n because this API is used by libraries.io and we don't want to\n download all .xml files from GitHub.", "Returns the object in the form of hash\n @return [Hash] Returns the object in the form of hash", "Outputs non-array value in the form of hash\n For object, use to_hash. Otherwise, just return the value\n @param [Object] value Any valid value\n @return [Hash] Returns the value in the form of hash", "Extract batch_token from Link header if present\n @param [Hash] headers hash with response headers\n @return [String] batch_token or nil if no token is present", "ListCashDrawerShifts\n Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.\n @param location_id The ID of the location to list cash drawer shifts for.\n @param [Hash] opts the optional parameters\n @option opts [String] :order The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC\n @option opts [String] :begin_time The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days.\n @option opts [String] :end_time The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time.\n @return [Array<V1CashDrawerShift>]", "RetrieveCashDrawerShift\n Provides the details for a single cash drawer shift, including all events that occurred during the shift.\n @param location_id The ID of the location to list cash drawer shifts for.\n @param shift_id The shift&#39;s ID.\n @param [Hash] opts the optional parameters\n @return [V1CashDrawerShift]", "RetrieveEmployee\n Provides the details for a single employee.\n @param employee_id The employee&#39;s ID.\n @param [Hash] opts the optional parameters\n @return [V1Employee]", "RetrieveEmployeeRole\n Provides the details for a single employee role.\n @param role_id The role&#39;s ID.\n @param [Hash] opts the optional parameters\n @return [V1EmployeeRole]", "UpdateEmployeeRole\n Modifies the details of an employee role.\n @param role_id The ID of the role to modify.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1EmployeeRole]", "UpdateTimecard\n Modifies the details of a timecard with an `API_EDIT` event for the timecard. Updating an active timecard with a `clockout_time` clocks the employee out.\n @param timecard_id TThe ID of the timecard to modify.\n @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Timecard]", "CreateCustomerCard\n Adds a card on file to an existing customer.  As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call.  Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged.\n @param customer_id The ID of the customer to link the card on file to.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [CreateCustomerCardResponse]", "DeleteCustomer\n Deletes a customer from a business, along with any linked cards on file. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to delete merged profiles.\n @param customer_id The ID of the customer to delete.\n @param [Hash] opts the optional parameters\n @return [DeleteCustomerResponse]", "DeleteCustomerCard\n Removes a card on file from a customer.\n @param customer_id The ID of the customer that the card on file belongs to.\n @param card_id The ID of the card on file to delete.\n @param [Hash] opts the optional parameters\n @return [DeleteCustomerCardResponse]", "RetrieveCustomer\n Returns details for a single customer.\n @param customer_id The ID of the customer to retrieve.\n @param [Hash] opts the optional parameters\n @return [RetrieveCustomerResponse]", "SearchCustomers\n Searches the customer profiles associated with a Square account. Calling SearchCustomers without an explicit query parameter returns all customer profiles ordered alphabetically based on `given_name` and `family_name`.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [SearchCustomersResponse]", "AdjustInventory\n Adjusts an item variation's current available inventory.\n @param location_id The ID of the item&#39;s associated location.\n @param variation_id The ID of the variation to adjust inventory information for.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1InventoryEntry]", "ApplyFee\n Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.\n @param location_id The ID of the fee&#39;s associated location.\n @param item_id The ID of the item to add the fee to.\n @param fee_id The ID of the fee to apply.\n @param [Hash] opts the optional parameters\n @return [V1Item]", "ApplyModifierList\n Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.\n @param location_id The ID of the item&#39;s associated location.\n @param modifier_list_id The ID of the modifier list to apply.\n @param item_id The ID of the item to add the modifier list to.\n @param [Hash] opts the optional parameters\n @return [V1Item]", "CreateCategory\n Creates an item category.\n @param location_id The ID of the location to create an item for.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Category]", "CreateDiscount\n Creates a discount.\n @param location_id The ID of the location to create an item for.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Discount]", "CreateItem\n Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system.  When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity.  Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters.\n @param location_id The ID of the location to create an item for.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Item]", "CreateModifierList\n Creates an item modifier list and at least one modifier option for it.\n @param location_id The ID of the location to create a modifier list for.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1ModifierList]", "CreateModifierOption\n Creates an item modifier option and adds it to a modifier list.\n @param location_id The ID of the item&#39;s associated location.\n @param modifier_list_id The ID of the modifier list to edit.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1ModifierOption]", "CreatePage\n Creates a Favorites page in Square Register.\n @param location_id The ID of the location to create an item for.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Page]", "CreateVariation\n Creates an item variation for an existing item.\n @param location_id The ID of the item&#39;s associated location.\n @param item_id The item&#39;s ID.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Variation]", "ListCategories\n Lists all of a location's item categories.\n @param location_id The ID of the location to list categories for.\n @param [Hash] opts the optional parameters\n @return [Array<V1Category>]", "ListDiscounts\n Lists all of a location's discounts.\n @param location_id The ID of the location to list categories for.\n @param [Hash] opts the optional parameters\n @return [Array<V1Discount>]", "ListInventory\n Provides inventory information for all of a merchant's inventory-enabled item variations.\n @param location_id The ID of the item&#39;s associated location.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.\n @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.\n @return [Array<V1InventoryEntry>]", "ListItems\n Provides summary information for all of a location's items.\n @param location_id The ID of the location to list items for.\n @param [Hash] opts the optional parameters\n @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.\n @return [Array<V1Item>]", "ListModifierLists\n Lists all of a location's modifier lists.\n @param location_id The ID of the location to list modifier lists for.\n @param [Hash] opts the optional parameters\n @return [Array<V1ModifierList>]", "ListPages\n Lists all of a location's Favorites pages in Square Register.\n @param location_id The ID of the location to list Favorites pages for.\n @param [Hash] opts the optional parameters\n @return [Array<V1Page>]", "RemoveFee\n Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.\n @param location_id The ID of the fee&#39;s associated location.\n @param item_id The ID of the item to add the fee to.\n @param fee_id The ID of the fee to apply.\n @param [Hash] opts the optional parameters\n @return [V1Item]", "RemoveModifierList\n Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.\n @param location_id The ID of the item&#39;s associated location.\n @param modifier_list_id The ID of the modifier list to remove.\n @param item_id The ID of the item to remove the modifier list from.\n @param [Hash] opts the optional parameters\n @return [V1Item]", "RetrieveItem\n Provides the details for a single item, including associated modifier lists and fees.\n @param location_id The ID of the item&#39;s associated location.\n @param item_id The item&#39;s ID.\n @param [Hash] opts the optional parameters\n @return [V1Item]", "RetrieveModifierList\n Provides the details for a single modifier list.\n @param location_id The ID of the item&#39;s associated location.\n @param modifier_list_id The modifier list&#39;s ID.\n @param [Hash] opts the optional parameters\n @return [V1ModifierList]", "UpdateCategory\n Modifies the details of an existing item category.\n @param location_id The ID of the category&#39;s associated location.\n @param category_id The ID of the category to edit.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Category]", "UpdateDiscount\n Modifies the details of an existing discount.\n @param location_id The ID of the category&#39;s associated location.\n @param discount_id The ID of the discount to edit.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Discount]", "UpdateItem\n Modifies the core details of an existing item.\n @param location_id The ID of the item&#39;s associated location.\n @param item_id The ID of the item to modify.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Item]", "UpdateModifierList\n Modifies the details of an existing item modifier list.\n @param location_id The ID of the item&#39;s associated location.\n @param modifier_list_id The ID of the modifier list to edit.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1ModifierList]", "UpdateModifierOption\n Modifies the details of an existing item modifier option.\n @param location_id The ID of the item&#39;s associated location.\n @param modifier_list_id The ID of the modifier list to edit.\n @param modifier_option_id The ID of the modifier list to edit.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1ModifierOption]", "UpdatePage\n Modifies the details of a Favorites page in Square Register.\n @param location_id The ID of the Favorites page&#39;s associated location\n @param page_id The ID of the page to modify.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Page]", "UpdatePageCell\n Modifies a cell of a Favorites page in Square Register.\n @param location_id The ID of the Favorites page&#39;s associated location.\n @param page_id The ID of the page the cell belongs to.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Page]", "UpdateVariation\n Modifies the details of an existing item variation.\n @param location_id The ID of the item&#39;s associated location.\n @param item_id The ID of the item to modify.\n @param variation_id The ID of the variation to modify.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [V1Variation]", "DeleteBreakType\n Deletes an existing `BreakType`.   A `BreakType` can be deleted even if it is referenced from a `Shift`.\n @param id UUID for the &#x60;BreakType&#x60; being deleted.\n @param [Hash] opts the optional parameters\n @return [DeleteBreakTypeResponse]", "DeleteShift\n Deletes a `Shift`.\n @param id UUID for the &#x60;Shift&#x60; being deleted.\n @param [Hash] opts the optional parameters\n @return [DeleteShiftResponse]", "GetBreakType\n Returns a single `BreakType` specified by id.\n @param id UUID for the &#x60;BreakType&#x60; being retrieved.\n @param [Hash] opts the optional parameters\n @return [GetBreakTypeResponse]", "GetEmployeeWage\n Returns a single `EmployeeWage` specified by id.\n @param id UUID for the &#x60;EmployeeWage&#x60; being retrieved.\n @param [Hash] opts the optional parameters\n @return [GetEmployeeWageResponse]", "GetShift\n Returns a single `Shift` specified by id.\n @param id UUID for the &#x60;Shift&#x60; being retrieved.\n @param [Hash] opts the optional parameters\n @return [GetShiftResponse]", "UpdateBreakType\n Updates an existing `BreakType`.\n @param id UUID for the &#x60;BreakType&#x60; being updated.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [UpdateBreakTypeResponse]", "UpdateShift\n Updates an existing `Shift`.   When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift` have  the `end_at` property set to a valid RFC-3339 datetime string.   When closing a `Shift`, all `Break` instances in the shift must be complete with `end_at` set on each `Break`.\n @param id ID of the object being updated.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [UpdateShiftResponse]", "UpdateWorkweekConfig\n Updates a `WorkweekConfig`.\n @param id UUID for the &#x60;WorkweekConfig&#x60; object being updated.\n @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.\n @param [Hash] opts the optional parameters\n @return [UpdateWorkweekConfigResponse]", "RetrieveTransaction\n Retrieves details for a single transaction.\n @param location_id The ID of the transaction&#39;s associated location.\n @param transaction_id The ID of the transaction to retrieve.\n @param [Hash] opts the optional parameters\n @return [RetrieveTransactionResponse]", "ListBankAccounts\n Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.\n @param location_id The ID of the location to list bank accounts for.\n @param [Hash] opts the optional parameters\n @return [Array<V1BankAccount>]", "ListOrders\n Provides summary information for a merchant's online store orders.\n @param location_id The ID of the location to list online store orders for.\n @param [Hash] opts the optional parameters\n @option opts [String] :order TThe order in which payments are listed in the response.\n @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.\n @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.\n @return [Array<V1Order>]", "RetrieveBankAccount\n Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.\n @param location_id The ID of the bank account&#39;s associated location.\n @param bank_account_id The bank account&#39;s Square-issued ID. You obtain this value from Settlement objects returned.\n @param [Hash] opts the optional parameters\n @return [V1BankAccount]", "RetrieveOrder\n Provides comprehensive information for a single online store order, including the order's history.\n @param location_id The ID of the order&#39;s associated location.\n @param order_id The order&#39;s Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint\n @param [Hash] opts the optional parameters\n @return [V1Order]", "RetrievePayment\n Provides comprehensive information for a single payment.\n @param location_id The ID of the payment&#39;s associated location.\n @param payment_id The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.\n @param [Hash] opts the optional parameters\n @return [V1Payment]", "View helper for rendering many activities", "Adds or redefines a parameter\n @param  [Symbol]       name\n @param  [#call, nil]   type (nil)\n @option opts [Proc]    :default\n @option opts [Boolean] :optional\n @option opts [Symbol]  :as\n @option opts [true, false, :protected, :public, :private] :reader\n @return [self] itself", "Human-readable representation of configured params and options\n @return [String]", "Returns a version of the module with custom settings\n @option settings [Boolean] :undefined\n   If unassigned params and options should be treated different from nil\n @return [Dry::Initializer]", "Returns mixin module to be included to target class by hand\n @return [Module]\n @yield proc defining params and options", "class AndroidElements\n Android only.\n Returns a string containing interesting elements.\n The text, content description, and id are returned.\n @param class_name [String] the class name to filter on.\n if false (default) then all classes will be inspected\n @return [String]", "Intended for use with console.\n Inspects and prints the current page.\n Will return XHTML for Web contexts because of a quirk with Nokogiri.\n @option class [Symbol] the class name to filter on. case insensitive include match.\n if nil (default) then all classes will be inspected\n @return [void]", "Find the element of type class_name at matching index.\n @param class_name [String] the class name to find\n @param index [Integer] the index\n @return [Element] the found element of type class_name", "Returns a hash of the driver attributes", "Returns the server's version info\n\n @example\n   {\n     \"build\" => {\n         \"version\" => \"0.18.1\",\n         \"revision\" => \"d242ebcfd92046a974347ccc3a28f0e898595198\"\n     }\n   }\n\n @return [Hash]", "Creates a new global driver and quits the old one if it exists.\n You can customise http_client as the following\n\n Read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device to understand more what the driver\n can call instance methods.\n\n @example\n\n   require 'rubygems'\n   require 'appium_lib'\n\n   # platformName takes a string or a symbol.\n   # Start iOS driver\n   opts = {\n            caps: {\n              platformName: :ios,\n              app: '/path/to/MyiOS.app'\n            },\n            appium_lib: {\n              wait_timeout: 30\n            }\n          }\n   appium_driver = Appium::Driver.new(opts) #=> return an Appium::Driver instance\n   appium_driver.start_driver #=> return an Appium::Core::Base::Driver\n\n @option http_client_ops [Hash] :http_client Custom HTTP Client\n @option http_client_ops [Hash] :open_timeout Custom open timeout for http client.\n @option http_client_ops [Hash] :read_timeout Custom read timeout for http client.\n @return [Selenium::WebDriver] the new global driver", "To ignore error for Espresso Driver", "Returns existence of element.\n\n Example:\n\n exists { button('sign in') } ? puts('true') : puts('false')\n\n @param [Integer] pre_check The amount in seconds to set the\n                             wait to before checking existence\n @param [Integer] post_check The amount in seconds to set the\n                             wait to after checking existence\n @yield The block to call\n @return [Boolean]", "Find the last TextField.\n @return [TextField]", "Converts pixel values to window relative values\n\n @example\n\n   px_to_window_rel x: 50, y: 150 #=> #<OpenStruct x=\"50.0 / 375.0\", y=\"150.0 / 667.0\">", "Search strings.xml's values for target.\n @param target [String] the target to search for in strings.xml values\n @return [Array]", "Search strings.xml's keys for target.\n @param target [String] the target to search for in strings.xml keys\n @return [Array]", "backward compatibility\n Find the first button that contains value or by index.\n @param value [String, Integer] the value to exactly match.\n If int then the button at that index is returned.\n @return [BUTTON]", "Find the last button.\n @return [BUTTON]", "Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.\n @param value [String, Integer] the value to find.\n If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.\n @return [UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]", "Scroll to the first element containing target text or description.\n @param text [String] the text or resourceId to search for in the text value and content description\n @param scrollable_index [Integer] the index for scrollable views.\n @return [Element] the element scrolled to", "Prints a string of interesting elements to the console.\n\n @example\n     ```ruby\n     page class: :UIAButton # filter on buttons\n     page class: :UIAButton, window: 1\n     ```\n\n @option visible [Symbol] visible value to filter on\n @option class [Symbol] class name to filter on\n\n @return [void]", "Get the element of type class_name at matching index.\n @param class_name [String] the class name to find\n @param index [Integer] the index\n @return [Element]", "predicate - the predicate to evaluate on the main app\n\n visible - if true, only visible elements are returned. default true", "Check every interval seconds to see if yield returns a truthy value.\n Note this isn't a strict boolean true, any truthy value is accepted.\n false and nil are considered failures.\n Give up after timeout seconds.\n\n Wait code from the selenium Ruby gem\n https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb\n\n If only a number is provided then it's treated as the timeout value.\n\n @param [Hash|Numeric] opts Options. If the value is _Numeric_, the value is set as `{ timeout: value }`\n @option opts [Numeric] :timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).\n @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).\n @option opts [String] :message Exception message if timed out.\n @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)\n\n @example\n\n     wait_true(timeout: 20, interval: 0.2, message: 'custom message') { button_exact('Back') }.click\n     wait_true(20) { button_exact('Back') }.click", "Find the first EditText that contains value or by index.\n @param value [String, Integer] the text to match exactly.\n If int then the EditText at that index is returned.\n @return [EDIT_TEXT]", "Find the first TextView that contains value or by index.\n @param value [String, Integer] the value to find.\n If int then the TextView at that index is returned.\n @return [TextView]", "Find the first UIAButton|XCUIElementTypeButton that contains value or by index.\n @param value [String, Integer] the value to exactly match.\n If int then the UIAButton|XCUIElementTypeButton at that index is returned.\n @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]", "Handles extracting elements from the entry", "specifically handles extracting the preconditions for the population criteria", "extracts out any measure observation definitons, creating from them the proper criteria to generate a precondition", "generates the value given in an expression based on the number of criteria it references.", "Get the conjunction code, ALL_TRUE or AT_LEAST_ONE_TRUE\n @return [String] conjunction code", "Check whether the temporal reference should be marked as inclusive", "Check whether the length of stay should be inclusive.", "Check if are only AnyValue elements for low and high", "If a precondition references a population, remove it", "Extracts the measure observations, will return true if one exists", "Builds populations based an a predfined set of expected populations", "Generate the stratifications of populations, if any exist", "Method to generate the criteria defining a population", "if the data criteria is derived from another criteria, then we want to grab the properties from the derived criteria\n this is typically the case with Occurrence A, Occurrence B type data criteria", "source are things like exceptions or exclusions, target are IPP, or denom\n we want to find any denoms or IPPs that do not have exceptions or exclusions", "create a copy of each submeasre adding on the new values of the given type\n skip the unpaired values.  Unpaired values are denominators without exclusions or populations without exceptions", "Handles setup of the base values of the document, defined here as ones that are either\n  obtained from the xml directly or with limited parsing", "Extracts the code used by a particular attribute", "Extracts the value used by a particular attribute", "For specific occurrence data criteria, make sure the source data criteria reference points\n to the correct source data criteria.", "Set the value and code_list_xpath using the template mapping held in the ValueSetHelper class", "Apply some elements from the reference_criteria to the derived specific occurrence", "grouping data criteria are used to allow a single reference off of a temporal reference or subset operator\n grouping data criteria can reference either regular data criteria as children, or other grouping data criteria", "pull the children data criteria out of a set of preconditions", "this method creates V1 data criteria for the measurement period.  These data criteria can be\n referenced properly within the restrictions", "Generate a list of child criterias", "Extracts all subset operators contained in the entry xml", "Preconditions can have nil conjunctions as part of a DATEDIFF, we want to remove these and warn", "Get the source data criteria that are specific occurrences\n @return [Array] an array of HQMF::DataCriteria describing the data elements used by the measure that are specific occurrences", "Get specific attributes by code.\n @param [String] code the attribute code\n @param [String] code_system the attribute code system\n @return [Array#Attribute] the matching attributes, raises an Exception if not found", "patient characteristics data criteria such as GENDER require looking at the codes to determine if the\n measure is interested in Males or Females.  This process is awkward, and thus is done as a separate\n step after the document has been converted.", "Given a template id, modify the variables inside this data criteria to reflect the template", "Extracts information from a reference for a specific", "Apply additional information to a specific occurrence's elements from the criteria it references.", "If there is no entry type, extract the entry type from what it references, and extract additional information for\n specific occurrences. If there are no outbound references, print an error and mark it as variable.", "Create grouper data criteria for encapsulating variable data criteria\n and update document data criteria list and references map", "Check elements that do not already exist; else, if they do, check if those elements are the same\n in a different, potentially matching, data criteria", "Handle setting the specific and source instance variables with a given occurrence identifier", "Handles elments that can be extracted directly from the xml. Utilises the \"BaseExtractions\" class.", "Duplicates information from a child element to this data criteria if none exits.\n If the duplication requires that come values should be overwritten, do so only in the function calling this.", "Generate the models of the field values", "Generate the title and description used when producing the model", "class << self", "The URL for this Chef Zero server. If the given host is an IPV6 address,\n it is escaped in brackets according to RFC-2732.\n\n @see http://www.ietf.org/rfc/rfc2732.txt RFC-2732\n\n @return [String]", "Start a Chef Zero server in a forked process. This method returns the PID\n to the forked process.\n\n @param [Fixnum] wait\n   the number of seconds to wait for the server to start\n\n @return [Thread]\n   the thread the background process is running in", "Gracefully stop the Chef Zero server.\n\n @param [Fixnum] wait\n   the number of seconds to wait before raising force-terminating the\n   server", "Serializes `data` to JSON and returns an Array with the\n response code, HTTP headers and JSON body.\n\n @param [Fixnum] response_code HTTP response code\n @param [Hash] data The data for the response body as a Hash\n @param [Hash] options\n @option options [Hash] :headers (see #already_json_response)\n @option options [Boolean] :pretty (true) Pretty-format the JSON\n @option options [Fixnum] :request_version (see #already_json_response)\n @option options [Fixnum] :response_version (see #already_json_response)\n\n @return (see #already_json_response)", "Returns an Array with the response code, HTTP headers, and JSON body.\n\n @param [Fixnum] response_code The HTTP response code\n @param [String] json_text The JSON body for the response\n @param [Hash] options\n @option options [Hash] :headers ({}) HTTP headers (may override default headers)\n @option options [Fixnum] :request_version (0) Request API version\n @option options [Fixnum] :response_version (0) Response API version\n\n @return [Array(Fixnum, Hash{String => String}, String)]", "To be called from inside rest endpoints", "Processes SASL connection params and returns a hash with symbol keys or a nil", "Map states to symbols", "Async fetch results from an async execute", "Pull rows from the query result", "Raises an exception if given operation result is a failure", "this will clean up when we officially deprecate", "produces a printf formatter line for an array of items\n if an individual line item is an array, it will create columns\n that are lined-up\n\n line_formatter([\"foo\", \"barbaz\"])                 # => \"%-6s\"\n line_formatter([\"foo\", \"barbaz\"], [\"bar\", \"qux\"]) # => \"%-3s   %-6s\"", "creates a new StrVal object\n @option options [Array] :data\n @option options [String] :tag_name\n Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.\n @param [Array] values An array of cells or values.", "The relationships for this pivot table.\n @return [Relationships]", "Sets the color for the data bars.\n @param [Color|String] v The color object, or rgb string value to apply", "Serialize this object to an xml string\n @param [String] str\n @return [String]", "Serialize your workbook to disk as an xlsx document.\n\n @param [String] output The name of the file you want to serialize your package to\n @param [Boolean] confirm_valid Validate the package prior to serialization.\n @return [Boolean] False if confirm_valid and validation errors exist. True if the package was serialized\n @note A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents.\n   confirm_valid should be used in the rare case that you cannot open the serialized file.\n @see Package#validate\n @example\n   # This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.\n   # Take a look at the README for an example of how to do it!\n\n   #serialize to a file\n   p = Axlsx::Package.new\n   # ......add cool stuff to your workbook......\n   p.serialize(\"example.xlsx\")\n\n   # Serialize to a stream\n   s = p.to_stream()\n   File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }", "Serialize your workbook to a StringIO instance\n @param [Boolean] confirm_valid Validate the package prior to serialization.\n @return [StringIO|Boolean] False if confirm_valid and validation errors exist. rewound string IO if not.", "Writes the package parts to a zip archive.\n @param [Zip::OutputStream] zip\n @return [Zip::OutputStream]", "The parts of a package\n @return [Array] An array of hashes that define the entry, document and schema for each part of the package.\n @private", "Performs xsd validation for a signle document\n\n @param [String] schema path to the xsd schema to be used in validation.\n @param [String] doc The xml text to be validated\n @return [Array] An array of all validation errors encountered.\n @private", "Appends override objects for drawings, charts, and sheets as they exist in your workbook to the default content types.\n @return [ContentType]\n @private", "Creates the minimum content types for generating a valid xlsx document.\n @return [ContentType]\n @private", "Creates the relationships required for a valid xlsx document\n @return [Relationships]\n @private", "sets or updates a hyperlink for this image.\n @param [String] v The href value for the hyper link\n @option options @see Hyperlink#initialize All options available to the Hyperlink class apply - however href will be overridden with the v parameter value.", "noop if not using a two cell anchor\n @param [Integer] x The column\n @param [Integer] y The row\n @return [Marker]", "Changes the anchor to a one cell anchor.", "changes the anchor type to a two cell anchor", "refactoring of swapping code, law of demeter be damned!", "creates a new ColorScale object.\n @see Cfvo\n @see Color\n @example\n     color_scale = Axlsx::ColorScale.new({:type => :num, :val => 0.55, :color => 'fff7696c'})\n adds a new cfvo / color pair to the color scale and returns a hash containing\n a reference to the newly created cfvo and color objects so you can alter the default properties.\n @return [Hash] a hash with :cfvo and :color keys referencing the newly added objects.\n @param [Hash] options options for the new cfvo and color objects\n @option [Symbol] type The type of cfvo you to add\n @option [Any] val The value of the cfvo to add\n @option [String] The rgb color for the cfvo", "Serialize this color_scale object data to an xml string\n @param [String] str\n @return [String]", "There has got to be cleaner way of merging these arrays.", "Adds an axis to the collection\n @param [Symbol] name The name of the axis\n @param [Axis] axis_class The axis class to generate", "Creates a new Shared Strings Table agains an array of cells\n @param [Array] cells This is an array of all of the cells in the workbook\n @param [Symbol] xml_space The xml:space behavior for the shared string table.\n Serializes the object\n @param [String] str\n @return [String]", "Interate over all of the cells in the array.\n if our unique cells array does not contain a sharable cell,\n add the cell to our unique cells array and set the ssti attribute on the index of this cell in the shared strings table\n if a sharable cell already exists in our unique_cells array, set the ssti attribute of the cell and move on.\n @return [Array] unique cells", "seralize the collection of hyperlinks\n @return [String]", "A quick helper to retrive a worksheet by name\n @param [String] name The name of the sheet you are looking for\n @return [Worksheet] The sheet found, or nil", "inserts a worksheet into this workbook at the position specified.\n It the index specified is out of range, the worksheet will be added to the end of the\n worksheets collection\n @return [Worksheet]\n @param index The zero based position to insert the newly created worksheet\n @param [Hash] options Options to pass into the worksheed during initialization.\n @option options [String] name The name of the worksheet\n @option options [Hash] page_margins The page margins for the worksheet", "The workbook relationships. This is managed automatically by the workbook\n @return [Relationships]", "returns a range of cells in a worksheet\n @param [String] cell_def The excel style reference defining the worksheet and cells. The range must specify the sheet to\n retrieve the cells from. e.g. range('Sheet1!A1:B2') will return an array of four cells [A1, A2, B1, B2] while range('Sheet1!A1') will return a single Cell.\n @return [Cell, Array]", "Serialize the workbook\n @param [String] str\n @return [String]", "Set some or all margins at once.\n @param [Hash] margins the margins to set (possible keys are :left, :right, :top, :bottom, :header and :footer).", "shortcut to set the column, row position for this marker\n @param col the column for the marker, a Cell object or a string reference like \"B7\"\n or an Array.\n @param row the row of the marker. This is ignored if the col parameter is a Cell or\n String or Array.", "handles multiple inputs for setting the position of a marker\n @see Chart#start_at", "Creates a new Comments object\n @param [Worksheet] worksheet The sheet that these comments belong to.\n Adds a new comment to the worksheet that owns these comments.\n @note the author, text and ref options are required\n @option options [String] author The name of the author for this comment\n @option options [String] text The text for this comment\n @option options [Stirng|Cell] ref The cell that this comment is attached to.", "Tries to work out the width of the longest line in the run\n @param [Array] widtharray this array is populated with the widths of each line in the run.\n @return [Array]", "Serializes the RichTextRun\n @param [String] str\n @return [String]", "Returns the width of a string according to the current style\n This is still not perfect...\n  - scaling is not linear as font sizes increase", "we scale the font size if bold style is applied to either the style font or\n the cell itself. Yes, it is a bit of a hack, but it is much better than using\n imagemagick and loading metrics for every character.", "validates that the value provided is between 0.0 and 1.0", "Serialize the contenty type to xml", "serialize the conditional formattings", "Initalize the simple typed list of value objects\n I am keeping this private for now as I am not sure what impact changes to the required two cfvo objects will do.", "Creates a byte string for this storage\n @return [String]", "Sets the col_id attribute for this filter column.\n @param [Integer | Cell] column_index The zero based index of the column to which this filter applies.\n                         When you specify a cell, the column index will be read off the cell\n @return [Integer]", "Apply the filters for this column\n @param [Array] row A row from a worksheet that needs to be\n filtered.", "Serialize the sheet data\n @param [String] str the string this objects serializaton will be concacted to.\n @return [String]", "creates the DefinedNames object\n Serialize to xml\n @param [String] str\n @return [String]", "Add a ConditionalFormattingRule. If a hash of options is passed\n in create a rule on the fly.\n @param [ConditionalFormattingRule|Hash] rule A rule to use, or the options necessary to create one.\n @see ConditionalFormattingRule#initialize", "Serializes the conditional formatting element\n @example Conditional Formatting XML looks like:\n    <conditionalFormatting sqref=\"E3:E9\">\n        <cfRule type=\"cellIs\" dxfId=\"0\" priority=\"1\" operator=\"greaterThan\">\n             <formula>0.5</formula>\n        </cfRule>\n    </conditionalFormatting>\n @param [String] str\n @return [String]", "Specify the degree of label rotation to apply to labels\n default true", "The title object for the chart.\n @param [String, Cell] v\n @return [Title]", "Initalizes page margin, setup and print options\n @param [Hash] options Options passed in from the initializer", "Add conditional formatting to this worksheet.\n\n @param [String] cells The range to apply the formatting to\n @param [Array|Hash] rules An array of hashes (or just one) to create Conditional formatting rules from.\n @example This would format column A whenever it is FALSE.\n        # for a longer example, see examples/example_conditional_formatting.rb (link below)\n        worksheet.add_conditional_formatting( \"A1:A1048576\", { :type => :cellIs, :operator => :equal, :formula => \"FALSE\", :dxfId => 1, :priority => 1 }\n\n @see ConditionalFormattingRule#initialize\n @see file:examples/example_conditional_formatting.rb", "Add data validation to this worksheet.\n\n @param [String] cells The cells the validation will apply to.\n @param [hash] data_validation options defining the validation to apply.\n @see  examples/data_validation.rb for an example", "Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects and all the other dirty details.\n @param [Class] chart_type\n @option options [Array] start_at\n @option options [Array] end_at\n @option options [Cell, String] title\n @option options [Boolean] show_legend\n @option options [Integer] style\n @note each chart type also specifies additional options\n @see Chart\n @see Pie3DChart\n @see Bar3DChart\n @see Line3DChart\n @see README for examples", "This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go.\n Note that you must call column_widths AFTER adding data, otherwise the width will not be set successfully.\n Setting a fixed column width to nil will revert the behaviour back to calculating the width for you on the next call to add_row.\n @example This would set the first and third column widhts but leave the second column in autofit state.\n      ws.column_widths 7.2, nil, 3\n @note For updating only a single column it is probably easier to just set the width of the ws.column_info[col_index].width directly\n @param [Integer|Float|nil] widths", "Set the style for cells in a specific column\n @param [Integer] index the index of the column\n @param [Integer] style the cellXfs index\n @param [Hash] options\n @option [Integer] :row_offset only cells after this column will be updated.\n @note You can also specify the style for specific columns in the call to add_row by using an array for the :styles option\n @see Worksheet#add_row\n @see README.md for an example", "Set the style for cells in a specific row\n @param [Integer] index or range of indexes in the table\n @param [Integer] style the cellXfs index\n @param [Hash] options the options used when applying the style\n @option [Integer] :col_offset only cells after this column will be updated.\n @note You can also specify the style in the add_row call\n @see Worksheet#add_row\n @see README.md for an example", "Returns a sheet node serialization for this sheet in the workbook.", "Serializes the worksheet object to an xml string\n This intentionally does not use nokogiri for performance reasons\n @return [String]", "The worksheet relationships. This is managed automatically by the worksheet\n @return [Relationships]", "returns the column and row index for a named based cell\n @param [String] name The cell or cell range to return. \"A1\" will return the first cell of the first row.\n @return [Cell]", "shortcut level to specify the outline level for a series of rows\n Oulining is what lets you add collapse and expand to a data set.\n @param [Integer] start_index The zero based index of the first row of outlining.\n @param [Integer] end_index The zero based index of  the last row to be outlined\n @param [integer] level The level of outline to apply\n @param [Integer] collapsed The initial collapsed state of the outline group", "shortcut level to specify the outline level for a series of columns\n Oulining is what lets you add collapse and expand to a data set.\n @param [Integer] start_index The zero based index of the first column of outlining.\n @param [Integer] end_index The zero based index of  the last column to be outlined\n @param [integer] level The level of outline to apply\n @param [Integer] collapsed The initial collapsed state of the outline group", "Serializes the row\n @param [Integer] r_index The row index, 0 based.\n @param [String] str The string this rows xml will be appended to.\n @return [String]", "Adds a single cell to the row based on the data provided and updates the worksheet's autofit data.\n @return [Cell]", "sets the color for every cell in this row", "sets the style for every cell in this row", "Converts values, types, and style options into cells and associates them with this row.\n A new cell is created for each item in the values array.\n If value option is defined and is a symbol it is applied to all the cells created.\n If the value option is an array, cell types are applied by index for each cell\n If the style option is defined and is an Integer, it is applied to all cells created.\n If the style option is an array, style is applied by index for each cell.\n @option options [Array] values\n @option options [Array, Symbol] types\n @option options [Array, Integer] style", "Creates a new Drawing object\n @param [Worksheet] worksheet The worksheet that owns this drawing\n Adds an image to the chart If th end_at option is specified we create a two cell anchor. By default we use a one cell anchor.\n @note The recommended way to manage images is to use Worksheet.add_image. Please refer to that method for documentation.\n @see Worksheet#add_image\n @return [Pic]", "Adds a chart to the drawing.\n @note The recommended way to manage charts is to use Worksheet.add_chart. Please refer to that method for documentation.\n @see Worksheet#add_chart", "An array of charts that are associated with this drawing's anchors\n @return [Array]", "An array of hyperlink objects associated with this drawings images\n @return [Array]", "An array of image objects that are associated with this drawing's anchors\n @return [Array]", "The drawing's relationships.\n @return [Relationships]", "Serialize the object\n @param [String] str serialized output will be appended to this object if provided.\n @return [String]", "Creates a new pie chart object\n @param [GraphicFrame] frame The workbook that owns this chart.\n @option options [Cell, String] title\n @option options [Boolean] show_legend\n @option options [Symbol] grouping\n @option options [String] gap_depth\n @option options [Integer] rot_x\n @option options [String] h_percent\n @option options [Integer] rot_y\n @option options [String] depth_percent\n @option options [Boolean] r_ang_ax\n @option options [Integer] perspective\n @see Chart\n @see View3D\n Serializes the object\n @param [String] str\n @return [String]", "creates the book views object\n Serialize to xml\n @param [String] str\n @return [String]", "updates the width for this col based on the cells autowidth and\n an optionally specified fixed width\n @param [Cell] cell The cell to use in updating this col's width\n @param [Integer] fixed_width If this is specified the width is set\n to this value and the cell's attributes are ignored.\n @param [Boolean] use_autowidth If this is false, the cell's\n autowidth value will be ignored.", "parse convert and assign node text to symbol", "parse, convert and assign note text to integer", "parse, convert and assign node text to float", "return node text based on xpath", "adds a chart to the drawing object\n @param [Class] chart_type The type of chart to add\n @param [Hash] options Options to pass on to the drawing and chart\n @see Worksheet#add_chart", "Adds a protected range\n @param [Array|String] cells A string range reference or array of cells that will be protected", "Serializes the protected ranges\n @param [String] str\n @return [String]", "Adds a filter column. This is the recommended way to create and manage filter columns for your autofilter.\n In addition to the require id and type parameters, options will be passed to the filter column during instantiation.\n @param [String] col_id Zero-based index indicating the AutoFilter column to which this filter information applies.\n @param [Symbol] filter_type A symbol representing one of the supported filter types.\n @param [Hash] options a hash of options to pass into the generated filter\n @return [FilterColumn]", "actually performs the filtering of rows who's cells do not\n match the filter.", "delete the item from the list\n @param [Any] v The item to be deleted.\n @raise [ArgumentError] if the item's index is protected by locking\n @return [Any] The item deleted", "positional assignment. Adds the item at the index specified\n @param [Integer] index\n @param [Any] v\n @raise [ArgumentError] if the index is protected by locking\n @raise [ArgumentError] if the item is not one of the allowed types", "creates a XML tag with serialized attributes\n @see SerializedAttributes#serialized_attributes", "serializes the instance values of the defining object based on the\n list of serializable attributes.\n @param [String] str The string instance to append this\n serialization to.\n @param [Hash] additional_attributes An option key value hash for\n defining values that are not serializable attributes list.", "A hash of instance variables that have been declared with\n seraialized_attributes and are not nil.\n This requires ruby 1.9.3 or higher", "serialized instance values at text nodes on a camelized element of the\n attribute name. You may pass in a block for evaluation against non nil\n values. We use an array for element attributes becuase misordering will\n break the xml and 1.8.7 does not support ordered hashes.\n @param [String] str The string instance to which serialized data is appended\n @param [Array] additional_attributes An array of additional attribute names.\n @return [String] The serialized output.", "serializes the data labels\n @return [String]", "The node name to use in serialization. As LineChart is used as the\n base class for Liine3DChart we need to be sure to serialize the\n chart based on the actual class type and not a fixed node name.\n @return [String]", "Serialize the app.xml document\n @return [String]", "Merges all the cells in a range created between this cell and the cell or string name for a cell  provided\n @see worksheet.merge_cells\n @param [Cell, String] target The last cell, or str ref for the cell in the merge range", "Attempts to determine the correct width for this cell's content\n @return [Float]", "Determines the cell type based on the cell value.\n @note This is only used when a cell is created but no :type option is specified, the following rules apply:\n   1. If the value is an instance of Date, the type is set to :date\n   2. If the value is an instance of Time, the type is set to :time\n   3. If the value is an instance of TrueClass or FalseClass, the type is set to :boolean\n   4. :float and :integer types are determined by regular expression matching.\n   5. Anything that does not meet either of the above is determined to be :string.\n @return [Symbol] The determined type", "Cast the value into this cells data type.\n @note\n   About Time - Time in OOXML is *different* from what you might expect. The history as to why is interesting, but you can safely assume that if you are generating docs on a mac, you will want to specify Workbook.1904 as true when using time typed values.\n @see Axlsx#date1904", "Tells us if the row of the cell provided should be filterd as it\n does not meet any of the specified filter_items or\n date_group_items restrictions.\n @param [Cell] cell The cell to test against items\n TODO implement this for date filters as well!", "Serialize the object to xml", "Date group items are date group filter items where you specify the\n date_group and a value for that option as part of the auto_filter\n @note This can be specified, but will not be applied to the date\n values in your workbook at this time.", "Creates a password hash for a given password\n @return [String]", "Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.\n @param [Array] values An array of cells or values.", "The name of the Table.\n @param [String, Cell] v\n @return [Title]", "Serializes the conditional formatting rule\n @param [String] str\n @return [String]", "Sets the cell location of this hyperlink in the worksheet\n @param [String|Cell] cell_reference The string reference or cell that defines where this hyperlink shows in the worksheet.", "serializes the core.xml document\n @return [String]", "creates a new MergedCells object\n @param [Worksheet] worksheet\n adds cells to the merged cells collection\n @param [Array||String] cells The cells to add to the merged cells\n collection. This can be an array of actual cells or a string style\n range like 'A1:C1'", "SEARCH GEOCODING PARAMS \n\n  :q             =>    required, full text search param)\n  :limit         =>    force limit number of results returned by raw API\n                       (default = 5) note : only first result is taken\n                       in account in geocoder\n\n  :autocomplete  =>    pass 0 to disable autocomplete treatment of :q\n                       (default = 1)\n\n  :lat           =>    force filter results around specific lat/lon\n\n  :lon           =>    force filter results around specific lat/lon\n\n  :type          =>    force filter the returned result type\n                       (check results for a list of accepted types)\n\n  :postcode      =>    force filter results on a specific city post code\n\n  :citycode      =>    force filter results on a specific city UUID INSEE code\n\n  For up to date doc (in french only) : https://adresse.data.gouv.fr/api/", "REVERSE GEOCODING PARAMS \n\n  :lat           =>    required\n\n  :lon           =>    required\n\n  :type          =>    force returned results type\n                       (check results for a list of accepted types)", "Convert an \"underscore\" version of a name into a \"class\" version.", "Return the name of the configured service, or raise an exception.", "Read from the Cache.", "Write to the Cache.", "Return the error but also considering its name. This is used\n when errors for a hidden field need to be shown.\n\n == Examples\n\n    f.full_error :token #=> <span class=\"error\">Token is invalid</span>", "Extract the model names from the object_name mess, ignoring numeric and\n explicit child indexes.\n\n Example:\n\n route[blocks_attributes][0][blocks_learning_object_attributes][1][foo_attributes]\n [\"route\", \"blocks\", \"blocks_learning_object\", \"foo\"]", "The action to be used in lookup.", "Find an input based on the attribute name.", "Checks if the file of given path is a valid ELF file.\n\n @param [String] path Path to target file.\n @return [Boolean] If the file is an ELF or not.\n @example\n   Helper.valid_elf_file?('/etc/passwd')\n   #=> false\n   Helper.valid_elf_file?('/lib64/ld-linux-x86-64.so.2')\n   #=> true", "Get the Build ID of target ELF.\n @param [String] path Absolute file path.\n @return [String] Target build id.\n @example\n   Helper.build_id_of('/lib/x86_64-linux-gnu/libc-2.23.so')\n   #=> '60131540dadc6796cab33388349e6e4e68692053'", "Wrap string with color codes for pretty inspect.\n @param [String] str Contents to colorize.\n @param [Symbol] sev Specify which kind of color to use, valid symbols are defined in {.COLOR_CODE}.\n @return [String] String wrapped with color codes.", "Get request.\n @param [String] url The url.\n @return [String]\n   The request response body.\n   If the response is +302 Found+, returns the location in header.", "Fetch the ELF archiecture of +file+.\n @param [String] file The target ELF filename.\n @return [Symbol]\n   Currently supports amd64, i386, arm, aarch64, and mips.\n @example\n   Helper.architecture('/bin/cat')\n   #=> :amd64", "Find objdump that supports architecture +arch+.\n @param [String] arch\n @return [String?]\n @example\n   Helper.find_objdump(:amd64)\n   #=> '/usr/bin/objdump'\n   Helper.find_objdump(:aarch64)\n   #=> '/usr/bin/aarch64-linux-gnu-objdump'", "Checks if the register is a stack-related pointer.\n @param [String] reg\n   Register's name.\n @return [Boolean]", "Show the message of ask user to update gem.\n @return [void]", "Main method of CLI.\n @param [Array<String>] argv\n   Command line arguments.\n @return [Boolean]\n   Whether the command execute successfully.\n @example\n   CLI.work(%w[--help])\n   # usage message\n   #=> true\n   CLI.work(%w[--version])\n   # version message\n   #=> true\n @example\n   CLI.work([])\n   # usage message\n   #=> false\n @example\n   CLI.work(%w[-b b417c0ba7cc5cf06d1d1bed6652cedb9253c60d0 -r])\n   # 324293 324386 1090444\n   #=> true", "Decides how to display fetched gadgets according to options.\n @param [Array<OneGadget::Gadget::Gadget>] gadgets\n @param [String] libc_file\n @return [Boolean]", "Displays libc information given BuildID.\n @param [String] id\n @return [Boolean]\n   +false+ is returned if no information found.\n @example\n   CLI.info_build_id('b417c')\n   # [OneGadget] Information of b417c:\n   #             spec/data/libc-2.27-b417c0ba7cc5cf06d1d1bed6652cedb9253c60d0.so\n   \n   #             Advanced Micro Devices X86-64\n   \n   #             GNU C Library (Ubuntu GLIBC 2.27-3ubuntu1) stable release version 2.27.\n   #             Copyright (C) 2018 Free Software Foundation, Inc.\n   #             This is free software; see the source for copying conditions.\n   #             There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A\n   #             PARTICULAR PURPOSE.\n   #             Compiled by GNU CC version 7.3.0.\n   #             libc ABIs: UNIQUE IFUNC\n   #             For bug reporting instructions, please see:\n   #             <https://bugs.launchpad.net/ubuntu/+source/glibc/+bugs>.\n   #=> true", "The option parser.\n @return [OptionParser]", "Writes gadgets to stdout.\n @param [Array<OneGadget::Gadget::Gadget>] gadgets\n @param [Boolean] raw\n   In raw mode, only the offset of gadgets are printed.\n @return [true]", "Turns on logging\n\n   class Foo\n     include HTTParty\n     logger Logger.new('http_logger'), :info, :apache\n   end", "Allows setting http proxy information to be used\n\n   class Foo\n     include HTTParty\n     http_proxy 'http://foo.com', 80, 'user', 'pass'\n   end", "Allows setting default parameters to be appended to each request.\n Great for api keys and such.\n\n   class Foo\n     include HTTParty\n     default_params api_key: 'secret', another: 'foo'\n   end", "Allows setting HTTP headers to be used for each request.\n\n   class Foo\n     include HTTParty\n     headers 'Accept' => 'text/html'\n   end", "Allows setting a custom connection_adapter for the http connections\n\n @example\n   class Foo\n     include HTTParty\n     connection_adapter Proc.new {|uri, options| ... }\n   end\n\n @example provide optional configuration for your connection_adapter\n   class Foo\n     include HTTParty\n     connection_adapter Proc.new {|uri, options| ... }, {foo: :bar}\n   end\n\n @see HTTParty::ConnectionAdapter", "Allows making a get request to a url.\n\n   class Foo\n     include HTTParty\n   end\n\n   # Simple get with full url\n   Foo.get('http://foo.com/resource.json')\n\n   # Simple get with full url and query parameters\n   # ie: http://foo.com/resource.json?limit=10\n   Foo.get('http://foo.com/resource.json', query: {limit: 10})", "Allows making a post request to a url.\n\n   class Foo\n     include HTTParty\n   end\n\n   # Simple post with full url and setting the body\n   Foo.post('http://foo.com/resources', body: {bar: 'baz'})\n\n   # Simple post with full url using :query option,\n   # which appends the parameters to the URI.\n   Foo.post('http://foo.com/resources', query: {bar: 'baz'})", "Perform a PATCH request to a path", "Perform a PUT request to a path", "Perform a DELETE request to a path", "Perform a MOVE request to a path", "Perform a COPY request to a path", "Perform a HEAD request to a path", "Perform an OPTIONS request to a path", "Perform a MKCOL request to a path", "Returns a new array with the concatenated results of running block once for every element in enumerable.\n If no block is given, an enumerator is returned instead.\n\n @param enumerable [Enumerable]\n @return [Array, Enumerator]", "Returns a new array with the results of running block once for every element in enumerable.\n If no block is given, an enumerator is returned instead.\n\n @param enumerable [Enumerable]\n @return [Array, Enumerator]", "Converts query string to a hash\n\n @param query_string [String] The query string of a URL.\n @return [Hash] The query string converted to a hash (with symbol keys).\n @example Convert query string to a hash\n   query_string_to_hash(\"foo=bar&baz=qux\") #=> {:foo=>\"bar\", :baz=>\"qux\"}", "Time when the object was created on Twitter\n\n @return [Time]", "JSON representation of the Access Token instance.\n\n @return [Hash] hash with token data", "Check whether the given plain text secret matches our stored secret\n\n @param input [#to_s] Plain secret provided by user\n        (any object that responds to `#to_s`)\n\n @return [true] Whether the given secret matches the stored secret\n                of this application.", "Determine whether +reuse_access_token+ and a non-restorable\n +token_secret_strategy+ have both been activated.\n\n In that case, disable reuse_access_token value and warn the user.", "Allow SSL context to be configured via settings, for Ruby >= 1.9\n Just returns openssl verify mode for Ruby 1.8.x", "Returns the attachment by filename or at index.\n\n mail.attachments['test.png'] = File.read('test.png')\n mail.attachments['test.jpg'] = File.read('test.jpg')\n\n mail.attachments['test.png'].filename #=> 'test.png'\n mail.attachments[1].filename          #=> 'test.jpg'", "Find emails in a POP3 mailbox. Without any options, the 5 last received emails are returned.\n\n Possible options:\n   what:  last or first emails. The default is :first.\n   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.\n   count: number of emails to retrieve. The default value is 10. A value of 1 returns an\n          instance of Message, not an array of Message instances.\n   delete_after_find: flag for whether to delete each retreived email after find. Default\n           is false. Use #find_and_delete if you would like this to default to true.", "Delete all emails from a POP3 server", "Returns the address string of all the addresses in the address list", "Returns the formatted string of all the addresses in the address list", "Returns the display name of all the addresses in the address list", "Returns a list of decoded group addresses", "Returns a list of encoded group addresses", "Send the message via SMTP.\n The from and to attributes are optional. If not set, they are retrieve from the Message.", "Various special cases from random emails found that I am not going to change\n the parser for", "If the string supplied has PHRASE unsafe characters in it, will return the string quoted\n in double quotes, otherwise returns the string unmodified", "If the string supplied has TOKEN unsafe characters in it, will return the string quoted\n in double quotes, otherwise returns the string unmodified", "Capitalizes a string that is joined by hyphens correctly.\n\n Example:\n\n  string = 'resent-from-field'\n  capitalize_field( string ) #=> 'Resent-From-Field'", "Takes an underscored word and turns it into a class name\n\n Example:\n\n  constantize(\"hello\") #=> \"Hello\"\n  constantize(\"hello-there\") #=> \"HelloThere\"\n  constantize(\"hello-there-mate\") #=> \"HelloThereMate\"", "Returns true if the object is considered blank.\n A blank includes things like '', '   ', nil,\n and arrays and hashes that have nothing in them.\n\n This logic is mostly shared with ActiveSupport's blank?", "Find emails in a IMAP mailbox. Without any options, the 10 last received emails are returned.\n\n Possible options:\n   mailbox: mailbox to search the email(s) in. The default is 'INBOX'.\n   what:    last or first emails. The default is :first.\n   order:   order of emails returned. Possible values are :asc or :desc. Default value is :asc.\n   count:   number of emails to retrieve. The default value is 10. A value of 1 returns an\n            instance of Message, not an array of Message instances.\n   read_only: will ensure that no writes are made to the inbox during the session.  Specifically, if this is\n              set to true, the code will use the EXAMINE command to retrieve the mail.  If set to false, which\n              is the default, a SELECT command will be used to retrieve the mail\n              This is helpful when you don't want your messages to be set to read automatically. Default is false.\n   delete_after_find: flag for whether to delete each retreived email after find. Default\n           is false. Use #find_and_delete if you would like this to default to true.\n   keys:   are passed as criteria to the SEARCH command.  They can either be a string holding the entire search string,\n           or a single-dimension array of search keywords and arguments.  Refer to  [IMAP] section 6.4.4 for a full list\n           The default is 'ALL'\n   search_charset: charset to pass to IMAP server search. Omitted by default. Example: 'UTF-8' or 'ASCII'.", "Delete all emails from a IMAP mailbox", "Start an IMAP session and ensures that it will be closed in any case.", "3.6. Field definitions\n\n   It is important to note that the header fields are not guaranteed to\n   be in a particular order.  They may appear in any order, and they\n   have been known to be reordered occasionally when transported over\n   the Internet.  However, for the purposes of this standard, header\n   fields SHOULD NOT be reordered when a message is transported or\n   transformed.  More importantly, the trace header fields and resent\n   header fields MUST NOT be reordered, and SHOULD be kept in blocks\n   prepended to the message.  See sections 3.6.6 and 3.6.7 for more\n   information.\n\n Populates the fields container with Field objects in the order it\n receives them in.\n\n Acceps an array of field string values, for example:\n\n  h = Header.new\n  h.fields = ['From: mikel@me.com', 'To: bob@you.com']", "Sets the FIRST matching field in the header to passed value, or deletes\n the FIRST field matched from the header if passed nil\n\n Example:\n\n  h = Header.new\n  h.fields = ['To: mikel@me.com', 'X-Mail-SPAM: 15', 'X-Mail-SPAM: 20']\n  h['To'] = 'bob@you.com'\n  h['To']    #=> 'bob@you.com'\n  h['X-Mail-SPAM'] = '10000'\n  h['X-Mail-SPAM'] # => ['15', '20', '10000']\n  h['X-Mail-SPAM'] = nil\n  h['X-Mail-SPAM'] # => nil", "Returns the default value of the field requested as a symbol.\n\n Each header field has a :default method which returns the most common use case for\n that field, for example, the date field types will return a DateTime object when\n sent :default, the subject, or unstructured fields will return a decoded string of\n their value, the address field types will return a single addr_spec or an array of\n addr_specs if there is more than one.", "Allows you to add an arbitrary header\n\n Example:\n\n  mail['foo'] = '1234'\n  mail['foo'].to_s #=> '1234'", "Method Missing in this implementation allows you to set any of the\n standard fields directly as you would the \"to\", \"subject\" etc.\n\n Those fields used most often (to, subject et al) are given their\n own method for ease of documentation and also to avoid the hook\n call to method missing.\n\n This will only catch the known fields listed in:\n\n  Mail::Field::KNOWN_FIELDS\n\n as per RFC 2822, any ruby string or method name could pretty much\n be a field name, so we don't want to just catch ANYTHING sent to\n a message object and interpret it as a header.\n\n This method provides all three types of header call to set, read\n and explicitly set with the = operator\n\n Examples:\n\n  mail.comments = 'These are some comments'\n  mail.comments #=> 'These are some comments'\n\n  mail.comments 'These are other comments'\n  mail.comments #=> 'These are other comments'\n\n\n  mail.date = 'Tue, 1 Jul 2003 10:52:37 +0200'\n  mail.date.to_s #=> 'Tue, 1 Jul 2003 10:52:37 +0200'\n\n  mail.date 'Tue, 1 Jul 2003 10:52:37 +0200'\n  mail.date.to_s #=> 'Tue, 1 Jul 2003 10:52:37 +0200'\n\n\n  mail.resent_msg_id = '<1234@resent_msg_id.lindsaar.net>'\n  mail.resent_msg_id #=> '<1234@resent_msg_id.lindsaar.net>'\n\n  mail.resent_msg_id '<4567@resent_msg_id.lindsaar.net>'\n  mail.resent_msg_id #=> '<4567@resent_msg_id.lindsaar.net>'", "Adds a content type and charset if the body is US-ASCII\n\n Otherwise raises a warning", "Adds a part to the parts list or creates the part list", "Allows you to add a part in block form to an existing mail message object\n\n Example:\n\n  mail = Mail.new do\n    part :content_type => \"multipart/alternative\", :content_disposition => \"inline\" do |p|\n      p.part :content_type => \"text/plain\", :body => \"test text\\nline #2\"\n      p.part :content_type => \"text/html\", :body => \"<b>test</b> HTML<br/>\\nline #2\"\n    end\n  end", "Adds a file to the message.  You have two options with this method, you can\n just pass in the absolute path to the file you want and Mail will read the file,\n get the filename from the path you pass in and guess the MIME media type, or you\n can pass in the filename as a string, and pass in the file content as a blob.\n\n Example:\n\n  m = Mail.new\n  m.add_file('/path/to/filename.png')\n\n  m = Mail.new\n  m.add_file(:filename => 'filename.png', :content => File.read('/path/to/file.jpg'))\n\n Note also that if you add a file to an existing message, Mail will convert that message\n to a MIME multipart email, moving whatever plain text body you had into its own text\n plain part.\n\n Example:\n\n  m = Mail.new do\n    body 'this is some text'\n  end\n  m.multipart? #=> false\n  m.add_file('/path/to/filename.png')\n  m.multipart? #=> true\n  m.parts.first.content_type.content_type #=> 'text/plain'\n  m.parts.last.content_type.content_type #=> 'image/png'\n\n See also #attachments", "Encodes the message, calls encode on all its parts, gets an email message\n ready to send", "Outputs an encoded string representation of the mail message including\n all headers, attachments, etc.  This is an encoded email in US-ASCII,\n so it is able to be directly sent to an email server.", "see comments to body=. We take data and process it lazily", "Returns an array of comments that are in the email, or nil if there\n are no comments\n\n  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')\n  a.comments #=> ['My email address']\n\n  b = Address.new('Mikel Lindsaar <mikel@test.lindsaar.net>')\n  b.comments #=> nil", "Get all emails.\n\n Possible options:\n   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.", "Find emails in the mailbox, and then deletes them. Without any options, the\n five last received emails are returned.\n\n Possible options:\n   what:  last or first emails. The default is :first.\n   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.\n   count: number of emails to retrieve. The default value is 10. A value of 1 returns an\n          instance of Message, not an array of Message instances.\n   delete_after_find: flag for whether to delete each retreived email after find. Default\n           is true. Call #find if you would like this to default to false.", "Insert the field in sorted order.\n\n Heavily based on bisect.insort from Python, which is:\n   Copyright (C) 2001-2013 Python Software Foundation.\n   Licensed under <http://docs.python.org/license.html>\n   From <http://hg.python.org/cpython/file/2.7/Lib/bisect.py>", "Updates all of the template catalogs and returns their filepaths.\n If there is a Rambafile in the current directory, it also updates all of the catalogs specified there.\n\n @return [Array] An array of filepaths to downloaded catalogs", "Clones a template catalog from a remote repository\n\n @param name [String] The name of the template catalog\n @param url [String] The url of the repository\n\n @return [Pathname] A filepath to the downloaded catalog", "Provides the appropriate strategy for a given template type", "Browses a given catalog and returns a template path\n\n @param catalog_path [Pathname] A path to a catalog\n @param template_name [String] A name of the template\n\n @return [Pathname] A path to a template, if found", "This method parses Rambafile, serializes templates hashes into model objects and install them", "Clears all of the currently installed templates", "Clones remote template catalogs to the local directory", "Create a XCScheme either from scratch or using an existing file\n\n @param [String] file_path\n        The path of the existing .xcscheme file. If nil will create an empty scheme\n\n Convenience method to quickly add app and test targets to a new scheme.\n\n It will add the runnable_target to the Build, Launch and Profile actions\n and the test_target to the Build and Test actions\n\n @param [Xcodeproj::Project::Object::PBXAbstractTarget] runnable_target\n        The target to use for the 'Run', 'Profile' and 'Analyze' actions\n\n @param [Xcodeproj::Project::Object::PBXAbstractTarget] test_target\n        The target to use for the 'Test' action\n\n @param [Boolean] launch_target\n        Determines if the runnable_target is launchable.", "Sets a runnable target to be the target of the launch action of the scheme.\n\n @param [Xcodeproj::Project::Object::AbstractTarget] build_target\n        A target used by scheme in the launch step.", "Serializes the current state of the object to a \".xcscheme\" file.\n\n @param [String, Pathname] project_path\n        The path where the \".xcscheme\" file should be stored.\n\n @param [String] name\n        The name of the scheme, to have \".xcscheme\" appended.\n\n @param [Boolean] shared\n        true  => if the scheme must be a shared scheme (default value)\n        false => if the scheme must be a user scheme\n\n @return [void]\n\n @example Saving a scheme\n   scheme.save_as('path/to/Project.xcodeproj') #=> true", "Initializes the instance with the project stored in the `path` attribute.", "Converts the objects tree to a hash substituting the hash\n of the referenced to their UUID reference. As a consequence the hash of\n an object might appear multiple times and the information about their\n uniqueness is lost.\n\n This method is designed to work in conjunction with {Hash#recursive_diff}\n to provide a complete, yet readable, diff of two projects *not* affected\n by differences in UUIDs.\n\n @return [Hash] a hash representation of the project different from the\n         plist one.", "Pre-generates the given number of UUIDs. Useful for optimizing\n performance when the rough number of objects that will be created is\n known in advance.\n\n @param  [Integer] count\n         the number of UUIDs that should be generated.\n\n @note   This method might generated a minor number of uniques UUIDs than\n         the given count, because some might be duplicated a thus will be\n         discarded.\n\n @return [void]", "Returns the file reference for the given absolute path.\n\n @param  [#to_s] absolute_path\n         The absolute path of the file whose reference is needed.\n\n @return [PBXFileReference] The file reference.\n @return [Nil] If no file reference could be found.", "Checks the native target for any targets in the project\n that are dependent on the native target and would be\n embedded in it at build time\n\n @param  [PBXNativeTarget] native target to check for\n         embedded targets\n\n\n @return [Array<PBXNativeTarget>] A list of all targets that\n         are embedded in the passed in target", "Returns the native targets, in which the embedded target is\n embedded. This works by traversing the targets to find those\n where the target is a dependency.\n\n @param  [PBXNativeTarget] native target that might be embedded\n         in another target\n\n @return [Array<PBXNativeTarget>] the native targets that host the\n         embedded target", "Creates a new resource bundles target and adds it to the project.\n\n The target is configured for the given platform and its file reference it\n is added to the {products_group}.\n\n The target is pre-populated with common build settings\n\n @param  [String] name\n         the name of the resources bundle.\n\n @param  [Symbol] platform\n         the platform of the resources bundle. Can be `:ios` or `:osx`.\n\n @return [PBXNativeTarget] the target.", "Adds a new build configuration to the project and populates its with\n default settings according to the provided type.\n\n @param  [String] name\n         The name of the build configuration.\n\n @param  [Symbol] type\n         The type of the build configuration used to populate the build\n         settings, must be :debug or :release.\n\n @return [XCBuildConfiguration] The new build configuration.", "Writes the serialized representation of the internal data to the given\n path.\n\n @param  [Pathname] pathname\n         The file where the data should be written to.\n\n @return [void]", "Returns a hash from the string representation of an Xcconfig file.\n\n @param  [String] string\n         The string representation of an xcconfig file.\n\n @return [Hash] the hash containing the xcconfig data.", "Merges the given attributes hash while ensuring values are not duplicated.\n\n @param  [Hash] attributes\n         The attributes hash to merge into @attributes.\n\n @return [void]", "Returns the key and the value described by the given line of an xcconfig.\n\n @param  [String] line\n         the line to process.\n\n @return [Array] A tuple where the first entry is the key and the second\n         entry is the value.", "Generates test cases to compare two settings hashes.\n\n @param [Hash{String => String}] produced\n        the produced build settings.\n\n @param [Hash{String => String}] expected\n        the expected build settings.\n\n @param [#to_s] params\n        the parameters used to construct the produced build settings.", "Load settings from fixtures\n\n @param  [String] path\n         the directory, where the fixture set is located.\n\n @param  [Symbol] type\n         the type, where the specific\n\n @param  [Hash{String => String}]\n         the build settings", "Saves the workspace at the given `xcworkspace` path.\n\n @param  [String] path\n         the path where to save the project.\n\n @return [void]", "Load all schemes from project\n\n @param [String] project_full_path\n         project full path\n\n @return [void]", "Return container content.", "Return own toc content.", "called from strategy", "Take YAML +file+ and update parameter hash.", "Update parameters by merging from new parameter hash +config+.", "Write mimetype file to IO object +wobj+.", "Write opf file to IO object +wobj+.", "Write ncx file to IO object +wobj+. +indentarray+ defines prefix\n string for each level.", "Write container file to IO object +wobj+.", "Write colophon file to IO object +wobj+.", "Write own toc file to IO object +wobj+.", "Return ncx content. +indentarray+ has prefix marks for each level.", "Produce EPUB file +epubfile+.\n +basedir+ points the directory has contents.\n +tmpdir+ defines temporary directory.", "index -> italic", "load YAML files\n\n `inherit: [3.yml, 6.yml]` in 7.yml; `inherit: [1.yml, 2.yml]` in 3.yml; `inherit: [4.yml, 5.yml]` in 6.yml\n    => 7.yml > 6.yml > 5.yml > 4.yml > 3.yml > 2.yml > 1.yml", "Complement other parameters by using file parameter.", "Choose an alternative, add a participant, and save the alternative choice on the user. This\n method is guaranteed to only run once, and will skip the alternative choosing process if run\n a second time.", "Set default program_name in performance_schema.session_connect_attrs\n and performance_schema.session_account_connect_attrs", "In MySQL 5.5+ error messages are always constructed server-side as UTF-8\n then returned in the encoding set by the `character_set_results` system\n variable.\n\n See http://dev.mysql.com/doc/refman/5.5/en/charset-errors.html for\n more context.\n\n Before MySQL 5.5 error message template strings are in whatever encoding\n is associated with the error message language.\n See http://dev.mysql.com/doc/refman/5.1/en/error-message-language.html\n for more information.\n\n The issue is that the user-data inserted in the message could potentially\n be in any encoding MySQL supports and is insert into the latin1, euckr or\n koi8r string raw. Meaning there's a high probability the string will be\n corrupt encoding-wise.\n\n See http://dev.mysql.com/doc/refman/5.1/en/charset-errors.html for\n more information.\n\n So in an attempt to make sure the error message string is always in a valid\n encoding, we'll assume UTF-8 and clean the string of anything that's not a\n valid UTF-8 character.\n\n Returns a valid UTF-8 string.", "Custom describe block that sets metadata to enable the rest of RAD\n\n   resource \"Orders\", :meta => :data do\n     # ...\n   end\n\n Params:\n +args+:: Glob of RSpec's `describe` arguments\n +block+:: Block to pass into describe", "Defines a new sub configuration\n\n Automatically sets the `filter` to the group name, and the `docs_dir` to\n a subfolder of the parent's `doc_dir` named the group name.\n\n   RspecApiDocumentation.configure do |config|\n     config.docs_dir = \"doc/api\"\n     config.define_group(:public) do |config|\n       # Default values\n       config.docs_dir = \"doc/api/public\"\n       config.filter = :public\n     end\n   end\n\n Params:\n +name+:: String name of the group\n +block+:: Block configuration block", "Must be called after the backtrace cleaner.", "Rails relies on backtrace cleaner to set the application root directory\n filter. The problem is that the backtrace cleaner is initialized before\n this gem. This ensures that the value of `root` used by the filter\n is correct.", "Mass assigns attributes on the model.\n\n This is a version of +update_attributes+ that takes some extra options\n for internal use.\n\n ==== Attributes\n\n * +values+ - Hash of values to use to update the current attributes of\n   the object.\n * +opts+ - Options for +StripeObject+ like an API key that will be reused\n   on subsequent API calls.\n\n ==== Options\n\n * +:dirty+ - Whether values should be initiated as \"dirty\" (unsaved) and\n   which applies only to new StripeObjects being initiated under this\n   StripeObject. Defaults to true.", "Returns a hash of empty values for all the values that are in the given\n StripeObject.", "Iterates through each resource in all pages, making additional fetches to\n the API as necessary.\n\n Note that this method will make as many API calls as necessary to fetch\n all resources. For more granular control, please see +each+ and\n +next_page+.", "Formats a plugin \"app info\" hash into a string that we can tack onto the\n end of a User-Agent string where it'll be fairly prominent in places like\n the Dashboard. Note that this formatting has been implemented to match\n other libraries, and shouldn't be changed without universal consensus.", "Attempts to look at a response's error code and return an OAuth error if\n one matches. Will return `nil` if the code isn't recognized.", "Format ActiveRecord instance object.\n\n NOTE: by default only instance attributes (i.e. columns) are shown. To format\n ActiveRecord instance as regular object showing its instance variables and\n accessors use :raw => true option:\n\n ap record, :raw => true\n\n------------------------------------------------------------------------------", "Format Ripple instance object.\n\n NOTE: by default only instance attributes are shown. To format a Ripple document instance\n as a regular object showing its instance variables and accessors use :raw => true option:\n\n ap document, :raw => true\n\n------------------------------------------------------------------------------", "Format MongoMapper instance object.\n\n NOTE: by default only instance attributes (i.e. keys) are shown. To format\n MongoMapper instance as regular object showing its instance variables and\n accessors use :raw => true option:\n\n ap record, :raw => true\n\n------------------------------------------------------------------------------", "Use HTML colors and add default \"debug_dump\" class to the resulting HTML.", "Returns list of ancestors, starting from parent until root.\n\n   subchild1.ancestors # => [child1, root]", "Returns all children and children of children", "if passed nil will use default seed classes", "Writing to the seed file. Takes in file handler and array of hashes with\n `header` and `content` keys", "Collecting fragment data and writing attachment files to disk", "Importing translations for given page. They look like `content.locale.html`", "Constructing frag attributes hash that can be assigned to page or translation\n also returning list of frag identifiers so we can destroy old ones", "Preparing fragment attachments. Returns hashes with file data for\n ActiveStorage and a list of ids of old attachements to destroy", "Same as cms_fragment_content but with cms tags expanded and rendered. Use\n it only if you know you got more stuff in the fragment content other than\n text because this is a potentially expensive call.", "Same as cms_snippet_content but cms tags will be expanded. Note that there\n is no page context, so snippet cannot contain fragment tags.", "Wrapper to deal with Kaminari vs WillPaginate", "HTTP methods with a body", "Checks if method_name is set in the attributes hash\n and returns true when found, otherwise proxies the\n call to the superclass.", "Overrides method_missing to check the attribute hash\n for resources matching method_name and proxies the call\n to the superclass if no match is found.", "Fetches the attributes for the specified resource from JIRA unless\n the resource is already expanded and the optional force reload flag\n is not set", "Sets the attributes hash from a HTTPResponse object from JIRA if it is\n not nil or is not a json response.", "Set the current attributes from a hash.  If clobber is true, any existing\n hash values will be clobbered by the new hash, otherwise the hash will\n be deeply merged into attrs.  The target paramater is for internal use only\n and should not be used.", "Note that we delegate almost all methods to the result of the que_target\n method, which could be one of a few things, depending on the circumstance.\n Run the job with error handling and cleanup logic. Optionally support\n overriding the args, because it's necessary when jobs are invoked from\n ActiveJob.", "To be overridden in subclasses.", "Explicitly check for the job id in these helpers, because it won't exist\n if we're running synchronously.", "Since we use a mutex, which is not reentrant, we have to be a little\n careful to not call a method that locks the mutex when we've already\n locked it. So, as a general rule, public methods handle locking the mutex\n when necessary, while private methods handle the actual underlying data\n changes. This lets us reuse those private methods without running into\n locking issues.", "Get ips for given name\n\n First the local resolver is used. On POSIX-systems /etc/hosts is used. On\n Windows C:\\Windows\\System32\\drivers\\etc\\hosts is used.\n\n @param [String] name\n   The name which should be resolved.", "Add a new mime-type for a specific extension\n\n @param [Symbol] type File extension\n @param [String] value Mime type\n @return [void]", "Activate an extension, optionally passing in options.\n This method is typically used from a project's `config.rb`.\n\n @example Activate an extension with no options\n     activate :lorem\n\n @example Activate an extension, with options\n     activate :minify_javascript, inline: true\n\n @example Use a block to configure extension options\n     activate :minify_javascript do |opts|\n       opts.ignore += ['*-test.js']\n     end\n\n @param [Symbol] ext_name The name of thed extension to activate\n @param [Hash] options Options to pass to the extension\n @yield [Middleman::Configuration::ConfigurationManager] Extension options that can be modified before the extension is initialized.\n @return [void]", "Initialize the Middleman project", "Clean up missing Tilt exts", "The extension task", "Extensions are instantiated when they are activated.\n @param [Middleman::Application] app The Middleman::Application instance\n @param [Hash] options_hash The raw options hash. Subclasses should not manipulate this directly - it will be turned into {#options}.\n @yield An optional block that can be used to customize options before the extension is activated.\n @yieldparam [Middleman::Configuration::ConfigurationManager] options Extension options\n @!method before_configuration\n   Respond to the `before_configuration` event.\n   If a `before_configuration` method is implemented, that method will be run before `config.rb` is run.\n   @note Because most extensions are activated from within `config.rb`, they *will not run* any `before_configuration` hook.\n @!method after_configuration\n   Respond to the `after_configuration` event.\n   If an `after_configuration` method is implemented, that method will be run before `config.rb` is run.\n @!method before_build\n   Respond to the `before_build` event.\n   If an `before_build` method is implemented, that method will be run before the builder runs.\n @!method after_build\n   Respond to the `after_build` event.\n   If an `after_build` method is implemented, that method will be run after the builder runs.\n @!method ready\n   Respond to the `ready` event.\n   If an `ready` method is implemented, that method will be run after the app has finished booting up.\n @!method manipulate_resource_list(resources)\n   Manipulate the resource list by transforming or adding {Sitemap::Resource}s.\n   Sitemap manipulation is a powerful way of interacting with a project, since it can modify each {Sitemap::Resource} or generate new {Sitemap::Resources}. This method is used in a pipeline where each sitemap manipulator is run in turn, with each one being fed the output of the previous manipulator. See the source of built-in Middleman extensions like {Middleman::Extensions::DirectoryIndexes} and {Middleman::Extensions::AssetHash} for examples of how to use this.\n   @note This method *must* return the full set of resources, because its return value will be used as the new sitemap.\n   @see http://middlemanapp.com/advanced/sitemap/ Sitemap Documentation\n   @see Sitemap::Store\n   @see Sitemap::Resource\n   @param [Array<Sitemap::Resource>] resources A list of all the resources known to the sitemap.\n   @return [Array<Sitemap::Resource>] The transformed list of resources.", "The init task", "Copied from Bundler", "Core build Thor command\n @return [void]", "Handles incoming events from the builder.\n @param [Symbol] event_type The type of event.\n @param [String] target The event contents.\n @param [String] extra The extra information.\n @return [void]", "Find empty directories in the build folder and remove them.\n @return [Boolean]", "Core response method. We process the request, check with\n the sitemap, and return the correct file, response or status\n message.\n\n @param env\n @param [Rack::Request] req\n @param [Rack::Response] res", "Halt request and return 404", "Immediately send static file", "Start the server", "Allow layouts to be wrapped in the contents of other layouts.\n\n @param [String, Symbol] layout_name\n @return [void]", "Render a path with locs, opts and contents block.\n\n @api private\n @param [Middleman::SourceFile] file The file.\n @param [Hash] locs Template locals.\n @param [Hash] opts Template options.\n @param [Proc] block A block will be evaluated to return internal contents.\n @return [String] The resulting content string.\n Contract IsA['Middleman::SourceFile'], Hash, Hash, Maybe[Proc] => String", "Glob a directory and try to keep path encoding consistent.\n\n @param [String] path The glob path.\n @return [Array<String>]", "Recursively builds entity instances\n out of all hashes in the response object", "Decrypts a value for the attribute specified using options evaluated in the current object's scope\n\n Example\n\n  class User\n    attr_accessor :secret_key\n    attr_encrypted :email, key: :secret_key\n\n    def initialize(secret_key)\n      self.secret_key = secret_key\n    end\n  end\n\n  @user = User.new('some-secret-key')\n  @user.decrypt(:email, 'SOME_ENCRYPTED_EMAIL_STRING')", "Encrypts a value for the attribute specified using options evaluated in the current object's scope\n\n Example\n\n  class User\n    attr_accessor :secret_key\n    attr_encrypted :email, key: :secret_key\n\n    def initialize(secret_key)\n      self.secret_key = secret_key\n    end\n  end\n\n  @user = User.new('some-secret-key')\n  @user.encrypt(:email, 'test@example.com')", "Copies the class level hash of encrypted attributes with virtual attribute names as keys\n and their corresponding options as values to the instance", "Change color of string\n\n Examples:\n\n   puts \"This is blue\".colorize(:blue)\n   puts \"This is light blue\".colorize(:light_blue)\n   puts \"This is also blue\".colorize(:color => :blue)\n   puts \"This is light blue with red background\".colorize(:color => :light_blue, :background => :red)\n   puts \"This is light blue with red background\".colorize(:light_blue ).colorize( :background => :red)\n   puts \"This is blue text on red\".blue.on_red\n   puts \"This is red on blue\".colorize(:red).on_blue\n   puts \"This is red on blue and underline\".colorize(:red).on_blue.underline\n   puts \"This is blue text on red\".blue.on_red.blink\n   puts \"This is uncolorized\".blue.on_red.uncolorize", "Return true if string is colorized", "Set color from params", "Set colors from params hash", "Generate color and on_color methods", "User Code Block", "consuming a terminal may set off a series of reduces before the terminal\n is shifted", "Sequence of state transitions which would be taken when starting\n from 'state', then following the RHS of 'rule' right to the end", "traverse a directed graph\n each entry in 'bitmap' corresponds to a graph node\n after the traversal, the bitmap for each node will be the union of its\n original value, and ALL the values for all the nodes which are reachable\n from it", "Like `transition_graph`, but rather than vectors labeled with NTs, we\n have vectors labeled with the shortest series of terminals and reduce\n operations which could take us through the same transition", "sometimes a Rule is instantiated before the target is actually known\n it may be given a \"placeholder\" target first, which is later replaced\n with the real one", "If an instance of this NT comes next, then what rules could we be\n starting?", "Generates an image tag for the given attachment, adding appropriate\n classes and optionally falling back to the given fallback image if there\n is no file attached.\n\n Returns `nil` if there is no file attached and no fallback specified.\n\n @param [String] fallback                   The path to an image asset to be used as a fallback\n @param [Hash] options                      Additional options for the image tag\n @see #attachment_url\n @return [ActiveSupport::SafeBuffer, nil]   The generated image tag", "Generates a hidden form field which tracks the id of the file in the cache\n before it is permanently stored.\n\n @param object_name                    The name of the object to generate a field for\n @param method                         The name of the field\n @param [Hash] options\n @option options [Object] object       Set by the form builder\n @return [ActiveSupport::SafeBuffer]   The generated hidden form field", "Macro which generates accessors in pure Ruby classes for assigning\n multiple attachments at once. This is primarily useful together with\n multiple file uploads. There is also an Active Record version of\n this macro.\n\n The name of the generated accessors will be the name of the association\n (represented by an attribute accessor) and the name of the attachment in\n the associated class. So if a `Post` accepts attachments for `images`, and\n the attachment in the `Image` class is named `file`, then the accessors will\n be named `images_files`.\n\n @example in associated class\n   class Document\n     extend Refile::Attachment\n     attr_accessor :file_id\n\n     attachment :file\n\n     def initialize(attributes = {})\n       self.file = attributes[:file]\n     end\n   end\n\n @example in class\n   class Post\n     extend Refile::Attachment\n     include ActiveModel::Model\n\n     attr_accessor :documents\n\n     accepts_attachments_for :documents, accessor_prefix: 'documents_files', collection_class: Document\n\n     def initialize(attributes = {})\n       @documents = attributes[:documents] || []\n     end\n   end\n\n @example in form\n   <%= form_for @post do |form| %>\n     <%= form.attachment_field :documents_files, multiple: true %>\n   <% end %>\n\n @param [Symbol]  collection_name      Name of the association\n @param [Class]   collection_class     Associated class\n @param [String]  accessor_prefix      Name of the generated accessors\n @param [Symbol]  attachment           Name of the attachment in the associated class\n @param [Boolean] append               If true, new files are appended instead of replacing the entire list of associated classes.\n @return [void]", "Downloads the file to a Tempfile on disk and returns this tempfile.\n\n @example\n   file = backend.upload(StringIO.new(\"hello\"))\n   tempfile = file.download\n   File.read(tempfile.path) # => \"hello\"\n\n @return [Tempfile] a tempfile with the file's content", "Builds a serializable hash from the response data.\n\n @return [Hash] hash that represents this response\n  and can be easily serialized.\n @see Response.from_hash", "Adds a callback that will be executed around each HTTP request.\n\n @example\n  VCR.configure do |c|\n    c.around_http_request(lambda {|r| r.uri =~ /api.geocoder.com/}) do |request|\n      # extract an address like \"1700 E Pine St, Seattle, WA\"\n      # from a query like \"address=1700+E+Pine+St%2C+Seattle%2C+WA\"\n      address = CGI.unescape(URI(request.uri).query.split('=').last)\n      VCR.use_cassette(\"geocoding/#{address}\", &request)\n    end\n  end\n\n @yield the callback\n @yieldparam request [VCR::Request::FiberAware] the request that is being made\n @raise [VCR::Errors::NotSupportedError] if the fiber library cannot be loaded.\n @param filters [optional splat of #to_proc] one or more filters to apply.\n   The objects provided will be converted to procs using `#to_proc`. If provided,\n   the callback will only be invoked if these procs all return `true`.\n @note This method can only be used on ruby interpreters that support\n  fibers (i.e. 1.9+). On 1.8 you can use separate `before_http_request` and\n  `after_http_request` hooks.\n @note You _must_ call `request.proceed` or pass the request as a proc on to a\n  method that yields to a block (i.e. `some_method(&request)`).\n @see #before_http_request\n @see #after_http_request", "Define a country's rules.\n\n Use the other DSL methods to define the country's rules.\n\n @param [String] country_code The country code of the country.\n @param [Phony::CountryCodes] definition Rules for this country.\n\n @return Undefined.\n\n @example Add a country with country code 27.\n   country '27', # CC, followed by rules, for example fixed(2) >> ...", "National matcher & splitters.\n\n By default, a fixed length NDC\n uses a zero prefix when formatted\n with format :national.\n\n @param [Fixnum] length The length of the fixed length NDC.\n @param [Hash] options An options hash (set zero: false to not add a zero on format :national).\n\n @return NationalSplitters::Fixed A fixed length national splitter.\n\n @example France. Uses a fixed NDC of size 1.\n   country '33', fixed(1) >> split(2,2,2,2)", "Add the given country to the mapping under the\n given country code.", "Splits this number into cc, ndc and locally split number parts.", "Format the number.", "Is this number plausible?", "Is the given number a vanity number?", "Split off the country and the cc, and also return the national number part.", "A number is split with the code handlers as given in the initializer.\n\n Note: If the ndc is nil, it will not return it.\n\n @return [Trunk, String (ndc), Array<String> (national pieces)]", "Format the number, given the national part of it.", "Removes 0s from partially normalized numbers\n such as 410443643533.\n\n Example:\n   410443643533 -> 41443643533\n\n In some cases it doesn't, like Italy.", "Tests for plausibility of this national number.", "Merge the other criteria into this one.\n\n @example Merge another criteria into this criteria.\n   criteria.merge(Person.where(name: \"bob\"))\n\n @param [ Criteria ] other The criteria to merge in.\n\n @return [ Criteria ] The merged criteria.\n\n @since 3.0.0", "Overriden to include _type in the fields.\n\n @example Limit the fields returned from the database.\n   Band.only(:name)\n\n @param [ Array<Symbol> ] args The names of the fields.\n\n @return [ Criteria ] The cloned criteria.\n\n @since 1.0.0", "Set the read preference for the criteria.\n\n @example Set the read preference.\n   criteria.read(mode: :primary_preferred)\n\n @param [ Hash ] value The mode preference.\n\n @return [ Criteria ] The cloned criteria.\n\n @since 5.0.0", "Returns true if criteria responds to the given method.\n\n @example Does the criteria respond to the method?\n   crtiteria.respond_to?(:each)\n\n @param [ Symbol ] name The name of the class method on the +Document+.\n @param [ true, false ] include_private Whether to include privates.\n\n @return [ true, false ] If the criteria responds to the method.", "Are documents in the query missing, and are we configured to raise an\n error?\n\n @api private\n\n @example Check for missing documents.\n   criteria.check_for_missing_documents!([], [ 1 ])\n\n @param [ Array<Document> ] result The result.\n @param [ Array<Object> ] ids The ids.\n\n @raise [ Errors::DocumentNotFound ] If none are found and raising an\n   error.\n\n @since 3.0.0", "Clone or dup the current +Criteria+. This will return a new criteria with\n the selector, options, klass, embedded options, etc intact.\n\n @api private\n\n @example Clone a criteria.\n   criteria.clone\n\n @example Dup a criteria.\n   criteria.dup\n\n @param [ Criteria ] other The criteria getting cloned.\n\n @return [ nil ] nil.\n\n @since 1.0.0", "Get the selector for type selection.\n\n @api private\n\n @example Get a type selection hash.\n   criteria.type_selection\n\n @return [ Hash ] The type selection.\n\n @since 3.0.3", "Takes the provided selector and atomic operations and replaces the\n indexes of the embedded documents with the positional operator when\n needed.\n\n @note The only time we can accurately know when to use the positional\n   operator is at the exact time we are going to persist something. So\n   we can tell by the selector that we are sending if it is actually\n   possible to use the positional operator at all. For example, if the\n   selector is: { \"_id\" => 1 }, then we could not use the positional\n   operator for updating embedded documents since there would never be a\n   match - we base whether we can based on the number of levels deep the\n   selector goes, and if the id values are not nil.\n\n @example Process the operations.\n   positionally(\n     { \"_id\" => 1, \"addresses._id\" => 2 },\n     { \"$set\" => { \"addresses.0.street\" => \"hobrecht\" }}\n   )\n\n @param [ Hash ] selector The selector.\n @param [ Hash ] operations The update operations.\n @param [ Hash ] processed The processed update operations.\n\n @return [ Hash ] The new operations.\n\n @since 3.1.0", "Add the association to the touchable associations if the touch option was\n provided.\n\n @example Add the touchable.\n   Model.define_touchable!(assoc)\n\n @param [ Association ] association The association metadata.\n\n @return [ Class ] The model class.\n\n @since 3.0.0", "Gets the default Mongoid logger - stdout.\n\n @api private\n\n @example Get the default logger.\n   Loggable.default_logger\n\n @return [ Logger ] The default logger.\n\n @since 3.0.0", "When cloning, if the document has localized fields we need to ensure they\n are properly processed in the clone.\n\n @api private\n\n @example Process localized attributes.\n   model.process_localized_attributes(attributes)\n\n @param [ Hash ] attrs The attributes.\n\n @since 3.0.20", "Get the document selector with the defined shard keys.\n\n @example Get the selector for the shard keys.\n   person.shard_key_selector\n\n @return [ Hash ] The shard key selector.\n\n @since 2.0.0", "Reloads the +Document+ attributes from the database. If the document has\n not been saved then an error will get raised if the configuration option\n was set. This can reload root documents or embedded documents.\n\n @example Reload the document.\n   person.reload\n\n @raise [ Errors::DocumentNotFound ] If the document was deleted.\n\n @return [ Document ] The document, reloaded.\n\n @since 1.0.0", "Reload the root document.\n\n @example Reload the document.\n   document.reload_root_document\n\n @return [ Hash ] The reloaded attributes.\n\n @since 2.3.2", "Reload the embedded document.\n\n @example Reload the document.\n   document.reload_embedded_document\n\n @return [ Hash ] The reloaded attributes.\n\n @since 2.3.2", "Extract only the desired embedded document from the attributes.\n\n @example Extract the embedded document.\n   document.extract_embedded_attributes(attributes)\n\n @param [ Hash ] attributes The document in the db.\n\n @return [ Hash ] The document's extracted attributes.\n\n @since 2.3.2", "Determine if an attribute is present.\n\n @example Is the attribute present?\n   person.attribute_present?(\"title\")\n\n @param [ String, Symbol ] name The name of the attribute.\n\n @return [ true, false ] True if present, false if not.\n\n @since 1.0.0", "Read a value from the document attributes. If the value does not exist\n it will return nil.\n\n @example Read an attribute.\n   person.read_attribute(:title)\n\n @example Read an attribute (alternate syntax.)\n   person[:title]\n\n @param [ String, Symbol ] name The name of the attribute to get.\n\n @return [ Object ] The value of the attribute.\n\n @since 1.0.0", "Read a value from the attributes before type cast. If the value has not\n yet been assigned then this will return the attribute's existing value\n using read_raw_attribute.\n\n @example Read an attribute before type cast.\n   person.read_attribute_before_type_cast(:price)\n\n @param [ String, Symbol ] name The name of the attribute to get.\n\n @return [ Object ] The value of the attribute before type cast, if\n   available. Otherwise, the value of the attribute.\n\n @since 3.1.0", "Remove a value from the +Document+ attributes. If the value does not exist\n it will fail gracefully.\n\n @example Remove the attribute.\n   person.remove_attribute(:title)\n\n @param [ String, Symbol ] name The name of the attribute to remove.\n\n @raise [ Errors::ReadonlyAttribute ] If the field cannot be removed due\n   to being flagged as reaodnly.\n\n @since 1.0.0", "Write a single attribute to the document attribute hash. This will\n also fire the before and after update callbacks, and perform any\n necessary typecasting.\n\n @example Write the attribute.\n   person.write_attribute(:title, \"Mr.\")\n\n @example Write the attribute (alternate syntax.)\n   person[:title] = \"Mr.\"\n\n @param [ String, Symbol ] name The name of the attribute to update.\n @param [ Object ] value The value to set for the attribute.\n\n @since 1.0.0", "Determine if the attribute is missing from the document, due to loading\n it from the database with missing fields.\n\n @example Is the attribute missing?\n   document.attribute_missing?(\"test\")\n\n @param [ String ] name The name of the attribute.\n\n @return [ true, false ] If the attribute is missing.\n\n @since 4.0.0", "Return the typecasted value for a field.\n\n @example Get the value typecasted.\n   person.typed_value_for(:title, :sir)\n\n @param [ String, Symbol ] key The field name.\n @param [ Object ] value The uncast value.\n\n @return [ Object ] The cast value.\n\n @since 1.0.0", "Validates an attribute value. This provides validation checking if\n the value is valid for given a field.\n For now, only Hash and Array fields are validated.\n\n @param [ String, Symbol ] access The name of the attribute to validate.\n @param [ Object ] value The to be validated.\n\n @since 3.0.10", "Builds a new +Document+ from the supplied attributes.\n\n @example Build the document.\n   Mongoid::Factory.build(Person, { \"name\" => \"Durran\" })\n\n @param [ Class ] klass The class to instantiate from if _type is not present.\n @param [ Hash ] attributes The document attributes.\n\n @return [ Document ] The instantiated document.", "Builds a new +Document+ from the supplied attributes loaded from the\n database.\n\n If a criteria object is given, it is used in two ways:\n 1. If the criteria has a list of fields specified via #only,\n    only those fields are populated in the returned document.\n 2. If the criteria has a referencing association (i.e., this document\n    is being instantiated as an association of another document),\n    the other document is also populated in the returned document's\n    reverse association, if one exists.\n\n @example Build the document.\n   Mongoid::Factory.from_db(Person, { \"name\" => \"Durran\" })\n\n @param [ Class ] klass The class to instantiate from if _type is not present.\n @param [ Hash ] attributes The document attributes.\n @param [ Criteria ] criteria Optional criteria object.\n @param [ Hash ] selected_fields Fields which were retrieved via\n   #only. If selected_fields are specified, fields not listed in it\n   will not be accessible in the returned document.\n\n @return [ Document ] The instantiated document.", "Add the document as an atomic pull.\n\n @example Add the atomic pull.\n   person.add_atomic_pull(address)\n\n @param [ Document ] document The embedded document to pull.\n\n @since 2.2.0", "Add an atomic unset for the document.\n\n @example Add an atomic unset.\n   document.add_atomic_unset(doc)\n\n @param [ Document ] document The child document.\n\n @return [ Array<Document> ] The children.\n\n @since 3.0.0", "Get all the atomic updates that need to happen for the current\n +Document+. This includes all changes that need to happen in the\n entire hierarchy that exists below where the save call was made.\n\n @note MongoDB does not allow \"conflicting modifications\" to be\n   performed in a single operation. Conflicting modifications are\n   detected by the 'haveConflictingMod' function in MongoDB.\n   Examination of the code suggests that two modifications (a $set\n   and a $push with $each, for example) conflict if:\n     (1) the key paths being modified are equal.\n     (2) one key path is a prefix of the other.\n   So a $set of 'addresses.0.street' will conflict with a $push and $each\n   to 'addresses', and we will need to split our update into two\n   pieces. We do not, however, attempt to match MongoDB's logic\n   exactly. Instead, we assume that two updates conflict if the\n   first component of the two key paths matches.\n\n @example Get the updates that need to occur.\n   person.atomic_updates(children)\n\n @return [ Hash ] The updates and their modifiers.\n\n @since 2.1.0", "Get all the attributes that need to be pulled.\n\n @example Get the pulls.\n   person.atomic_pulls\n\n @return [ Array<Hash> ] The $pullAll operations.\n\n @since 2.2.0", "Get all the attributes that need to be unset.\n\n @example Get the unsets.\n   person.atomic_unsets\n\n @return [ Array<Hash> ] The $unset operations.\n\n @since 2.2.0", "Generates the atomic updates in the correct order.\n\n @example Generate the updates.\n   model.generate_atomic_updates(mods, doc)\n\n @param [ Modifiers ] mods The atomic modifications.\n @param [ Document ] doc The document to update for.\n\n @since 2.2.0", "Initialize the persistence context object.\n\n @example Create a new persistence context.\n   PersistenceContext.new(model, collection: 'other')\n\n @param [ Object ] object The class or model instance for which a persistence context\n   should be created.\n @param [ Hash ] opts The persistence context options.\n\n @since 6.0.0\n Get the collection for this persistence context.\n\n @example Get the collection for this persistence context.\n   context.collection\n\n @param [ Object ] parent The parent object whose collection name is used\n   instead of this persistence context's collection name.\n\n @return [ Mongo::Collection ] The collection for this persistence\n   context.\n\n @since 6.0.0", "Get the client for this persistence context.\n\n @example Get the client for this persistence context.\n   context.client\n\n @return [ Mongo::Client ] The client for this persistence\n  context.\n\n @since 6.0.0", "Get all the changes for the document.\n\n @example Get all the changes.\n   model.changes\n\n @return [ Hash<String, Array<Object, Object> ] The changes.\n\n @since 2.4.0", "Call this method after save, so the changes can be properly switched.\n\n This will unset the memoized children array, set new record to\n false, set the document as validated, and move the dirty changes.\n\n @example Move the changes to previous.\n   person.move_changes\n\n @since 2.1.0", "Get the old and new value for the provided attribute.\n\n @example Get the attribute change.\n   model.attribute_change(\"name\")\n\n @param [ String ] attr The name of the attribute.\n\n @return [ Array<Object> ] The old and new values.\n\n @since 2.1.0", "Determine if a specific attribute has changed.\n\n @example Has the attribute changed?\n   model.attribute_changed?(\"name\")\n\n @param [ String ] attr The name of the attribute.\n\n @return [ true, false ] Whether the attribute has changed.\n\n @since 2.1.6", "Get whether or not the field has a different value from the default.\n\n @example Is the field different from the default?\n   model.attribute_changed_from_default?\n\n @param [ String ] attr The name of the attribute.\n\n @return [ true, false ] If the attribute differs.\n\n @since 3.0.0", "Get the previous value for the attribute.\n\n @example Get the previous value.\n   model.attribute_was(\"name\")\n\n @param [ String ] attr The attribute name.\n\n @since 2.4.0", "Flag an attribute as going to change.\n\n @example Flag the attribute.\n   model.attribute_will_change!(\"name\")\n\n @param [ String ] attr The name of the attribute.\n\n @return [ Object ] The old value.\n\n @since 2.3.0", "Set the attribute back to its old value.\n\n @example Reset the attribute.\n   model.reset_attribute!(\"name\")\n\n @param [ String ] attr The name of the attribute.\n\n @return [ Object ] The old value.\n\n @since 2.4.0", "Use the application configuration to get every model and require it, so\n that indexing and inheritance work in both development and production\n with the same results.\n\n @example Load all the application models.\n   Rails::Mongoid.load_models(app)\n\n @param [ Application ] app The rails application.", "I don't want to mock out kernel for unit testing purposes, so added this\n method as a convenience.\n\n @example Load the model.\n   Mongoid.load_model(\"/mongoid/behavior\")\n\n @param [ String ] file The base filename.\n\n @since 2.0.0.rc.3", "Applies a single default value for the given name.\n\n @example Apply a single default.\n   model.apply_default(\"name\")\n\n @param [ String ] name The name of the field.\n\n @since 2.4.0", "Post process the persistence operation.\n\n @api private\n\n @example Post process the persistence operation.\n   document.post_process_persist(true)\n\n @param [ Object ] result The result of the operation.\n @param [ Hash ] options The options.\n\n @return [ true ] true.\n\n @since 4.0.0", "Process the atomic operations - this handles the common behavior of\n iterating through each op, getting the aliased field name, and removing\n appropriate dirty changes.\n\n @api private\n\n @example Process the atomic operations.\n   document.process_atomic_operations(pulls) do |field, value|\n     ...\n   end\n\n @param [ Hash ] operations The atomic operations.\n\n @return [ Hash ] The operations.\n\n @since 4.0.0", "If we are in an atomically block, add the operations to the delayed group,\n otherwise persist immediately.\n\n @api private\n\n @example Persist immediately or delay the operations.\n   document.persist_or_delay_atomic_operation(ops)\n\n @param [ Hash ] operation The operation.\n\n @since 4.0.0", "Persist the atomic operations.\n\n @api private\n\n @example Persist the atomic operations.\n   persist_atomic_operations(ops)\n\n @param [ Hash ] operations The atomic operations.\n\n @since 4.0.0", "Gets the document as a serializable hash, used by ActiveModel's JSON\n serializer.\n\n @example Get the serializable hash.\n   document.serializable_hash\n\n @example Get the serializable hash with options.\n   document.serializable_hash(:include => :addresses)\n\n @param [ Hash ] options The options to pass.\n\n @option options [ Symbol ] :include What associations to include.\n @option options [ Symbol ] :only Limit the fields to only these.\n @option options [ Symbol ] :except Dont include these fields.\n @option options [ Symbol ] :methods What methods to include.\n\n @return [ Hash ] The document, ready to be serialized.\n\n @since 2.0.0.rc.6", "Get the names of all fields that will be serialized.\n\n @api private\n\n @example Get all the field names.\n   document.send(:field_names)\n\n @return [ Array<String> ] The names of the fields.\n\n @since 3.0.0", "Serialize a single attribute. Handles associations, fields, and dynamic\n attributes.\n\n @api private\n\n @example Serialize the attribute.\n   document.serialize_attribute({}, \"id\" , [ \"id\" ])\n\n @param [ Hash ] attrs The attributes.\n @param [ String ] name The attribute name.\n @param [ Array<String> ] names The names of all attributes.\n @param [ Hash ] options The options.\n\n @return [ Object ] The attribute.\n\n @since 3.0.0", "For each of the provided include options, get the association needed and\n provide it in the hash.\n\n @example Serialize the included associations.\n   document.serialize_relations({}, :include => :addresses)\n\n @param [ Hash ] attributes The attributes to serialize.\n @param [ Hash ] options The serialization options.\n\n @option options [ Symbol ] :include What associations to include\n @option options [ Symbol ] :only Limit the fields to only these.\n @option options [ Symbol ] :except Dont include these fields.\n\n @since 2.0.0.rc.6", "Since the inclusions can be a hash, symbol, or array of symbols, this is\n provided as a convenience to parse out the names.\n\n @example Get the association names.\n   document.relation_names(:include => [ :addresses ])\n\n @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.\n\n @return [ Array<Symbol> ] The names of the included associations.\n\n @since 2.0.0.rc.6", "Since the inclusions can be a hash, symbol, or array of symbols, this is\n provided as a convenience to parse out the options.\n\n @example Get the association options.\n   document.relation_names(:include => [ :addresses ])\n\n @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.\n @param [ Hash ] options The options.\n @param [ Symbol ] name The name of the association.\n\n @return [ Hash ] The options for the association.\n\n @since 2.0.0.rc.6", "Get the current Mongoid scope.\n\n @example Get the scope.\n   Threaded.current_scope(klass)\n   Threaded.current_scope\n\n @param [ Klass ] klass The class type of the scope.\n\n @return [ Criteria ] The scope.\n\n @since 5.0.0", "Set the current Mongoid scope. Safe for multi-model scope chaining.\n\n @example Set the scope.\n   Threaded.current_scope(scope, klass)\n\n @param [ Criteria ] scope The current scope.\n @param [ Class ] klass The current model class.\n\n @return [ Criteria ] The scope.\n\n @since 5.0.1", "Apply the default scoping to the attributes of the document, as long as\n they are not complex queries.\n\n @api private\n\n @example Apply the default scoping.\n   document.apply_default_scoping\n\n @return [ true, false ] If default scoping was applied.\n\n @since 4.0.0", "Overrides the default ActiveModel behavior since we need to handle\n validations of associations slightly different than just calling the\n getter.\n\n @example Read the value.\n   person.read_attribute_for_validation(:addresses)\n\n @param [ Symbol ] attr The name of the field or association.\n\n @return [ Object ] The value of the field or the association.\n\n @since 2.0.0.rc.1", "Collect all the children of this document.\n\n @example Collect all the children.\n   document.collect_children\n\n @return [ Array<Document> ] The children.\n\n @since 2.4.0", "Remove a child document from this parent. If an embeds one then set to\n nil, otherwise remove from the embeds many.\n\n This is called from the +RemoveEmbedded+ persistence command.\n\n @example Remove the child.\n   document.remove_child(child)\n\n @param [ Document ] child The child (embedded) document to remove.\n\n @since 2.0.0.beta.1", "After children are persisted we can call this to move all their changes\n and flag them as persisted in one call.\n\n @example Reset the children.\n   document.reset_persisted_children\n\n @return [ Array<Document> ] The children.\n\n @since 2.1.0", "Returns an instance of the specified class with the attributes,\n errors, and embedded documents of the current document.\n\n @example Return a subclass document as a superclass instance.\n   manager.becomes(Person)\n\n @raise [ ArgumentError ] If the class doesn't include Mongoid::Document\n\n @param [ Class ] klass The class to become.\n\n @return [ Document ] An instance of the specified class.\n\n @since 2.0.0", "Convenience method for iterating through the loaded associations and\n reloading them.\n\n @example Reload the associations.\n   document.reload_relations\n\n @return [ Hash ] The association metadata.\n\n @since 2.1.6", "Get an array of inspected fields for the document.\n\n @api private\n\n @example Inspect the defined fields.\n   document.inspect_fields\n\n @return [ String ] An array of pretty printed field values.\n\n @since 1.0.0", "Run the callbacks for the document. This overrides active support's\n functionality to cascade callbacks to embedded documents that have been\n flagged as such.\n\n @example Run the callbacks.\n   run_callbacks :save do\n     save!\n   end\n\n @param [ Symbol ] kind The type of callback to execute.\n @param [ Array ] args Any options.\n\n @return [ Document ] The document\n\n @since 2.3.0", "Get all the child embedded documents that are flagged as cascadable.\n\n @example Get all the cascading children.\n   document.cascadable_children(:update)\n\n @param [ Symbol ] kind The type of callback.\n\n @return [ Array<Document> ] The children.\n\n @since 2.3.0", "Determine if the child should fire the callback.\n\n @example Should the child fire the callback?\n   document.cascadable_child?(:update, doc)\n\n @param [ Symbol ] kind The type of callback.\n @param [ Document ] child The child document.\n\n @return [ true, false ] If the child should fire the callback.\n\n @since 2.3.0", "Connect to the provided database name on the default client.\n\n @note Use only in development or test environments for convenience.\n\n @example Set the database to connect to.\n   config.connect_to(\"mongoid_test\")\n\n @param [ String ] name The database name.\n\n @since 3.0.0", "Load the settings from a compliant mongoid.yml file. This can be used for\n easy setup with frameworks other than Rails.\n\n @example Configure Mongoid.\n   Mongoid.load!(\"/path/to/mongoid.yml\")\n\n @param [ String ] path The path to the file.\n @param [ String, Symbol ] environment The environment to load.\n\n @since 2.0.1", "Register a model in the application with Mongoid.\n\n @example Register a model.\n   config.register_model(Band)\n\n @param [ Class ] klass The model to register.\n\n @since 3.1.0", "From a hash of settings, load all the configuration.\n\n @example Load the configuration.\n   config.load_configuration(settings)\n\n @param [ Hash ] settings The configuration settings.\n\n @since 3.1.0", "Truncate all data in all collections, but not the indexes.\n\n @example Truncate all collection data.\n   Mongoid::Config.truncate!\n\n @note This will be slower than purge!\n\n @return [ true ] true.\n\n @since 2.0.2", "Set the configuration options. Will validate each one individually.\n\n @example Set the options.\n   config.options = { raise_not_found_error: true }\n\n @param [ Hash ] options The configuration options.\n\n @since 3.0.0", "Responds to unauthorized requests in a manner fitting the request format.\n `js`, `json`, and `xml` requests will receive a 401 with no body. All\n other formats will be redirected appropriately and can optionally have the\n flash message set.\n\n When redirecting, the originally requested url will be stored in the\n session (`session[:return_to]`), allowing it to be used as a redirect url\n once the user has successfully signed in.\n\n If there is a signed in user, the request will be redirected according to\n the value returned from {#url_after_denied_access_when_signed_in}.\n\n If there is no signed in user, the request will be redirected according to\n the value returned from {#url_after_denied_access_when_signed_out}.\n For the exact redirect behavior, see {#redirect_request}.\n\n @param [String] flash_message", "Reads previously existing sessions from a cookie and maintains the cookie\n on each response.", "Send the user a file.\n @param file [File] The file to send to the user\n @param caption [String] The caption of the file being sent\n @param filename [String] Overrides the filename of the uploaded file\n @param spoiler [true, false] Whether or not this file should appear as a spoiler.\n @return [Message] the message sent to this user.\n @example Send a file from disk\n   user.send_file(File.open('rubytaco.png', 'r'))", "Set the user's presence data\n @note for internal use only\n @!visibility private", "Checks whether this user can do the particular action, regardless of whether it has the permission defined,\n through for example being the server owner or having the Manage Roles permission\n @param action [Symbol] The permission that should be checked. See also {Permissions::FLAGS} for a list.\n @param channel [Channel, nil] If channel overrides should be checked too, this channel specifies where the overrides should be checked.\n @example Check if the bot can send messages to a specific channel in a server.\n   bot_profile = bot.profile.on(event.server)\n   can_send_messages = bot_profile.permission?(:send_messages, channel)\n @return [true, false] whether or not this user has the permission.", "Sets this channels parent category\n @param channel [Channel, #resolve_id] the target category channel\n @raise [ArgumentError] if the target channel isn't a category", "Sorts this channel's position to follow another channel.\n @param other [Channel, #resolve_id, nil] The channel below which this channel should be sorted. If the given\n   channel is a category, this channel will be sorted at the top of that category. If it is `nil`, the channel will\n   be sorted at the top of the channel list.\n @param lock_permissions [true, false] Whether the channel's permissions should be synced to the category's", "Sets whether this channel is NSFW\n @param nsfw [true, false]\n @raise [ArguementError] if value isn't one of true, false", "Sends a temporary message to this channel.\n @param content [String] The content to send. Should not be longer than 2000 characters or it will result in an error.\n @param timeout [Float] The amount of time in seconds after which the message sent will be deleted.\n @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.\n @param embed [Hash, Discordrb::Webhooks::Embed, nil] The rich embed to append to this message.", "Convenience method to send a message with an embed.\n @example Send a message with an embed\n   channel.send_embed do |embed|\n     embed.title = 'The Ruby logo'\n     embed.image = Discordrb::Webhooks::EmbedImage.new(url: 'https://www.ruby-lang.org/images/header-ruby-logo.png')\n   end\n @param message [String] The message that should be sent along with the embed. If this is the empty string, only the embed will be shown.\n @param embed [Discordrb::Webhooks::Embed, nil] The embed to start the building process with, or nil if one should be created anew.\n @yield [embed] Yields the embed to allow for easy building inside a block.\n @yieldparam embed [Discordrb::Webhooks::Embed] The embed from the parameters, or a new one.\n @return [Message] The resulting message.", "Sends a file to this channel. If it is an image, it will be embedded.\n @param file [File] The file to send. There's no clear size limit for this, you'll have to attempt it for yourself (most non-image files are fine, large images may fail to embed)\n @param caption [string] The caption for the file.\n @param tts [true, false] Whether or not this file's caption should be sent using Discord text-to-speech.\n @param filename [String] Overrides the filename of the uploaded file\n @param spoiler [true, false] Whether or not this file should appear as a spoiler.\n @example Send a file from disk\n   channel.send_file(File.open('rubytaco.png', 'r'))", "Deletes a permission overwrite for this channel\n @param target [Member, User, Role, Profile, Recipient, #resolve_id] What permission overwrite to delete\n   @param reason [String] The reason the for the overwrite deletion.", "Updates the cached data from another channel.\n @note For internal use only\n @!visibility private", "The list of users currently in this channel. For a voice channel, it will return all the members currently\n in that channel. For a text channel, it will return all online members that have permission to read it.\n @return [Array<Member>] the users in this channel", "Retrieves some of this channel's message history.\n @param amount [Integer] How many messages to retrieve. This must be less than or equal to 100, if it is higher\n   than 100 it will be treated as 100 on Discord's side.\n @param before_id [Integer] The ID of the most recent message the retrieval should start at, or nil if it should\n   start at the current message.\n @param after_id [Integer] The ID of the oldest message the retrieval should start at, or nil if it should start\n   as soon as possible with the specified amount.\n @param around_id [Integer] The ID of the message retrieval should start from, reading in both directions\n @example Count the number of messages in the last 50 messages that contain the letter 'e'.\n   message_count = channel.history(50).count {|message| message.content.include? \"e\"}\n @example Get the last 10 messages before the provided message.\n   last_ten_messages = channel.history(10, message.id)\n @return [Array<Message>] the retrieved messages.", "Retrieves message history, but only message IDs for use with prune.\n @note For internal use only\n @!visibility private", "Returns a single message from this channel's history by ID.\n @param message_id [Integer] The ID of the message to retrieve.\n @return [Message, nil] the retrieved message, or `nil` if it couldn't be found.", "Requests all pinned messages in a channel.\n @return [Array<Message>] the received messages.", "Delete the last N messages on this channel.\n @param amount [Integer] The amount of message history to consider for pruning. Must be a value between 2 and 100 (Discord limitation)\n @param strict [true, false] Whether an error should be raised when a message is reached that is too old to be bulk\n   deleted. If this is false only a warning message will be output to the console.\n @raise [ArgumentError] if the amount of messages is not a value between 2 and 100\n @yield [message] Yields each message in this channels history for filtering the messages to delete\n @example Pruning messages from a specific user ID\n   channel.prune(100) { |m| m.author.id == 83283213010599936 }\n @return [Integer] The amount of messages that were successfully deleted", "Deletes a collection of messages\n @param messages [Array<Message, Integer, #resolve_id>] the messages (or message IDs) to delete. Total must be an amount between 2 and 100 (Discord limitation)\n @param strict [true, false] Whether an error should be raised when a message is reached that is too old to be bulk\n   deleted. If this is false only a warning message will be output to the console.\n @raise [ArgumentError] if the amount of messages is not a value between 2 and 100\n @return [Integer] The amount of messages that were successfully deleted", "Creates a new invite to this channel.\n @param max_age [Integer] How many seconds this invite should last.\n @param max_uses [Integer] How many times this invite should be able to be used.\n @param temporary [true, false] Whether membership should be temporary (kicked after going offline).\n @param unique [true, false] If true, Discord will always send a unique invite instead of possibly re-using a similar one\n @param reason [String] The reason the for the creation of this invite.\n @return [Invite] the created invite.", "Creates a Group channel\n @param user_ids [Array<Integer>] Array of user IDs to add to the new group channel (Excluding\n   the recipient of the PM channel).\n @return [Channel] the created channel.", "Adds a user to a group channel.\n @param user_ids [Array<#resolve_id>, #resolve_id] User ID or array of user IDs to add to the group channel.\n @return [Channel] the group channel.", "Removes a user from a group channel.\n @param user_ids [Array<#resolve_id>, #resolve_id] User ID or array of user IDs to remove from the group channel.\n @return [Channel] the group channel.", "Requests a list of Webhooks on the channel.\n @return [Array<Webhook>] webhooks on the channel.", "Requests a list of Invites to the channel.\n @return [Array<Invite>] invites to the channel.", "Adds a recipient to a group channel.\n @param recipient [Recipient] the recipient to add to the group\n @raise [ArgumentError] if tried to add a non-recipient\n @note For internal use only\n @!visibility private", "Removes a recipient from a group channel.\n @param recipient [Recipient] the recipient to remove from the group\n @raise [ArgumentError] if tried to remove a non-recipient\n @note For internal use only\n @!visibility private", "Deletes a list of messages on this channel using bulk delete.", "Adds all event handlers from another container into this one. Existing event handlers will be overwritten.\n @param container [Module] A module that `extend`s {EventContainer} from which the handlers will be added.", "Updates the webhook if you need to edit more than 1 attribute.\n @param data [Hash] the data to update.\n @option data [String, #read, nil] :avatar The new avatar, in base64-encoded JPG format, or nil to delete the avatar.\n @option data [Channel, String, Integer, #resolve_id] :channel The channel the webhook should use.\n @option data [String] :name The webhook's new name.\n @option data [String] :reason The reason for the webhook changes.", "Deletes the webhook.\n @param reason [String] The reason the invite is being deleted.", "Sets the colour of the bar to the side of the embed to something new.\n @param value [Integer, String, {Integer, Integer, Integer}, #to_i, nil] The colour in decimal, hexadecimal, R/G/B decimal, or nil to clear the embeds colour\n   form.", "Convenience method to add a field to the embed without having to create one manually.\n @see EmbedField\n @example Add a field to an embed, conveniently\n   embed.add_field(name: 'A field', value: \"The field's content\")\n @param name [String] The field's name\n @param value [String] The field's value\n @param inline [true, false] Whether the field should be inlined", "Create a new LightBot. This does no networking yet, all networking is done by the methods on this class.\n @param token [String] The token that should be used to authenticate to Discord. Can be an OAuth token or a regular\n   user account token.\n @return [LightProfile] the details of the user this bot is connected to.", "Gets the connections associated with this account.\n @return [Array<Connection>] this account's connections.", "Finds an emoji by its name.\n @param name [String] The emoji name that should be resolved.\n @return [GlobalEmoji, nil] the emoji identified by the name, or `nil` if it couldn't be found.", "The bot's OAuth application.\n @return [Application, nil] The bot's application info. Returns `nil` if bot is not a bot account.", "Makes the bot join an invite to a server.\n @param invite [String, Invite] The invite to join. For possible formats see {#resolve_invite_code}.", "Sends a text message to a channel given its ID and the message's content.\n @param channel [Channel, Integer, #resolve_id] The channel to send something to.\n @param content [String] The text that should be sent as a message. It is limited to 2000 characters (Discord imposed).\n @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.\n @param embed [Hash, Discordrb::Webhooks::Embed, nil] The rich embed to append to this message.\n @return [Message] The message that was sent.", "Sends a text message to a channel given its ID and the message's content,\n then deletes it after the specified timeout in seconds.\n @param channel [Channel, Integer, #resolve_id] The channel to send something to.\n @param content [String] The text that should be sent as a message. It is limited to 2000 characters (Discord imposed).\n @param timeout [Float] The amount of time in seconds after which the message sent will be deleted.\n @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.\n @param embed [Hash, Discordrb::Webhooks::Embed, nil] The rich embed to append to this message.", "Sends a file to a channel. If it is an image, it will automatically be embedded.\n @note This executes in a blocking way, so if you're sending long files, be wary of delays.\n @param channel [Channel, Integer, #resolve_id] The channel to send something to.\n @param file [File] The file that should be sent.\n @param caption [string] The caption for the file.\n @param tts [true, false] Whether or not this file's caption should be sent using Discord text-to-speech.\n @param filename [String] Overrides the filename of the uploaded file\n @param spoiler [true, false] Whether or not this file should appear as a spoiler.\n @example Send a file from disk\n   bot.send_file(83281822225530880, File.open('rubytaco.png', 'r'))", "Creates a server on Discord with a specified name and a region.\n @note Discord's API doesn't directly return the server when creating it, so this method\n   waits until the data has been received via the websocket. This may make the execution take a while.\n @param name [String] The name the new server should have. Doesn't have to be alphanumeric.\n @param region [Symbol] The region where the server should be created, for example 'eu-central' or 'hongkong'.\n @return [Server] The server that was created.", "Changes information about your OAuth application\n @param name [String] What your application should be called.\n @param redirect_uris [Array<String>] URIs that Discord should redirect your users to after authorizing.\n @param description [String] A string that describes what your application does.\n @param icon [String, nil] A data URI for your icon image (for example a base 64 encoded image), or nil if no icon\n   should be set or changed.", "Gets the users, channels, roles and emoji from a string.\n @param mentions [String] The mentions, which should look like `<@12314873129>`, `<#123456789>`, `<@&123456789>` or `<:name:126328:>`.\n @param server [Server, nil] The server of the associated mentions. (recommended for role parsing, to speed things up)\n @return [Array<User, Channel, Role, Emoji>] The array of users, channels, roles and emoji identified by the mentions, or `nil` if none exists.", "Updates presence status.\n @param status [String] The status the bot should show up as. Can be `online`, `dnd`, `idle`, or `invisible`\n @param activity [String, nil] The name of the activity to be played/watched/listened to/stream name on the stream.\n @param url [String, nil] The Twitch URL to display as a stream. nil for no stream.\n @param since [Integer] When this status was set.\n @param afk [true, false] Whether the bot is AFK.\n @param activity_type [Integer] The type of activity status to display. Can be 0 (Playing), 1 (Streaming), 2 (Listening), 3 (Watching)\n @see Gateway#send_status_update", "Awaits an event, blocking the current thread until a response is received.\n @param type [Class] The event class that should be listened for.\n @option attributes [Numeric] :timeout the amount of time to wait for a response before returning `nil`. Waits forever if omitted.\n @return [Event, nil] The event object that was triggered, or `nil` if a `timeout` was set and no event was raised in time.\n @raise [ArgumentError] if `timeout` is given and is not a positive numeric value", "Makes the bot leave any groups with no recipients remaining", "Internal handler for VOICE_STATE_UPDATE", "Internal handler for VOICE_SERVER_UPDATE", "Internal handler for CHANNEL_CREATE", "Internal handler for CHANNEL_UPDATE", "Internal handler for CHANNEL_DELETE", "Internal handler for CHANNEL_RECIPIENT_ADD", "Internal handler for GUILD_MEMBER_ADD", "Internal handler for GUILD_MEMBER_UPDATE", "Internal handler for GUILD_MEMBER_DELETE", "Internal handler for GUILD_ROLE_UPDATE", "Internal handler for GUILD_ROLE_CREATE", "Internal handler for GUILD_ROLE_DELETE", "Internal handler for GUILD_EMOJIS_UPDATE", "Returns or caches the available voice regions", "Gets a channel given its ID. This queries the internal channel cache, and if the channel doesn't\n exist in there, it will get the data from Discord.\n @param id [Integer] The channel ID for which to search for.\n @param server [Server] The server for which to search the channel for. If this isn't specified, it will be\n   inferred using the API\n @return [Channel] The channel identified by the ID.", "Gets a user by its ID.\n @note This can only resolve users known by the bot (i.e. that share a server with the bot).\n @param id [Integer] The user ID that should be resolved.\n @return [User, nil] The user identified by the ID, or `nil` if it couldn't be found.", "Gets a server by its ID.\n @note This can only resolve servers the bot is currently in.\n @param id [Integer] The server ID that should be resolved.\n @return [Server, nil] The server identified by the ID, or `nil` if it couldn't be found.", "Gets a member by both IDs, or `Server` and user ID.\n @param server_or_id [Server, Integer] The `Server` or server ID for which a member should be resolved\n @param user_id [Integer] The ID of the user that should be resolved\n @return [Member, nil] The member identified by the IDs, or `nil` if none could be found", "Ensures a given user object is cached and if not, cache it from the given data hash.\n @param data [Hash] A data hash representing a user.\n @return [User] the user represented by the data hash.", "Ensures a given server object is cached and if not, cache it from the given data hash.\n @param data [Hash] A data hash representing a server.\n @return [Server] the server represented by the data hash.", "Ensures a given channel object is cached and if not, cache it from the given data hash.\n @param data [Hash] A data hash representing a channel.\n @param server [Server, nil] The server the channel is on, if known.\n @return [Channel] the channel represented by the data hash.", "Gets information about an invite.\n @param invite [String, Invite] The invite to join. For possible formats see {#resolve_invite_code}.\n @return [Invite] The invite with information about the given invite URL.", "Finds a channel given its name and optionally the name of the server it is in.\n @param channel_name [String] The channel to search for.\n @param server_name [String] The server to search for, or `nil` if only the channel should be searched for.\n @param type [Integer, nil] The type of channel to search for (0: text, 1: private, 2: voice, 3: group), or `nil` if any type of\n   channel should be searched for\n @return [Array<Channel>] The array of channels that were found. May be empty if none were found.", "Finds a user given its username or username & discriminator.\n @overload find_user(username)\n   Find all cached users with a certain username.\n   @param username [String] The username to look for.\n   @return [Array<User>] The array of users that were found. May be empty if none were found.\n @overload find_user(username, discrim)\n   Find a cached user with a certain username and discriminator.\n   Find a user by name and discriminator\n   @param username [String] The username to look for.\n   @param discrim [String] The user's discriminator\n   @return [User, nil] The user that was found, or `nil` if none was found\n @note This method only searches through users that have been cached. Users that have not yet been cached\n   by the bot but still share a connection with the user (mutual server) will not be found.\n @example Find users by name\n   bot.find_user('z64') #=> Array<User>\n @example Find a user by name and discriminator\n   bot.find_user('z64', '2639') #=> User", "Edits this message to have the specified content instead.\n You can only edit your own messages.\n @param new_content [String] the new content the message should have.\n @param new_embed [Hash, Discordrb::Webhooks::Embed, nil] The new embed the message should have. If `nil` the message will be changed to have no embed.\n @return [Message] the resulting message.", "Reacts to a message.\n @param reaction [String, #to_reaction] the unicode emoji or {Emoji}", "Returns the list of users who reacted with a certain reaction.\n @param reaction [String, #to_reaction] the unicode emoji or {Emoji}\n @param limit [Integer] the limit of how many users to retrieve. `nil` will return all users\n @example Get all the users that reacted with a thumbsup.\n   thumbs_up_reactions = message.reacted_with(\"\\u{1F44D}\")\n @return [Array<User>] the users who used this reaction", "Deletes a reaction made by a user on this message.\n @param user [User, #resolve_id] the user who used this reaction\n @param reaction [String, #to_reaction] the reaction to remove", "Deletes this client's reaction on this message.\n @param reaction [String, #to_reaction] the reaction to remove", "Process user objects given by the request\n @note For internal use only\n @!visibility private", "Process webhook objects given by the request\n @note For internal use only\n @!visibility private", "Divides the command chain into chain arguments and command chain, then executes them both.\n @param event [CommandEvent] The event to execute the command with.\n @return [String] the result of the command chain execution.", "Updates the data cache from another Role object\n @note For internal use only\n @!visibility private", "Updates the data cache from a hash containing data\n @note For internal use only\n @!visibility private", "Changes this role's permissions to a fixed bitfield. This allows setting multiple permissions at once with just\n one API call.\n\n Information on how this bitfield is structured can be found at\n https://discordapp.com/developers/docs/topics/permissions.\n @example Remove all permissions from a role\n   role.packed = 0\n @param packed [Integer] A bitfield with the desired permissions value.\n @param update_perms [true, false] Whether the internal data should also be updated. This should always be true\n   when calling externally.", "Moves this role above another role in the list.\n @param other [Role, #resolve_id, nil] The role above which this role should be moved. If it is `nil`,\n   the role will be moved above the @everyone role.\n @return [Integer] the new position of this role", "Bulk sets a member's roles.\n @param role [Role, Array<Role>] The role(s) to set.\n @param reason [String] The reason the user's roles are being changed.", "Adds and removes roles from a member.\n @param add [Role, Array<Role>] The role(s) to add.\n @param remove [Role, Array<Role>] The role(s) to remove.\n @param reason [String] The reason the user's roles are being changed.\n @example Remove the 'Member' role from a user, and add the 'Muted' role to them.\n   to_add = server.roles.find {|role| role.name == 'Muted'}\n   to_remove = server.roles.find {|role| role.name == 'Member'}\n   member.modify_roles(to_add, to_remove)", "Adds one or more roles to this member.\n @param role [Role, Array<Role, #resolve_id>, #resolve_id] The role(s) to add.\n @param reason [String] The reason the user's roles are being changed.", "Removes one or more roles from this member.\n @param role [Role, Array<Role>] The role(s) to remove.\n @param reason [String] The reason the user's roles are being changed.", "Sets or resets this member's nickname. Requires the Change Nickname permission for the bot itself and Manage\n Nicknames for other users.\n @param nick [String, nil] The string to set the nickname to, or nil if it should be reset.\n @param reason [String] The reason the user's nickname is being changed.", "Update this member's roles\n @note For internal use only.\n @!visibility private", "Executes a particular command on the bot. Mostly useful for internal stuff, but one can never know.\n @param name [Symbol] The command to execute.\n @param event [CommandEvent] The event to pass to the command.\n @param arguments [Array<String>] The arguments to pass to the command.\n @param chained [true, false] Whether or not it should be executed as part of a command chain. If this is false,\n   commands that have chain_usable set to false will not work.\n @param check_permissions [true, false] Whether permission parameters such as `required_permission` or\n   `permission_level` should be checked.\n @return [String, nil] the command's result, if there is any.", "Executes a command in a simple manner, without command chains or permissions.\n @param chain [String] The command with its arguments separated by spaces.\n @param event [CommandEvent] The event to pass to the command.\n @return [String, nil] the command's result, if there is any.", "Check if a user has permission to do something\n @param user [User] The user to check\n @param level [Integer] The minimum permission level the user should have (inclusive)\n @param server [Server] The server on which to check\n @return [true, false] whether or not the user has the given permission", "Internal handler for MESSAGE_CREATE that is overwritten to allow for command handling", "Check whether a message should trigger command execution, and if it does, return the raw chain", "Stops the current playback entirely.\n @param wait_for_confirmation [true, false] Whether the method should wait for confirmation from the playback\n   method that the playback has actually stopped.", "Plays a stream of audio data in the DCA format. This format has the advantage that no recoding has to be\n done - the file contains the data exactly as Discord needs it.\n @note DCA playback will not be affected by the volume modifier ({#volume}) because the modifier operates on raw\n   PCM, not opus data. Modifying the volume of DCA data would involve decoding it, multiplying the samples and\n   re-encoding it, which defeats its entire purpose (no recoding).\n @see https://github.com/bwmarrin/dca\n @see #play", "Plays the data from the @io stream as Discord requires it", "Create a new webhook\n @param url [String] The URL to post messages to.\n @param id [Integer] The webhook's ID. Will only be used if `url` is not\n   set.\n @param token [String] The webhook's authorisation token. Will only be used\n   if `url` is not set.\n Executes the webhook this client points to with the given data.\n @param builder [Builder, nil] The builder to start out with, or nil if one should be created anew.\n @param wait [true, false] Whether Discord should wait for the message to be successfully received by clients, or\n   whether it should return immediately after sending the message.\n @yield [builder] Gives the builder to the block to add additional steps, or to do the entire building process.\n @yieldparam builder [Builder] The builder given as a parameter which is used as the initial step to start from.\n @example Execute the webhook with an already existing builder\n   builder = Discordrb::Webhooks::Builder.new # ...\n   client.execute(builder)\n @example Execute the webhook by building a new message\n   client.execute do |builder|\n     builder.content = 'Testing'\n     builder.username = 'discordrb'\n     builder.add_embed do |embed|\n       embed.timestamp = Time.now\n       embed.title = 'Testing'\n       embed.image = Discordrb::Webhooks::EmbedImage.new(url: 'https://i.imgur.com/PcMltU7.jpg')\n     end\n   end\n @return [RestClient::Response] the response returned by Discord.", "Makes a new await. For internal use only.\n @!visibility private\n Checks whether the await can be triggered by the given event, and if it can, execute the block\n and return its result along with this await's key.\n @param event [Event] An event to check for.\n @return [Array] This await's key and whether or not it should be deleted. If there was no match, both are nil.", "Drains the currently saved message into a result string. This prepends it before that string, clears the saved\n message and returns the concatenation.\n @param result [String] The result string to drain into.\n @return [String] a string formed by concatenating the saved message and the argument.", "Attaches a file to the message event and converts the message into\n a caption.\n @param file [File] The file to be attached\n @param filename [String] Overrides the filename of the uploaded file\n @param spoiler [true, false] Whether or not this file should appear as a spoiler.", "Gets a role on this server based on its ID.\n @param id [Integer, String, #resolve_id] The role ID to look for.", "Gets a member on this server based on user ID\n @param id [Integer] The user ID to look for\n @param request [true, false] Whether the member should be requested from Discord if it's not cached", "Returns the amount of members that are candidates for pruning\n @param days [Integer] the number of days to consider for inactivity\n @return [Integer] number of members to be removed\n @raise [ArgumentError] if days is not between 1 and 30 (inclusive)", "Removes a role from the role cache\n @note For internal use only\n @!visibility private", "Updates the positions of all roles on the server\n @note For internal use only\n @!visibility private", "Updates a member's voice state\n @note For internal use only\n @!visibility private", "Creates a role on this server which can then be modified. It will be initialized\n with the regular role defaults the client uses unless specified, i.e. name is \"new role\",\n permissions are the default, colour is the default etc.\n @param name [String] Name of the role to create\n @param colour [Integer, ColourRGB, #combined] The roles colour\n @param hoist [true, false]\n @param mentionable [true, false]\n @param permissions [Integer, Array<Symbol>, Permissions, #bits] The permissions to write to the new role.\n @param reason [String] The reason the for the creation of this role.\n @return [Role] the created role.", "Adds a new custom emoji on this server.\n @param name [String] The name of emoji to create.\n @param image [String, #read] A base64 encoded string with the image data, or an object that responds to `#read`, such as `File`.\n @param roles [Array<Role, String, Integer>] An array of roles, or role IDs to be whitelisted for this emoji.\n @param reason [String] The reason the for the creation of this emoji.\n @return [Emoji] The emoji that has been added.", "Delete a custom emoji on this server\n @param emoji [Emoji, Integer, String] The emoji or emoji ID to be deleted.\n @param reason [String] The reason the for the deletion of this emoji.", "Bans a user from this server.\n @param user [User, #resolve_id] The user to ban.\n @param message_days [Integer] How many days worth of messages sent by the user should be deleted.\n @param reason [String] The reason the user is being banned.", "Unbans a previously banned user from this server.\n @param user [User, #resolve_id] The user to unban.\n @param reason [String] The reason the user is being unbanned.", "Kicks a user from this server.\n @param user [User, #resolve_id] The user to kick.\n @param reason [String] The reason the user is being kicked.", "Forcibly moves a user into a different voice channel. Only works if the bot has the permission needed.\n @param user [User, #resolve_id] The user to move.\n @param channel [Channel, #resolve_id] The voice channel to move into.", "Sets the server's icon.\n @param icon [String, #read] The new icon, in base64-encoded JPG format.", "Sets the verification level of the server\n @param level [Integer, Symbol] The verification level from 0-4 or Symbol (see {VERIFICATION_LEVELS})", "Sets the default message notification level\n @param notification_level [Integer, Symbol] The default message notificiation 0-1 or Symbol (see {NOTIFICATION_LEVELS})", "Sets the server content filter.\n @param filter_level [Integer, Symbol] The content filter from 0-2 or Symbol (see {FILTER_LEVELS})", "Requests a list of Webhooks on the server.\n @return [Array<Webhook>] webhooks on the server.", "Requests a list of Invites to the server.\n @return [Array<Invite>] invites to the server.", "Processes a GUILD_MEMBERS_CHUNK packet, specifically the members field\n @note For internal use only\n @!visibility private", "Adjusts the volume of a given buffer of s16le PCM data.\n @param buf [String] An unencoded PCM (s16le) buffer.\n @param mult [Float] The volume multiplier, 1 for same volume.\n @return [String] The buffer with adjusted volume, s16le again", "Adds a new command to the container.\n @param name [Symbol, Array<Symbol>] The name of the command to add, or an array of multiple names for the command\n @param attributes [Hash] The attributes to initialize the command with.\n @option attributes [Integer] :permission_level The minimum permission level that can use this command, inclusive.\n   See {CommandBot#set_user_permission} and {CommandBot#set_role_permission}.\n @option attributes [String, false] :permission_message Message to display when a user does not have sufficient\n   permissions to execute a command. %name% in the message will be replaced with the name of the command. Disable\n   the message by setting this option to false.\n @option attributes [Array<Symbol>] :required_permissions Discord action permissions (e.g. `:kick_members`) that\n   should be required to use this command. See {Discordrb::Permissions::FLAGS} for a list.\n @option attributes [Array<Role>, Array<#resolve_id>] :required_roles Roles that user must have to use this command\n   (user must have all of them).\n @option attributes [Array<Role>, Array<#resolve_id>] :allowed_roles Roles that user should have to use this command\n   (user should have at least one of them).\n @option attributes [Array<String, Integer, Channel>] :channels The channels that this command can be used on. An\n   empty array indicates it can be used on any channel. Supersedes the command bot attribute.\n @option attributes [true, false] :chain_usable Whether this command is able to be used inside of a command chain\n   or sub-chain. Typically used for administrative commands that shouldn't be done carelessly.\n @option attributes [true, false] :help_available Whether this command is visible in the help command. See the\n   :help_command attribute of {CommandBot#initialize}.\n @option attributes [String] :description A short description of what this command does. Will be shown in the help\n   command if the user asks for it.\n @option attributes [String] :usage A short description of how this command should be used. Will be displayed in\n   the help command or if the user uses it wrong.\n @option attributes [Array<Class>] :arg_types An array of argument classes which will be used for type-checking.\n   Hard-coded for some native classes, but can be used with any class that implements static\n   method `from_argument`.\n @option attributes [Integer] :min_args The minimum number of arguments this command should have. If a user\n   attempts to call the command with fewer arguments, the usage information will be displayed, if it exists.\n @option attributes [Integer] :max_args The maximum number of arguments the command should have.\n @option attributes [String] :rate_limit_message The message that should be displayed if the command hits a rate\n   limit. None if unspecified or nil. %time% in the message will be replaced with the time in seconds when the\n   command will be available again.\n @option attributes [Symbol] :bucket The rate limit bucket that should be used for rate limiting. No rate limiting\n   will be done if unspecified or nil.\n @option attributes [String, #call] :rescue A string to respond with, or a block to be called in the event an exception\n   is raised internally. If given a String, `%exception%` will be substituted with the exception's `#message`. If given\n   a `Proc`, it will be passed the `CommandEvent` along with the `Exception`.\n @yield The block is executed when the command is executed.\n @yieldparam event [CommandEvent] The event of the message that contained the command.\n @note `LocalJumpError`s are rescued from internally, giving bots the opportunity to use `return` or `break` in\n   their blocks without propagating an exception.\n @return [Command] The command that was added.\n @deprecated The command name argument will no longer support arrays in the next release.\n   Use the `aliases` attribute instead.", "Changes the bot's avatar.\n @param avatar [String, #read] A JPG file to be used as the avatar, either\n  something readable (e.g. File Object) or as a data URL.", "Creates a new UDP connection. Only creates a socket as the discovery reply may come before the data is\n initialized.\n Initializes the UDP socket with data obtained from opcode 2.\n @param endpoint [String] The voice endpoint to connect to.\n @param port [Integer] The port to connect to.\n @param ssrc [Integer] The Super Secret Relay Code (SSRC). Discord uses this to identify different voice users\n   on the same endpoint.", "Waits for a UDP discovery reply, and returns the sent data.\n @return [Array(String, Integer)] the IP and port received from the discovery reply.", "Makes an audio packet from a buffer and sends it to Discord.\n @param buf [String] The audio data to send, must be exactly one Opus frame\n @param sequence [Integer] The packet sequence number, incremented by one for subsequent packets\n @param time [Integer] When this packet should be played back, in no particular unit (essentially just the\n   sequence number multiplied by 960)", "Encrypts audio data using RbNaCl\n @param header [String] The header of the packet, to be used as the nonce\n @param buf [String] The encoded audio data to be encrypted\n @return [String] the audio data, encrypted", "Performs a rate limit request.\n @param key [Symbol] Which bucket to perform the request for.\n @param thing [#resolve_id, Integer, Symbol] What should be rate-limited.\n @param increment (see Bucket#rate_limited?)\n @see Bucket#rate_limited?\n @return [Integer, false] How much time to wait or false if the request succeeded.", "Makes a new bucket\n @param limit [Integer, nil] How many requests the user may perform in the given time_span, or nil if there should be no limit.\n @param time_span [Integer, nil] The time span after which the request count is reset, in seconds, or nil if the bucket should never be reset. (If this is nil, limit should be nil too)\n @param delay [Integer, nil] The delay for which the user has to wait after performing a request, in seconds, or nil if the user shouldn't have to wait.\n Cleans the bucket, removing all elements that aren't necessary anymore\n @param rate_limit_time [Time] The time to base the cleaning on, only useful for testing.", "Performs a rate limiting request\n @param thing [#resolve_id, Integer, Symbol] The particular thing that should be rate-limited (usually a user/channel, but you can also choose arbitrary integers or symbols)\n @param rate_limit_time [Time] The time to base the rate limiting on, only useful for testing.\n @param increment [Integer] How much to increment the rate-limit counter. Default is 1.\n @return [Integer, false] the waiting time until the next request, in seconds, or false if the request succeeded", "Connect to the gateway server in a separate thread", "Sends a custom packet over the connection. This can be useful to implement future yet unimplemented functionality\n or for testing. You probably shouldn't use this unless you know what you're doing.\n @param opcode [Integer] The opcode the packet should be sent as. Can be one of {Opcodes} or a custom value if\n   necessary.\n @param packet [Object] Some arbitrary JSON-serialisable data that should be sent as the `d` field.", "Create and connect a socket using a URI", "Gets the target schema of a link. This is normally just the standard\n response schema, but we allow some legacy behavior for hyper-schema links\n tagged with rel=instances to instead use the schema of their parent\n resource.", "A single name according to gender parameter", "Mobile prefixes are in the 015x, 016x, 017x ranges", "Runs `identify` on the current image, and raises an error if it doesn't\n pass.\n\n @raise [MiniMagick::Invalid]", "This is used to change the format of the image. That is, from \"tiff to\n jpg\" or something like that. Once you run it, the instance is pointing to\n a new file with a new extension!\n\n *DANGER*: This renames the file that the instance is pointing to. So, if\n you manually opened the file with Image.new(file_path)... Then that file\n is DELETED! If you used Image.open(file) then you are OK. The original\n file will still be there. But, any changes to it might not be...\n\n Formatting an animation into a non-animated type will result in\n ImageMagick creating multiple pages (starting with 0).  You can choose\n which page you want to manipulate.  We default to the first page.\n\n If you would like to convert between animated formats, pass nil as your\n page and ImageMagick will copy all of the pages.\n\n @param format [String] The target format... Like 'jpg', 'gif', 'tiff' etc.\n @param page [Integer] If this is an animated gif, say which 'page' you\n   want with an integer. Default 0 will convert only the first page; 'nil'\n   will convert all pages.\n @param read_opts [Hash] Any read options to be passed to ImageMagick\n   for example: image.format('jpg', page, {density: '300'})\n @yield [MiniMagick::Tool::Convert] It optionally yields the command,\n   if you want to add something.\n @return [self]", "Runs `identify` on itself. Accepts an optional block for adding more\n options to `identify`.\n\n @example\n   image = MiniMagick::Image.open(\"image.jpg\")\n   image.identify do |b|\n     b.verbose\n   end # runs `identify -verbose image.jpg`\n @return [String] Output from `identify`\n @yield [MiniMagick::Tool::Identify]", "Redact sensitive info from provided data", "Splits a header value +str+ according to HTTP specification.", "Escapes HTTP reserved and unwise characters in +str+", "Unescapes HTTP reserved and unwise characters in +str+", "Unescape form encoded values in +str+", "Sends the supplied request to the destination host.\n   @yield [chunk] @see Response#self.parse\n   @param [Hash<Symbol, >] params One or more optional params, override defaults set in Connection.new\n     @option params [String] :body text to be sent over a socket\n     @option params [Hash<Symbol, String>] :headers The default headers to supply in a request\n     @option params [String] :path appears after 'scheme://host:port/'\n     @option params [Hash]   :query appended to the 'scheme://host:port/path/' in the form of '?key=value'", "Sends the supplied requests to the destination host using pipelining.\n   @pipeline_params [Array<Hash>] pipeline_params An array of one or more optional params, override defaults set in Connection.new, see #request for details", "Sends the supplied requests to the destination host using pipelining in\n batches of @limit [Numeric] requests. This is your soft file descriptor\n limit by default, typically 256.\n   @pipeline_params [Array<Hash>] pipeline_params An array of one or more optional params, override defaults set in Connection.new, see #request for details", "Start the aruba console\n\n rubocop:disable Metrics/MethodLength", "Make deep dup copy of configuration", "Define or run before-hook\n\n @param [Symbol, String] name\n   The name of the hook\n\n @param [Proc] context\n   The context a hook should run in. This is a runtime only option.\n\n @param [Array] args\n   Arguments for the run of hook. This is a runtime only option.\n\n @yield\n   The code block which should be run. This is a configure time only option", "Broadcast an event\n\n @param [Object] event\n   An object of registered event class. This object is passed to the event\n   handler.", "The path to the directory which contains fixtures\n You might want to overwrite this method to place your data else where.\n\n @return [ArubaPath]\n   The directory to where your fixtures are stored", "Create files etc.", "Create store\n Add new hook\n\n @param [String, Symbol] label\n   The name of the hook\n\n @param [Proc] block\n   The block which should be run for the hook", "Find all files for which the block yields.", "Find unique keys in redis\n\n @param [String] pattern a pattern to scan for in redis\n @param [Integer] count the maximum number of keys to delete\n @return [Array<String>] an array with active unique keys", "Find unique keys with ttl\n @param [String] pattern a pattern to scan for in redis\n @param [Integer] count the maximum number of keys to delete\n @return [Hash<String, Integer>] a hash with active unique keys and corresponding ttl", "Deletes unique keys from redis\n\n @param [String] pattern a pattern to scan for in redis\n @param [Integer] count the maximum number of keys to delete\n @return [Integer] the number of keys deleted", "Unlocks a job.\n @param [Hash] item a Sidekiq job hash", "Deletes a lock regardless of if it was locked or not.\n\n This is good for situations when a job is locked by another item\n @param [Hash] item a Sidekiq job hash", "Call a lua script with the provided file_name\n\n @note this method is recursive if we need to load a lua script\n   that wasn't previously loaded.\n\n @param [Symbol] file_name the name of the lua script\n @param [Sidekiq::RedisConnection, ConnectionPool] redis_pool the redis connection\n @param [Hash] options arguments to pass to the script file\n @option options [Array] :keys the array of keys to pass to the script\n @option options [Array] :argv the array of arguments to pass to the script\n\n @return value from script", "Execute the script file\n\n @param [Symbol] file_name the name of the lua script\n @param [Sidekiq::RedisConnection, ConnectionPool] redis_pool the redis connection\n @param [Hash] options arguments to pass to the script file\n @option options [Array] :keys the array of keys to pass to the script\n @option options [Array] :argv the array of arguments to pass to the script\n\n @return value from script (evalsha)", "Return sha of already loaded lua script or load it and return the sha\n\n @param [Sidekiq::RedisConnection] conn the redis connection\n @param [Symbol] file_name the name of the lua script\n @return [String] sha of the script file\n\n @return [String] the sha of the script", "Handle errors to allow retrying errors that need retrying\n\n @param [Redis::CommandError] ex exception to handle\n @param [Symbol] file_name the name of the lua script\n\n @return [void]\n\n @yieldreturn [void] yields back to the caller when NOSCRIPT is raised", "Deletes the lock regardless of if it has a ttl set", "Create a lock for the item\n\n @param [Integer] timeout the number of seconds to wait for a lock.\n\n @return [String] the Sidekiq job_id (jid)", "Removes the lock keys from Redis\n\n @param [String] token the token to unlock (defaults to jid)\n\n @return [false] unless locked?\n @return [String] Sidekiq job_id (jid) if successful", "Creates a connection to redis\n @return [Sidekiq::RedisConnection, ConnectionPool] a connection to redis", "Return unique digests matching pattern\n\n @param [String] pattern a pattern to match with\n @param [Integer] count the maximum number to match\n @return [Array<String>] with unique digests", "Paginate unique digests\n\n @param [String] pattern a pattern to match with\n @param [Integer] cursor the maximum number to match\n @param [Integer] page_size the current cursor position\n\n @return [Array<String>] with unique digests", "Deletes unique digest either by a digest or pattern\n\n @param [String] digest the full digest to delete\n @param [String] pattern a key pattern to match with\n @param [Integer] count the maximum number\n @raise [ArgumentError] when both pattern and digest are nil\n @return [Array<String>] with unique digests", "Deletes unique digests by pattern\n\n @param [String] pattern a key pattern to match with\n @param [Integer] count the maximum number\n @return [Array<String>] with unique digests", "Get a total count of unique digests\n\n @param [String] digest a key pattern to match with", "Attempt to constantize a string worker_class argument, always\n failing back to the original argument when the constant can't be found\n\n @return [Sidekiq::Worker]", "Adds a lock type to the configuration. It will raise if the lock exists already\n\n @param [String] name the name of the lock\n @param [Class] klass the class describing the lock", "Adds an on_conflict strategy to the configuration.\n It will raise if the strategy exists already\n\n @param [String] name the name of the custom strategy\n @param [Class] klass the class describing the strategy", "Filter a hash to use for digest\n @return [Hash] to use for digest", "Filters unique arguments by proc or symbol\n @param [Array] args the arguments passed to the sidekiq worker\n @return [Array] {#filter_by_proc} when {#unique_args_method} is a Proc\n @return [Array] {#filter_by_symbol} when {#unique_args_method} is a Symbol\n @return [Array] args unfiltered when neither of the above", "Filters unique arguments by method configured in the sidekiq worker\n @param [Array] args the arguments passed to the sidekiq worker\n @return [Array] unfiltered unless {#worker_method_defined?}\n @return [Array] with the filtered arguments", "used to capture only the \"RequestLimitExceeded\" error from an aws\n client api call.  In the case of matching it we want to try again,\n backing off successively each time, until the backoff_limit is reached or\n exceeded, in which case, the error will be re-raised and it should fail\n as expected.", "Return diff from the initial state to specified time or version.\n Optional `data` paramater can be used as initial diff state.", "Return diff object representing changes since specified time or version.\n\n @example\n\n   diff_from(time: 2.days.ago)\n   #=> { \"id\" => 1, \"changes\" => { \"title\" => { \"old\" => \"Hello!\", \"new\" => \"World\" } } }\n rubocop:disable Metrics/AbcSize", "Return true iff time corresponds to current version", "Return a dirty copy of specified version of record", "Return diff object representing changes since specified time.\n\n @example\n\n   post.diff_from(time: 2.days.ago) # or post.diff_from(version: 2)\n   #=> { \"id\" => 1, \"changes\" => { \"title\" => { \"old\" => \"Hello!\", \"new\" => \"World\" } } }", "Restore record to the previous version.\n Return false if no previous version found, otherwise return updated record.", "Restore record to the specified version.\n Return false if version is unknown.", "Find all elements of a given type, returning their options hash. The\n options hash has most of the useful data about an element and often you\n can just use this in your rules.\n\n   # Returns [ { :location => 1, :element_level => 2 }, ... ]\n   elements = find_type(:li)\n\n If +nested+ is set to false, this returns only top level elements of a\n given type.", "Find all elements of a given type, returning a list of the element\n objects themselves.\n\n Instead of a single type, a list of types can be provided instead to\n find all types.\n\n If +nested+ is set to false, this returns only top level elements of a\n given type.", "A variation on find_type_elements that allows you to skip drilling down\n into children of specific element types.\n\n Instead of a single type, a list of types can be provided instead to\n find all types.\n\n Unlike find_type_elements, this method will always search for nested\n elements, and skip the element types given to nested_except.", "Returns the line number a given element is located on in the source\n file. You can pass in either an element object or an options hash here.", "Returns line numbers for lines that match the given regular expression", "Extracts the text from an element whose children consist of text\n elements and other things", "Adds a 'level' option to all elements to show how nested they are", "Guess a specific time within the given span.\n\n span - The Chronic::Span object to calcuate a guess from.\n\n Returns a new Time object.", "returns a hash of each word's Definitions", "Handle ordinal this month", "anchors\n Handle repeaters", "narrows\n Handle oridinal repeaters", "Recursively finds repeaters within other repeaters.\n Returns a Span representing the innermost time span\n or nil if no repeater union could be found", "pattern        - An Array of patterns to match tokens against.\n handler_method - A Symbol representing the method to be invoked\n   when a pattern matches.\n tokens - An Array of tokens to process.\n definitions - A Hash of definitions to check against.\n\n Returns true if a match is found.", "Create a new repository for the authenticated user.\n\n @param [Hash] params\n @option params [String] :name\n   Required string\n @option params [String] :description\n   Optional string\n @option params [String] :homepage\n   Optional string\n @option params [Boolean] :private\n   Optional boolean - true to create a private  repository,\n                      false to create a public one.\n @option params [Boolean] :has_issues\n   Optional boolean - true to enable issues  for this repository,\n                      false to disable them\n @option params [Boolean] :has_wiki\n   Optional boolean - true to enable the wiki for this repository,\n                      false to disable it. Default is true\n @option params [Boolean] :has_downloads\n   Optional boolean - true to enable downloads for this repository\n @option params [String] :org\n   Optional string - The organisation in which this\n   repository will be created\n @option params [Numeric] :team_id\n   Optional number - The id of the team that will be granted\n   access to this repository. This is only valid when creating\n   a repo in an organization\n @option params [Boolean] :auto_init\n   Optional boolean - true to create an initial commit with\n   empty README. Default is false.\n @option params [String] :gitignore_template\n   Optional string - Desired language or platform .gitignore\n   template to apply. Use the name of the template without\n   the extension. For example, \u201cHaskell\u201d Ignored if\n   auto_init parameter is not provided.\n\n @example\n  github = Github.new\n  github.repos.create \"name\": 'repo-name'\n    \"description\": \"This is your first repo\",\n    \"homepage\": \"https://github.com\",\n    \"private\": false,\n    \"has_issues\": true,\n    \"has_wiki\": true,\n    \"has_downloads\": true\n\n Create a new repository in this organisation. The authenticated user\n must be a member of this organisation\n\n @example\n   github = Github.new oauth_token: '...'\n   github.repos.create name: 'repo-name', org: 'organisation-name'\n\n @example", "Get a single unauthenticated user\n\n @example\n  github = Github.new\n  github.users.get user: 'user-name'\n\n Get the authenticated user\n\n @example\n  github = Github.new oauth_token: '...'\n  github.users.get\n\n @api public", "Create a pull request review\n\n @param [Hash] params\n @option params [String] :event\n   Required string - The review action (event) to perform; can be one of\n   APPROVE, REQUEST_CHANGES, or COMMENT. If left blank, the API returns\n   HTTP 422 (Unrecognizable entity) and the review is left PENDING\n @option params [String] :body\n   Optional string. The text of the review.\n @option params [Array] :comments\n   Optional array of draft review comment objects. An array of comments\n   part of the review.\n\n @example\n  github = Github.new\n  github.pull_requests.reviews.create 'user-name', 'repo-name', 'number',\n    body: \"Nice change\",\n    event: \"APPROVE\",\n    comments: [\n      {\n        path: 'path/to/file/commented/on',\n        position: 10,\n        body:     'This looks good.'\n      }\n    ]\n\n @api public", "Update a pull request review\n\n @param [Hash] params\n @option params [String] :state\n   Required string - The review action (event) to perform; can be one of\n   APPROVE, REQUEST_CHANGES, or COMMENT. If left blank, the API returns\n   HTTP 422 (Unrecognizable entity) and the review is left PENDING\n @optoin params [String] :body\n   Optional string\n\n @example\n  github = Github.new oauth_token: '...'\n  github.pull_requests.reviews.update 'user-name', 'repo-name', 'number', 'review-id'\n    body: \"Update body\",\n    event: \"APPROVE\"\n\n @api public", "Get all the items for a named timeline\n\n @see https://developer.github.com/v3/activity/feeds/#list-feeds\n\n @example\n   github = Github.new\n   github.activity.feeds.get \"timeline\"\n\n @param [String] name\n   the name of the timeline resource\n\n @api public", "List project cards for a column\n\n @example\n  github = Github.new\n  github.projects.cards.list :column_id\n\n @see https://developer.github.com/v3/projects/cards/#list-project-cards\n\n @api public", "Create a project card for a column\n\n @param [Hash] params\n @option params [String] :note\n  The card's note content. Only valid for cards without another type of\n  content, so this must be omitted if content_id and content_type are\n  specified.\n @option params [Integer] :content_id\n  The id of the Issue to associate with this card.\n @option params [String] :content_type\n  The type of content to associate with this card. Can only be \"Issue\" at\n  this time.\n\n @example\n  github = Github.new\n  github.projects.cards.create :column_id, note: 'Card Note'\n\n @example\n github = Github.new\n github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'\n\n @see https://developer.github.com/v3/projects/cards/#create-a-project-card\n\n @api public", "Update a project card\n\n @param [Hash] params\n @option params [String] :note\n   The card's note content. Only valid for cards without another type of\n   content, so this cannot be specified if the card already has a\n   content_id and content_type.\n\n @example\n   github = Github.new\n   github.projects.cards.update :card_id, note: 'New card note'\n\n @see https://developer.github.com/v3/projects/cards/#update-a-project-card\n\n @api public", "Delete a project card\n\n @example\n   github = Github.new\n   github.projects.cards.delete :card_id\n\n @see https://developer.github.com/v3/projects/cards/#delete-a-project-card\n\n @api public", "Move a project card\n\n @param [Hash] params\n @option params [String] :position\n   Required. Required. Can be one of 'first', 'last', or\n   'after:<column-id>', where <column-id> is the id value of a column in\n   the same project.\n\n @example\n  github = Github.new\n  github.projects.cards.move :card_id, position: 'bottom'\n\n @example\n  github = Github.new\n  github.projects.cards.move :card_id, position: 'after:<card-id>', column_id: <column-id>\n\n @see https://developer.github.com/v3/projects/cards/#move-a-project-card\n\n @api public", "List your issues\n\n List all issues across all the authenticated user\u2019s visible repositories\n including owned repositories, member repositories,\n and organization repositories.\n\n @example\n  github = Github.new oauth_token: '...'\n  github.issues.list\n\n List all issues across owned and member repositories for the\n authenticated user.\n\n @example\n  github = Github.new oauth_token: '...'\n  github.issues.list :user\n\n List all issues for a given organization for the authenticated user.\n\n @example\n  github = Github.new oauth_token: '...'\n  github.issues.list org: 'org-name'\n\n List issues for a repository\n\n @example\n  github = Github.new\n  github.issues.list user: 'user-name', repo: 'repo-name'\n\n @param [Hash] params\n @option params [String] :filter\n  * assigned   Issues assigned to you (default)\n  * created    Issues created by you\n  * mentioned  Issues mentioning you\n  * subscribed Issues you've subscribed to updates for\n  * all        All issues the user can see\n @option params [String] :milestone\n  * Integer Milestone number\n  * none for Issues with no Milestone.\n  * *    for Issues with any Milestone\n @option params [String] :state\n   open, closed, default: open\n @option params [String] :labels\n   String list of comma separated Label names. Example: bug,ui,@high\n @option params [String] :assignee\n  * String User login\n  * <tt>none</tt> for Issues with no assigned User.\n  * <tt>*</tt>    for Issues with any assigned User.\n @option params [String] :creator\n   String User login\n @option params [String] :mentioned\n   String User login\n @option params [String] :sort\n   created, updated, comments, default: <tt>created</tt>\n @option params [String] :direction\n   asc, desc, default: desc\n @option params [String] :since\n   Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\n @example\n  github = Github.new oauth_token: '...'\n  github.issues.list since: '2011-04-12T12:12:12Z',\n    filter: 'created',\n    state: 'open',\n    labels: \"bug,ui,bla\",\n    sort: 'comments',\n    direction: 'asc'\n\n @api public", "Upload a release asset\n\n @param [Hash] params\n @input params [String] :name\n   Required string. The file name of the asset\n @input params [String] :content_type\n   Required string. The content type of the asset.\n   Example: \u201capplication/zip\u201d.\n\n @example\n   github = Github.new\n   github.repos.releases.assets.upload 'owner', 'repo', 'id', 'file-path'\n     name: \"batman.jpg\",\n     content_type: \"application/octet-stream\"\n\n @api public", "Infer media type of the asset", "Edit a release asset\n\n Users with push access to the repository can edit a release asset.\n\n @param [Hash] params\n @input params [String] :name\n   Required. The file name of the asset.\n @input params [String] :label\n   An alternate short description of the asset.\n   Used in place of the filename.\n\n @example\n   github = Github.new\n   github.repos.releases.assets.edit 'owner', 'repo', 'id',\n     name: \"foo-1.0.0-osx.zip\",\n     label: \"Mac binary\"\n\n @api public", "Render an arbitrary Markdown document\n\n = Parameters\n  <tt>:text</tt> - Required string - The Markdown text to render\n  <tt>:mode<tt> - Optional string - The rendering mode\n    * <tt>markdown</tt> to render a document as plain Markdown, just\n                        like README files are rendered.\n    * <tt>gfm</tt> to render a document as user-content, e.g. like user\n      comments or issues are rendered. In GFM mode, hard line breaks are\n      always taken into account, and issue and user mentions are\n      linked accordingly.\n  <tt>:context<tt> - Optional string - The repository context, only taken\n                     into account when rendering as <tt>gfm</tt>\n\n = Examples\n  github = Github.new\n  github.markdown.render\n    \"text\": \"Hello world github/linguist#1 **cool**, and #1!\",\n    \"mode\": \"gfm\",\n    \"context\": \"github/gollum\"", "Render a Markdown document in raw mode\n\n = Input\n  The raw API it not JSON-based. It takes a Markdown document as plaintext\n  <tt>text/plain</tt> or <tt>text/x-markdown</tt> and renders it as plain\n  Markdown without a repository context (just like a README.md file is\n  rendered \u2013 this is the simplest way to preview a readme online)\n\n = Examples\n  github = Github.new\n  github.markdown.render_raw \"Hello github/linguist#1 **cool**, and #1!\",\n    \"accept\": \"text/plain\",", "Create a status\n\n @param [Hash] params\n @input params [String] :state\n   Required. The state of the status. Can be one of pending,\n   success, error, or failure.\n @input params [String] :target_url\n   The target URL to associate with this status. This URL will\n   be linked from the GitHub UI to allow users to easily see\n   the \u2018source\u2019 of the Status.\n\n   For example, if your Continuous Integration system is posting\n   build status, you would want to provide the deep link for\n   the build output for this specific SHA:\n   http://ci.example.com/user/repo/build/sha.\n @input params [String] :description\n   A short description of the status\n @input params [String] :context\n   A string label to differentiate this status from the\n   status of other systems. Default: \"default\"\n\n @example\n   github = Github.new\n   github.repos.statuses.create 'user-name', 'repo-name', 'sha',\n     state:  \"success\",\n     target_url: \"http://ci.example.com/johndoe/my-repo/builds/sha\",\n     description: \"Successful build #3 from origin/master\"\n\n @api public", "Check if you are starring a repository\n\n @see https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository\n\n @example\n   github = Github.new\n   github.activity.starring.starring? 'user-name', 'repo-name'\n\n @example\n   github.activity.starring.starring? user: 'user-name', repo: 'repo-name'\n\n @return [Boolean]\n   Returns true if this repo is starred by you, false otherwise.\n\n @api public", "List all templates available to pass as an option\n when creating a repository.\n\n @see https://developer.github.com/v3/gitignore/#listing-available-templates\n\n @example\n  github = Github.new\n  github.gitignore.list\n  github.gitignore.list { |template| ... }\n\n @api public", "Get a single template\n\n @see https://developer.github.com/v3/gitignore/#get-a-single-template\n\n @example\n  github = Github.new\n  github.gitignore.get \"template-name\"\n\n Use the raw media type to get the raw contents.\n\n @examples\n  github = Github.new\n  github.gitignore.get \"template-name\", accept: 'applicatin/vnd.github.raw'\n\n @api public", "Get a single label\n\n @example\n   github = Github.new\n   github.issues.labels.find 'user-name', 'repo-name', 'label-name'\n\n @example\n   github = Github.new user: 'user-name', repo: 'repo-name'\n   github.issues.labels.get label_name: 'bug'\n\n @api public", "Create a label\n\n @param [Hash] params\n @option params [String] :name\n   Required string\n @option params [String] :color\n   Required string - 6 character hex code, without leading \n\n @example\n   github = Github.new user: 'user-name', repo: 'repo-name'\n   github.issues.labels.create name: 'API', color: 'FFFFFF'\n\n @api public", "Update a label\n\n @param [Hash] params\n @option params [String] :name\n   Required string\n @option params [String] :color\n   Required string - 6 character hex code, without leading \n\n @example\n   github = Github.new\n   github.issues.labels.update 'user-name', 'repo-name', 'label-name',\n     name: 'API', color: \"FFFFFF\"\n\n @api public", "Remove a label from an issue\n\n @example\n   github = Github.new\n   github.issues.labels.remove 'user-name', 'repo-name', 'issue-number',\n     label_name: 'label-name'\n\n Remove all labels from an issue\n\n @example\n   github = Github.new\n   github.issues.labels.remove 'user-name', 'repo-name', 'issue-number'\n\n @api public", "Replace all labels for an issue\n\n Sending an empty array ([]) will remove all Labels from the Issue.\n\n @example\n   github = Github.new\n   github.issues.labels.replace 'user-name', 'repo-name', 'issue-number',\n     'label1', 'label2', ...\n\n @api public", "Extracts query string parameter for given name", "Check what OAuth scopes you have.\n\n @see https://developer.github.com/v3/oauth/#scopes\n\n @example\n   github = Github.new oauth_token: 'e72e16c7e42f292c6912e7710c838347ae17'\n   github.scopes.all\n\n @example\n   github = Github.new\n   github.scopes.list 'e72e16c7e42f292c6912e7710c838347ae17'\n\n @example\n   github = Github.new\n   github.scopes.list token: 'e72e16c7e42f292c6912e7710c838347ae17'\n\n @api public", "List all events that a user has received\n\n @see https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received\n\n These are events that you\u2019ve received by watching repos\n and following users. If you are authenticated as the given user,\n you will see private events. Otherwise, you\u2019ll only see public events.\n\n @example\n   github = Github.new\n   github.activity.events.received 'user-name'\n   github.activity.events.received 'user-name' { |event| ... }\n\n List all public events that a user has received\n\n @see https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received\n\n @example\n   github = Github.new\n   github.activity.events.received 'user-name', public: true\n   github.activity.events.received 'user-name', public: true { |event| ... }\n\n @api public", "Iterate over results set pages by automatically calling `next_page`\n until all pages are exhausted. Caution needs to be exercised when\n using this feature - 100 pages iteration will perform 100 API calls.\n By default this is off. You can set it on the client, individual API\n instances or just per given request.", "Get a project columns\n\n @example\n  github = Github.new\n  github.projects.columns.get :column_id\n\n @see https://developer.github.com/v3/projects/columns/#get-a-project-column\n\n @api public", "Get a tree\n\n @example\n  github = Github.new\n  github.git_data.trees.get 'user-name', 'repo-name', 'sha'\n  github.git_data.trees.get 'user-name', 'repo-name', 'sha' do |file|\n    file.path\n  end\n\n Get a tree recursively\n\n @example\n  github = Github.new\n  github.git_data.trees.get 'user-name', 'repo-name', 'sha', recursive: true\n\n @api public", "Create a tree\n\n The tree creation API will take nested entries as well.\n If both a tree and a nested path modifying that tree are specified,\n it will overwrite the contents of that tree with the new path contents\n and write a new tree out.\n\n @param [Hash] params\n @input params [String] :base_tree\n   The SHA1 of the tree you want to update with new data\n @input params [Array[Hash]] :tree\n   Required. Objects (of path, mode, type, and sha)\n   specifying a tree structure\n\n The tree parameter takes the following keys:\n @input tree [String] :path\n   The file referenced in the tree\n @input tree [String] :mode\n   The file mode; one of 100644 for file (blob), 100755 for\n   executable (blob), 040000 for subdirectory (tree), 160000 for\n   submodule (commit), or 120000 for a blob that specifies\n   the path of a symlink\n @input tree [String] :type\n   Either blob, tree, or commit\n @input tree [String] :sha\n   The SHA1 checksum ID of the object in the tree\n @input tree [String] :content\n   The content you want this file to have - GitHub will write\n   this blob out and use the SHA for this entry.\n   Use either this or <tt>tree.sha</tt>\n\n @example\n  github = Github.new\n  github.git_data.trees.create 'user-name', 'repo-name',\n    tree: [\n      {\n        path: \"file.rb\",\n        mode: \"100644\",\n        type: \"blob\",\n        sha: \"44b4fc6d56897b048c772eb4087f854f46256132\"\n      },\n      ...\n    ]\n\n @api public", "Create a commit\n\n @param [Hash] params\n @input params [String] :message\n   The commit message\n @input params [String] :tree\n   String of the SHA of the tree object this commit points to\n @input params [Array[String]] :parents\n   Array of the SHAs of the commits that were the parents of this commit.\n   If omitted or empty, the commit will be written as a root commit.\n   For a single parent, an array of one SHA should be provided,\n   for a merge commit, an array of more than one should be provided.\n\n Optional Parameters\n\n You can provide an additional commiter parameter, which is a hash\n containing information about the committer. Or, you can provide an author\n parameter, which is a hash containing information about the author.\n\n The committer section is optional and will be filled with the author\n data if omitted. If the author section is omitted, it will be filled\n in with the authenticated users information and the current date.\n\n Both the author and commiter parameters have the same keys:\n\n @input params [String] :name\n   String of the name of the author (or commiter) of the commit\n @input params [String] :email\n   String of the email of the author (or commiter) of the commit\n @input params [Timestamp] :date\n   Indicates when this commit was authored (or committed).\n   This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\n\n @example\n   github = Github.new\n   github.git_data.commits.create 'user-name', 'repo-name',\n     message: \"my commit message\",\n     author: {\n       name: \"Scott Chacon\",\n       email: \"schacon@gmail.com\",\n       date: \"2008-07-09T16:13:30+12:00\"\n     },\n     parents: [\n       \"7d1b31e74ee336d15cbd21741bc88a537ed063a0\"\n     ],\n     tree: \"827efc6d56897b048c772eb4087f854f46256132\"]\n\n @api public", "Remove a assignees from an issue\n\n @example\n   github = Github.new\n   github.issues.assignees.remove 'user', 'repo', 'issue-number',\n     'hubot', 'other_assignee'\n\n @api public", "Filter callbacks based on kind\n\n @param [Symbol] kind\n   one of :before or :after\n\n @return [Array[Hash]]\n\n @api private", "Run all callbacks associated with this action\n\n @apram [Symbol] action_name\n\n @api private", "Set a configuration option for a given namespace\n\n @param [String] option\n @param [Object] value\n @param [Boolean] ignore_setter\n\n @return [self]\n\n @api public", "Set multiple options\n\n @api private", "Define setters and getters\n\n @api private", "Dynamically define a method for setting request option\n\n @api private", "Create a tag object\n\n Note that creating a tag object does not create the reference that\n makes a tag in Git. If you want to create an annotated tag in Git,\n you have to do this call to create the tag object, and then create\n the refs/tags/[tag] reference. If you want to create a lightweight\n tag, you simply have to create the reference -\n this call would be unnecessary.\n\n @param [Hash] params\n @input params [String] :tag\n   The tag\n @input params [String] :message\n   The tag message\n @input params [String] :object\n   The SHA of the git object this is tagging\n @input params [String] :type\n   The type of the object we're tagging.\n   Normally this is a commit but it can also be a tree or a blob\n @input params [Hash] :tagger\n   A hash with information about the individual creating the tag.\n\n The tagger hash contains the following keys:\n @input tagger [String] :name\n   The name of the author of the tag\n @input tagger [String] :email\n   The email of the author of the tag\n @input tagger [String] :date\n   When this object was tagged. This is a timestamp in ISO 8601\n   format: YYYY-MM-DDTHH:MM:SSZ.\n\n @xample\n  github = Github.new\n  github.git_data.tags.create 'user-name', 'repo-name',\n     tag: \"v0.0.1\",\n     message: \"initial version\\n\",\n     type: \"commit\",\n     object: \"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\n     tagger: {\n       name: \"Scott Chacon\",\n       email: \"schacon@gmail.com\",\n       date: \"2011-06-17T14:53:3\"\n     }\n\n @api public", "List a user's followers\n\n @example\n  github = Github.new\n  github.users.followers.list 'user-name'\n  github.users.followers.list 'user-name' { |user| ... }\n\n List the authenticated user's followers\n\n @example\n  github = Github.new oauth_token: '...'\n  github.users.followers\n  github.users.followers { |user| ... }\n\n @api public", "Check if you are following a user\n\n @example\n   github = Github.new oauth_token: '...'\n   github.users.followers.following? 'user-name'\n   github.users.followers.following? username: 'user-name'\n\n Check if one user follows another\n\n @example\n   github = Github.new oauth_token: '...'\n   github.users.followers.following? username: 'user-name',\n     target_user: 'target-user-name'\n\n @api public", "List repos being watched by a user\n\n @see https://developer.github.com/v3/activity/watching/#list-repositories-being-watched\n\n @example\n   github = Github.new\n   github.activity.watching.watched user: 'user-name'\n\n List repos being watched by the authenticated user\n\n @example\n   github = Github.new oauth_token: '...'\n   github.activity.watching.watched\n\n @api public", "Check if user is, publicly or privately, a member of an organization\n\n @example\n   github = Github.new\n   github.orgs.members.member? 'org-name', 'member-name'\n\n Check if a user is a public member of an organization\n\n @example\n   github = Github.new\n   github.orgs.members.member? 'org-name', 'member-name', public: true\n\n @api public", "Edit a branch protection\n\n Users with push access to the repository can edit a branch protection.\n\n @param [Hash] params\n @input params [String] :required_status_checks\n   Required.\n @input params [String] :enforce_admins\n   Required.\n @input params [String] :restrictions\n   Required.\n @input params [String] :required_pull_request_reviews\n   Required.\n Look to the branch protection API to see how to use these\n https://developer.github.com/v3/repos/branches/#update-branch-protection\n\n @example\n   github = Github.new\n   github.repos.branches.protections.edit 'user', 'repo', 'branch',\n     required_pull_request_reviews: {dismiss_stale_reviews: false}\n\n @api public", "Removes any keys from nested hashes that don't match predefiend keys", "Check if a repository belongs to a team\n\n @see https://developer.github.com/v3/orgs/teams/#get-team-repo\n\n @example\n  github = Github.new oauth_token: '...'\n  github.orgs.teams.team_repo? 'team-id', 'user-name', 'repo-name'\n\n @api public", "Check if status code requires raising a ServiceError\n\n @api private", "Create a deployment\n\n @param [Hash] params\n @option params [String] :ref\n   Required string. The ref to deploy. This can be a branch, tag, or sha.\n @option params [Boolean] :auto_merge\n   Optional boolean. Merge the default branch into the requested.\n @option params [Array] :required_contexts\n   Optional array of status contexts verified against commit status checks.\n   If this parameter is omitted from the parameters then all unique\n   contexts will be verified before a deployment is created. To bypass\n   checking entirely pass an empty array. Defaults to all unique contexts.\n @option params [String] :payload\n   Optional JSON payload with extra information about the deployment.\n   Default: \"\"\n @option params [String] :payload\n   Optional String. Name for the target deployment environment (e.g.,\n   production, staging, qa). Default: \"production\"\n @option params [String] :description\n   Optional string. Optional short description.\n\n @example\n  github = Github.new\n  github.repos.deployments.create 'user-name', 'repo-name', ref: '...'\n  github.repos.deployments.create\n     'user-name',\n     'repo-name',\n     ref: '...',\n     description: 'New deploy',\n     force: true\n\n @api public", "List the statuses of a deployment.\n\n @param [Hash] params\n @option params [String] :id\n   Required string. Id of the deployment being queried.\n\n @example\n  github = Github.new\n  github.repos.deployments.statuses 'user-name', 'repo-name', DEPLOYMENT_ID\n  github.repos.deployments.statuses 'user-name', 'repo-name', DEPLOYMENT_ID { |status| ... }\n\n @api public", "Create a deployment status\n\n @param [Hash] params\n @option params [String] :id\n   Required string. Id of the deployment being referenced.\n @option params [String] :state\n   Required string. State of the deployment. Can be one of:\n   pending, success, error, or failure.\n @option params [String] :target_url\n   Optional string. The URL associated with the status.\n @option params [String] :description\n   Optional string. A short description of the status.\n\n @example\n  github = Github.new\n  github.repos.deployments.create_status 'user-name', 'repo-name', DEPLOYMENT_ID, state: '...'\n\n @api public", "Configuration options from request\n\n @return [Hash]\n\n @api public", "Update hash with default parameters for non existing keys", "Base64 encode string removing newline characters\n\n @api public", "Creates a commit comment\n\n @param [Hash] params\n @option params [String] :body\n   Required. The contents of the comment.\n @option params [String] :path\n   Required. Relative path of the file to comment on.\n @option params [Number] :position\n   Required number - Line index in the diff to comment on.\n @option params [Number] :line\n   Required number - Line number in the file to comment on.\n\n @example\n  github = Github.new\n  github.repos.comments.create 'user-name', 'repo-name', 'sha-key',\n    body: \"Nice change\",\n    position: 4,\n    line: 1,\n    path: \"file1.txt\"\n\n @api public", "Update a commit comment\n\n @param [Hash] params\n @option params [String] :body\n   Required. The contents of the comment.\n\n @example\n   github = Github.new\n   github.repos.comments.update 'user-name', 'repo-name', 'id',\n     body: \"Nice change\"\n\n @api public", "Create a file\n\n This method creates a new file in a repository\n\n @param [Hash] params\n @option params [String] :path\n   Required string. The content path\n @option params [String]\n @option params [String] :message\n   Required string. The commit message.\n @option params [String] :content\n   Required string. The new file content, which will be Base64 encoded\n @option params [String] :branch\n   The branch name. If not provided, uses the repository\u2019s\n   default branch (usually master)\n\n Optional Parameters\n\n The :author section is optional and is filled in with the\n :committer information if omitted. If the :committer\n information is omitted, the authenticated user\u2019s information is used.\n\n You must provide values for both :name and :email, whether\n you choose to use :author or :committer. Otherwise, you\u2019ll\n receive a 500 status code.\n\n Both the author and commiter parameters have the same keys:\n\n @option params [String] :name\n   The name of the author (or commiter) of the commit\n @option params [String] :email\n   The email of the author (or commiter) of the commit\n\n @example\n   github = Github.new\n   github.repos.contents.create 'user-name', 'repo-name', 'path',\n     path: 'hello.rb',\n     content: \"puts 'hello ruby'\",\n     message: \"my commit message\"\n\n @api public", "Delete a file\n\n This method deletes a file in a repository\n\n @param [Hash] params\n @option params [String] :path\n   Requried string. The content path\n @option params [String]\n @option params [String] :message\n   Requried string. The commit message.\n @option params [String] :sha\n   Required string. The blob SHA of the file being replaced.\n @option params [String] :branch\n   The branch name. If not provided, uses the repository\u2019s\n   default branch (usually master)\n\n Optional Parameters\n\n The :author section is optional and is filled in with the\n :committer information if omitted. If the :committer\n information is omitted, the authenticated user\u2019s information is used.\n\n You must provide values for both :name and :email, whether\n you choose to use :author or :committer. Otherwise, you\u2019ll\n receive a 500 status code.\n\n Both the author and commiter parameters have the same keys:\n\n @option params [String] :name\n   The name of the author (or commiter) of the commit\n @option params [String] :email\n   The email of the author (or commiter) of the commit\n\n @example\n  github = Github.new\n  github.repos.contents.delete 'user-name', 'repo-name', 'path',\n    path: 'hello.rb',\n    message: \"delete hello.rb file\",\n    sha: \"329688480d39049927147c162b9d2deaf885005f\"", "Get archive link\n\n This method will return a 302 to a URL to download a tarball or zipball\n archive for a repository. Please make sure your HTTP framework is configured\n to follow redirects or you will need to use the Location header to make\n a second GET request.\n\n @note\n   For private repositories, these links are temporary and expire quickly.\n\n @param [Hash] params\n @input params [String] :archive_format\n   Required string. Either tarball or zipball. Default: tarball\n @input params [String] :ref\n   Optional string. A valid Git reference.\n   Default: the repository\u2019s default branch (usually master)\n\n @example\n  github = Github.new\n  github.repos.contents.archive 'user-name', 'repo-name',\n    archive_format: \"tarball\",\n    ref: \"master\"\n\n @api public", "Turns any keys from nested hashes including nested arrays into strings", "Get-or-create an authorization for a specific app\n\n @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app\n\n @param [Hash] params\n @option params [String] client_secret\n  The 40 character OAuth app client secret associated with the client\n  ID specified in the URL.\n @option params [Array] :scopes\n   Optional array - A list of scopes that this authorization is in.\n @option params [String] :note\n   Optional string - A note to remind you what the OAuth token is for.\n @option params [String] :note_url\n   Optional string - A URL to remind you what the OAuth token is for.\n\n @example\n   github = Github.new\n   github.oauth.app.create 'client-id', client_secret: '...'\n\n @api public", "Check if an access token is a valid authorization for an application\n\n @example\n   github = Github.new basic_auth: \"client_id:client_secret\"\n   github.oauth.app.check 'client_id', 'access-token'\n\n @api public", "Revoke all authorizations for an application\n\n @example\n  github = Github.new basic_auth: \"client_id:client_secret\"\n  github.oauth.app.delete 'client-id'\n\n Revoke an authorization for an application\n\n @example\n  github = Github.new basic_auth: \"client_id:client_secret\"\n  github.oauth.app.delete 'client-id', 'access-token'\n\n @api public", "Edit a project\n\n @param [Hash] params\n @option params [String] :name\n   Optional string\n @option params [String] :body\n   Optional string\n @option params [String] :state\n   Optional string\n\n @example\n  github = Github.new\n  github.projects.edit 1002604,\n    name: \"Outcomes Tracker\",\n    body: \"The board to track work for the Outcomes application.\"\n\n @api public", "List a user's gists\n\n @see https://developer.github.com/v3/gists/#list-a-users-gists\n\n @example\n  github = Github.new\n  github.gists.list user: 'user-name'\n\n List the authenticated user\u2019s gists or if called anonymously,\n this will returns all public gists\n\n @example\n  github = Github.new oauth_token: '...'\n  github.gists.list\n\n List all public gists\n\n @see https://developer.github.com/v3/gists/#list-all-public-gists\n\n  github = Github.new\n  github.gists.list :public\n\n @return [Hash]\n\n @api public", "Get a single gist\n\n @see https://developer.github.com/v3/gists/#get-a-single-gist\n\n @example\n   github = Github.new\n   github.gists.get 'gist-id'\n\n Get a specific revision of gist\n\n @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist\n\n @example\n   github = Github.new\n   github.gists.get 'gist-id', sha: '\n\n @return [Hash]\n\n @api public", "Setup OAuth2 instance", "Create a new project for the specified repo\n\n @param [Hash] params\n @option params [String] :name\n   Required string - The name of the project.\n @option params [String] :body\n   Optional string - The body of the project.\n\n @example\n  github = Github.new\n  github.repos.create 'owner-name', 'repo-name', name: 'project-name'\n  github.repos.create name: 'project-name', body: 'project-body', owner: 'owner-name', repo: 'repo-name'", "Create a new Request\n\n @return [Github::Request]\n\n @api public\n Performs a request\n\n @param [Symbol] method - The Symbol the HTTP verb\n @param [String] path   - String relative URL to access\n @param [ParamsHash] params - ParamsHash to configure the request API\n\n @return [Github::ResponseWrapper]\n\n @api private", "Get a single authorization\n\n @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization\n\n @example\n  github = Github.new basic_auth: 'login:password'\n  github.oauth.get 'authorization-id'\n\n @return [ResponseWrapper]\n\n @api public", "Create a new authorization\n\n @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization\n\n @param [Hash] params\n @option params [Array[String]] :scopes\n   A list of scopes that this authorization is in.\n @option params [String] :note\n   Required. A note to remind you what the OAuth token is for.\n @option params [String] :note_url\n   A URL to remind you what the OAuth token is for.\n @option params [String] :client_id\n   The 20 character OAuth app client key for which to create the token.\n @option params [String] :client_secret\n   The 40 character OAuth app client secret for which to create the token.\n @option params [String] :fingerprint\n   A unique string to distinguish an authorization from others\n   created for the same client ID and user.\n\n @example\n   github = Github.new basic_auth: 'login:password'\n   github.oauth.create scopes: [\"public_repo\"], note: 'amdmin script'\n\n @api public", "Update an existing authorization\n\n @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization\n\n @param [Hash] inputs\n @option inputs [Array] :scopes\n   Optional array - A list of scopes that this authorization is in.\n @option inputs [Array] :add_scopes\n   Optional array - A list of scopes to add to this authorization.\n @option inputs [Array] :remove_scopes\n   Optional array - A list of scopes to remove from this authorization.\n @option inputs [String] :note\n   Optional string - A note to remind you what the OAuth token is for.\n @optoin inputs [String] :note_url\n   Optional string - A URL to remind you what the OAuth token is for.\n @option params [String] :fingerprint\n   A unique string to distinguish an authorization from others\n   created for the same client ID and user.\n\n @example\n   github = Github.new basic_auth: 'login:password'\n   github.oauth.update \"authorization-id\", add_scopes: [\"repo\"]\n\n @api public", "Delete an authorization\n\n @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization\n\n @example\n   github = Github.new\n   github.oauth.delete 'authorization-id'\n\n @api public", "List your notifications\n\n List all notifications for the current user, grouped by repository.\n\n @see https://developer.github.com/v3/activity/notifications/#list-your-notifications\n\n @param [Hash] params\n @option params [Boolean] :all\n   If true, show notifications marked as read.\n   Default: false\n @option params [Boolean] :participating\n   If true, only shows notifications in which the user\n   is directly participating or mentioned. Default: false\n @option params [String] :since\n   Filters out any notifications updated before the given time.\n   This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\n   Default: Time.now\n\n @example\n   github = Github.new oauth_token: 'token'\n   github.activity.notifications.list\n\n List your notifications in a repository\n\n @see https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository\n\n @example\n  github = Github.new\n  github.activity.notifications.list user: 'user-name', repo: 'repo-name'\n\n @api public", "Mark as read\n\n Marking a notification as \u201cread\u201d removes it from the default view on GitHub.com.\n\n @see https://developer.github.com/v3/activity/notifications/#mark-as-read\n\n @param [Hash] params\n @option params [String] :last_read_at\n   Describes the last point that notifications were checked.\n   Anything updated since this time will not be updated.\n   This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.\n   Default: Time.now\n\n @example\n  github = Github.new oauth_token: 'token'\n  github.activity.notifications.mark\n\n Mark notifications as read in a repository\n\n @see https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository\n\n @example\n  github.activity.notifications.mark user: 'user-name', repo: 'repo-name'\n\n Mark a thread as read\n\n @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read\n\n @example\n  github.activity.notifications.mark id: 'thread-id'\n\n @api public", "Perform http get request with pagination parameters", "Generate ASCII octocat with speech bubble.\n\n @example\n  Github::Client::Say.new.say \"My custom string...\"\n\n @example\n  github = Github.new\n  github.octocat.say \"My custom string...\"", "Iterate over each resource inside the body", "Finds api methods in a class\n\n @param [Class] klass\n   The klass to inspect for methods.\n\n @api private", "Create default connection options\n\n @return [Hash[Symbol]]\n   the default options\n\n @api private", "Creates http connection\n\n Returns a Fraday::Connection object", "Update a public key for the authenticated user\n\n @param [Hash] params\n @option [String] :title\n   Required string\n @option [String] :key\n   Required string. sha key\n\n @example\n  github = Github.new oauth_token: '...'\n  github.users.keys.update 'key-id', \"title\": \"octocat@octomac\",\n    \"key\": \"ssh-rsa AAA...\"\n\n @api public", "Parse media type param", "Create a hook\n\n @see https://developer.github.com/v3/orgs/hooks/#create-a-hook\n\n @param [Hash] params\n @input params [String] :name\n   Required. The name of the service that is being called.\n @input params [Hash] :config\n   Required. Key/value pairs to provide settings for this hook.\n   These settings vary between the services and are defined in\n   the github-services repository. Booleans are stored internally\n   as \"1\" for true, and \"0\" for false. Any JSON true/false values\n   will be converted automatically.\n @input params [Array] :events\n   Determines what events the hook is triggered for. Default: [\"push\"]\n @input params [Boolean] :active\n   Determines whether the hook is actually triggered on pushes.\n\n To create a webhook, the following fields are required by the config:\n\n @input config [String] :url\n   A required string defining the URL to which the payloads\n   will be delivered.\n @input config [String] :content_type\n   An optional string defining the media type used to serialize\n   the payloads. Supported values include json and form.\n   The default is form.\n @input config [String] :secret\n   An optional string that\u2019s passed with the HTTP requests as\n   an X-Hub-Signature header. The value of this header is\n   computed as the HMAC hex digest of the body,\n   using the secret as the key.\n @input config [String] :insecure_ssl\n   An optional string that determines whether the SSL certificate\n   of the host for url will be verified when delivering payloads.\n   Supported values include \"0\" (verification is performed) and\n   \"1\" (verification is not performed). The default is \"0\".or instance, if the library doesn't get updated to permit a given parameter the api call won't work, however if we skip permission all together, the endpoint should always work provided the actual resource path doesn't change. I'm in the process of completely removing the permit functionality.\n\n @example\n   github = Github.new\n   github.orgs.hooks.create 'org-name',\n     name:  \"web\",\n     active: true,\n     config: {\n       url: \"http://something.com/webhook\"\n     }\n   }\n\n @api public", "Create a milestone\n\n @param [Hash] params\n @option params [String] :title\n   Required string. The title of the milestone\n @option params [String] :state\n   The state of the milestone. Either open or closed. Default: open.\n @option params [String] :description\n   A description of the milestone\n @option params [String] :due_on\n   The milestone due date. This is a timestamp in ISO 8601 format:\n   YYYY-MM-DDTHH:MM:SSZ.\n\n @example\n  github = Github.new user: 'user-name', repo: 'repo-name'\n  github.issues.milestones.create title: 'hello-world',\n    state: \"open or closed\",\n    description: \"String\",\n    due_on: \"Time\"\n\n @api public", "Get a reference\n\n The ref in the URL must be formatted as <tt>heads/branch</tt>,\n not just branch. For example, the call to get the data for a\n branch named sc/featureA would be formatted as heads/sc/featureA\n\n @example\n  github = Github.new\n  github.git_data.references.get 'user-name', 'repo-name', 'heads/branch'\n\n @api public", "Create a reference\n\n @param [Hash] params\n @input params [String] :ref\n   The name of the fully qualified reference (ie: refs/heads/master).\n   If it doesn\u2019t start with \u2018refs\u2019 and have at least two slashes,\n   it will be rejected.\n @input params [String] :sha\n   The SHA1 value to set this reference to\n\n @example\n  github = Github.new\n  github.git_data.references.create 'user-name', 'repo-name',\n    ref: \"refs/heads/master\",\n    sha:  \"827efc6d56897b048c772eb4087f854f46256132\"\n\n @api public", "Update a reference\n\n @param [Hash] params\n @input params [String] :sha\n   The SHA1 value to set this reference to\n @input params [Boolean] :force\n   Indicates whether to force the update or to make sure the update\n   is a fast-forward update. Leaving this out or setting it to false\n   will make sure you\u2019re not overwriting work. Default: false\n\n @example\n  github = Github.new\n  github.git_data.references.update 'user-name', 'repo-name', 'heads/master',\n    sha:  \"827efc6d56897b048c772eb4087f854f46256132\",\n    force: true\n\n @api public", "Delete a reference\n\n @example\n  github = Github.new\n  github.git_data.references.delete 'user-name', 'repo-name',\n    \"heads/master\"\n\n @api public", "Caches the available locales list as both strings and symbols in a Set, so\n that we can have faster lookups to do the available locales enforce check.", "Returns the current handler for situations when interpolation argument\n is missing. MissingInterpolationArgument will be raised by default.", "Translates, pluralizes and interpolates a given key using a given locale,\n scope, and default, as well as interpolation values.\n\n *LOOKUP*\n\n Translation data is organized as a nested hash using the upper-level keys\n as namespaces. <em>E.g.</em>, ActionView ships with the translation:\n <tt>:date => {:formats => {:short => \"%b %d\"}}</tt>.\n\n Translations can be looked up at any level of this hash using the key argument\n and the scope option. <em>E.g.</em>, in this example <tt>I18n.t :date</tt>\n returns the whole translations hash <tt>{:formats => {:short => \"%b %d\"}}</tt>.\n\n Key can be either a single key or a dot-separated key (both Strings and Symbols\n work). <em>E.g.</em>, the short format can be looked up using both:\n   I18n.t 'date.formats.short'\n   I18n.t :'date.formats.short'\n\n Scope can be either a single key, a dot-separated key or an array of keys\n or dot-separated keys. Keys and scopes can be combined freely. So these\n examples will all look up the same short date format:\n   I18n.t 'date.formats.short'\n   I18n.t 'formats.short', :scope => 'date'\n   I18n.t 'short', :scope => 'date.formats'\n   I18n.t 'short', :scope => %w(date formats)\n\n *INTERPOLATION*\n\n Translations can contain interpolation variables which will be replaced by\n values passed to #translate as part of the options hash, with the keys matching\n the interpolation variable names.\n\n <em>E.g.</em>, with a translation <tt>:foo => \"foo %{bar}\"</tt> the option\n value for the key +bar+ will be interpolated into the translation:\n   I18n.t :foo, :bar => 'baz' # => 'foo baz'\n\n *PLURALIZATION*\n\n Translation data can contain pluralized translations. Pluralized translations\n are arrays of singluar/plural versions of translations like <tt>['Foo', 'Foos']</tt>.\n\n Note that <tt>I18n::Backend::Simple</tt> only supports an algorithm for English\n pluralization rules. Other algorithms can be supported by custom backends.\n\n This returns the singular version of a pluralized translation:\n   I18n.t :foo, :count => 1 # => 'Foo'\n\n These both return the plural version of a pluralized translation:\n   I18n.t :foo, :count => 0 # => 'Foos'\n   I18n.t :foo, :count => 2 # => 'Foos'\n\n The <tt>:count</tt> option can be used both for pluralization and interpolation.\n <em>E.g.</em>, with the translation\n <tt>:foo => ['%{count} foo', '%{count} foos']</tt>, count will\n be interpolated to the pluralized translation:\n   I18n.t :foo, :count => 1 # => '1 foo'\n\n *DEFAULTS*\n\n This returns the translation for <tt>:foo</tt> or <tt>default</tt> if no translation was found:\n   I18n.t :foo, :default => 'default'\n\n This returns the translation for <tt>:foo</tt> or the translation for <tt>:bar</tt> if no\n translation for <tt>:foo</tt> was found:\n   I18n.t :foo, :default => :bar\n\n Returns the translation for <tt>:foo</tt> or the translation for <tt>:bar</tt>\n or <tt>default</tt> if no translations for <tt>:foo</tt> and <tt>:bar</tt> were found.\n   I18n.t :foo, :default => [:bar, 'default']\n\n *BULK LOOKUP*\n\n This returns an array with the translations for <tt>:foo</tt> and <tt>:bar</tt>.\n   I18n.t [:foo, :bar]\n\n Can be used with dot-separated nested keys:\n   I18n.t [:'baz.foo', :'baz.bar']\n\n Which is the same as using a scope option:\n   I18n.t [:foo, :bar], :scope => :baz\n\n *LAMBDAS*\n\n Both translations and defaults can be given as Ruby lambdas. Lambdas will be\n called and passed the key and options.\n\n E.g. assuming the key <tt>:salutation</tt> resolves to:\n   lambda { |key, options| options[:gender] == 'm' ? \"Mr. #{options[:name]}\" : \"Mrs. #{options[:name]}\" }\n\n Then <tt>I18n.t(:salutation, :gender => 'w', :name => 'Smith') will result in \"Mrs. Smith\".\n\n Note that the string returned by lambda will go through string interpolation too,\n so the following lambda would give the same result:\n   lambda { |key, options| options[:gender] == 'm' ? \"Mr. %{name}\" : \"Mrs. %{name}\" }\n\n It is recommended to use/implement lambdas in an \"idempotent\" way. E.g. when\n a cache layer is put in front of I18n.translate it will generate a cache key\n from the argument values passed to #translate. Therefor your lambdas should\n always return the same translations/values per unique combination of argument\n values.", "Returns true if a translation exists for a given key, otherwise returns false.", "Localizes certain objects, such as dates and numbers to local formatting.", "Merges the given locale, key and scope into a single array of keys.\n Splits keys that contain dots into multiple keys. Makes sure all\n keys are Symbols.", "Raises an InvalidLocale exception when the passed locale is not available.", "Main plugin action, called by Jekyll-core", "Special case the \"posts\" collection, which, for ease of use and backwards\n compatability, can be configured via top-level keys or directly as a collection", "Return everything that matches the query.", "Retrieves an attribute set in the Mash. Will convert\n any key passed in to a string before retrieving.", "Sets an attribute in the Mash. Key will be converted to\n a string before it is set, and Hashes will be converted\n into Mashes for nesting purposes.", "This is the bang method reader, it will return a new Mash\n if there isn't a value already assigned to the key requested.", "This is the under bang method reader, it will return a temporary new Mash\n if there isn't a value already assigned to the key requested.", "Recursively merges this mash with the passed\n in hash, merging each hash in the hierarchy.", "called by after_update callback", "check if record is soft-deleted", "increments or decrements a counter cache\n\n options:\n   :increment => true to increment, false to decrement\n   :relation => which relation to increment the count on,\n   :counter_cache_name => the column name of the counter cache\n   :counter_column => overrides :counter_cache_name\n   :delta_column => override the default count delta (1) with the value of this column in the counted record\n   :was => whether to get the current value or the old value of the\n      first part of the relation\n   :with_papertrail => update the column via Papertrail touch_with_version method", "gets the value of the foreign key on the given relation\n\n relation: a symbol or array of symbols; specifies the relation\n   that has the counter cache column\n was: whether to get the current or past value from ActiveRecord;\n   pass true to get the past value, false or nothing to get the\n   current value", "gets the reflect object on the given relation\n\n relation: a symbol or array of symbols; specifies the relation\n   that has the counter cache column", "gets the class of the given relation\n\n relation: a symbol or array of symbols; specifies the relation\n   that has the counter cache column\n source [optional]: the source object,\n   only needed for polymorphic associations,\n   probably only works with a single relation (symbol, or array of 1 symbol)\n was: boolean\n   we're actually looking for the old value -- only can change for polymorphic relations", "gets the primary key name of the given relation\n\n relation: a symbol or array of symbols; specifies the relation\n   that has the counter cache column\n source[optional]: the model instance that the relationship is linked from,\n   only needed for polymorphic associations,\n   probably only works with a single relation (symbol, or array of 1 symbol)\n was: boolean\n   we're actually looking for the old value -- only can change for polymorphic relations", "Convert to Japanese era.\n @param [String] format_string\n   Time#strftime format string can be used\n   #### extra format string\n   * %o - era(alphabet)\n   * %O - era(kanzi)\n   * %E - era year\n   * %J - kanzi number\n @param [Hash] era_names\n    If you want to convert custom to era strings (eg `\u5e73`, `h`), you can set this argument.\n    key is `:meiji' or `:taisho' or `:showa` or `:heisei` or `:reiwa`.\n    value is [\"alphabet era name\"(ex `h`, `s`)(related to `%o`), \"multibyte era name\"(eg `\u5e73`, `\u662d`)(related to `%O`)].\n    this argument is same as one element of ERA_NAME_DEFAULTS.\n @return [String]", "Produce a thresholds array containing absolute values based on supplied\n percentages applied to a literal max value.", "Is the detected dependency currently open?", "Obtains the default credentials implementation to use in this\n environment.\n\n Use this to obtain the Application Default Credentials for accessing\n Google APIs.  Application Default Credentials are described in detail\n at http://goo.gl/IUuyuX.\n\n If supplied, scope is used to create the credentials instance, when it can\n be applied.  E.g, on google compute engine and for user credentials the\n scope is ignored.\n\n @param scope [string|array|nil] the scope(s) to access\n @param options [Hash] Connection options. These may be used to configure\n     the `Faraday::Connection` used for outgoing HTTP requests. For\n     example, if a connection proxy must be used in the current network,\n     you may provide a connection with with the needed proxy options.\n     The following keys are recognized:\n     * `:default_connection` The connection object to use for token\n       refresh requests.\n     * `:connection_builder` A `Proc` that creates and returns a\n       connection to use for token refresh requests.\n     * `:connection` The connection to use to determine whether GCE\n       metadata credentials are available.", "Returns an Array of directive structures. Each structure\n is an Array with the line number as the first element, the\n directive name as the second element, followed by any\n arguments.\n\n     [[1, \"require\", \"foo\"], [2, \"require\", \"bar\"]]", "Set logger level with constant or symbol.\n\n   t.log_level = Logger::INFO\n   t.log_level = :debug", "Sub out environment logger with our rake task logger that\n writes to stderr.", "Registers a pipeline that will be called by `call_processor` method.", "Prepend a `path` to the `paths` list.\n\n Paths at the end of the `Array` have the least priority.", "Append a `path` to the `paths` list.\n\n Paths at the beginning of the `Array` have a higher priority.", "`depend_on` allows you to state a dependency on a file without\n including it.\n\n This is used for caching purposes. Any changes made to\n the dependency file will invalidate the cache of the\n source file.", "Returns a Base64-encoded data URI.", "Optimizes an SVG for being URI-escaped.\n\n This method only performs these basic but crucial optimizations:\n * Replaces \" with ', because ' does not need escaping.\n * Removes comments, meta, doctype, and newlines.\n * Collapses whitespace.", "Un-escapes characters in the given URI-escaped string that do not need\n escaping in \"-quoted data URIs.", "Compile asset to directory. The asset is written to a\n fingerprinted filename like\n `application-2e8e9a7c6b0aafa0c9bdeec90ea30213.js`. An entry is\n also inserted into the manifest file.\n\n   compile(\"application.js\")", "Removes file from directory and from manifest. `filename` must\n be the name with any directory path.\n\n   manifest.remove(\"application-2e8e9a7c6b0aafa0c9bdeec90ea30213.js\")", "Cleanup old assets in the compile directory. By default it will\n keep the latest version, 2 backups and any created within the past hour.\n\n Examples\n\n   To force only 1 backup to be kept, set count=1 and age=0.\n\n   To only keep files created within the last 10 minutes, set count=0 and\n   age=600.", "Persist manfiest back to FS", "Given an asset, finds all exporters that\n match its mime-type.\n\n Will yield each expoter to the passed in block.\n\n     array = []\n     puts asset.content_type # => \"application/javascript\"\n     exporters_for_asset(asset) do |exporter|\n       array << exporter\n     end\n     # puts array => [Exporters::FileExporter, Exporters::ZlibExporter]", "`call` implements the Rack 1.x specification which accepts an\n `env` Hash and returns a three item tuple with the status code,\n headers, and body.\n\n Mapping your environment at a url prefix will serve all assets\n in the path.\n\n     map \"/assets\" do\n       run Sprockets::Environment.new\n     end\n\n A request for `\"/assets/foo/bar.js\"` will search your\n environment for `\"foo/bar.js\"`.", "Returns a 200 OK response tuple", "Get a thumbnail job object given a geometry and whether to strip image profiles and comments.", "Intelligently works out dimensions for a thumbnail of this image based on the Dragonfly geometry string.", "Repositions the child page_parts that belong to this page.\n This ensures that they are in the correct 0,1,2,3,4... etc order.", "Returns the full path to this page.\n This automatically prints out this page title and all parent page titles.\n The result is joined by the path_separator argument.", "Generates the link to determine where the site bar switch button returns to.", "image_fu is a helper for inserting an image that has been uploaded into a template.\n Say for example that we had a @model.image (@model having a belongs_to :image relationship)\n and we wanted to display a thumbnail cropped to 200x200 then we can use image_fu like this:\n <%= image_fu @model.image, '200x200' %> or with no thumbnail: <%= image_fu @model.image %>", "Creates a decorator factory.\n\n @option options [Decorator, CollectionDecorator] :with (nil)\n   decorator class to use. If nil, it is inferred from the object\n   passed to {#decorate}.\n @option options [Hash, #call] context\n   extra data to be stored in created decorators. If a proc is given, it\n   will be called each time {#decorate} is called and its return value\n   will be used as the context.\n Decorates an object, inferring whether to create a singular or collection\n decorator from the type of object passed.\n\n @param [Object] object\n   object to decorate.\n @option options [Hash] context\n   extra data to be stored in the decorator. Overrides any context passed\n   to the constructor.\n @option options [Object, Array] context_args (nil)\n   argument(s) to be passed to the context proc.\n @return [Decorator, CollectionDecorator] the decorated object.", "Proxies missing query methods to the source class if the strategy allows.", "Lets you specify the addon modules to use with FriendlyId.\n\n This method is invoked by {FriendlyId::Base#friendly_id friendly_id} when\n passing the `:use` option, or when using {FriendlyId::Base#friendly_id\n friendly_id} with a block.\n\n @example\n   class Book < ActiveRecord::Base\n     extend FriendlyId\n     friendly_id :name, :use => :slugged\n   end\n\n @param [#to_s,Module] modules Arguments should be Modules, or symbols or\n   strings that correspond with the name of an addon to use with FriendlyId.\n   By default FriendlyId provides `:slugged`, `:history`, `:simple_i18n`,\n   and `:scoped`.", "Process the given value to make it suitable for use as a slug.\n\n This method is not intended to be invoked directly; FriendlyId uses it\n internally to process strings into slugs.\n\n However, if FriendlyId's default slug generation doesn't suit your needs,\n you can override this method in your model class to control exactly how\n slugs are generated.\n\n ### Example\n\n     class Person < ActiveRecord::Base\n       extend FriendlyId\n       friendly_id :name_and_location\n\n       def name_and_location\n         \"#{name} from #{location}\"\n       end\n\n       # Use default slug, but upper case and with underscores\n       def normalize_friendly_id(string)\n         super.upcase.gsub(\"-\", \"_\")\n       end\n     end\n\n     bob = Person.create! :name => \"Bob Smith\", :location => \"New York City\"\n     bob.friendly_id #=> \"BOB_SMITH_FROM_NEW_YORK_CITY\"\n\n ### More Resources\n\n You might want to look into Babosa[https://github.com/norman/babosa],\n which is the slugging library used by FriendlyId prior to version 4, which\n offers some specialized functionality missing from Active Support.\n\n @param [#to_s] value The value used as the basis of the slug.\n @return The candidate slug text, without a sequence.", "Configure FriendlyId's behavior in a model.\n\n     class Post < ActiveRecord::Base\n       extend FriendlyId\n       friendly_id :title, :use => :slugged\n     end\n\n When given the optional block, this method will yield the class's instance\n of {FriendlyId::Configuration} to the block before evaluating other\n arguments, so configuration values set in the block may be overwritten by\n the arguments. This order was chosen to allow passing the same proc to\n multiple models, while being able to override the values it sets. Here is\n a contrived example:\n\n     $friendly_id_config_proc = Proc.new do |config|\n       config.base = :name\n       config.use :slugged\n     end\n\n     class Foo < ActiveRecord::Base\n       extend FriendlyId\n       friendly_id &$friendly_id_config_proc\n     end\n\n     class Bar < ActiveRecord::Base\n       extend FriendlyId\n       friendly_id :title, &$friendly_id_config_proc\n     end\n\n However, it's usually better to use {FriendlyId.defaults} for this:\n\n     FriendlyId.defaults do |config|\n       config.base = :name\n       config.use :slugged\n     end\n\n     class Foo < ActiveRecord::Base\n       extend FriendlyId\n     end\n\n     class Bar < ActiveRecord::Base\n       extend FriendlyId\n       friendly_id :title\n     end\n\n In general you should use the block syntax either because of your personal\n aesthetic preference, or because you need to share some functionality\n between multiple models that can't be well encapsulated by\n {FriendlyId.defaults}.\n\n ### Order Method Calls in a Block vs Ordering Options\n\n When calling this method without a block, you may set the hash options in\n any order.\n\n However, when using block-style invocation, be sure to call\n FriendlyId::Configuration's {FriendlyId::Configuration#use use} method\n *prior* to the associated configuration options, because it will include\n modules into your class, and these modules in turn may add required\n configuration options to the `@friendly_id_configuraton`'s class:\n\n     class Person < ActiveRecord::Base\n       friendly_id do |config|\n         # This will work\n         config.use :slugged\n         config.sequence_separator = \":\"\n       end\n     end\n\n     class Person < ActiveRecord::Base\n       friendly_id do |config|\n         # This will fail\n         config.sequence_separator = \":\"\n         config.use :slugged\n       end\n     end\n\n ### Including Your Own Modules\n\n Because :use can accept a name or a Module, {FriendlyId.defaults defaults}\n can be a convenient place to set up behavior common to all classes using\n FriendlyId. You can include any module, or more conveniently, define one\n on-the-fly. For example, let's say you want to make\n [Babosa](http://github.com/norman/babosa) the default slugging library in\n place of Active Support, and transliterate all slugs from Russian Cyrillic\n to ASCII:\n\n     require \"babosa\"\n\n     FriendlyId.defaults do |config|\n       config.base = :name\n       config.use :slugged\n       config.use Module.new {\n         def normalize_friendly_id(text)\n           text.to_slug.normalize! :transliterations => [:russian, :latin]\n         end\n       }\n     end\n\n\n @option options [Symbol,Module] :use The addon or name of an addon to use.\n   By default, FriendlyId provides {FriendlyId::Slugged :slugged},\n   {FriendlyId::History :history}, {FriendlyId::Reserved :reserved}, and\n   {FriendlyId::Scoped :scoped}, and {FriendlyId::SimpleI18n :simple_i18n}.\n\n @option options [Array] :reserved_words Available when using `:reserved`,\n   which is loaded by default. Sets an array of words banned for use as\n   the basis of a friendly_id. By default this includes \"edit\" and \"new\".\n\n @option options [Symbol] :scope Available when using `:scoped`.\n   Sets the relation or column used to scope generated friendly ids. This\n   option has no default value.\n\n @option options [Symbol] :sequence_separator Available when using `:slugged`.\n   Configures the sequence of characters used to separate a slug from a\n   sequence. Defaults to `-`.\n\n @option options [Symbol] :slug_column Available when using `:slugged`.\n   Configures the name of the column where FriendlyId will store the slug.\n   Defaults to `:slug`.\n\n @option options [Integer] :slug_limit Available when using `:slugged`.\n   Configures the limit of the slug. This option has no default value.\n\n @option options [Symbol] :slug_generator_class Available when using `:slugged`.\n   Sets the class used to generate unique slugs. You should not specify this\n   unless you're doing some extensive hacking on FriendlyId. Defaults to\n   {FriendlyId::SlugGenerator}.\n\n @yield Provides access to the model class's friendly_id_config, which\n   allows an alternate configuration syntax, and conditional configuration\n   logic.\n\n @option options [Symbol,Boolean] :dependent Available when using `:history`.\n   Sets the value used for the slugged association's dependent option. Use\n   `false` if you do not want to dependently destroy the associated slugged\n   record. Defaults to `:destroy`.\n\n @option options [Symbol] :routes When set to anything other than :friendly,\n   ensures that all routes generated by default do *not* use the slug.  This\n   allows `form_for` and `polymorphic_path` to continue to generate paths like\n   `/team/1` instead of `/team/number-one`.  You can still generate paths\n   like the latter using: team_path(team.slug).  When set to :friendly, or\n   omitted, the default friendly_id behavior is maintained.\n\n @yieldparam config The model class's {FriendlyId::Configuration friendly_id_config}.", "Finds a record using the given id.\n\n If the id is \"unfriendly\", it will call the original find method.\n If the id is a numeric string like '123' it will first look for a friendly\n id matching '123' and then fall back to looking for a record with the\n numeric id '123'.\n\n Since FriendlyId 5.0, if the id is a nonnumeric string like '123-foo' it\n will *only* search by friendly id and not fall back to the regular find\n method.\n\n If you want to search only by the friendly id, use {#find_by_friendly_id}.\n @raise ActiveRecord::RecordNotFound", "To delete an account Intuit requires we provide Id and SyncToken fields", "Fabricated easy.\n\n @example Prepared easy.\n   easy_factory.get\n\n @return [ Ethon::Easy ] The easy.", "Sets on_complete callback on easy in order to be able to\n track progress.\n\n @example Set callback.\n   easy_factory.set_callback\n\n @return [ Ethon::Easy ] The easy.", "Creates a new request.\n\n @example Simplest request.\n   response = Typhoeus::Request.new(\"www.example.com\").run\n\n @example Request with url parameters.\n   response = Typhoeus::Request.new(\n     \"www.example.com\",\n     params: {a: 1}\n   ).run\n\n @example Request with a body.\n   response = Typhoeus::Request.new(\n     \"www.example.com\",\n     body: {b: 2}\n   ).run\n\n @example Request with parameters and body.\n   response = Typhoeus::Request.new(\n     \"www.example.com\",\n     params: {a: 1},\n     body: {b: 2}\n   ).run\n\n @example Create a request and allow follow redirections.\n   response = Typhoeus::Request.new(\n     \"www.example.com\",\n     followlocation: true\n   ).run\n\n @param [ String ] base_url The url to request.\n @param [ options ] options The options.\n\n @option options [ Hash ] :params Translated\n   into url parameters.\n @option options [ Hash ] :body Translated\n   into HTTP POST request body.\n\n @return [ Typhoeus::Request ] The request.\n\n @note See {http://rubydoc.info/github/typhoeus/ethon/Ethon/Easy/Options Ethon::Easy::Options} for more options.\n\n @see Typhoeus::Hydra\n @see Typhoeus::Response\n @see Typhoeus::Request::Actions\n Return the url.\n In contrast to base_url which returns the value you specified, url returns\n the full url including the parameters.\n\n @example Get the url.\n   request.url\n\n @since 0.5.5", "Checks if two hashes are equal or not, discarding\n first-level hash order.\n\n @param [ Hash ] left\n @param [ Hash ] right hash to check for equality\n\n @return [ Boolean ] Returns true if hashes have\n   same values for same keys and same length,\n   even if the keys are given in a different order.", "Sets default header and verbose when turned on.", "Specify what should be returned,\n when this expectation is hit.\n\n @example Add response.\n   expectation.and_return(response)\n\n @return [ void ]", "Return the response. When there are\n multiple responses, they are returned one\n by one.\n\n @example Return response.\n   expectation.response\n\n @return [ Response ] The response.\n\n @api private", "Check whether the options matches the request options.\n I checks options and original options.", "Check whether the base_url matches the request url.\n The base_url can be a string, regex or nil. String and\n regexp are checked, nil is always true, else false.\n\n Nil serves as a placeholder in case you want to match\n all urls.", "sets collection to class.for_fae_index if not defined", "sets default prompt for pulldowns", "removes language suffix from label and adds data attr for languange nav", "set cloneable attributes and associations", "Changes the Logger's log level.", "Sessions are initialized with a Sunspot configuration and a Solr\n connection. Usually you will want to stick with the default arguments\n when instantiating your own sessions.\n\n\n See Sunspot.new_search", "See Sunspot.new_more_like_this", "See Sunspot.more_like_this", "See Sunspot.atomic_update", "See Sunspot.remove", "See Sunspot.remove_by_id", "See Sunspot.remove_all", "Retrieve the Solr connection for this session, creating one if it does not\n already exist.\n\n ==== Returns\n\n RSolr::Connection::Base:: The connection for this session", "DynamicField instances representing all the available types and variants", "Return an XML representation of this schema using the ERB template", "All of the possible combinations of variants", "Get a text field object by its public name. A field will be returned if\n it is configured for any of the enclosed types.\n\n ==== Returns\n\n Sunspot::FulltextField:: Text field with the given public name\n\n ==== Raises\n\n UnrecognizedFieldError::\n   If no field with that name is configured for any of the enclosed types.", "Return a hash of field names to text field objects, containing all fields\n that are configured for any of the types enclosed.\n\n ==== Returns\n\n Hash:: Hash of field names to text field objects.", "Return a hash of field names to field objects, containing all fields\n that are common to all of the classes enclosed. In order for fields\n to be common, they must be of the same type and have the same\n value for allow_multiple? and stored?. This method is memoized.\n\n ==== Returns\n\n Hash:: field names keyed to field objects", "Add field_factories for fulltext search\n\n ==== Parameters\n\n field_factories<Array>:: Array of Sunspot::Field objects", "Add dynamic field_factories\n\n ==== Parameters\n\n field_factories<Array>:: Array of dynamic field objects", "Return all more_like_this fields", "Get all static, dynamic, and text field_factories associated with this setup as\n well as all inherited field_factories\n\n ==== Returns\n\n Array:: Collection of all text and scope field_factories associated with this setup", "Construct a representation of the given class instances for atomic properties update\n and send it to the connection for indexing\n\n ==== Parameters\n\n clazz<Class>:: the class of the models to be updated\n updates<Hash>:: hash of updates where keys are model ids\n                 and values are hash with property name/values to be updated", "Remove the given model from the Solr index", "Remove the model from the Solr index by specifying the class and ID", "Convert documents into hash of indexed properties", "All indexed documents index and store the +id+ and +type+ fields.\n These methods construct the document hash containing those key-value\n pairs.", "parses provided phone if it is valid for  country data and\n returns result of analyze\n\n ==== Attributes\n\n * +phone+ - Phone number for parsing\n * +passed_country+ - Country provided for parsing. Must be ISO code of\n   country (2 letters) like 'US', 'us' or :us for United States", "method checks which result is better to return", "replacing national prefix to simplified format", "trying to parse phone for single country including international prefix\n check for provided country\n\n ==== Attributes\n\n * +phone+ - phone for parsing\n * +country+ - country to parse phone with", "method checks if phone is valid against single provided country data\n\n ==== Attributes\n\n * +e164+ - e164 representation of phone for parsing\n * +data+ - country data for single country for parsing", "method tries to detect what is the country for provided phone\n\n ==== Attributes\n\n * +phone+ - phone number for parsing", "Create phone representation in e164 format\n\n ==== Attributes\n\n * +phone+ - phone number for parsing\n * +data+  - country data to be based on for creating e164 representation", "returns national number and analyzing results for provided phone number\n\n ==== Attributes\n\n * +data+ - country data\n * +country_match+ - result of match of phone within full regex\n * +not_valid+ - specifies that number is not valid by general desc pattern", "Returns all valid and possible phone number types for currently parsed\n phone for provided data hash.\n\n ==== Attributes\n\n * +phone+ - phone number for parsing\n * +data+  - country data\n * +not_valid+ - specifies that number is not valid by general desc pattern", "Gets matched number formatting rule or default one\n\n ==== Attributes\n\n * +national+ - national phone number\n * +format_data+  - formatting data from country data", "Returns possible and valid patterns for validation for provided type\n\n ==== Attributes\n\n * +all_patterns+ - hash of all patterns for validation\n * +type+ - type of phone to get patterns for", "converts symbols in phone to numbers", "defines if to validate against single country or not", "returns country prefix for provided country or nil", "defines whether country can have double country prefix in number", "checks if country can have numbers with double country prefixes\n\n ==== Attributes\n\n * +data+ - country data used for parsing\n * +phone+ - phone number being parsed\n * +parsed+ - parsed regex match for phone", "Get country that was provided or default country in needable format\n\n ==== Attributes\n\n * +country+ - country passed for parsing", "Returns regex for type with special types if needed\n\n ==== Attributes\n\n * +data+ - country types data for single type\n * +type+ - possible or valid regex type needed", "Check if phone match country data\n\n ==== Attributes\n\n * +phone+ - phone number for parsing\n * +data+  - country data", "returns array of phone types for check for current country data\n\n ==== Attributes\n\n * +data+  - country data hash", "Checks if fixed line pattern and mobile pattern are the same and returns\n appropriate keys\n\n ==== Attributes\n\n * +data+  - country data", "Checks if passed number matches valid and possible patterns\n\n ==== Attributes\n\n * +number+ - phone number for validation\n * +p_regex+ - possible regex pattern for validation\n * +v_regex+ - valid regex pattern for validation\n * +not_valid+ - specifies that number is not valid by general desc pattern", "Checks number against regex and compares match length\n\n ==== Attributes\n\n * +number+ - phone number for validation\n * +regex+ - regex for perfoming a validation", "returns local number\n @return [String] local number", "Returns whether a current parsed phone number is valid for specified\n country\n @param country [String|Symbol] ISO code of country (2 letters) like 'US',\n   'us' or :us for United States\n @return [Boolean] parsed phone number is valid", "method saves parsed data to data files", "method saves extended data file", "method updates prefixes hash recursively", "method parses raw data file", "get main body from parsed xml document", "Returns formatted national number\n @param formatted [Boolean] whether to return numbers only or formatted\n @return [String] formatted national number", "Returns the raw national number that was defined during parsing\n @return [String] raw national number", "Returns e164 formatted phone number. Method can receive single string parameter that will be defined as prefix\n @param formatted [Boolean] whether to return numbers only or formatted\n @param prefix [String] prefix to be placed before the number, \"+\" by default\n @return [String] formatted international number", "returns area code of parsed number\n @return [String|nil] parsed phone area code if available", "Create a new scanner\n Tokenize +string+ returning the Ruby object", "Parse and return a Time from +string+", "Handles start_document events with +version+, +tag_directives+,\n and +implicit+ styling.\n\n See Psych::Handler#start_document", "Handles end_document events with +version+, +tag_directives+,\n and +implicit+ styling.\n\n See Psych::Handler#start_document", "deletes the field_key referencing the translation", "below for adding new locale to an existing translation", "ordering of results happens client-side with paloma search.js", "Setter- called by update_extras in properties controller\n expects a hash with keys like \"cl.casafactory.fieldLabels.extras.alarma\"\n each with a value of true or false", "will return nil if price is 0", "below is used by logo_photo and about_us_photo,\n where only one photo is allowed", "below used when uploading carousel images", "seed_content is ...", "set block contents\n on page_part model", "Will retrieve saved page_part blocks and use that along with template\n to rebuild page_content html", "when seeding I only need to ensure that a photo exists for the fragment\n so will return existing photo if it can be found", "spt 2017 - above 2 will be redundant once vic becomes default layout\n below used when rendering to decide which class names\n to use for which elements", "allow setting of styles to a preset config from admin UI", "Initialize a Prompt\n\n @param [Hash] options\n @option options [IO] :input\n   the input stream\n @option options [IO] :output\n   the output stream\n @option options [Hash] :env\n   the environment variables\n @option options [String] :prefix\n   the prompt prefix, by default empty\n @option options [Boolean] :enable_color\n   enable color support, true by default\n @option options [String] :active_color\n   the color used for selected option\n @option options [String] :help_color\n   the color used for help text\n @option options [String] :error_color\n   the color used for displaying error messages\n @option options [Symbol] :interrupt\n   handling of Ctrl+C key out of :signal, :exit, :noop\n @option options [Boolean] :track_history\n   disable line history tracking, true by default\n @option options [Hash] :symbols\n   the symbols displayed in prompts such as :pointer, :cross\n\n @api public\n Invoke a question type of prompt\n\n @example\n   prompt = TTY::Prompt.new\n   prompt.invoke_question(Question, \"Your name? \")\n\n @return [String]\n\n @api public", "Invoke a list type of prompt\n\n @example\n   prompt = TTY::Prompt.new\n   editors = %w(emacs nano vim)\n   prompt.invoke_select(EnumList, \"Select editor: \", editors)\n\n @return [String]\n\n @api public", "A shortcut method to ask the user positive question and return\n true for 'yes' reply, false for 'no'.\n\n @example\n   prompt = TTY::Prompt.new\n   prompt.yes?('Are you human?')\n   # => Are you human? (Y/n)\n\n @return [Boolean]\n\n @api public", "Ask a question with a range slider\n\n @example\n   prompt = TTY::Prompt.new\n   prompt.slider('What size?', min: 32, max: 54, step: 2)\n\n @param [String] question\n   the question to ask\n\n @return [String]\n\n @api public", "Print statement out. If the supplied message ends with a space or\n tab character, a new line will not be appended.\n\n @example\n   say(\"Simple things.\", color: :red)\n\n @param [String] message\n\n @return [String]\n\n @api public", "Print debug information in terminal top right corner\n\n @example\n   prompt.debug \"info1\", \"info2\"\n\n @param [Array] messages\n\n @retrun [nil]\n\n @api public", "Takes the string provided by the user and compare it with other possible\n matches to suggest an unambigous string\n\n @example\n   prompt.suggest('sta', ['status', 'stage', 'commit', 'branch'])\n   # => \"status, stage\"\n\n @param [String] message\n\n @param [Array] possibilities\n\n @param [Hash] options\n @option options [String] :indent\n   The number of spaces for indentation\n @option options [String] :single_text\n   The text for a single suggestion\n @option options [String] :plural_text\n   The text for multiple suggestions\n\n @return [String]\n\n @api public", "Gathers more than one aswer\n\n @example\n   prompt.collect do\n     key(:name).ask('Name?')\n   end\n\n @return [Hash]\n   the collection of answers\n\n @api public", "Extract options hash from array argument\n\n @param [Array[Object]] args\n\n @api public", "Check if value is nil or an empty string\n\n @param [Object] value\n   the value to check\n\n @return [Boolean]\n\n @api public", "This feels very naughty", "Decodes a json document in string s and\n returns the corresponding ruby value.\n String s must be valid UTF-8. If you have\n a string in some other encoding, convert\n it first.\n\n String values in the resulting structure\n will be UTF-8.", "Parses an \"object\" in the sense of RFC 4627.\n Returns the parsed value and any trailing tokens.", "Parses a \"member\" in the sense of RFC 4627.\n Returns the parsed values and any trailing tokens.", "Parses an \"array\" in the sense of RFC 4627.\n Returns the parsed value and any trailing tokens.", "Scans the first token in s and\n returns a 3-element list, or nil\n if s does not begin with a valid token.\n\n The first list element is one of\n '{', '}', ':', ',', '[', ']',\n :val, :str, and :space.\n\n The second element is the lexeme.\n\n The third element is the value of the\n token for :val and :str, otherwise\n it is the lexeme.", "Converts a quoted json string literal q into a UTF-8-encoded string.\n The rules are different than for Ruby, so we cannot use eval.\n Unquote will raise an error if q contains control characters.", "Encodes unicode character u as UTF-8\n bytes in string a at position i.\n Returns the number of bytes written.", "Returns the pid of the process running the command, or nil if the application process died.", "Ensures that a hash uses symbols as opposed to strings\n Useful for allowing either syntax for end users", "Helper for setting content_for in activity partial, needed to\n flush remains in between partial renders.", "Directly saves activity to database. Works the same as create_activity\n but throws validation error for each supported ORM.\n\n @see #create_activity", "Prepares and resolves custom fields\n users can pass to `tracked` method\n @private", "Helper method to serialize class name into relevant key\n @return [String] the resulted key\n @param [Symbol] or [String] the name of the operation to be done on class\n @param [Hash] options to be used on key generation, defaults to {}", "Virtual attribute returning text description of the activity\n using the activity's key to translate using i18n.", "Renders activity from views.\n\n @param [ActionView::Base] context\n @return [nil] nil\n\n Renders activity to the given ActionView context with included\n AV::Helpers::RenderingHelper (most commonly just ActionView::Base)\n\n The *preferred* *way* of rendering activities is\n to provide a template specifying how the rendering should be happening.\n However, one may choose using _I18n_ based approach when developing\n an application that supports plenty of languages.\n\n If partial view exists that matches the *key* attribute\n renders that partial with local variables set to contain both\n Activity and activity_parameters (hash with indifferent access)\n\n Otherwise, it outputs the I18n translation to the context\n @example Render a list of all activities from a view (erb)\n   <ul>\n     <% for activity in PublicActivity::Activity.all %>\n      <li><%= render_activity(activity) %></li>\n     <% end %>\n   </ul>\n\n = Layouts\n You can supply a layout that will be used for activity partials\n with :layout param.\n Keep in mind that layouts for partials are also partials.\n @example Supply a layout\n   # in views:\n   #   All examples look for a layout in app/views/layouts/_activity.erb\n    render_activity @activity, :layout => \"activity\"\n    render_activity @activity, :layout => \"layouts/activity\"\n    render_activity @activity, :layout => :activity\n\n   # app/views/layouts/_activity.erb\n   <p><%= a.created_at %></p>\n   <%= yield %>\n\n == Custom Layout Location\n You can customize the layout directory by supplying :layout_root\n or by using an absolute path.\n\n @example Declare custom layout location\n\n   # Both examples look for a layout in \"app/views/custom/_layout.erb\"\n\n    render_activity @activity, :layout_root => \"custom\"\n    render_activity @activity, :layout      => \"/custom/layout\"\n\n = Creating a template\n To use templates for formatting how the activity should render,\n create a template based on activity key, for example:\n\n Given a key _activity.article.create_, create directory tree\n _app/views/public_activity/article/_ and create the _create_ partial there\n\n Note that if a key consists of more than three parts splitted by commas, your\n directory structure will have to be deeper, for example:\n   activity.article.comments.destroy => app/views/public_activity/articles/comments/_destroy.html.erb\n\n == Custom Directory\n You can override the default `public_directory` template root with the :root parameter\n\n @example Custom template root\n    # look for templates inside of /app/views/custom instead of /app/views/public_directory\n    render_activity @activity, :root => \"custom\"\n\n == Variables in templates\n From within a template there are two variables at your disposal:\n * activity (aliased as *a* for a shortcut)\n * params   (aliased as *p*) [converted into a HashWithIndifferentAccess]\n\n @example Template for key: _activity.article.create_ (erb)\n   <p>\n     Article <strong><%= p[:name] %></strong>\n     was written by <em><%= p[\"author\"] %></em>\n     <%= distance_of_time_in_words_to_now(a.created_at) %>\n   </p>", "Builds the path to template based on activity key", "Given a hash and client, will create an Enumerator that will lazily\n request Salesforce for the next page of results.\n Yield each value on each page.", "Featured detect form encoding.\n URI in 1.8 does not include encode_www_form", "Test for multiple values of the same enum type", "background_fill defaults to 'none'. If background_fill has been set to something\n else, combine it with the background_fill_opacity.", "Sets an image to use as the canvas background. See background_position= for layout options.", "Primitives for the outermost RVG object", "Primitives for nested RVG objects", "Convert object to a geometry string", "Draw an arc.", "Draw a circle", "Define the clipping rule.", "Define the clip units", "Set color in image according to specified colorization rule. Rule is one of\n point, replace, floodfill, filltoborder,reset", "Draw an ellipse", "IM 6.5.5-8 and later", "Draw a line", "Specify drawing fill and stroke opacities. If the value is a string\n ending with a %, the number will be multiplied by 0.01.", "Define a pattern. In the block, call primitive methods to\n draw the pattern. Reference the pattern by using its name\n as the argument to the 'fill' or 'stroke' methods", "Draw a polygon", "Draw a rectangle", "Draw a rectangle with rounded corners", "Specify a stroke dash pattern", "Draw text at position x,y. Add quotes to text that is not already quoted.", "Specify text alignment relative to a given point", "SVG-compatible version of text_align", "Set the color at x,y", "Set all pixels that have the same color as the pixel at x,y and\n are neighbors to the fill color", "Set all pixels that are neighbors of x,y and are not the border color\n to the fill color", "Thanks to Russell Norris!", "Make transparent any neighbor pixel that is not the border color.", "Replace matching neighboring pixels with texture pixels", "Replace neighboring pixels to border color with texture pixels", "Construct a view. If a block is present, yield and pass the view\n object, otherwise return the view object.", "Find old current image, update scene number\n current is the id of the old current image.", "Allow scene to be set to nil", "Make a deep copy", "Set same delay for all images", "Initialize new instances", "Call inspect for all the images", "Set the number of iterations of an animated GIF", "Create a new image and add it to the end", "Read files and concatenate the new images", "override Enumerable's reject", "The alpha frequencies are shown as white dots.", "Make the color histogram. Quantize the image to 256 colors if necessary.", "Returns a value between 0 and MAX_QUANTUM. Same as the PixelIntensity macro.", "Create the histogram montage.", "Get the value and CAS ID associated with the key.  If a block is provided,\n value and CAS will be passed to the block.", "Set the key-value pair, verifying existing CAS.\n Returns the resulting CAS value if succeeded, and falsy otherwise.", "Fetch the value associated with the key.\n If a value is found, then it is returned.\n\n If a value is not found and no block is given, then nil is returned.\n\n If a value is not found (or if the found value is nil and :cache_nils is false)\n and a block is given, the block will be invoked and its return value\n written to the cache and returned.", "compare and swap values using optimistic locking.\n Fetch the existing value for key.\n If it exists, yield the value to the block.\n Add the block's return value as the new value for the key.\n Add will fail if someone else changed the value.\n\n Returns:\n - nil if the key did not exist.\n - false if the value was changed by someone else.\n - true if the value was successfully updated.", "Incr adds the given amount to the counter on the memcached server.\n Amt must be a positive integer value.\n\n If default is nil, the counter must already exist or the operation\n will fail and will return nil.  Otherwise this method will return\n the new value for the counter.\n\n Note that the ttl will only apply if the counter does not already\n exist.  To increase an existing counter and update its TTL, use\n #cas.", "Touch updates expiration time for a given key.\n\n Returns true if key exists, otherwise nil.", "Version of the memcache servers.", "Yields, one at a time, keys and their values+attributes.", "delete_options are passed as a JSON payload in the delete request", "Format datetime according to RFC3339", "Extracts a mapping from the URI using a URI Template pattern.\n\n @param [Addressable::URI, #to_str] uri\n   The URI to extract from.\n\n @param [#restore, #match] processor\n   A template processor object may optionally be supplied.\n\n   The object should respond to either the <tt>restore</tt> or\n   <tt>match</tt> messages or both. The <tt>restore</tt> method should\n   take two parameters: `[String] name` and `[String] value`.\n   The <tt>restore</tt> method should reverse any transformations that\n   have been performed on the value to ensure a valid URI.\n   The <tt>match</tt> method should take a single\n   parameter: `[String] name`.  The <tt>match</tt> method should return\n   a <tt>String</tt> containing a regular expression capture group for\n   matching on that particular variable. The default value is `\".*?\"`.\n   The <tt>match</tt> method has no effect on multivariate operator\n   expansions.\n\n @return [Hash, NilClass]\n   The <tt>Hash</tt> mapping that was extracted from the URI, or\n   <tt>nil</tt> if the URI didn't match the template.\n\n @example\n   class ExampleProcessor\n     def self.restore(name, value)\n       return value.gsub(/\\+/, \" \") if name == \"query\"\n       return value\n     end\n\n     def self.match(name)\n       return \".*?\" if name == \"first\"\n       return \".*\"\n     end\n   end\n\n   uri = Addressable::URI.parse(\n     \"http://example.com/search/an+example+search+query/\"\n   )\n   Addressable::Template.new(\n     \"http://example.com/search/{query}/\"\n   ).extract(uri, ExampleProcessor)\n   #=> {\"query\" => \"an example search query\"}\n\n   uri = Addressable::URI.parse(\"http://example.com/a/b/c/\")\n   Addressable::Template.new(\n     \"http://example.com/{first}/{second}/\"\n   ).extract(uri, ExampleProcessor)\n   #=> {\"first\" => \"a\", \"second\" => \"b/c\"}\n\n   uri = Addressable::URI.parse(\"http://example.com/a/b/c/\")\n   Addressable::Template.new(\n     \"http://example.com/{first}/{-list|/|second}/\"\n   ).extract(uri)\n   #=> {\"first\" => \"a\", \"second\" => [\"b\", \"c\"]}", "Extracts match data from the URI using a URI Template pattern.\n\n @param [Addressable::URI, #to_str] uri\n   The URI to extract from.\n\n @param [#restore, #match] processor\n   A template processor object may optionally be supplied.\n\n   The object should respond to either the <tt>restore</tt> or\n   <tt>match</tt> messages or both. The <tt>restore</tt> method should\n   take two parameters: `[String] name` and `[String] value`.\n   The <tt>restore</tt> method should reverse any transformations that\n   have been performed on the value to ensure a valid URI.\n   The <tt>match</tt> method should take a single\n   parameter: `[String] name`. The <tt>match</tt> method should return\n   a <tt>String</tt> containing a regular expression capture group for\n   matching on that particular variable. The default value is `\".*?\"`.\n   The <tt>match</tt> method has no effect on multivariate operator\n   expansions.\n\n @return [Hash, NilClass]\n   The <tt>Hash</tt> mapping that was extracted from the URI, or\n   <tt>nil</tt> if the URI didn't match the template.\n\n @example\n   class ExampleProcessor\n     def self.restore(name, value)\n       return value.gsub(/\\+/, \" \") if name == \"query\"\n       return value\n     end\n\n     def self.match(name)\n       return \".*?\" if name == \"first\"\n       return \".*\"\n     end\n   end\n\n   uri = Addressable::URI.parse(\n     \"http://example.com/search/an+example+search+query/\"\n   )\n   match = Addressable::Template.new(\n     \"http://example.com/search/{query}/\"\n   ).match(uri, ExampleProcessor)\n   match.variables\n   #=> [\"query\"]\n   match.captures\n   #=> [\"an example search query\"]\n\n   uri = Addressable::URI.parse(\"http://example.com/a/b/c/\")\n   match = Addressable::Template.new(\n     \"http://example.com/{first}/{+second}/\"\n   ).match(uri, ExampleProcessor)\n   match.variables\n   #=> [\"first\", \"second\"]\n   match.captures\n   #=> [\"a\", \"b/c\"]\n\n   uri = Addressable::URI.parse(\"http://example.com/a/b/c/\")\n   match = Addressable::Template.new(\n     \"http://example.com/{first}{/second*}/\"\n   ).match(uri)\n   match.variables\n   #=> [\"first\", \"second\"]\n   match.captures\n   #=> [\"a\", [\"b\", \"c\"]]", "Expands a URI template into another URI template.\n\n @param [Hash] mapping The mapping that corresponds to the pattern.\n @param [#validate, #transform] processor\n   An optional processor object may be supplied.\n @param [Boolean] normalize_values\n   Optional flag to enable/disable unicode normalization. Default: true\n\n The object should respond to either the <tt>validate</tt> or\n <tt>transform</tt> messages or both. Both the <tt>validate</tt> and\n <tt>transform</tt> methods should take two parameters: <tt>name</tt> and\n <tt>value</tt>. The <tt>validate</tt> method should return <tt>true</tt>\n or <tt>false</tt>; <tt>true</tt> if the value of the variable is valid,\n <tt>false</tt> otherwise. An <tt>InvalidTemplateValueError</tt>\n exception will be raised if the value is invalid. The <tt>transform</tt>\n method should return the transformed variable value as a <tt>String</tt>.\n If a <tt>transform</tt> method is used, the value will not be percent\n encoded automatically. Unicode normalization will be performed both\n before and after sending the value to the transform method.\n\n @return [Addressable::Template] The partially expanded URI template.\n\n @example\n   Addressable::Template.new(\n     \"http://example.com/{one}/{two}/\"\n   ).partial_expand({\"one\" => \"1\"}).pattern\n   #=> \"http://example.com/1/{two}/\"\n\n   Addressable::Template.new(\n     \"http://example.com/{?one,two}/\"\n   ).partial_expand({\"one\" => \"1\"}).pattern\n   #=> \"http://example.com/?one=1{&two}/\"\n\n   Addressable::Template.new(\n     \"http://example.com/{?one,two,three}/\"\n   ).partial_expand({\"one\" => \"1\", \"three\" => 3}).pattern\n   #=> \"http://example.com/?one=1{&two}&three=3\"", "Expands a URI template into a full URI.\n\n @param [Hash] mapping The mapping that corresponds to the pattern.\n @param [#validate, #transform] processor\n   An optional processor object may be supplied.\n @param [Boolean] normalize_values\n   Optional flag to enable/disable unicode normalization. Default: true\n\n The object should respond to either the <tt>validate</tt> or\n <tt>transform</tt> messages or both. Both the <tt>validate</tt> and\n <tt>transform</tt> methods should take two parameters: <tt>name</tt> and\n <tt>value</tt>. The <tt>validate</tt> method should return <tt>true</tt>\n or <tt>false</tt>; <tt>true</tt> if the value of the variable is valid,\n <tt>false</tt> otherwise. An <tt>InvalidTemplateValueError</tt>\n exception will be raised if the value is invalid. The <tt>transform</tt>\n method should return the transformed variable value as a <tt>String</tt>.\n If a <tt>transform</tt> method is used, the value will not be percent\n encoded automatically. Unicode normalization will be performed both\n before and after sending the value to the transform method.\n\n @return [Addressable::URI] The expanded URI template.\n\n @example\n   class ExampleProcessor\n     def self.validate(name, value)\n       return !!(value =~ /^[\\w ]+$/) if name == \"query\"\n       return true\n     end\n\n     def self.transform(name, value)\n       return value.gsub(/ /, \"+\") if name == \"query\"\n       return value\n     end\n   end\n\n   Addressable::Template.new(\n     \"http://example.com/search/{query}/\"\n   ).expand(\n     {\"query\" => \"an example search query\"},\n     ExampleProcessor\n   ).to_str\n   #=> \"http://example.com/search/an+example+search+query/\"\n\n   Addressable::Template.new(\n     \"http://example.com/search/{query}/\"\n   ).expand(\n     {\"query\" => \"an example search query\"}\n   ).to_str\n   #=> \"http://example.com/search/an%20example%20search%20query/\"\n\n   Addressable::Template.new(\n     \"http://example.com/search/{query}/\"\n   ).expand(\n     {\"query\" => \"bogus!\"},\n     ExampleProcessor\n   ).to_str\n   #=> Addressable::Template::InvalidTemplateValueError", "Generates a route result for a given set of parameters.\n Should only be used by rack-mount.\n\n @param params [Hash] The set of parameters used to expand the template.\n @param recall [Hash] Default parameters used to expand the template.\n @param options [Hash] Either a `:processor` or a `:parameterize` block.\n\n @api private", "Loops through each capture and expands any values available in mapping\n\n @param [Hash] mapping\n   Set of keys to expand\n @param [String] capture\n   The expression to expand\n @param [#validate, #transform] processor\n   An optional processor object may be supplied.\n @param [Boolean] normalize_values\n   Optional flag to enable/disable unicode normalization. Default: true\n\n The object should respond to either the <tt>validate</tt> or\n <tt>transform</tt> messages or both. Both the <tt>validate</tt> and\n <tt>transform</tt> methods should take two parameters: <tt>name</tt> and\n <tt>value</tt>. The <tt>validate</tt> method should return <tt>true</tt>\n or <tt>false</tt>; <tt>true</tt> if the value of the variable is valid,\n <tt>false</tt> otherwise. An <tt>InvalidTemplateValueError</tt> exception\n will be raised if the value is invalid. The <tt>transform</tt> method\n should return the transformed variable value as a <tt>String</tt>. If a\n <tt>transform</tt> method is used, the value will not be percent encoded\n automatically. Unicode normalization will be performed both before and\n after sending the value to the transform method.\n\n @return [String] The expanded expression", "Generates a hash with string keys\n\n @param [Hash] mapping A mapping hash to normalize\n\n @return [Hash]\n   A hash with stringified keys", "Creates a new uri object from component parts.\n\n @option [String, #to_str] scheme The scheme component.\n @option [String, #to_str] user The user component.\n @option [String, #to_str] password The password component.\n @option [String, #to_str] userinfo\n   The userinfo component. If this is supplied, the user and password\n   components must be omitted.\n @option [String, #to_str] host The host component.\n @option [String, #to_str] port The port component.\n @option [String, #to_str] authority\n   The authority component. If this is supplied, the user, password,\n   userinfo, host, and port components must be omitted.\n @option [String, #to_str] path The path component.\n @option [String, #to_str] query The query component.\n @option [String, #to_str] fragment The fragment component.\n\n @return [Addressable::URI] The constructed URI object.\n\n Freeze URI, initializing instance variables.\n\n @return [Addressable::URI] The frozen URI object.", "The scheme component for this URI, normalized.\n\n @return [String] The scheme component, normalized.", "Sets the scheme component for this URI.\n\n @param [String, #to_str] new_scheme The new scheme component.", "Sets the user component for this URI.\n\n @param [String, #to_str] new_user The new user component.", "The password component for this URI, normalized.\n\n @return [String] The password component, normalized.", "Sets the password component for this URI.\n\n @param [String, #to_str] new_password The new password component.", "The userinfo component for this URI.\n Combines the user and password components.\n\n @return [String] The userinfo component.", "The userinfo component for this URI, normalized.\n\n @return [String] The userinfo component, normalized.", "Sets the userinfo component for this URI.\n\n @param [String, #to_str] new_userinfo The new userinfo component.", "The host component for this URI, normalized.\n\n @return [String] The host component, normalized.", "Sets the host component for this URI.\n\n @param [String, #to_str] new_host The new host component.", "The authority component for this URI.\n Combines the user, password, host, and port components.\n\n @return [String] The authority component.", "The authority component for this URI, normalized.\n\n @return [String] The authority component, normalized.", "Sets the authority component for this URI.\n\n @param [String, #to_str] new_authority The new authority component.", "Sets the origin for this URI, serialized to ASCII, as per\n RFC 6454, section 6.2. This assignment will reset the `userinfo`\n component.\n\n @param [String, #to_str] new_origin The new origin component.", "Sets the port component for this URI.\n\n @param [String, Integer, #to_s] new_port The new port component.", "The combination of components that represent a site.\n Combines the scheme, user, password, host, and port components.\n Primarily useful for HTTP and HTTPS.\n\n For example, <code>\"http://example.com/path?query\"</code> would have a\n <code>site</code> value of <code>\"http://example.com\"</code>.\n\n @return [String] The components that identify a site.", "The normalized combination of components that represent a site.\n Combines the scheme, user, password, host, and port components.\n Primarily useful for HTTP and HTTPS.\n\n For example, <code>\"http://example.com/path?query\"</code> would have a\n <code>site</code> value of <code>\"http://example.com\"</code>.\n\n @return [String] The normalized components that identify a site.", "Sets the site value for this URI.\n\n @param [String, #to_str] new_site The new site value.", "The path component for this URI, normalized.\n\n @return [String] The path component, normalized.", "Sets the path component for this URI.\n\n @param [String, #to_str] new_path The new path component.", "The query component for this URI, normalized.\n\n @return [String] The query component, normalized.", "Sets the query component for this URI.\n\n @param [String, #to_str] new_query The new query component.", "Converts the query component to a Hash value.\n\n @param [Class] return_type The return type desired. Value must be either\n   `Hash` or `Array`.\n\n @return [Hash, Array, nil] The query string parsed as a Hash or Array\n   or nil if the query string is blank.\n\n @example\n   Addressable::URI.parse(\"?one=1&two=2&three=3\").query_values\n   #=> {\"one\" => \"1\", \"two\" => \"2\", \"three\" => \"3\"}\n   Addressable::URI.parse(\"?one=two&one=three\").query_values(Array)\n   #=> [[\"one\", \"two\"], [\"one\", \"three\"]]\n   Addressable::URI.parse(\"?one=two&one=three\").query_values(Hash)\n   #=> {\"one\" => \"three\"}\n   Addressable::URI.parse(\"?\").query_values\n   #=> {}\n   Addressable::URI.parse(\"\").query_values\n   #=> nil", "Sets the query component for this URI from a Hash object.\n An empty Hash or Array will result in an empty query string.\n\n @param [Hash, #to_hash, Array] new_query_values The new query values.\n\n @example\n   uri.query_values = {:a => \"a\", :b => [\"c\", \"d\", \"e\"]}\n   uri.query\n   # => \"a=a&b=c&b=d&b=e\"\n   uri.query_values = [['a', 'a'], ['b', 'c'], ['b', 'd'], ['b', 'e']]\n   uri.query\n   # => \"a=a&b=c&b=d&b=e\"\n   uri.query_values = [['a', 'a'], ['b', ['c', 'd', 'e']]]\n   uri.query\n   # => \"a=a&b=c&b=d&b=e\"\n   uri.query_values = [['flag'], ['key', 'value']]\n   uri.query\n   # => \"flag&key=value\"", "Sets the HTTP request URI for this URI.\n\n @param [String, #to_str] new_request_uri The new HTTP request URI.", "The fragment component for this URI, normalized.\n\n @return [String] The fragment component, normalized.", "Sets the fragment component for this URI.\n\n @param [String, #to_str] new_fragment The new fragment component.", "Joins two URIs together.\n\n @param [String, Addressable::URI, #to_str] The URI to join with.\n\n @return [Addressable::URI] The joined URI.", "Returns a normalized URI object.\n\n NOTE: This method does not attempt to fully conform to specifications.\n It exists largely to correct other people's failures to read the\n specifications, and also to deal with caching issues since several\n different URIs may represent the same resource and should not be\n cached multiple times.\n\n @return [Addressable::URI] The normalized URI.", "This method allows you to make several changes to a URI simultaneously,\n which separately would cause validation errors, but in conjunction,\n are valid.  The URI will be revalidated as soon as the entire block has\n been executed.\n\n @param [Proc] block\n   A set of operations to perform on a given URI.", "Ensures that the URI is valid.", "Replaces the internal state of self with the specified URI's state.\n Used in destructive operations to avoid massive code repetition.\n\n @param [Addressable::URI] uri The URI to replace <code>self</code> with.\n\n @return [Addressable::URI] <code>self</code>.", "Write an attribute on the object. Also marks the previous value as dirty.\n\n @param [Symbol] name the name of the field\n @param [Object] value the value to assign to that field\n\n @since 0.2.0", "Automatically called during the created callback to set the created_at time.\n\n @since 0.2.0", "Automatically called during the save callback to set the updated_at time.\n\n @since 0.2.0", "An object is equal to another object if their ids are equal.\n\n @since 0.2.0\n Reload an object from the database -- if you suspect the object has changed in the datastore and you need those\n changes to be reflected immediately, you would call this method. This is a consistent read.\n\n @return [Dynamoid::Document] the document this method was called on\n\n @since 0.2.0", "Evaluates the default value given, this is used by undump\n when determining the value of the default given for a field options.\n\n @param [Object] :value the attribute's default value", "Set updated_at and any passed in field to current DateTime. Useful for things like last_login_at, etc.", "Run the callbacks and then persist this object in the datastore.\n\n @since 0.2.0", "Updates multiple attributes at once, saving the object once the updates are complete.\n\n @param [Hash] attributes a hash of attributes to update\n\n @since 0.2.0", "Delete this object from the datastore.\n\n @since 0.2.0", "Persist the object into the datastore. Assign it an id first if it doesn't have one.\n\n @since 0.2.0", "The actual adapter currently in use.\n\n @since 0.2.0", "Shows how long it takes a method to run on the adapter. Useful for generating logged output.\n\n @param [Symbol] method the name of the method to appear in the log\n @param [Array] args the arguments to the method to appear in the log\n @yield the actual code to benchmark\n\n @return the result of the yield\n\n @since 0.2.0", "Read one or many keys from the selected table.\n This method intelligently calls batch_get or get on the underlying adapter\n depending on whether ids is a range or a single key.\n If a range key is present, it will also interpolate that into the ids so\n that the batch get will acquire the correct record.\n\n @param [String] table the name of the table to write the object to\n @param [Array] ids to fetch, can also be a string of just one id\n @param [Hash] options: Passed to the underlying query. The :range_key option is required whenever the table has a range key,\n                        unless multiple ids are passed in.\n\n @since 0.2.0", "Delete an item from a table.\n\n @param [String] table the name of the table to write the object to\n @param [Array] ids to delete, can also be a string of just one id\n @param [Array] range_key of the record to delete, can also be a string of just one range_key", "Scans a table. Generally quite slow; try to avoid using scan if at all possible.\n\n @param [String] table the name of the table to write the object to\n @param [Hash] scan_hash a hash of attributes: matching records will be returned by the scan\n\n @since 0.2.0", "Delegate all methods that aren't defind here to the underlying adapter.\n\n @since 0.2.0", "If you want to, set the logger manually to any output you'd like. Or pass false or nil to disable logging entirely.\n\n @since 0.2.0", "Formats an object into PDF format. This is used my the PDF object to format the PDF file and it is used in the secure injection which is still being developed.", "adds a new page to the end of the PDF object.\n\n returns the new page object.\n\n unless the media box is specified, it defaults to US Letter: [0, 0, 612.0, 792.0]", "Formats the data to PDF formats and returns a binary string that represents the PDF file content.\n\n This method is used by the save(file_name) method to save the content to a file.\n\n use this to export the PDF file without saving to disk (such as sending through HTTP ect').", "this method returns all the pages cataloged in the catalog.\n\n if no catalog is passed, it seeks the existing catalog(s) and searches\n for any registered Page objects.\n\n Page objects are Hash class objects. the page methods are added using a mixin or inheritance.\n\n catalogs:: a catalog, or an Array of catalog objects. defaults to the existing catalog.", "returns an array with the different fonts used in the file.\n\n Type0 font objects ( \"font[:Subtype] == :Type0\" ) can be registered with the font library\n for use in PDFWriter objects (font numbering / table creation etc').\n @param limit_to_type0 [true,false] limits the list to type0 fonts.", "removes a PDF page from the file and the catalog\n\n returns the removed page.\n\n returns nil if failed or if out of bounds.\n\n page_index:: the page's index in the zero (0) based page array. negative numbers represent a count backwards (-1 being the end of the page array and 0 being the begining).", "Register a font that already exists in a pdf object into the font library.\n\n The implementation is experimental, but this function attempts to deconstruct a font object in order to\n extract it's cmap and metric data, allowing it's use in the CombinePDF library.", "initializes the content stream in case it was not initialized before", "adds a string or an object to the content stream, at the location indicated\n\n accepts:\n object:: can be a string or a hash object\n location:: can be any numeral related to the possition in the :Contents array. defaults to -1 == insert at the end.", "register or get a registered graphic state dictionary.\n the method returns the name of the graphos state, for use in a content stream.", "Don't save Buffer.current.", "Set mark at pos, and push the mark on the mark ring.\n Unlike Emacs, the new mark is pushed on the mark ring instead of\n the old one.", "Return true if modified.", "app_id or corp_id", "Validate if the current time unit matches the same unit from the schedule\n start time, returning the difference to the interval", "Lock the hour if explicitly set by hour_of_day, but allow for the nearest\n hour during DST start to keep the correct interval.", "For monthly rules that have no specified day value, the validation relies\n on the schedule start time and jumps to include every month even if it\n has fewer days than the schedule's start day.\n\n Negative day values (from month end) also include all months.\n\n Positive day values are taken literally so months with fewer days will\n be skipped.", "Build for a single rule entry", "Add hour of day validations", "Add a recurrence time to the schedule", "Add an exception time to the schedule", "Remove a recurrence time", "The next n occurrences after now", "The previous occurrence from a given time", "The previous n occurrences before a given time", "Return a boolean indicating if an occurrence falls between two times", "Return a boolean indicating if an occurrence falls on a certain date", "Determine if the schedule is occurring at a given time", "Determine if this schedule conflicts with another schedule\n @param [IceCube::Schedule] other_schedule - The schedule to compare to\n @param [Time] closing_time - the last time to consider\n @return [Boolean] whether or not the schedules conflict at all", "Get the first n occurrences, or the first occurrence if n is skipped", "Get the final n occurrences of a terminating schedule\n or the final one if no n is given", "Serialize this schedule to_ical", "Convert the schedule to a hash", "Find all of the occurrences for the schedule between opening_time\n and closing_time\n Iteration is unrolled in pairs to skip duplicate times in end of DST", "Calculate how many days to the first wday validation in the correct\n interval week. This may move backwards within the week if starting in an\n interval week with earlier validations.", "Finds given resource by id\n\n Examples:\n   client.find(:board, \"board1234\")\n   client.find(:member, \"user1234\")", "Finds given resource by path with params", "Update the fields of a label.\n\n Supply a hash of stringkeyed data retrieved from the Trello API representing\n a label.", "Save the webhook.\n\n @raise  [Trello::Error] if the Webhook could not be saved.\n\n @return [String] the JSON representation of the saved webhook.", "Update the webhook.\n\n @raise  [Trello::Error] if the Webhook could not be saved.\n\n @return [String] the JSON representation of the updated webhook.", "Supply a hash of stringkeyed data retrieved from the Trello API representing\n an attachment.", "Update the fields of a card.\n\n Supply a hash of string keyed data retrieved from the Trello API representing\n a card.\n\n Note that this this method does not save anything new to the Trello API,\n it just assigns the input attributes to your local object. If you use\n this method to assign attributes, call `save` or `update!` afterwards if\n you want to persist your changes to Trello.\n\n @param [Hash] fields\n @option fields [String] :id\n @option fields [String] :short_id\n @option fields [String] :name The new name of the card.\n @option fields [String] :desc A string with a length from 0 to\n     16384.\n @option fields [Date] :due A date, or `nil`.\n @option fields [Boolean] :due_complete\n @option fields [Boolean] :closed\n @option fields [String] :url\n @option fields [String] :short_url\n @option fields [String] :board_id\n @option fields [String] :member_ids A comma-separated list of objectIds\n     (24-character hex strings).\n @option fields [String] :pos A position. `\"top\"`, `\"bottom\"`, or a\n     positive number. Defaults to `\"bottom\"`.\n @option fields [Array]  :labels An Array of Trello::Label objects\n     derived from the JSON response\n @option fields [String] :card_labels A comma-separated list of\n     objectIds (24-character hex strings).\n @option fields [Object] :cover_image_id\n @option fields [Object] :badges\n @option fields [Object] :card_members\n @option fields [String] :source_card_id\n @option fields [Array]  :source_card_properties\n\n @return [Trello::Card] self", "Update an existing record.\n\n Warning: this updates all fields using values already in memory. If\n an external resource has updated these fields, you should refresh!\n this object before making your changes, and before updating the record.\n\n @raise [Trello::Error] if the card could not be updated.\n\n @return [String] The JSON representation of the updated card returned by\n     the Trello API.", "Move this card to the given list", "Moves this card to the given list no matter which board it is on", "Current authenticated user upvotes a card", "Recind upvote. Noop if authenticated user hasn't previously voted", "Add a label", "Remove a label", "Add an attachment to this card", "Retrieve a list of attachments", "Returns a list of boards under this organization.", "Returns an array of members associated with the organization.", "Update the attributes of a Comment\n\n Supply a hash of string keyed data retrieved from the Trello API representing\n a Comment.", "Update the fields of an attachment.\n\n Supply a hash of stringkeyed data retrieved from the Trello API representing\n an attachment.", "Need to make another call to get the actual value if the custom field type == 'list'", "Update the fields of a checklist.\n\n Supply a hash of string keyed data retrieved from the Trello API representing\n a checklist.", "Save a record.", "Return a list of members active in this checklist.", "Add an item to the checklist", "Returns a list of the actions associated with this object.", "Update the fields of an item state.\n\n Supply a hash of string keyed data retrieved from the Trello API representing\n an item state.", "Clean text of unwanted formatting\n\n Example:\n   >> text = \"This is a sentence\\ncut off in the middle because pdf.\"\n   >> PragmaticSegmenter::Cleaner(text: text).clean\n   => \"This is a sentence cut off in the middle because pdf.\"\n\n Arguments:\n    text:       (String)  *required\n    language:   (String)  *optional\n                (two character ISO 639-1 code e.g. 'en')\n    doc_type:   (String)  *optional\n                (e.g. 'pdf')", "Subscribes to a channel which executes the given callback when a message\n is published to the channel\n\n @example Subscribing to a channel for message\n   client = MessageBus::HTTPClient.new('http://some.test.com')\n\n   client.subscribe(\"/test\") do |payload, _message_id, _global_id|\n     puts payload\n   end\n\n A last_message_id may be provided.\n  * -1 will subscribe to all new messages\n  * -2 will recieve last message + all new messages\n  * -3 will recieve last 2 message + all new messages\n\n @example Subscribing to a channel with `last_message_id`\n   client.subscribe(\"/test\", last_message_id: -2) do |payload|\n     puts payload\n   end\n\n @param channel [String] channel to listen for messages on\n @param last_message_id [Integer] last message id to start polling on.\n\n @yield [data, message_id, global_id]\n  callback to be executed whenever a message is received\n\n @yieldparam data [Hash] data payload of the message received on the channel\n @yieldparam message_id [Integer] id of the message in the channel\n @yieldparam global_id [Integer] id of the message in the global backlog\n @yieldreturn [void]\n\n @return [Integer] the current status of the client", "unsubscribes from a channel\n\n @example Unsubscribing from a channel\n   client = MessageBus::HTTPClient.new('http://some.test.com')\n   callback = -> { |payload| puts payload }\n   client.subscribe(\"/test\", &callback)\n   client.unsubscribe(\"/test\")\n\n If a callback is given, only the specific callback will be unsubscribed.\n\n @example Unsubscribing a callback from a channel\n   client.unsubscribe(\"/test\", &callback)\n\n When the client does not have any channels left, it will stop polling and\n waits until a new subscription is started.\n\n @param channel [String] channel to unsubscribe\n @yield [data, global_id, message_id] specific callback to unsubscribe\n\n @return [Integer] the current status of the client", "Handle connection request from WebSocket server", "Build Rack env from request", "Build gRPC server parameters", "Build Redis parameters", "Start gRPC server in background and\n wait untill it ready to accept connections", "Deprecated method. Removed in v1.0.", "Generate a long, cryptographically secure random ID string, which\n is also a valid filename.", "Print the given exception, including the stack trace, to STDERR.\n\n +current_location+ is a string which describes where the code is\n currently at. Usually the current class name will be enough.\n It may be nil.\n\n This method requires 'ruby_core_enhancements'. If 'debug_logging'\n is loaded and included in the current module, it will use that for\n logging.", "A wrapper around Thread.new that installs a default exception handler.\n If an uncaught exception is encountered, it will immediately log the\n exception and abort the entire program.\n\n Thread#abort_on_exception is also supposed to do that, but the problem\n is that it is implemented by forwarding the uncaught exception\n to the main thread, which may not expect that particular exception\n and may not handle it properly. The exception could be forwarded to\n the main thread during any point of the main thread's execution.\n\n This method requires 'thread' and 'ruby_core_enhancements'.\n If 'debug_logging' is loaded and included in the current module,\n it will use that for logging.", "Checks whether the given process exists.", "Returns a string which reports the backtraces for all threads,\n or if that's not supported the backtrace for the current thread.", "Name of the user under which we are executing, or the id as fallback\n N.B. loader_shared_helpers.rb has the same method", "If the current working directory equals `app_root`, and `abs_path` is a\n file inside `app_root`, then returns its basename. Otherwise, returns\n `abs_path`.\n\n The main use case for this method is to ensure that we load config.ru\n with a relative path (only its base name) in most circumstances,\n instead of with an absolute path. This is necessary in order to retain\n compatibility with apps that expect config.ru's __FILE__ to be relative.\n See https://github.com/phusion/passenger/issues/1596", "To be called before the request handler main loop is entered, but after the app\n startup file has been loaded. This function will fire off necessary events\n and perform necessary preparation tasks.\n\n +forked+ indicates whether the current worker process is forked off from\n an ApplicationSpawner that has preloaded the app code.\n +options+ are the spawn options that were passed.", "Read an array message from the underlying file descriptor and return the\n result as a hash instead of an array. This assumes that the array message\n has an even number of elements.\n Returns nil when end-of-stream has been reached.\n\n Might raise SystemCallError, IOError or SocketError when something\n goes wrong.", "Read a scalar message from the underlying IO object. Returns the\n read message, or nil on end-of-stream.\n\n Might raise SystemCallError, IOError or SocketError when something\n goes wrong.\n\n The +buffer+ argument specifies a buffer in which #read_scalar\n stores the read data. It is good practice to reuse existing buffers\n in order to minimize stress on the garbage collector.\n\n The +max_size+ argument allows one to specify the maximum allowed\n size for the scalar message. If the received scalar message's size\n is larger than +max_size+, then a SecurityError will be raised.", "Create a new RequestHandler with the given owner pipe.\n +owner_pipe+ must be the readable part of a pipe IO object.\n\n Additionally, the following options may be given:\n - connect_password\n Clean up temporary stuff created by the request handler.\n\n If the main loop was started by #main_loop, then this method may only\n be called after the main loop has exited.\n\n If the main loop was started by #start_main_loop_thread, then this method\n may be called at any time, and it will stop the main loop thread.", "Enter the request handler's main loop.", "Reset signal handlers to their default handler, and install some\n special handlers for a few signals. The previous signal handlers\n will be put back by calling revert_signal_handlers.", "Get the default value.\n\n @example\n   ActiveInteraction::Filter.new(:example).default\n   # => ActiveInteraction::NoDefaultError: example\n @example\n   ActiveInteraction::Filter.new(:example, default: nil).default\n   # => nil\n @example\n   ActiveInteraction::Filter.new(:example, default: 0).default\n   # => ActiveInteraction::InvalidDefaultError: example: 0\n\n @param context [Base, nil]\n\n @return (see #raw_default)\n\n @raise [NoDefaultError] If the default is missing.\n @raise [InvalidDefaultError] If the default is invalid.", "Returns the column object for the named filter.\n\n @param name [Symbol] The name of a filter.\n\n @example\n   class Interaction < ActiveInteraction::Base\n     string :email, default: nil\n\n     def execute; end\n   end\n\n   Interaction.new.column_for_attribute(:email)\n   # => #<ActiveInteraction::FilterColumn:0x007faebeb2a6c8 @type=:string>\n\n   Interaction.new.column_for_attribute(:not_a_filter)\n   # => nil\n\n @return [FilterColumn, nil]\n\n @since 1.2.0", "Add a number of business days to a date. If a non-business day is given,\n counting will start from the next business day. So,\n   monday + 1 = tuesday\n   friday + 1 = monday\n   sunday + 1 = tuesday", "Subtract a number of business days to a date. If a non-business day is\n given, counting will start from the previous business day. So,\n   friday - 1 = thursday\n   monday - 1 = friday\n   sunday - 1 = thursday", "Internal method for assigning working days from a calendar config.", "Send an event received from Redis to the EventMachine channel\n which will send it to subscribed clients.", "Dispatches message handling to method with same name as\n the event name", "Send an event received from Redis to the EventMachine channel", "Add a property to the schema\n\n @param name [Symbol] the name of the property\n @param options [Hash] property options\n @option options [Symbol] :type The property type\n @option options [Symbol] :default The default value for the property\n @return [void]", "insert middleware before ParseJson - middleware executed in reverse order -\n   inserted middleware will run after json parsed", "Try to destroy this resource\n\n @return [Boolean] Whether or not the destroy succeeded", "remember queries we've seen, ignore future ones", "Proofer runs faster if we pull out all the external URLs and run the checks\n at the end. Otherwise, we're halting the consuming process for every file during\n `process_files`.\n\n In addition, sorting the list lets libcurl keep connections to the same hosts alive.\n\n Finally, we'll first make a HEAD request, rather than GETing all the contents.\n If the HEAD fails, we'll fall back to GET, as some servers are not configured\n for HEAD. If we've decided to check for hashes, we must do a GET--HEAD is\n not available as an option.", "Even though the response was a success, we may have been asked to check\n if the hash on the URL exists on the page", "Collects any external URLs found in a directory of files. Also collectes\n every failed test from process_files.\n Sends the external URLs to Typhoeus for batch processing.", "Walks over each implemented check and runs them on the files, in parallel.", "Adds the request body to the request in the appropriate format.\n if the request body is a JSON Object, transform its keys into camel-case,\n since this is the common format for JSON APIs.", "Replaces the body of the response with the parsed version of the body,\n according to the format specified in the Request.", "Returns the list of server errors worth retrying the request once.", "Set up a number of navigational commands to be performed by Byebug.", "Resume an existing Pry REPL at the paused point.", "Processes the template and returns the result as a string.\n\n `scope` is the context in which the template is evaluated.\n If it's a `Binding`, Haml uses it as the second argument to `Kernel#eval`;\n otherwise, Haml just uses its `#instance_eval` context.\n\n Note that Haml modifies the evaluation context\n (either the scope object or the `self` object of the scope binding).\n It extends {Haml::Helpers}, and various instance variables are set\n (all prefixed with `haml_`).\n For example:\n\n     s = \"foobar\"\n     Haml::Engine.new(\"%p= upcase\").render(s) #=> \"<p>FOOBAR</p>\"\n\n     # s now extends Haml::Helpers\n     s.respond_to?(:html_attrs) #=> true\n\n `locals` is a hash of local variables to make available to the template.\n For example:\n\n     Haml::Engine.new(\"%p= foo\").render(Object.new, :foo => \"Hello, world!\") #=> \"<p>Hello, world!</p>\"\n\n If a block is passed to render,\n that block is run when `yield` is called\n within the template.\n\n Due to some Ruby quirks,\n if `scope` is a `Binding` object and a block is given,\n the evaluation context may not be quite what the user expects.\n In particular, it's equivalent to passing `eval(\"self\", scope)` as `scope`.\n This won't have an effect in most cases,\n but if you're relying on local variables defined in the context of `scope`,\n they won't work.\n\n @param scope [Binding, Object] The context in which the template is evaluated\n @param locals [{Symbol => Object}] Local variables that will be made available\n   to the template\n @param block [#to_proc] A block that can be yielded to within the template\n @return [String] The rendered template", "Returns a proc that, when called,\n renders the template and returns the result as a string.\n\n `scope` works the same as it does for render.\n\n The first argument of the returned proc is a hash of local variable names to values.\n However, due to an unfortunate Ruby quirk,\n the local variables which can be assigned must be pre-declared.\n This is done with the `local_names` argument.\n For example:\n\n     # This works\n     Haml::Engine.new(\"%p= foo\").render_proc(Object.new, :foo).call :foo => \"Hello!\"\n       #=> \"<p>Hello!</p>\"\n\n     # This doesn't\n     Haml::Engine.new(\"%p= foo\").render_proc.call :foo => \"Hello!\"\n       #=> NameError: undefined local variable or method `foo'\n\n The proc doesn't take a block; any yields in the template will fail.\n\n @param scope [Binding, Object] The context in which the template is evaluated\n @param local_names [Array<Symbol>] The names of the locals that can be passed to the proc\n @return [Proc] The proc that will run the template", "Defines a method on `object` with the given name\n that renders the template and returns the result as a string.\n\n If `object` is a class or module,\n the method will instead be defined as an instance method.\n For example:\n\n     t = Time.now\n     Haml::Engine.new(\"%p\\n  Today's date is\\n  .date= self.to_s\").def_method(t, :render)\n     t.render #=> \"<p>\\n  Today's date is\\n  <div class='date'>Fri Nov 23 18:28:29 -0800 2007</div>\\n</p>\\n\"\n\n     Haml::Engine.new(\".upcased= upcase\").def_method(String, :upcased_div)\n     \"foobar\".upcased_div #=> \"<div class='upcased'>FOOBAR</div>\\n\"\n\n The first argument of the defined method is a hash of local variable names to values.\n However, due to an unfortunate Ruby quirk,\n the local variables which can be assigned must be pre-declared.\n This is done with the `local_names` argument.\n For example:\n\n     # This works\n     obj = Object.new\n     Haml::Engine.new(\"%p= foo\").def_method(obj, :render, :foo)\n     obj.render(:foo => \"Hello!\") #=> \"<p>Hello!</p>\"\n\n     # This doesn't\n     obj = Object.new\n     Haml::Engine.new(\"%p= foo\").def_method(obj, :render)\n     obj.render(:foo => \"Hello!\") #=> NameError: undefined local variable or method `foo'\n\n Note that Haml modifies the evaluation context\n (either the scope object or the `self` object of the scope binding).\n It extends {Haml::Helpers}, and various instance variables are set\n (all prefixed with `haml_`).\n\n @param object [Object, Module] The object on which to define the method\n @param name [String, Symbol] The name of the method to define\n @param local_names [Array<Symbol>] The names of the locals that can be passed to the proc", "Compiles attribute values with the similar key to Temple expression.\n\n @param values [Array<AttributeValue>] whose `key`s are partially or fully the same from left.\n @return [Array] Temple expression", "Renders attribute values statically.\n\n @param values [Array<AttributeValue>]\n @return [Array] Temple expression", "Compiles attribute values for one key to Temple expression that generates ` key='value'`.\n\n @param key [String]\n @param values [Array<AttributeValue>]\n @return [Array] Temple expression", "Parses a magic comment at the beginning of a Haml file.\n The parsing rules are basically the same as Ruby's.\n\n @return [(Boolean, String or nil)]\n   Whether the document begins with a UTF-8 BOM,\n   and the declared encoding of the document (or nil if none is declared)", "Remove the whitespace from the right side of the buffer string.\n Doesn't do anything if we're at the beginning of a capture_haml block.", "Takes any string, finds all the newlines, and converts them to\n HTML entities so they'll render correctly in\n whitespace-sensitive tags without screwing up the indentation.\n\n @overload preserve(input)\n   Escapes newlines within a string.\n\n   @param input [String] The string within which to escape all newlines\n @overload preserve\n   Escapes newlines within a block of Haml code.\n\n   @yield The block within which to escape newlines", "Captures the result of a block of Haml code,\n gets rid of the excess indentation,\n and returns it as a string.\n For example, after the following,\n\n     .foo\n       - foo = capture_haml(13) do |a|\n         %p= a\n\n the local variable `foo` would be assigned to `\"<p>13</p>\\n\"`.\n\n @param args [Array] Arguments to pass into the block\n @yield [args] A block of Haml code that will be converted to a string\n @yieldparam args [Array] `args`", "Internal method to write directly to the buffer with control of\n whether the first line should be indented, and if there should be a\n final newline.\n\n Lines added will have the proper indentation. This can be controlled\n for the first line.\n\n Used by #haml_concat and #haml_tag.\n\n @param text [#to_s] The text to output\n @param newline [Boolean] Whether to add a newline after the text\n @param indent [Boolean] Whether to add indentation to the first line", "Runs a block of code with the given buffer as the currently active buffer.\n\n @param buffer [Haml::Buffer] The Haml buffer to use temporarily\n @yield A block in which the given buffer should be used", "Gives a proc the same local `_hamlout` and `_erbout` variables\n that the current template has.\n\n @param proc [#call] The proc to bind\n @return [Proc] A new proc with the new variables bound", "Processes and deals with lowering indentation.", "Processes a single line of Haml.\n\n This method doesn't return anything; it simply processes the line and\n adds the appropriate code to `@precompiled`.", "Renders an XHTML comment.", "Renders an XHTML doctype or XML shebang.", "Parses a line into tag_name, attributes, attributes_hash, object_ref, action, value", "Checks whether or not `line` is in a multiline sequence.", "Evaluates `text` in the context of the scope object, but\n does not output the result.", "Get rid of and whitespace at the end of the buffer\n or the merged text", "Removes a filter from Haml. If the filter was removed, it returns\n the Module that was removed upon success, or nil on failure. If you try\n to redefine a filter, Haml will raise an error. Use this method first to\n explicitly remove the filter before redefining it.\n @return Module The filter module that has been removed\n @since 4.0", "Waits until the condition is true.\n\n @example\n   browser.wait_until(timeout: 2) do |browser|\n     browser.windows.size == 1\n   end\n\n @example\n   browser.text_field(name: \"new_user_first_name\").wait_until(&:present?).click\n   browser.text_field(name: \"new_user_first_name\").wait_until(message: 'foo') { |field| field.present? }\n   browser.text_field(name: \"new_user_first_name\").wait_until(timeout: 60, &:present?)\n   browser.text_field(name: \"new_user_first_name\").wait_until(timeout: 60, name: 'new_user_first_name')\n\n @param [Integer] timeout seconds to wait before timing out\n @param [String] message error message for when times out", "Waits until the element is present.\n Element is always relocated, so this can be used in the case of an element going away and returning\n\n @example\n   browser.text_field(name: \"new_user_first_name\").wait_until_present\n\n @param [Integer] timeout seconds to wait before timing out\n @param [Float] interval seconds to wait before each try\n @param [String] message error message for when times out\n\n @see Watir::Wait\n @see Watir::Element#present?", "Waits while the element is present.\n Element is always relocated, so this can be used in the case of the element changing attributes\n\n @example\n   browser.text_field(name: \"abrakadbra\").wait_while_present\n\n @param [Integer] timeout seconds to wait before timing out\n @param [Float] interval seconds to wait before each try\n @param [String] message error message for when times out\n\n @see Watir::Wait\n @see Watir::Element#present?", "Uses JavaScript to enter most of the given value.\n Selenium is used to enter the first and last characters\n\n @param [String, Symbol] args", "Executes JavaScript snippet in context of frame.\n\n @see Watir::Browser#execute_script", "Simulates JavaScript events on element.\n Note that you may omit \"on\" from event name.\n\n @example\n   browser.button(name: \"new_user_button\").fire_event :click\n   browser.button(name: \"new_user_button\").fire_event \"mousemove\"\n   browser.button(name: \"new_user_button\").fire_event \"onmouseover\"\n\n @param [String, Symbol] event_name", "Returns true if the select list has one or more options where text or label matches the given value.\n\n @param [String, Regexp] str_or_rx\n @return [Boolean]", "Select the option whose text or label matches the given string.\n\n @param [String, Regexp] str_or_rx\n @raise [Watir::Exception::NoValueFoundException] if the value does not exist.\n @return [String] The text of the option selected. If multiple options match, returns the first match.", "Select all options whose text or label matches the given string.\n\n @param [String, Regexp] str_or_rx\n @raise [Watir::Exception::NoValueFoundException] if the value does not exist.\n @return [String] The text of the first option selected.", "Uses JavaScript to select the option whose text matches the given string.\n\n @param [String, Regexp] str_or_rx\n @raise [Watir::Exception::NoValueFoundException] if the value does not exist.", "Uses JavaScript to select all options whose text matches the given string.\n\n @param [String, Regexp] str_or_rx\n @raise [Watir::Exception::NoValueFoundException] if the value does not exist.", "Sets the file field to the given path\n\n @param [String] path", "Goes to the given URL.\n\n @example\n   browser.goto \"watir.github.io\"\n\n @param [String] uri The url.\n @return [String] The url you end up at.", "Only log a warn message if it is not set to be ignored.", "Marks code as deprecated with replacement.\n\n @param [String] old\n @param [String] new", "YARD macro to generated friendly\n documentation for attributes.\n\n @macro [attach] attribute\n  @method $2\n  @return [$1] value of $3 property", "Executes JavaScript snippet.\n\n If you are going to use the value snippet returns, make sure to use\n `return` explicitly.\n\n @example Check that Ajax requests are completed with jQuery\n   browser.execute_script(\"return jQuery.active\") == 0\n   #=> true\n\n @param [String] script JavaScript snippet to execute\n @param args Arguments will be available in the given script in the 'arguments' pseudo-array", "Resizes window to given width and height.\n\n @example\n   browser.window.resize_to 1600, 1200\n\n @param [Integer] width\n @param [Integer] height", "Moves window to given x and y coordinates.\n\n @example\n   browser.window.move_to 300, 200\n\n @param [Integer] x_coord\n @param [Integer] y_coord", "Returns array of cookies.\n\n @example\n   browser.cookies.to_a\n   #=> {:name=>\"my_session\", :value=>\"BAh7B0kiD3Nlc3Npb25faWQGOgZFRkk\", :domain=>\"mysite.com\"}\n\n @return [Array<Hash>]", "Adds new cookie.\n\n @example\n   browser.cookies.add 'my_session', 'BAh7B0kiD3Nlc3Npb25faWQGOgZFRkk', secure: true\n\n @param [String] name\n @param [String] value\n @param [Hash] opts\n @option opts [Boolean] :secure\n @option opts [String] :path\n @option opts [Time, DateTime, NilClass] :expires\n @option opts [String] :domain", "Load cookies from file\n\n @example\n   browser.cookies.load '.cookies'\n\n @param [String] file", "Returns first row of Table with proper subtype\n\n @return [TableCellCollection]", "Select the radio button whose value or label matches the given string.\n\n @param [String, Regexp] str_or_rx\n @raise [Watir::Exception::UnknownObjectException] if the Radio does not exist.\n @return [String] The value or text of the radio selected.", "Returns true if any of the radio button label matches the given value.\n\n @param [String, Regexp] str_or_rx\n @raise [Watir::Exception::UnknownObjectException] if the options do not exist\n @return [Boolean]", "Returns browser windows array.\n\n @example\n   browser.windows(title: 'closeable window')\n\n @return [Array<Window>]", "Returns browser window.\n\n @example\n   browser.window(title: 'closeable window')\n\n @return [Window]", "Scrolls to specified location.\n @param [Symbol] param", "Returns collection of elements of direct children of current element.\n\n @example\n   children = browser.select_list(id: \"new_user_languages\").children\n   children == browser.select_list(id: \"new_user_languages\").options.to_a\n   #=> true", "Waits until the element is present.\n\n @example\n   browser.text_field(name: \"new_user_first_name\").when_present.click\n   browser.text_field(name: \"new_user_first_name\").when_present { |field| field.set \"Watir\" }\n   browser.text_field(name: \"new_user_first_name\").when_present(60).text\n\n @param [Integer] timeout seconds to wait before timing out\n\n @see Watir::Wait\n @see Watir::Element#present?", "Waits until the element is enabled.\n\n @example\n   browser.button(name: \"new_user_button_2\").when_enabled.click\n\n @param [Integer] timeout seconds to wait before timing out\n\n @see Watir::Wait\n @see Watir::Element#enabled?", "Adds new after hook.\n\n @example\n   browser.after_hooks.add do |browser|\n     browser.text.include?(\"Server Error\") and puts \"Application exception or 500 error!\"\n   end\n   browser.goto \"watir.com/404\"\n   \"Application exception or 500 error!\"\n\n @param [#call] after_hook Object responding to call\n @yield after_hook block\n @yieldparam [Watir::Browser]", "Runs after hooks.", "Returns true if element exists.\n Checking for staleness is deprecated\n\n @return [Boolean]", "Clicks the element, optionally while pressing the given modifier keys.\n Note that support for holding a modifier key is currently experimental,\n and may not work at all.\n\n @example Click an element\n   browser.element(name: \"new_user_button\").click\n\n @example Click an element with shift key pressed\n   browser.element(name: \"new_user_button\").click(:shift)\n\n @example Click an element with several modifier keys pressed\n   browser.element(name: \"new_user_button\").click(:shift, :control)\n\n @param [:shift, :alt, :control, :command, :meta] modifiers to press while clicking.", "Drag and drop this element on to another element instance.\n Note that browser support may vary.\n\n @example\n   a = browser.div(id: \"draggable\")\n   b = browser.div(id: \"droppable\")\n   a.drag_and_drop_on b", "Drag and drop this element by the given offsets.\n Note that browser support may vary.\n\n @example\n   browser.div(id: \"draggable\").drag_and_drop_by 100, -200\n\n @param [Integer] right_by\n @param [Integer] down_by", "Returns given attribute value of element.\n\n @example\n   browser.a(id: \"link_2\").attribute_value \"title\"\n   #=> \"link_title_2\"\n\n @param [String, ::Symbol] attribute_name\n @return [String, nil]", "Returns all attribute values. Attributes with special characters are returned as String,\n rest are returned as a Symbol.\n\n @return [Hash]\n\n @example\n   browser.pre(id: 'rspec').attribute_values\n   #=> {class:'ruby', id: 'rspec' }", "Get centre coordinates of element\n\n @example\n   browser.button(name: \"new_user_button\").centre\n\n @return [Selenium::WebDriver::Point]", "Returns true if this element is visible on the page.\n Raises exception if element does not exist\n\n @return [Boolean]", "Returns true if the element exists and is visible on the page.\n Returns false if element does not exist or exists but is not visible\n\n @return [Boolean]\n @see Watir::Wait", "Get the element at the given index or range.\n\n Any call to an ElementCollection that includes an adjacent selector\n can not be lazy loaded because it must store the correct type\n\n Ranges can not be lazy loaded\n\n @param [Integer, Range] value Index (0-based) or Range of desired element(s)\n @return [Watir::Element, Watir::ElementCollection] Returns an instance of a Watir::Element subclass", "This collection as an Array.\n\n @return [Array<Watir::Element>]", "Return a diff between this commit and its first parent or another commit or tree.\n\n See Rugged::Tree#diff for more details.", "Checkout the specified branch, reference or commit.\n\n target - A revparse spec for the branch, reference or commit to check out.\n options - Options passed to #checkout_tree.", "Create a new branch in the repository\n\n name - The name of the branch (without a full reference path)\n sha_or_ref - The target of the branch; either a String representing\n an OID or a reference name, or a Rugged::Object instance.\n\n Returns a Rugged::Branch object", "Get the blob at a path for a specific revision.\n\n revision - The String SHA1.\n path     - The String file path.\n\n Returns a Rugged::Blob object", "Push a list of refspecs to the given remote.\n\n refspecs - A list of refspecs that should be pushed to the remote.\n\n Returns a hash containing the pushed refspecs as keys and\n any error messages or +nil+ as values.", "currently libgit2's `git_submodule_add_setup` initializes a repo\n with a workdir for the submodule. libgit2's `git_clone` however\n requires the target for the clone to be an empty dir.\n\n This provides a ghetto clone implementation that:\n 1. fetches the remote\n 2. sets up a master branch to be tracking origin/master\n 3. checkouts the submodule", "Builds the access token from the response of the HTTP call\n\n @return [AccessToken] the initialized AccessToken", "Apply the request credentials used to authenticate to the Authorization Server\n\n Depending on configuration, this might be as request params or as an\n Authorization header.\n\n User-provided params and header take precedence.\n\n @param [Hash] params a Hash of params for the token endpoint\n @return [Hash] params amended with appropriate authentication details", "Adds an `Authorization` header with Basic Auth credentials if and only if\n it is not already set in the params.", "Attempts to determine the content type of the response.", "Initalize a MACToken\n\n @param [Client] client the OAuth2::Client instance\n @param [String] token the Access Token value\n @option [String] secret the secret key value\n @param [Hash] opts the options to create the Access Token with\n @option opts [String] :refresh_token (nil) the refresh_token value\n @option opts [FixNum, String] :expires_in (nil) the number of seconds in which the AccessToken will expire\n @option opts [FixNum, String] :expires_at (nil) the epoch time in seconds in which AccessToken will expire\n @option opts [FixNum, String] :algorithm (hmac-sha-256) the algorithm to use for the HMAC digest (one of 'hmac-sha-256', 'hmac-sha-1')\n Make a request with the MAC Token\n\n @param [Symbol] verb the HTTP request method\n @param [String] path the HTTP URL path of the request\n @param [Hash] opts the options to make the request with\n @see Client#request", "Generate the MAC header\n\n @param [Symbol] verb the HTTP request method\n @param [String] url the HTTP URL path of the request", "Generate the Base64-encoded HMAC digest signature\n\n @param [Fixnum] timestamp the timestamp of the request in seconds since epoch\n @param [String] nonce the MAC header nonce\n @param [Symbol] verb the HTTP request method\n @param [String] url the HTTP URL path of the request", "Set the HMAC algorithm\n\n @param [String] alg the algorithm to use (one of 'hmac-sha-1', 'hmac-sha-256')", "Refreshes the current Access Token\n\n @return [AccessToken] a new AccessToken\n @note options should be carried over to the new AccessToken", "Make a request with the Access Token\n\n @param [Symbol] verb the HTTP request method\n @param [String] path the HTTP URL path of the request\n @param [Hash] opts the options to make the request with\n @see Client#request", "actually run the 'git log' command", "Returns the target branch\n\n Example:\n   Given (git branch -a):\n    master\n    remotes/working/master\n\n   g.branches['master'].full #=> 'master'\n   g.branches['working/master'].full => 'remotes/working/master'\n   g.branches['remotes/working/master'].full => 'remotes/working/master'\n\n @param [#to_s] branch_name the target branch name.\n @return [Git::Branch] the target branch.", "tries to clone the given repo\n\n returns {:repository} (if bare)\n         {:working_directory} otherwise\n\n accepts options:\n  :bare::      no working directory\n  :branch::    name of branch to track (rather than 'master')\n  :depth::     the number of commits back to pull\n  :origin::    name of remote (same as remote)\n  :path::      directory where the repo will be cloned\n  :remote::    name of remote (rather than 'origin')\n  :recursive:: after the clone is created, initialize all submodules within, using their default settings.\n\n TODO - make this work with SSH password or auth_key\n\n READ COMMANDS \n\n Returns most recent tag that is reachable from a commit\n\n accepts options:\n  :all\n  :tags\n  :contains\n  :debug\n  :exact_match\n  :dirty\n  :abbrev\n  :candidates\n  :long\n  :always\n  :math\n\n  @param [String|NilClass] committish target commit sha or object name\n  @param [{Symbol=>Object}] opts the given options\n  @return [String] the tag name", "returns useful array of raw commit object data", "reads a tree into the current index file", "creates an archive file\n\n options\n  :format  (zip, tar)\n  :prefix\n  :remote\n  :path", "returns the current version of git, as an Array of Fixnums.", "Returns an array holding the common options for the log commands\n\n @param [Hash] opts the given options\n @return [Array] the set of common options that the log command will use", "Retrurns an array holding path options for the log commands\n\n @param [Hash] opts the given options\n @return [Array] the set of path options that the log command will use", "returns +true+ if the branch exists locally", "returns +true+ if the branch exists remotely", "returns +true+ if the branch exists", "commits all pending changes in the index file to the git repository,\n but automatically adds all modified files without having to explicitly\n calling @git.add() on them.", "LOWER LEVEL INDEX OPERATIONS", "Returns a hash per row that includes the cell ids and values.\n Empty cells will be also included in the hash with a nil value.", "The unzipped XML file does not contain any node for empty cells.\n Empty cells are being padded in using this function", "Find drawing filepath for the current sheet.\n Sheet xml contains drawing relationship ID.\n Sheet relationships xml contains drawing file's location.", "Sends a report to Rollbar.\n\n Accepts any number of arguments. The last String argument will become\n the message or description of the report. The last Exception argument\n will become the associated exception for the report. The last hash\n argument will be used as the extra data for the report.\n\n If the extra hash contains a symbol key :custom_data_method_context\n the value of the key will be used as the context for\n configuration.custom_data_method and will be removed from the extra\n hash.\n\n @example\n   begin\n     foo = bar\n   rescue => e\n     Rollbar.log(e)\n   end\n\n @example\n   Rollbar.log('This is a simple log message')\n\n @example\n   Rollbar.log(e, 'This is a description of the exception')", "We will reraise exceptions in this method so async queues\n can retry the job or, in general, handle an error report some way.\n\n At same time that exception is silenced so we don't generate\n infinite reports. This example is what we want to avoid:\n\n 1. New exception in a the project is raised\n 2. That report enqueued to Sidekiq queue.\n 3. The Sidekiq job tries to send the report to our API\n 4. The report fails, for example cause a network failure,\n    and a exception is raised\n 5. We report an internal error for that exception\n 6. We reraise the exception so Sidekiq job fails and\n    Sidekiq can retry the job reporting the original exception\n 7. Because the job failed and Sidekiq can be managed by rollbar we'll\n    report a new exception.\n 8. Go to point 2.\n\n We'll then push to Sidekiq queue indefinitely until the network failure\n is fixed.\n\n Using Rollbar.silenced we avoid the above behavior but Sidekiq\n will have a chance to retry the original job.", "Reports an internal error in the Rollbar library. This will be reported within the configured\n Rollbar project. We'll first attempt to provide a report including the exception traceback.\n If that fails, we'll fall back to a more static failsafe response.", "Payload building functions", "force should only be used with care! currently only used when type is being refined to a subtype in a lexical scope", "merges bindings in self with bindings in other, preferring bindings in other if there is a common key", "other may not be a query", "Initializes TinyMCE on the current page based on the global configuration.\n\n Custom options can be set via the options hash, which will be passed to\n the TinyMCE init function.\n\n By default, all textareas with a class of \"tinymce\" will have the TinyMCE\n editor applied. The current locale will also be used as the language when\n TinyMCE language files are available, falling back to English if not\n available. The :editor_selector and :language options can be used to\n override these defaults.\n\n @example\n   <%= tinymce(selector: \"editorClass\", theme: \"inlite\") %>", "Returns the JavaScript code required to initialize TinyMCE.", "Returns the JavaScript code for initializing each configuration defined within tinymce.yml.", "route for handle paranoid verification", "Is this password older than the configured expiration timeout?\n @return [Boolean]", "Set the page title and return it back.\n\n This method is best suited for use in helpers. It sets the page title\n and returns it (or +headline+ if specified).\n\n @param [nil, String, Array] title page title. When passed as an\n   +Array+, parts will be joined using configured separator value\n   (see {#display_meta_tags}). When nil, current title will be returned.\n @param [String] headline the value to return from method. Useful\n   for using this method in views to set both page title\n   and the content of heading tag.\n @return [String] returns +title+ value or +headline+ if passed.\n\n @example Set HTML title to \"Please login\", return \"Please login\"\n   title 'Login Page'\n @example Set HTML title to \"Login Page\", return \"Please login\"\n   title 'Login Page', 'Please login'\n @example Set title as array of strings\n   title title: ['part1', 'part2'] # => \"part1 | part2\"\n @example Get current title\n   title\n\n @see #display_meta_tags", "Recursively merges a Hash of meta tag attributes into current list.\n\n @param [Hash, #to_meta_tags] object Hash of meta tags (or object responding\n   to #to_meta_tags and returning a hash) to merge into the current list.\n @return [Hash] result of the merge.", "Extracts full page title and deletes all related meta tags.\n\n @return [String] page title.", "Extracts page title as an array of segments without site title and separators.\n\n @return [Array<String>] segments of page title.", "Extracts title separator as a string.\n\n @return [String] page title separator.", "Extracts noindex settings as a Hash mapping noindex tag name to value.\n\n @return [Hash<String,String>] noindex attributes.", "Extracts noindex attribute name and value without deleting it from meta tags list.\n\n @param [String, Symbol] name noindex attribute name.\n @return [Array<String>] pair of noindex attribute name and value.", "Append noarchive attribute if it present.\n\n @param [Hash<String, String>] noindex noindex attributes.\n @return [Hash<String, String>] modified noindex attributes.", "Convert array of arrays to hashes and concatenate values\n\n @param [Array<Array>] attributes list of noindex keys and values\n @return [Hash<String, String>] hash of grouped noindex keys and values", "Initializes a new instance of Tag class.\n\n @param [String, Symbol] name HTML tag name\n @param [Hash] attributes list of HTML tag attributes\n\n Render tag into a Rails view.\n\n @param [ActionView::Base] view instance of a Rails view.\n @return [String] HTML string for the tag.", "Normalize description value.\n\n @param [String] description description string.\n @return [String] text with tags removed, squashed spaces, truncated\n to 200 characters.", "Normalize keywords value.\n\n @param [String, Array<String>] keywords list of keywords as a string or Array.\n @return [String] list of keywords joined with comma, with tags removed.", "Strips all HTML tags from the +html+, including comments.\n\n @param [String] string HTML string.\n @return [String] html_safe string with no HTML tags.", "Removes HTML tags and squashes down all the spaces.\n\n @param [String] string input string.\n @return [String] input string with no HTML tags and consequent white\n space characters squashed into a single space.", "Cleans multiple strings up.\n\n @param [Array<String>] strings input strings.\n @return [Array<String>] clean strings.\n @see cleanup_string", "Truncates a string to a specific limit. Return string without truncation when limit 0 or nil\n\n @param [String] string input strings.\n @param [Integer,nil] limit characters number to truncate to.\n @param [String] natural_separator natural separator to truncate at.\n @return [String] truncated string.", "Truncates a string to a specific limit.\n\n @param [Array<String>] string_array input strings.\n @param [Integer,nil] limit characters number to truncate to.\n @param [String] separator separator that will be used to join array later.\n @param [String] natural_separator natural separator to truncate at.\n @return [String] truncated string.", "Initialized a new instance of Renderer.\n\n @param [MetaTagsCollection] meta_tags meta tags object to render.\n\n Renders meta tags on the page.\n\n @param [ActionView::Base] view Rails view object.", "Renders charset tag.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders title tag.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders noindex and nofollow meta tags.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders refresh meta tag.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders alternate link tags.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders open_search link tag.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders links.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders complex hash objects.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders a complex hash object by key.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Renders custom meta tags.\n\n @param [Array<Tag>] tags a buffer object to store tag in.", "Recursive method to process all the hashes and arrays on meta tags\n\n @param [Array<Tag>] tags a buffer object to store tag in.\n @param [String, Symbol] property a Hash or a String to render as meta tag.\n @param [Hash, Array, String, Symbol] content text content or a symbol reference to\n top-level meta tag.", "Filter trackable URIs, i.e. absolute one with http", "Uses the stored location value from the cookie if it exists.  If\n no cookie exists, calls out to the web service to get the location.", "Return a hash-representation of the given fields for this message type that\n is safe to convert to JSON.", "Generate a url that use to redirect user to Alipay payment page.\n\n Example:\n\n   alipay_client.page_execute_url(\n     method: 'alipay.trade.page.pay',\n     biz_content: {\n       out_trade_no: '20160401000000',\n       product_code: 'FAST_INSTANT_TRADE_PAY',\n       total_amount: '0.01',\n       subject: 'test'\n     }.to_json(ascii_only: true),\n     timestamp: '2016-04-01 00:00:00'\n   )\n   # => 'https://openapi.alipaydev.com/gateway.do?app_id=2016...'", "Generate a form string that use to render in view and auto POST to\n Alipay server.\n\n Example:\n\n   alipay_client.page_execute_form(\n     method: 'alipay.trade.page.pay',\n     biz_content: {\n       out_trade_no: '20160401000000',\n       product_code: 'FAST_INSTANT_TRADE_PAY',\n       total_amount: '0.01',\n       subject: 'test'\n     }.to_json(ascii_only: true),\n     timestamp: '2016-04-01 00:00:00'\n   )\n   # => '<form id='alipaysubmit' name='alipaysubmit' action=...'", "Immediately make a API request to Alipay and return response body.\n\n Example:\n\n   alipay_client.execute(\n     method: 'alipay.data.dataservice.bill.downloadurl.query',\n     biz_content: {\n       bill_type: 'trade',\n       bill_date: '2016-04-01'\n     }.to_json(ascii_only: true)\n   )\n   # => '{ \"alipay_data_dataservice_bill_downloadurl_query_response\":{...'", "Generate sign for params.", "Verify Alipay notification.\n\n Example:\n\n   params = {\n     out_trade_no: '20160401000000',\n     trade_status: 'TRADE_SUCCESS'\n     sign_type: 'RSA2',\n     sign: '...'\n   }\n   alipay_client.verify?(params)\n   # => true / false", "This is a one-liner method to write a config setting, read the config\n setting, and also set a default value for the setting.", "Initialize the model class and builder", "Get the hash value of the client.\n\n @example Get the client hash value.\n   client.hash\n\n @return [ Integer ] The client hash value.\n\n @since 2.0.0\n Instantiate a new driver client.\n\n @example Instantiate a single server or mongos client.\n   Mongo::Client.new(['127.0.0.1:27017'])\n\n @example Instantiate a client for a replica set.\n   Mongo::Client.new(['127.0.0.1:27017', '127.0.0.1:27021'])\n\n @example Directly connect to a mongod in a replica set\n   Mongo::Client.new(['127.0.0.1:27017'], :connect => :direct)\n   # without `:connect => :direct`, Mongo::Client will discover and\n   # connect to the replica set if given the address of a server in\n   # a replica set\n\n @param [ Array<String> | String ] addresses_or_uri The array of server addresses in the\n   form of host:port or a MongoDB URI connection string.\n @param [ Hash ] options The options to be used by the client.\n\n\n @option options [ String, Symbol ] :app_name Application name that is\n   printed to the mongod logs upon establishing a connection in server\n   versions >= 3.4.\n @option options [ Symbol ] :auth_mech The authentication mechanism to\n   use. One of :mongodb_cr, :mongodb_x509, :plain, :scram, :scram256\n @option options [ Hash ] :auth_mech_properties\n @option options [ String ] :auth_source The source to authenticate from.\n @option options [ Array<String> ] :compressors A list of potential\n   compressors to use, in order of preference. The driver chooses the\n   first compressor that is also supported by the server. Currently the\n   driver only supports 'zlib'.\n @option options [ Symbol ] :connect The connection method to use. This\n   forces the cluster to behave in the specified way instead of\n   auto-discovering. One of :direct, :replica_set, :sharded\n @option options [ Float ] :connect_timeout The timeout, in seconds, to\n   attempt a connection.\n @option options [ String ] :database The database to connect to.\n @option options [ Float ] :heartbeat_frequency The number of seconds for\n   the server monitor to refresh it's description via ismaster.\n @option options [ Object ] :id_generator A custom object to generate ids\n   for documents. Must respond to #generate.\n @option options [ Integer ] :local_threshold The local threshold boundary\n   in seconds for selecting a near server for an operation.\n @option options [ Logger ] :logger A custom logger if desired.\n @option options [ Integer ] :max_idle_time The maximum seconds a socket can remain idle\n   since it has been checked in to the pool.\n @option options [ Integer ] :max_pool_size The maximum size of the\n   connection pool.\n @option options [ Integer ] :max_read_retries The maximum number of read\n   retries when legacy read retries are in use.\n @option options [ Integer ] :max_write_retries The maximum number of write\n   retries when legacy write retries are in use.\n @option options [ Integer ] :min_pool_size The minimum size of the\n   connection pool.\n @option options [ true, false ] :monitoring If false is given, the\n   client is initialized without global SDAM event subscribers and\n   will not publish SDAM events. Command monitoring and legacy events\n   will still be published, and the driver will still perform SDAM and\n   monitor its cluster in order to perform server selection. Built-in\n   driver logging of SDAM events will be disabled because it is\n   implemented through SDAM event subscription. Client#subscribe will\n   succeed for all event types, but subscribers to SDAM events will\n   not be invoked. Values other than false result in default behavior\n   which is to perform normal SDAM event publication.\n @option options [ true, false ] :monitoring_io For internal driver\n   use only. Set to false to prevent SDAM-related I/O from being\n   done by this client or servers under it. Note: setting this option\n   to false will make the client non-functional. It is intended for\n   use in tests which manually invoke SDAM state transitions.\n @option options [ String ] :password The user's password.\n @option options [ String ] :platform Platform information to include in\n   the metadata printed to the mongod logs upon establishing a connection\n   in server versions >= 3.4.\n @option options [ Hash ] :read The read preference options. The hash\n   may have the following items:\n   - *:mode* -- read preference specified as a symbol; valid values are\n     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*\n     and *:nearest*.\n   - *:tag_sets* -- an array of hashes.\n   - *:local_threshold*.\n @option options [ Hash ] :read_concern The read concern option.\n @option options [ Float ] :read_retry_interval The interval, in seconds,\n   in which reads on a mongos are retried.\n @option options [ Symbol ] :replica_set The name of the replica set to\n   connect to. Servers not in this replica set will be ignored.\n @option options [ true | false ] :retry_reads If true, modern retryable\n   reads are enabled (which is the default). If false, modern retryable\n   reads are disabled and legacy retryable reads are enabled.\n @option options [ true | false ] :retry_writes Retry writes once when\n   connected to a replica set or sharded cluster versions 3.6 and up.\n   (Default is true.)\n @option options [ true | false ] :scan Whether to scan all seeds\n   in constructor. The default in driver version 2.x is to do so;\n   driver version 3.x will not scan seeds in constructor. Opt in to the\n   new behavior by setting this option to false. *Note:* setting\n   this option to nil enables scanning seeds in constructor in driver\n   version 2.x. Driver version 3.x will recognize this option but\n   will ignore it and will never scan seeds in the constructor.\n @option options [ Proc ] :sdam_proc A Proc to invoke with the client\n   as the argument prior to performing server discovery and monitoring.\n   Use this to set up SDAM event listeners to receive events dispatched\n   during client construction.\n\n   Note: the client is not fully constructed when sdam_proc is invoked,\n   in particular the cluster is nil at this time. sdam_proc should\n   limit itself to calling #subscribe and #unsubscribe methods on the\n   client only.\n @option options [ Integer ] :server_selection_timeout The timeout in seconds\n   for selecting a server for an operation.\n @option options [ Float ] :socket_timeout The timeout, in seconds, to\n   execute operations on a socket.\n @option options [ true, false ] :ssl Whether to use SSL.\n @option options [ String ] :ssl_ca_cert The file containing concatenated\n   certificate authority certificates used to validate certs passed from the\n   other end of the connection. One of :ssl_ca_cert, :ssl_ca_cert_string or\n   :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.\n @option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object An array of\n   OpenSSL::X509::Certificate representing the certificate authority certificates used\n   to validate certs passed from the other end of the connection. One of :ssl_ca_cert,\n   :ssl_ca_cert_string or :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.\n @option options [ String ] :ssl_ca_cert_string A string containing concatenated\n   certificate authority certificates used to validate certs passed from the\n   other end of the connection. One of :ssl_ca_cert, :ssl_ca_cert_string or\n   :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.\n @option options [ String ] :ssl_cert The certificate file used to identify\n   the connection against MongoDB. This option, if present, takes precedence\n   over the values of :ssl_cert_string and :ssl_cert_object\n @option options [ OpenSSL::X509::Certificate ] :ssl_cert_object The OpenSSL::X509::Certificate\n   used to identify the connection against MongoDB\n @option options [ String ] :ssl_cert_string A string containing the PEM-encoded\n   certificate used to identify the connection against MongoDB. This option, if present,\n   takes precedence over the value of :ssl_cert_object\n @option options [ String ] :ssl_key The private keyfile used to identify the\n   connection against MongoDB. Note that even if the key is stored in the same\n   file as the certificate, both need to be explicitly specified. This option,\n   if present, takes precedence over the values of :ssl_key_string and :ssl_key_object\n @option options [ OpenSSL::PKey ] :ssl_key_object The private key used to identify the\n   connection against MongoDB\n @option options [ String ] :ssl_key_pass_phrase A passphrase for the private key.\n @option options [ String ] :ssl_key_string A string containing the PEM-encoded private key\n   used to identify the connection against MongoDB. This parameter, if present,\n   takes precedence over the value of option :ssl_key_object\n @option options [ true, false ] :ssl_verify Whether to perform peer certificate validation and\n   hostname verification. Note that the decision of whether to validate certificates will be\n   overridden if :ssl_verify_certificate is set, and the decision of whether to validate\n   hostnames will be overridden if :ssl_verify_hostname is set.\n @option options [ true, false ] :ssl_verify_certificate Whether to perform peer certificate\n   validation. This setting overrides :ssl_verify with respect to whether certificate\n   validation is performed.\n @option options [ true, false ] :ssl_verify_hostname Whether to perform peer hostname\n   validation. This setting overrides :ssl_verify with respect to whether hostname validation\n   is performed.\n @option options [ true, false ] :truncate_logs Whether to truncate the\n   logs at the default 250 characters.\n @option options [ String ] :user The user name.\n @option options [ Float ] :wait_queue_timeout The time to wait, in\n   seconds, in the connection pool for a connection to be checked in.\n @option options [ Hash ] :write The write concern options. Can be :w =>\n   Integer|String, :fsync => Boolean, :j => Boolean.\n @option options [ Integer ] :zlib_compression_level The Zlib compression level to use, if using compression.\n   See Ruby's Zlib module for valid levels.\n\n @since 2.0.0\n @api private", "Creates a new client with the passed options merged over the existing\n options of this client. Useful for one-offs to change specific options\n without altering the original client.\n\n @note Depending on options given, the returned client may share the\n   cluster with the original client or be created with a new cluster.\n   If a new cluster is created, the monitoring event subscribers on\n   the new client are set to the default event subscriber set and\n   none of the subscribers on the original client are copied over.\n\n @example Get a client with changed options.\n   client.with(:read => { :mode => :primary_preferred })\n\n @param [ Hash ] new_options The new options to use.\n\n @return [ Mongo::Client ] A new client instance.\n\n @since 2.0.0", "Reconnect the client.\n\n @example Reconnect the client.\n   client.reconnect\n\n @return [ true ] Always true.\n\n @since 2.1.0", "Get the names of all databases.\n\n @example Get the database names.\n   client.database_names\n\n @param [ Hash ] filter The filter criteria for getting a list of databases.\n @param [ Hash ] opts The command options.\n\n @return [ Array<String> ] The names of the databases.\n\n @since 2.0.5", "Get info for each database.\n\n @example Get the info for each database.\n   client.list_databases\n\n @param [ Hash ] filter The filter criteria for getting a list of databases.\n @param [ true, false ] name_only Whether to only return each database name without full metadata.\n @param [ Hash ] opts The command options.\n\n @return [ Array<Hash> ] The info for each database.\n\n @since 2.0.5", "Start a session.\n\n If the deployment does not support sessions, raises\n Mongo::Error::InvalidSession. This exception can also be raised when\n the driver is not connected to a data-bearing server, for example\n during failover.\n\n @example Start a session.\n   client.start_session(causal_consistency: true)\n\n @param [ Hash ] options The session options. Accepts the options\n   that Session#initialize accepts.\n\n @note A Session cannot be used by multiple threads at once; session\n   objects are not thread-safe.\n\n @return [ Session ] The session.\n\n @since 2.5.0", "Get the DBRef as a JSON document\n\n @example Get the DBRef as a JSON hash.\n   dbref.as_json\n\n @return [ Hash ] The max key as a JSON hash.\n\n @since 2.1.0", "Instantiate a new DBRef.\n\n @example Create the DBRef.\n   Mongo::DBRef.new('users', id, 'database')\n\n @param [ String ] collection The collection name.\n @param [ BSON::ObjectId ] id The object id.\n @param [ String ] database The database name.\n\n @since 2.1.0\n Converts the DBRef to raw BSON.\n\n @example Convert the DBRef to raw BSON.\n   dbref.to_bson\n\n @param [ BSON::ByteBuffer ] buffer The encoded BSON buffer to append to.\n @param [ true, false ] validating_keys Whether keys should be validated when serializing.\n\n @return [ String ] The raw BSON.\n\n @since 2.1.0", "Disconnect all servers.\n\n @note Applications should call Client#close to disconnect from\n the cluster rather than calling this method. This method is for\n internal driver use only.\n\n @example Disconnect the cluster's servers.\n   cluster.disconnect!\n\n @param [ Boolean ] wait Whether to wait for background threads to\n   finish running.\n\n @return [ true ] Always true.\n\n @since 2.1.0", "Reconnect all servers.\n\n @example Reconnect the cluster's servers.\n   cluster.reconnect!\n\n @return [ true ] Always true.\n\n @since 2.1.0\n @deprecated Use Client#reconnect to reconnect to the cluster instead of\n   calling this method. This method does not send SDAM events.", "Force a scan of all known servers in the cluster.\n\n If the sync parameter is true which is the default, the scan is\n performed synchronously in the thread which called this method.\n Each server in the cluster is checked sequentially. If there are\n many servers in the cluster or they are slow to respond, this\n can be a long running operation.\n\n If the sync parameter is false, this method instructs all server\n monitor threads to perform an immediate scan and returns without\n waiting for scan results.\n\n @note In both synchronous and asynchronous scans, each monitor\n   thread maintains a minimum interval between scans, meaning\n   calling this method may not initiate a scan on a particular server\n   the very next instant.\n\n @example Force a full cluster scan.\n   cluster.scan!\n\n @return [ true ] Always true.\n\n @since 2.0.0", "Update the max cluster time seen in a response.\n\n @example Update the cluster time.\n   cluster.update_cluster_time(result)\n\n @param [ Operation::Result ] result The operation result containing the cluster time.\n\n @return [ Object ] The cluster time.\n\n @since 2.5.0", "Add a server to the cluster with the provided address. Useful in\n auto-discovery of new servers when an existing server executes an ismaster\n and potentially non-configured servers were included.\n\n @example Add the server for the address to the cluster.\n   cluster.add('127.0.0.1:27018')\n\n @param [ String ] host The address of the server to add.\n\n @option options [ Boolean ] :monitor For internal driver use only:\n   whether to monitor the newly added server.\n\n @return [ Server ] The newly added server, if not present already.\n\n @since 2.0.0", "Remove the server from the cluster for the provided address, if it\n exists.\n\n @example Remove the server from the cluster.\n   server.remove('127.0.0.1:27017')\n\n @param [ String ] host The host/port or socket address.\n\n @return [ true|false ] Whether any servers were removed.\n\n @since 2.0.0, return value added in 2.7.0", "Get a socket for the provided address, given the options.\n\n The address the socket connects to is determined by the algorithm described in the\n #intialize_resolver! documentation. Each time this method is called, #initialize_resolver!\n will be called, meaning that a new hostname lookup will occur. This is done so that any\n changes to which addresses the hostname resolves to will be picked up even if a socket has\n been connected to it before.\n\n @example Get a socket.\n   address.socket(5, :ssl => true)\n\n @param [ Float ] socket_timeout The socket timeout.\n @param [ Hash ] ssl_options SSL options.\n @param [ Hash ] options The options.\n\n @option options [ Float ] :connect_timeout Connect timeout.\n\n @return [ Mongo::Socket::SSL, Mongo::Socket::TCP, Mongo::Socket::Unix ] The socket.\n\n @since 2.0.0", "Execute the bulk write operation.\n\n @example Execute the bulk write.\n   bulk_write.execute\n\n @return [ Mongo::BulkWrite::Result ] The result.\n\n @since 2.1.0", "Convenience helper to find a server by it's URI.\n\n @since 2.0.0", "Applies URI value transformation by either using the default cast\n or a transformation appropriate for the given type.\n\n @param key [String] URI option name.\n @param value [String] The value to be transformed.\n @param type [Symbol] The transform method.", "Merges a new option into the target.\n\n If the option exists at the target destination the merge will\n be an addition.\n\n Specifically required to append an additional tag set\n to the array of tag sets without overwriting the original.\n\n @param target [Hash] The destination.\n @param value [Object] The value to be merged.\n @param name [Symbol] The name of the option.", "Adds an option to the uri options hash via the supplied strategy.\n\n   Acquires a target for the option based on group.\n   Transforms the value.\n   Merges the option into the target.\n\n @param key [String] URI option name.\n @param strategy [Symbol] The strategy for this option.\n @param value [String] The value of the option.\n @param uri_options [Hash] The base option target.", "Auth mechanism properties extractor.\n\n @param value [ String ] The auth mechanism properties string.\n\n @return [ Hash ] The auth mechanism properties hash.", "Parses the zlib compression level.\n\n @param value [ String ] The zlib compression level string.\n\n @return [ Integer | nil ] The compression level value if it is between -1 and 9 (inclusive),\n   otherwise nil (and a warning will be logged).", "Parses a boolean value and returns its inverse.\n\n @param value [ String ] The URI option value.\n\n @return [ true | false | nil ] The inverse of the  boolean value parsed out, otherwise nil\n   (and a warning will be logged).", "Parses the max staleness value, which must be either \"0\" or an integer greater or equal to 90.\n\n @param value [ String ] The max staleness string.\n\n @return [ Integer | nil ] The max staleness integer parsed out if it is valid, otherwise nil\n   (and a warning will be logged).", "Extract values from the string and put them into a nested hash.\n\n @param value [ String ] The string to build a hash from.\n\n @return [ Hash ] The hash built from the string.", "Iterate through documents returned from the query.\n\n @example Iterate over the documents in the cursor.\n   cursor.each do |doc|\n     ...\n   end\n\n @return [ Enumerator ] The enumerator.\n\n @since 2.0.0", "Disconnect the server from the connection.\n\n @example Disconnect the server.\n   server.disconnect!\n\n @param [ Boolean ] wait Whether to wait for background threads to\n   finish running.\n\n @return [ true ] Always true with no exception.\n\n @since 2.0.0", "Start monitoring the server.\n\n Used internally by the driver to add a server to a cluster\n while delaying monitoring until the server is in the cluster.\n\n @api private", "Determine if the provided tags are a subset of the server's tags.\n\n @example Are the provided tags a subset of the server's tags.\n   server.matches_tag_set?({ 'rack' => 'a', 'dc' => 'nyc' })\n\n @param [ Hash ] tag_set The tag set to compare to the server's tags.\n\n @return [ true, false ] If the provided tags are a subset of the server's tags.\n\n @since 2.0.0", "Handle authentication failure.\n\n @example Handle possible authentication failure.\n   server.handle_auth_failure! do\n     Auth.get(user).login(self)\n   end\n\n @raise [ Auth::Unauthorized ] If the authentication failed.\n\n @return [ Object ] The result of the block execution.\n\n @since 2.3.0", "Load a json file and represent each document as a Hash.\n\n @example Load a file.\n   Benchmarking.load_file(file_name)\n\n @param [ String ] The file name.\n\n @return [ Array ] A list of extended-json documents.\n\n @since 2.2.3", "Get the authorization strategy for the provided auth mechanism.\n\n @example Get the strategy.\n   Auth.get(user)\n\n @param [ Auth::User ] user The user object.\n\n @return [ CR, X509, LDAP, Kerberos ] The auth strategy.\n\n @since 2.0.0", "Publish a started event.\n\n @example Publish a started event.\n   monitoring.started(COMMAND, event)\n\n @param [ String ] topic The event topic.\n @param [ Event ] event The event to publish.\n\n @since 2.1.0", "Publish a succeeded event.\n\n @example Publish a succeeded event.\n   monitoring.succeeded(COMMAND, event)\n\n @param [ String ] topic The event topic.\n @param [ Event ] event The event to publish.\n\n @since 2.1.0", "Publish a failed event.\n\n @example Publish a failed event.\n   monitoring.failed(COMMAND, event)\n\n @param [ String ] topic The event topic.\n @param [ Event ] event The event to publish.\n\n @since 2.1.0", "Create a write concern object for the provided options.\n\n @example Get a write concern.\n   Mongo::WriteConcern.get(:w => 1)\n\n @param [ Hash ] options The options to instantiate with.\n\n @option options :w [ Integer, String ] The number of servers or the\n   custom mode to acknowledge.\n @option options :j [ true, false ] Whether to acknowledge a write to\n   the journal.\n @option options :fsync [ true, false ] Should the write be synced to\n   disc.\n @option options :wtimeout [ Integer ] The number of milliseconds to\n   wait for acknowledgement before raising an error.\n\n @return [ Unacknowledged, Acknowledged ] The appropriate concern.\n\n @raise [ Error::InvalidWriteConcern ] If the options are invalid.\n\n @since 2.0.0", "Execute a command on the database.\n\n @example Execute a command.\n   database.command(:ismaster => 1)\n\n @param [ Hash ] operation The command to execute.\n @param [ Hash ] opts The command options.\n\n @option opts :read [ Hash ] The read preference for this command.\n @option opts :session [ Session ] The session to use for this command.\n\n @return [ Hash ] The result of the command execution.", "Drop the database and all its associated information.\n\n @example Drop the database.\n   database.drop\n\n @param [ Hash ] options The options for the operation.\n\n @option options [ Session ] :session The session to use for the operation.\n\n @return [ Result ] The result of the command.\n\n @since 2.0.0", "Create the new socket for the provided family - ipv4, piv6, or unix.\n\n @example Create a new ipv4 socket.\n   Socket.new(Socket::PF_INET)\n\n @param [ Integer ] family The socket domain.\n\n @since 2.0.0\n Will read all data from the socket for the provided number of bytes.\n If no data is returned, an exception will be raised.\n\n @example Read all the requested data from the socket.\n   socket.read(4096)\n\n @param [ Integer ] length The number of bytes to read.\n\n @raise [ Mongo::SocketError ] If not all data is returned.\n\n @return [ Object ] The data from the socket.\n\n @since 2.0.0", "End this session.\n\n @example\n   session.end_session\n\n @return [ nil ] Always nil.\n\n @since 2.5.0", "Add the transaction number to a command document if applicable.\n\n @example\n   session.add_txn_num!(cmd)\n\n @return [ Hash, BSON::Document ] The command document.\n\n @since 2.6.0\n @api private", "Add the transactions options if applicable.\n\n @example\n   session.add_txn_opts!(cmd)\n\n @return [ Hash, BSON::Document ] The command document.\n\n @since 2.6.0\n @api private", "Ensure that the read preference of a command primary.\n\n @example\n   session.validate_read_preference!(command)\n\n @raise [ Mongo::Error::InvalidTransactionOperation ] If the read preference of the command is\n   not primary.\n\n @since 2.6.0\n @api private", "Places subsequent operations in this session into a new transaction.\n\n Note that the transaction will not be started on the server until an\n operation is performed after start_transaction is called.\n\n @example Start a new transaction\n   session.start_transaction(options)\n\n @param [ Hash ] options The options for the transaction being started.\n\n @option options [ Hash ] read_concern The read concern options hash,\n   with the following optional keys:\n   - *:level* -- the read preference level as a symbol; valid values\n      are *:local*, *:majority*, and *:snapshot*\n @option options [ Hash ] :write_concern The write concern options. Can be :w =>\n   Integer|String, :fsync => Boolean, :j => Boolean.\n @option options [ Hash ] :read The read preference options. The hash may have the following\n   items:\n   - *:mode* -- read preference specified as a symbol; the only valid value is\n     *:primary*.\n\n @raise [ Error::InvalidTransactionOperation ] If a transaction is already in\n   progress or if the write concern is unacknowledged.\n\n @since 2.6.0", "Commit the currently active transaction on the session.\n\n @example Commits the transaction.\n   session.commit_transaction\n\n @option options :write_concern [ nil | WriteConcern::Base ] The write\n   concern to use for this operation.\n\n @raise [ Error::InvalidTransactionOperation ] If there is no active transaction.\n\n @since 2.6.0", "Abort the currently active transaction without making any changes to the database.\n\n @example Abort the transaction.\n   session.abort_transaction\n\n @raise [ Error::InvalidTransactionOperation ] If there is no active transaction.\n\n @since 2.6.0", "Executes the provided block in a transaction, retrying as necessary.\n\n Returns the return value of the block.\n\n Exact number of retries and when they are performed are implementation\n details of the driver; the provided block should be idempotent, and\n should be prepared to be called more than once. The driver may retry\n the commit command within an active transaction or it may repeat the\n transaction and invoke the block again, depending on the error\n encountered if any. Note also that the retries may be executed against\n different servers.\n\n Transactions cannot be nested - InvalidTransactionOperation will be raised\n if this method is called when the session already has an active transaction.\n\n Exceptions raised by the block which are not derived from Mongo::Error\n stop processing, abort the transaction and are propagated out of\n with_transaction. Exceptions derived from Mongo::Error may be\n handled by with_transaction, resulting in retries of the process.\n\n Currently, with_transaction will retry commits and block invocations\n until at least 120 seconds have passed since with_transaction started\n executing. This timeout is not configurable and may change in a future\n driver version.\n\n @note with_transaction contains a loop, therefore the if with_transaction\n   itself is placed in a loop, its block should not call next or break to\n   control the outer loop because this will instead affect the loop in\n   with_transaction. The driver will warn and abort the transaction\n   if it detects this situation.\n\n @example Execute a statement in a transaction\n   session.with_transaction(write_concern: {w: :majority}) do\n     collection.update_one({ id: 3 }, { '$set' => { status: 'Inactive'} },\n                           session: session)\n\n   end\n\n @example Execute a statement in a transaction, limiting total time consumed\n   Timeout.timeout(5) do\n     session.with_transaction(write_concern: {w: :majority}) do\n       collection.update_one({ id: 3 }, { '$set' => { status: 'Inactive'} },\n                             session: session)\n\n     end\n   end\n\n @param [ Hash ] options The options for the transaction being started.\n   These are the same options that start_transaction accepts.\n\n @raise [ Error::InvalidTransactionOperation ] If a transaction is already in\n   progress or if the write concern is unacknowledged.\n\n @since 2.7.0", "Get the read preference the session will use in the currently\n active transaction.\n\n This is a driver style hash with underscore keys.\n\n @example Get the transaction's read preference\n   session.txn_read_preference\n\n @return [ Hash ] The read preference of the transaction.\n\n @since 2.6.0", "Create a server selector object.\n\n @example Get a server selector object for selecting a secondary with\n   specific tag sets.\n   Mongo::ServerSelector.get(:mode => :secondary, :tag_sets => [{'dc' => 'nyc'}])\n\n @param [ Hash ] preference The server preference.\n\n @since 2.0.0", "Execute a read operation returning a cursor with retrying.\n\n This method performs server selection for the specified server selector\n and yields to the provided block, which should execute the initial\n query operation and return its result. The block will be passed the\n server selected for the operation. If the block raises an exception,\n and this exception corresponds to a read retryable error, and read\n retries are enabled for the client, this method will perform server\n selection again and yield to the block again (with potentially a\n different server). If the block returns successfully, the result\n of the block (which should be a Mongo::Operation::Result) is used to\n construct a Mongo::Cursor object for the result set. The cursor\n is then returned.\n\n If modern retry reads are on (which is the default), the initial read\n operation will be retried once. If legacy retry reads are on, the\n initial read operation will be retried zero or more times depending\n on the :max_read_retries client setting, the default for which is 1.\n To disable read retries, turn off modern read retries by setting\n retry_reads: false and set :max_read_retries to 0 on the client.\n\n @api private\n\n @example Execute a read returning a cursor.\n   cursor = read_with_retry_cursor(session, server_selector, view) do |server|\n     # return a Mongo::Operation::Result\n     ...\n   end\n\n @param [ Mongo::Session ] session The session that the operation is being\n   run on.\n @param [ Mongo::ServerSelector::Selectable ] server_selector Server\n   selector for the operation.\n @param [ CollectionView ] view The +CollectionView+ defining the query.\n @param [ Proc ] block The block to execute.\n\n @return [ Cursor ] The cursor for the result set.", "Execute a read operation with retrying.\n\n This method performs server selection for the specified server selector\n and yields to the provided block, which should execute the initial\n query operation and return its result. The block will be passed the\n server selected for the operation. If the block raises an exception,\n and this exception corresponds to a read retryable error, and read\n retries are enabled for the client, this method will perform server\n selection again and yield to the block again (with potentially a\n different server). If the block returns successfully, the result\n of the block is returned.\n\n If modern retry reads are on (which is the default), the initial read\n operation will be retried once. If legacy retry reads are on, the\n initial read operation will be retried zero or more times depending\n on the :max_read_retries client setting, the default for which is 1.\n To disable read retries, turn off modern read retries by setting\n retry_reads: false and set :max_read_retries to 0 on the client.\n\n @api private\n\n @example Execute the read.\n   read_with_retry(session, server_selector) do |server|\n     ...\n   end\n\n @param [ Mongo::Session ] session The session that the operation is being\n   run on.\n @param [ Mongo::ServerSelector::Selectable ] server_selector Server\n   selector for the operation.\n @param [ Proc ] block The block to execute.\n\n @return [ Result ] The result of the operation.", "Execute a read operation with a single retry on network errors.\n\n This method is used by the driver for some of the internal housekeeping\n operations. Application-requested reads should use read_with_retry\n rather than this method.\n\n @api private\n\n @example Execute the read.\n   read_with_one_retry do\n     ...\n   end\n\n @note This only retries read operations on socket errors.\n\n @param [ Hash ] options Options.\n @param [ Proc ] block The block to execute.\n\n @option options [ String ] :retry_message Message to log when retrying.\n\n @return [ Result ] The result of the operation.\n\n @since 2.2.6", "Implements write retrying functionality by yielding to the passed\n block one or more times.\n\n If the session is provided (hence, the deployment supports sessions),\n and modern retry writes are enabled on the client, the modern retry\n logic is invoked. Otherwise the legacy retry logic is invoked.\n\n If ending_transaction parameter is true, indicating that a transaction\n is being committed or aborted, the operation is executed exactly once.\n Note that, since transactions require sessions, this method will raise\n ArgumentError if ending_transaction is true and session is nil.\n\n @api private\n\n @example Execute the write.\n   write_with_retry do\n     ...\n   end\n\n @note This only retries operations on not master failures, since it is\n   the only case we can be sure a partial write did not already occur.\n\n @param [ nil | Session ] session Optional session to use with the operation.\n @param [ nil | Hash | WriteConcern::Base ] write_concern The write concern.\n @param [ true | false ] ending_transaction True if the write operation is abortTransaction or\n   commitTransaction, false otherwise.\n @param [ Proc ] block The block to execute.\n\n @yieldparam [ Server ] server The server to which the write should be sent.\n @yieldparam [ Integer ] txn_num Transaction number (NOT the ACID kind).\n\n @return [ Result ] The result of the operation.\n\n @since 2.1.0", "Log a warning so that any application slow down is immediately obvious.", "Force the collection to be created in the database.\n\n @example Force the collection to be created.\n   collection.create\n\n @param [ Hash ] opts The options for the create operation.\n\n @option options [ Session ] :session The session to use for the operation.\n\n @return [ Result ] The result of the command.\n\n @since 2.0.0", "Drop the collection. Will also drop all indexes associated with the\n collection.\n\n @note An error returned if the collection doesn't exist is suppressed.\n\n @example Drop the collection.\n   collection.drop\n\n @param [ Hash ] opts The options for the drop operation.\n\n @option options [ Session ] :session The session to use for the operation.\n\n @return [ Result ] The result of the command.\n\n @since 2.0.0", "Get a list of distinct values for a specific field.\n\n @example Get the distinct values.\n   collection.distinct('name')\n\n @param [ Symbol, String ] field_name The name of the field.\n @param [ Hash ] filter The documents from which to retrieve the distinct values.\n @param [ Hash ] options The distinct command options.\n\n @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command to run.\n @option options [ Hash ] :read The read preference options.\n @option options [ Hash ] :collation The collation to use.\n @option options [ Session ] :session The session to use.\n\n @return [ Array<Object> ] The list of distinct values.\n\n @since 2.1.0", "Insert a single document into the collection.\n\n @example Insert a document into the collection.\n   collection.insert_one({ name: 'test' })\n\n @param [ Hash ] document The document to insert.\n @param [ Hash ] opts The insert options.\n\n @option opts [ Session ] :session The session to use for the operation.\n\n @return [ Result ] The database response wrapper.\n\n @since 2.0.0", "Insert the provided documents into the collection.\n\n @example Insert documents into the collection.\n   collection.insert_many([{ name: 'test' }])\n\n @param [ Array<Hash> ] documents The documents to insert.\n @param [ Hash ] options The insert options.\n\n @option options [ Session ] :session The session to use for the operation.\n\n @return [ Result ] The database response wrapper.\n\n @since 2.0.0", "Replaces a single document in the collection with the new document.\n\n @example Replace a single document.\n   collection.replace_one({ name: 'test' }, { name: 'test1' })\n\n @param [ Hash ] filter The filter to use.\n @param [ Hash ] replacement The replacement document..\n @param [ Hash ] options The options.\n\n @option options [ true, false ] :upsert Whether to upsert if the\n   document doesn't exist.\n @option options [ true, false ] :bypass_document_validation Whether or\n   not to skip document level validation.\n @option options [ Hash ] :collation The collation to use.\n @option options [ Session ] :session The session to use.\n\n @return [ Result ] The response from the database.\n\n @since 2.1.0", "Update documents in the collection.\n\n @example Update multiple documents in the collection.\n   collection.update_many({ name: 'test'}, '$set' => { name: 'test1' })\n\n @param [ Hash ] filter The filter to use.\n @param [ Hash ] update The update statement.\n @param [ Hash ] options The options.\n\n @option options [ true, false ] :upsert Whether to upsert if the\n   document doesn't exist.\n @option options [ true, false ] :bypass_document_validation Whether or\n   not to skip document level validation.\n @option options [ Hash ] :collation The collation to use.\n @option options [ Array ] :array_filters A set of filters specifying to which array elements\n   an update should apply.\n @option options [ Session ] :session The session to use.\n\n @return [ Result ] The response from the database.\n\n @since 2.1.0", "Update a single document in the collection.\n\n @example Update a single document in the collection.\n   collection.update_one({ name: 'test'}, '$set' => { name: 'test1'})\n\n @param [ Hash ] filter The filter to use.\n @param [ Hash ] update The update statement.\n @param [ Hash ] options The options.\n\n @option options [ true, false ] :upsert Whether to upsert if the\n   document doesn't exist.\n @option options [ true, false ] :bypass_document_validation Whether or\n   not to skip document level validation.\n @option options [ Hash ] :collation The collation to use.\n @option options [ Array ] :array_filters A set of filters specifying to which array elements\n   an update should apply.\n @option options [ Session ] :session The session to use.\n\n @return [ Result ] The response from the database.\n\n @since 2.1.0", "Finds a single document via findAndModify and updates it, returning the original doc unless\n otherwise specified.\n\n @example Find a document and update it, returning the original.\n   collection.find_one_and_update({ name: 'test' }, { \"$set\" => { name: 'test1' }})\n\n @example Find a document and update it, returning the updated document.\n   collection.find_one_and_update({ name: 'test' }, { \"$set\" => { name: 'test1' }}, :return_document => :after)\n\n @param [ Hash ] filter The filter to use.\n @param [ BSON::Document ] update The update statement.\n @param [ Hash ] options The options.\n\n @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command\n   to run in milliseconds.\n @option options [ Hash ] :projection The fields to include or exclude in the returned doc.\n @option options [ Hash ] :sort The key and direction pairs by which the result set\n   will be sorted.\n @option options [ Symbol ] :return_document Either :before or :after.\n @option options [ true, false ] :upsert Whether to upsert if the document doesn't exist.\n @option options [ true, false ] :bypass_document_validation Whether or\n   not to skip document level validation.\n @option options [ Hash ] :write_concern The write concern options.\n   Defaults to the collection's write concern.\n @option options [ Hash ] :collation The collation to use.\n @option options [ Array ] :array_filters A set of filters specifying to which array elements\n   an update should apply.\n @option options [ Session ] :session The session to use.\n\n @return [ BSON::Document ] The document.\n\n @since 2.1.0", "Finds a single document and replaces it, returning the original doc unless\n otherwise specified.\n\n @example Find a document and replace it, returning the original.\n   collection.find_one_and_replace({ name: 'test' }, { name: 'test1' })\n\n @example Find a document and replace it, returning the new document.\n   collection.find_one_and_replace({ name: 'test' }, { name: 'test1' }, :return_document => :after)\n\n @param [ Hash ] filter The filter to use.\n @param [ BSON::Document ] replacement The replacement document.\n @param [ Hash ] options The options.\n\n @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command\n   to run in milliseconds.\n @option options [ Hash ] :projection The fields to include or exclude in the returned doc.\n @option options [ Hash ] :sort The key and direction pairs by which the result set\n   will be sorted.\n @option options [ Symbol ] :return_document Either :before or :after.\n @option options [ true, false ] :upsert Whether to upsert if the document doesn't exist.\n @option options [ true, false ] :bypass_document_validation Whether or\n   not to skip document level validation.\n @option options [ Hash ] :write_concern The write concern options.\n   Defaults to the collection's write concern.\n @option options [ Hash ] :collation The collation to use.\n @option options [ Session ] :session The session to use.\n\n @return [ BSON::Document ] The document.\n\n @since 2.1.0", "render bad params to user\n @overload render_bad_parameters()\n   render bad_parameters with `default_message` and status `400`\n @overload render_bad_parameters(message)\n   render bad_parameters with `message` and status `400`\n   @param [String] message\n @overload render_bad_parameters(error)\n   render bad_parameters with `error.message` and `error.status_code` if present\n   @param [Exception] error\n @overload render_bad_parameters(error, message)\n   add `message` to overload `exception.message`\n   @param [String] message\n   @param [Exception] error", "used in unit tests", "creates new env from create_params with self as a prior", "Unlike path which only gives the path from this environment going forward\n  Get the full path, that is go to the HEAD of the path this environment is on\n  and then give me that entire path", "Generic method to provide a list of options in the UI", "loop through checkbox list of products and sync", "Returns true if the pulp_task_id was triggered by the last synchronization\n action for the repository. Dynflow action handles the synchronization\n by it's own so no need to synchronize it again in this callback. Since the\n callbacks are run just after synchronization is finished, it should be enough\n to check for the last synchronization task.", "deleteable? is already taken by the authorization mixin", "Warning this call wipes out existing associations\n And replaces them with the component version ids passed in.", "get the library instances of all repos within this view", "Associate an environment with this content view.  This can occur whenever\n a version of the view is promoted to an environment.  It is necessary for\n candlepin to become aware that the view is available for consumers.", "Unassociate an environment from this content view. This can occur whenever\n a view is deleted from an environment. It is necessary to make candlepin\n aware that the view is no longer available for consumers.", "Possible formats coming from pulp\n\n We ignore this case:\n   {'finished_count' => {}}\n\n We extract from this case:\n   {'content' => {'error' => ''},\n    'errata' => {'error' => ''},\n    'packages' => {'error' => ''},\n    'metadata' => {'error_details => ''}\n   }", "returns copy of data stored", "Update remotes\n Perform validation", "Subscribe to one or more topics letting Kafka handle partition assignments.\n\n @param topics [Array<String>] One or more topic names\n\n @raise [RdkafkaError] When subscribing fails\n\n @return [nil]", "Unsubscribe from all subscribed topics.\n\n @raise [RdkafkaError] When unsubscribing fails\n\n @return [nil]", "Pause producing or consumption for the provided list of partitions\n\n @param list [TopicPartitionList] The topic with partitions to pause\n\n @raise [RdkafkaTopicPartitionListError] When pausing subscription fails.\n\n @return [nil]", "Resume producing consumption for the provided list of partitions\n\n @param list [TopicPartitionList] The topic with partitions to pause\n\n @raise [RdkafkaError] When resume subscription fails.\n\n @return [nil]", "Return the current subscription to topics and partitions\n\n @raise [RdkafkaError] When getting the subscription fails.\n\n @return [TopicPartitionList]", "Atomic assignment of partitions to consume\n\n @param list [TopicPartitionList] The topic with partitions to assign\n\n @raise [RdkafkaError] When assigning fails", "Return the current committed offset per partition for this consumer group.\n The offset field of each requested partition will either be set to stored offset or to -1001 in case there was no stored offset for that partition.\n\n @param list [TopicPartitionList, nil] The topic with partitions to get the offsets for or nil to use the current subscription.\n @param timeout_ms [Integer] The timeout for fetching this information.\n\n @raise [RdkafkaError] When getting the committed positions fails.\n\n @return [TopicPartitionList]", "Store offset of a message to be used in the next commit of this consumer\n\n When using this `enable.auto.offset.store` should be set to `false` in the config.\n\n @param message [Rdkafka::Consumer::Message] The message which offset will be stored\n\n @raise [RdkafkaError] When storing the offset fails\n\n @return [nil]", "Commit the current offsets of this consumer\n\n @param list [TopicPartitionList,nil] The topic with partitions to commit\n @param async [Boolean] Whether to commit async or wait for the commit to finish\n\n @raise [RdkafkaError] When comitting fails\n\n @return [nil]", "Poll for the next message on one of the subscribed topics\n\n @param timeout_ms [Integer] Timeout of this poll\n\n @raise [RdkafkaError] When polling fails\n\n @return [Message, nil] A message or nil if there was no new message within the timeout", "Create a consumer with this configuration.\n\n @raise [ConfigError] When the configuration contains invalid options\n @raise [ClientCreationError] When the native client cannot be created\n\n @return [Consumer] The created consumer", "Create a producer with this configuration.\n\n @raise [ConfigError] When the configuration contains invalid options\n @raise [ClientCreationError] When the native client cannot be created\n\n @return [Producer] The created producer", "This method is only intented to be used to create a client,\n using it in another way will leak memory.", "Searches upwards from current working directory for the given target file.\n\n @param target [String] Name of file to search for.\n @param start_dir [String] Directory to start searching from, defaults to Dir.pwd\n\n @return [String, nil] Fully qualified path to the given target file if found,\n   nil if the target file could not be found.", "Generate a name for a temporary directory.\n\n @param base [String] A string to base the name generation off.\n\n @return [String] The temporary directory path.", "Return an expanded, absolute path\n\n @param path [String] Existing path that may not be canonical\n\n @return [String] Canonical path", "Returns the fully qualified path to a per-user PDK cachedir.\n\n @return [String] Fully qualified path to per-user PDK cachedir.", "Returns path to the root of the module being worked on.\n\n @return [String, nil] Fully qualified base path to module, or nil if\n   the current working dir does not appear to be within a module.", "Iterate through possible JSON documents until we find one that is valid.\n\n @param [String] text the text in which to find a JSON document\n @param [Hash] opts options\n @option opts [Boolean] :break_on_first Whether or not to break after valid JSON is found, defaults to true\n\n @return [Hash, Array<Hash>, nil] subset of text as Hash of first valid JSON found, array of all valid JSON found, or nil if no valid\n   JSON found in the text\n\n @private", "Returns the targets' paths relative to the working directory\n\n @return [Array<String>] The absolute or path to the target", "Renders the report as a JUnit XML document.\n\n @param target [#write] an IO object that the report will be written to.\n   Defaults to PDK::Report.default_target.", "Renders the report as plain text.\n\n This report is designed for interactive use by a human and so excludes\n all passing events in order to be consise.\n\n @param target [#write] an IO object that the report will be written to.\n   Defaults to PDK::Report.default_target.", "Update the stored answers in memory and then save them to disk.\n\n @param new_answers [Hash{String => Object}] The new questions and answers\n   to be merged into the existing answers.\n\n @raise [PDK::CLI::FatalError] if the new answers are not provided as\n   a Hash.\n @raise (see #save_to_disk)", "Read existing answers into memory from the answer file on disk.\n\n @raise [PDK::CLI::FatalError] If the answer file exists but can not be\n   read.\n\n @return [Hash{String => Object}] The existing questions and answers.", "Save the in memory answer set to the answer file on disk.\n\n @raise [PDK::CLI::FatalError] if the answer file can not be written to.", "Reads the content of the template file into memory.\n\n @return [String] The content of the template file.\n\n @raise [ArgumentError] If the template file does not exist or can not be\n read.\n\n @api private", "Renders the content of the template file as an ERB template.\n\n @return [String] The rendered template.\n\n @raise (see #template_content)\n\n @api private", "If the attribute is not set, add it\n If the attribute is set, don't overwrite the existing value", "Returns a plain-text version of the markup contained by the document,\n  with HTML entities encoded.\n\n  This method is significantly faster than #to_text, but isn't\n  clever about whitespace around block elements.\n\n    Loofah.document(\"<h1>Title</h1><div>Content</div>\").text\n    # => \"TitleContent\"\n\n  By default, the returned text will have HTML entities\n  escaped. If you want unescaped entities, and you understand\n  that the result is unsafe to render in a browser, then you\n  can pass an argument as shown:\n\n    frag = Loofah.fragment(\"&lt;script&gt;alert('EVIL');&lt;/script&gt;\")\n    # ok for browser:\n    frag.text                                 # => \"&lt;script&gt;alert('EVIL');&lt;/script&gt;\"\n    # decidedly not ok for browser:\n    frag.text(:encode_special_chars => false) # => \"<script>alert('EVIL');</script>\"", "Add an option.\n\n Options are parsed via OptionParser so view it\n for additional usage documentation. A block may optionally be\n passed to handle the option, otherwise the _options_ struct seen below\n contains the results of this option. This handles common formats such as:\n\n   -h, --help          options.help           # => bool\n   --[no-]feature      options.feature        # => bool\n   --large-switch      options.large_switch   # => bool\n   --file FILE         options.file           # => file passed\n   --list WORDS        options.list           # => array\n   --date [DATE]       options.date           # => date or nil when optional argument not set\n\n === Examples\n\n   command :something do |c|\n     c.option '--recursive', 'Do something recursively'\n     c.option '--file FILE', 'Specify a file'\n     c.option('--info', 'Display info') { puts \"handle with block\" }\n     c.option '--[no-]feature', 'With or without feature'\n     c.option '--list FILES', Array, 'List the files specified'\n\n     c.when_called do |args, options|\n       do_something_recursively if options.recursive\n       do_something_with_file options.file if options.file\n     end\n   end\n\n === Help Formatters\n\n This method also parses the arguments passed in order to determine\n which were switches, and which were descriptions for the\n option which can later be used within help formatters\n using option[:switches] and option[:description].\n\n === Input Parsing\n\n Since Commander utilizes OptionParser you can pre-parse and evaluate\n option arguments. Simply require 'optparse/time', or 'optparse/date', as these\n objects must respond to #parse.\n\n   c.option '--time TIME', Time\n   c.option '--date [DATE]', Date", "Call the commands when_called block with _args_.", "Run command parsing and execution process.", "Assign program information.\n\n === Examples\n\n   # Set data\n   program :name, 'Commander'\n   program :version, Commander::VERSION\n   program :description, 'Commander utility program.'\n   program :help, 'Copyright', '2008 TJ Holowaychuk'\n   program :help, 'Anything', 'You want'\n   program :int_message 'Bye bye!'\n   program :help_formatter, :compact\n   program :help_formatter, Commander::HelpFormatter::TerminalCompact\n\n   # Get data\n   program :name # => 'Commander'\n\n === Keys\n\n   :version         (required) Program version triple, ex: '0.0.1'\n   :description     (required) Program description\n   :name            Program name, defaults to basename of executable\n   :help_formatter  Defaults to Commander::HelpFormatter::Terminal\n   :help            Allows addition of arbitrary global help blocks\n   :help_paging     Flag for toggling help paging\n   :int_message     Message to display when interrupted (CTRL + C)", "Alias command _name_ with _alias_name_. Optionally _args_ may be passed\n as if they were being passed straight to the original command via the command-line.", "Return arguments without the command name.", "Removes global _options_ from _args_. This prevents an invalid\n option error from occurring when options are parsed\n again for the command.", "Parse global command options.", "Raises a CommandError when the program any of the _keys_ are not present, or empty.", "Run the active command.", "Prompt an editor for input. Optionally supply initial\n _input_ which is written to the editor.\n\n _preferred_editor_ can be hinted.\n\n === Examples\n\n   ask_editor                # => prompts EDITOR with no input\n   ask_editor('foo')         # => prompts EDITOR with default text of 'foo'\n   ask_editor('foo', 'mate -w')  # => prompts TextMate with default text of 'foo'", "Enable paging of output after called.", "Output progress while iterating _arr_.\n\n === Examples\n\n   uris = %w( http://vision-media.ca http://google.com )\n   progress uris, :format => \"Remaining: :time_remaining\" do |uri|\n     res = open uri\n   end", "Substitute _hash_'s keys with their associated values in _str_.", "The ruby aws-sdk expects symbols for keys and AWS docs for the task\n definition uses json camelCase for the keys.  This method transforms\n the keys to the expected ruby aws-sdk format.\n\n One quirk is that the logConfiguration options casing should not be\n transformed.", "If the running count less than the desired account yet, check the events\n and show a message with helpful debugging information.", "Resovles infinite problem since Ufo.env can be determined from UFO_ENV or settings.yml files.\n When ufo is determined from settings it should not called Ufo.env since that in turn calls\n Settings.new.data which can then cause an infinite loop.", "All we're doing at this point is saving blocks of code into memory\n The instance_eval provides the task_definition and helper methods as they are part\n of this class.", "Prints out a user friendly task_definition error message", "do not memoize template_body it can change for a rename retry", "Store template in tmp in case for debugging", "Start a thread that will poll for ecs deployments and kill of tasks\n in old deployments.\n This must be done in a thread because the stack update process is blocking.", "Passing in service so method can be used else where.", "all top-level commands", "used for the ufo status command", "adjust network_configuration based on fargate and network mode of awsvpc", "Ensures at least 1 security group is assigned if awsvpc_configuration\n is provided.", "Decorates AR model object's association only when the object was decorated.\n Returns the association instance.", "Returns a decorator module for the given class.\n Returns `nil` if no decorator module was found.", "Delete an existing certificate order.\n\n Delete an existing certificate order.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param certificate_order_name [String] Name of the certificate order.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Resend certificate email.\n\n Resend certificate email.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param certificate_order_name [String] Name of the certificate order.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Retrieve the list of certificate actions.\n\n Retrieve the list of certificate actions.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the certificate order.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Retrieve email history.\n\n Retrieve email history.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the certificate order.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Get certificate orders in a resource group.\n\n Get certificate orders in a resource group.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AppServiceCertificateOrderCollection] operation results.", "Gets the specified virtual network peering.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_name [String] The name of the virtual network.\n @param virtual_network_peering_name [String] The name of the virtual network\n peering.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all virtual network peerings in a virtual network.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_name [String] The name of the virtual network.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<VirtualNetworkPeering>] operation results.", "Verifies for unexpected polling status code\n @param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.", "Updates polling state based on location header for PUT HTTP requests.\n @param request [MsRest::HttpOperationRequest] The url retrieve data from.\n @param polling_state [MsRestAzure::PollingState] polling state to update.\n @param custom_deserialization_block [Proc] custom deserialization method for parsing response.", "Updates polling state based on location header for HTTP requests.\n @param request [MsRest::HttpOperationRequest] The url retrieve data from.\n @param polling_state [MsRestAzure::PollingState] polling state to update.\n @param custom_deserialization_block [Proc] custom deserialization method for parsing response.\n @param final_state_via [MsRestAzure::FinalStateVia] Final State via value", "Updates polling state from Azure async operation header.\n @param polling_state [MsRestAzure::PollingState] polling state.", "Configures email notifications for this vault.\n\n Create or update an email notification(alert) configuration.\n\n @param alert_setting_name [String] The name of the email notification(alert)\n configuration.\n @param request [ConfigureAlertRequest] The input to configure the email\n notification(alert).\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Alert] operation results.", "Creates or updates a record set within a Private DNS zone.\n\n @param resource_group_name [String] The name of the resource group.\n @param private_zone_name [String] The name of the Private DNS zone (without a\n terminating dot).\n @param record_type [RecordType] The type of DNS record in this record set.\n Record sets of type SOA can be updated but not created (they are created when\n the Private DNS zone is created). Possible values include: 'A', 'AAAA',\n 'CNAME', 'MX', 'PTR', 'SOA', 'SRV', 'TXT'\n @param relative_record_set_name [String] The name of the record set, relative\n to the name of the zone.\n @param parameters [RecordSet] Parameters supplied to the CreateOrUpdate\n operation.\n @param if_match [String] The ETag of the record set. Omit this value to\n always overwrite the current record set. Specify the last-seen ETag value to\n prevent accidentally overwriting any concurrent changes.\n @param if_none_match [String] Set to '*' to allow a new record set to be\n created, but to prevent updating an existing record set. Other values will be\n ignored.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all record sets in a Private DNS zone.\n\n @param resource_group_name [String] The name of the resource group.\n @param private_zone_name [String] The name of the Private DNS zone (without a\n terminating dot).\n @param top [Integer] The maximum number of record sets to return. If not\n specified, returns up to 100 record sets.\n @param recordsetnamesuffix [String] The suffix label of the record set name\n to be used to filter the record set enumeration. If this parameter is\n specified, the returned enumeration will only contain records that end with\n \".<recordsetnamesuffix>\".\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets information about a configuration of server.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param configuration_name [String] The name of the server configuration.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a ServerEndpoint.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param sync_group_name [String] Name of Sync Group resource.\n @param server_endpoint_name [String] Name of Server Endpoint object.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a given ServerEndpoint.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param sync_group_name [String] Name of Sync Group resource.\n @param server_endpoint_name [String] Name of Server Endpoint object.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Makes a request and returns the operation response.\n @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.\n @param path [String] the path, relative to {base_url}.\n @param options [Hash{String=>String}] specifying any request options like :body.\n @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.", "Makes a request asynchronously.\n @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.\n @param path [String] the path, relative to {base_url}.\n @param options [Hash{String=>String}] specifying any request options like :body.\n @return [Concurrent::Promise] Promise object which holds the HTTP response.", "This interface is used for getting text operation result. The URL to this\n interface should be retrieved from 'Operation-Location' field returned from\n Recognize Text interface.\n\n @param operation_id [String] Id of the text operation returned in the\n response of the 'Recognize Text'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TextOperationResult] operation results.", "This interface is used for getting OCR results of Read operation. The URL to\n this interface should be retrieved from \"Operation-Location\" field returned\n from Batch Read File interface.\n\n @param operation_id [String] Id of read operation returned in the response of\n the \"Batch Read File\" interface.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ReadOperationResult] operation results.", "Update an existing Redis cache.\n\n @param resource_group_name [String] The name of the resource group.\n @param name [String] The name of the Redis cache.\n @param parameters [RedisUpdateParameters] Parameters supplied to the Update\n Redis operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve a Redis cache's access keys. This operation requires write\n permission to the cache resource.\n\n @param resource_group_name [String] The name of the resource group.\n @param name [String] The name of the Redis cache.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RedisAccessKeys] operation results.", "Create or update a redis cache firewall rule\n\n @param resource_group_name [String] The name of the resource group.\n @param cache_name [String] The name of the Redis cache.\n @param rule_name [String] The name of the firewall rule.\n @param parameters [RedisFirewallRule] Parameters supplied to the create or\n update redis firewall rule operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a single firewall rule in a specified redis cache.\n\n @param resource_group_name [String] The name of the resource group.\n @param cache_name [String] The name of the Redis cache.\n @param rule_name [String] The name of the firewall rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a single firewall rule in a specified redis cache.\n\n @param resource_group_name [String] The name of the resource group.\n @param cache_name [String] The name of the Redis cache.\n @param rule_name [String] The name of the firewall rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an existing CDN custom domain within an endpoint.\n\n @param custom_domain_name [String] Name of the custom domain within an\n endpoint.\n @param endpoint_name [String] Name of the endpoint within the CDN profile.\n @param profile_name [String] Name of the CDN profile within the resource\n group.\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CustomDomain] operation results.", "Updates a record set within a DNS zone.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param zone_name [String] The name of the DNS zone (without a terminating\n dot).\n @param relative_record_set_name [String] The name of the record set, relative\n to the name of the zone.\n @param record_type [RecordType] The type of DNS record in this record set.\n Possible values include: 'A', 'AAAA', 'CAA', 'CNAME', 'MX', 'NS', 'PTR',\n 'SOA', 'SRV', 'TXT'\n @param parameters [RecordSet] Parameters supplied to the Update operation.\n @param if_match [String] The etag of the record set. Omit this value to\n always overwrite the current record set. Specify the last-seen etag value to\n prevent accidentally overwritting concurrent changes.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a record set from a DNS zone. This operation cannot be undone.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param zone_name [String] The name of the DNS zone (without a terminating\n dot).\n @param relative_record_set_name [String] The name of the record set, relative\n to the name of the zone.\n @param record_type [RecordType] The type of DNS record in this record set.\n Record sets of type SOA cannot be deleted (they are deleted when the DNS zone\n is deleted). Possible values include: 'A', 'AAAA', 'CAA', 'CNAME', 'MX',\n 'NS', 'PTR', 'SOA', 'SRV', 'TXT'\n @param if_match [String] The etag of the record set. Omit this value to\n always delete the current record set. Specify the last-seen etag value to\n prevent accidentally deleting any concurrent changes.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Initializes a new instance of the RetryPolicyMiddleware class.\n\n\n Performs request and response processing.", "Gets a list of all VM Scale Sets in the subscription, regardless of the\n associated resource group. Use nextLink property in the response to get the\n next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM\n Scale Sets.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VirtualMachineScaleSetListWithLinkResult] operation results.", "Gets a packet capture session by name.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_watcher_name [String] The name of the network watcher.\n @param packet_capture_name [String] The name of the packet capture session.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified packet capture session.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_watcher_name [String] The name of the network watcher.\n @param packet_capture_name [String] The name of the packet capture session.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a service namespace. Once created, this namespace's resource manifest\n is immutable. This operation is idempotent.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param parameters [NamespaceUpdateParameters] Parameters supplied to update a\n namespace resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a namespace authorization rule.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param authorization_rule_name [String] The authorization rule name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates or updates a service namespace. Once created, this namespace's\n resource manifest is immutable. This operation is idempotent.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name.\n @param parameters [NamespaceCreateOrUpdateParameters] Parameters supplied to\n create a namespace resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an existing namespace. This operation also removes all associated\n resources under the namespace.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets all the available namespaces within the subscription, irrespective of\n the resource groups.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [NamespaceListResult] operation results.", "Creates a new version from the selected version.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param version_clone_object [TaskUpdateObject] A model containing the new\n version ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [String] operation results.\n\n\n Creates a new version from the selected version.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param version_clone_object [TaskUpdateObject] A model containing the new\n version ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a list of versions for this application ID.\n\n @param app_id The application ID.\n @param skip [Integer] The number of entries to skip. Default value is 0.\n @param take [Integer] The number of entries to return. Maximum page size is\n 500. Default is 100.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Exports a LUIS application to JSON format.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [LuisApp] operation results.", "Updates container properties as specified in request body. Properties not\n mentioned in the request will be unchanged. Update fails if the specified\n container doesn't already exist.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription. The name is case insensitive.\n @param account_name [String] The name of the storage account within the\n specified resource group. Storage account names must be between 3 and 24\n characters in length and use numbers and lower-case letters only.\n @param container_name [String] The name of the blob container within the\n specified storage account. Blob container names must be between 3 and 63\n characters in length and use numbers, lower-case letters and dash (-) only.\n Every dash (-) character must be immediately preceded and followed by a\n letter or number.\n @param blob_container [BlobContainer] Properties to update for the blob\n container.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets properties of a specified container.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription. The name is case insensitive.\n @param account_name [String] The name of the storage account within the\n specified resource group. Storage account names must be between 3 and 24\n characters in length and use numbers and lower-case letters only.\n @param container_name [String] The name of the blob container within the\n specified storage account. Blob container names must be between 3 and 63\n characters in length and use numbers, lower-case letters and dash (-) only.\n Every dash (-) character must be immediately preceded and followed by a\n letter or number.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes specified container under its account.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription. The name is case insensitive.\n @param account_name [String] The name of the storage account within the\n specified resource group. Storage account names must be between 3 and 24\n characters in length and use numbers and lower-case letters only.\n @param container_name [String] The name of the blob container within the\n specified storage account. Blob container names must be between 3 and 63\n characters in length and use numbers, lower-case letters and dash (-) only.\n Every dash (-) character must be immediately preceded and followed by a\n letter or number.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "The delete networkInterface operation deletes the specified networkInterface.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_interface_name [String] The name of the network interface.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets NetworkRuleSet for a Namespace.\n\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param namespace_name [String] The Namespace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [NetworkRuleSet] operation results.", "Gets all the stats from an express route circuit in a resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the express route circuit.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ExpressRouteCircuitStats] operation results.", "Deletes the specified express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the express route circuit.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates or updates an express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the circuit.\n @param parameters [ExpressRouteCircuit] Parameters supplied to the create or\n update express route circuit operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates an express route circuit tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the circuit.\n @param parameters [TagsObject] Parameters supplied to update express route\n circuit tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the currently advertised routes table associated with the express route\n circuit in a resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the express route circuit.\n @param peering_name [String] The name of the peering.\n @param device_path [String] The path of the device.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified ExpressRouteConnection.\n\n @param resource_group_name [String] The name of the resource group.\n @param express_route_gateway_name [String] The name of the ExpressRoute\n gateway.\n @param connection_name [String] The name of the ExpressRoute connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a workflow trigger history.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param trigger_name [String] The workflow trigger name.\n @param history_name [String] The workflow trigger history name. Corresponds\n to the run name for triggers that resulted in a run.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the Service Fabric cluster manifest.\n\n Get the Service Fabric cluster manifest. The cluster manifest contains\n properties of the cluster that include different node types on the cluster,\n security configurations, fault and upgrade domain topologies, etc.\n\n These properties are specified as part of the ClusterConfig.JSON file while\n deploying a stand alone cluster. However, most of the information in the\n cluster manifest\n is generated internally by service fabric during cluster deployment in other\n deployment scenarios (e.g. when using azure portal).\n\n The contents of the cluster manifest are for informational purposes only and\n users are not expected to take a dependency on the format of the file\n contents or its interpretation.\n\n @param timeout [Integer] The server timeout for performing the operation in\n seconds. This timeout specifies the time duration that the client is willing\n to wait for the requested operation to complete. The default value for this\n parameter is 60 seconds.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ClusterManifest] operation results.", "Gets the progress of the current cluster upgrade.\n\n Gets the current progress of the ongoing cluster upgrade. If no upgrade is\n currently in progress, gets the last state of the previous cluster upgrade.\n\n @param timeout [Integer] The server timeout for performing the operation in\n seconds. This timeout specifies the time duration that the client is willing\n to wait for the requested operation to complete. The default value for this\n parameter is 60 seconds.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ClusterUpgradeProgressObject] operation results.", "Get the cluster configuration upgrade status of a Service Fabric standalone\n cluster.\n\n Get the cluster configuration upgrade status details of a Service Fabric\n standalone cluster.\n\n @param timeout [Integer] The server timeout for performing the operation in\n seconds. This timeout specifies the time duration that the client is willing\n to wait for the requested operation to complete. The default value for this\n parameter is 60 seconds.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ClusterConfigurationUpgradeStatusInfo] operation results.", "Get the service state of Service Fabric Upgrade Orchestration Service.\n\n Get the service state of Service Fabric Upgrade Orchestration Service. This\n API is internally used for support purposes.\n\n @param timeout [Integer] The server timeout for performing the operation in\n seconds. This timeout specifies the time duration that the client is willing\n to wait for the requested operation to complete. The default value for this\n parameter is 60 seconds.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [UpgradeOrchestrationServiceState] operation results.", "Gets the Azure Active Directory metadata used for secured connection to\n cluster.\n\n Gets the Azure Active Directory metadata used for secured connection to\n cluster.\n This API is not supposed to be called separately. It provides information\n needed to set up an Azure Active Directory secured connection with a Service\n Fabric cluster.\n\n @param timeout [Integer] The server timeout for performing the operation in\n seconds. This timeout specifies the time duration that the client is willing\n to wait for the requested operation to complete. The default value for this\n parameter is 60 seconds.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AadMetadataObject] operation results.", "Creates a new repair task.\n\n For clusters that have the Repair Manager Service configured,\n this API provides a way to create repair tasks that run automatically or\n manually.\n For repair tasks that run automatically, an appropriate repair executor\n must be running for each repair action to run automatically.\n These are currently only available in specially-configured Azure Cloud\n Services.\n\n To create a manual repair task, provide the set of impacted node names and\n the\n expected impact. When the state of the created repair task changes to\n approved,\n you can safely perform repair actions on those nodes.\n\n This API supports the Service Fabric platform; it is not meant to be used\n directly from your code.\n\n @param repair_task [RepairTask] Describes the repair task to be created or\n updated.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RepairTaskUpdateInfo] operation results.", "Requests the cancellation of the given repair task.\n\n This API supports the Service Fabric platform; it is not meant to be used\n directly from your code.\n\n @param repair_task_cancel_description [RepairTaskCancelDescription] Describes\n the repair task to be cancelled.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RepairTaskUpdateInfo] operation results.", "Forces the approval of the given repair task.\n\n This API supports the Service Fabric platform; it is not meant to be used\n directly from your code.\n\n @param repair_task_approve_description [RepairTaskApproveDescription]\n Describes the repair task to be approved.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RepairTaskUpdateInfo] operation results.", "Updates the health policy of the given repair task.\n\n This API supports the Service Fabric platform; it is not meant to be used\n directly from your code.\n\n @param repair_task_update_health_policy_description\n [RepairTaskUpdateHealthPolicyDescription] Describes the repair task healthy\n policy to be updated.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RepairTaskUpdateInfo] operation results.", "Updates the execution state of a repair task.\n\n This API supports the Service Fabric platform; it is not meant to be used\n directly from your code.\n\n @param repair_task [RepairTask] Describes the repair task to be created or\n updated.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RepairTaskUpdateInfo] operation results.", "Get the status of Chaos.\n\n Get the status of Chaos indicating whether or not Chaos is running, the Chaos\n parameters used for running Chaos and the status of the Chaos Schedule.\n\n @param timeout [Integer] The server timeout for performing the operation in\n seconds. This timeout specifies the time duration that the client is willing\n to wait for the requested operation to complete. The default value for this\n parameter is 60 seconds.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Chaos] operation results.", "Get the Chaos Schedule defining when and how to run Chaos.\n\n Gets the version of the Chaos Schedule in use and the Chaos Schedule that\n defines when and how to run Chaos.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ChaosScheduleDescription] operation results.", "Gets the content information at the root of the image store.\n\n Returns the information about the image store content at the root of the\n image store.\n\n @param timeout [Integer] The server timeout for performing the operation in\n seconds. This timeout specifies the time duration that the client is willing\n to wait for the requested operation to complete. The default value for this\n parameter is 60 seconds.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ImageStoreContent] operation results.", "Get a given registered server list.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RegisteredServerArray] operation results.", "Get a given registered server.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param server_id [String] GUID identifying the on-premises server.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates the backup schedule.\n\n @param device_name [String] The device name\n @param backup_policy_name [String] The backup policy name.\n @param backup_schedule_name [String] The backup schedule name.\n @param parameters [BackupSchedule] The backup schedule.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [BackupSchedule] operation results.", "Deletes a managed instance.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the properties of the specified webhook.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param webhook_name [String] The name of the webhook.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all the webhooks for the specified container registry.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<Webhook>] operation results.", "Deletes a webhook from a container registry.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param webhook_name [String] The name of the webhook.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all the inbound nat rules in a load balancer.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<InboundNatRule>] operation results.", "Gets the specified load balancer inbound nat rule.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param inbound_nat_rule_name [String] The name of the inbound nat rule.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a key of any type from storage in Azure Key Vault.\n\n The delete key operation cannot be used to remove individual versions of a\n key. This operation removes the cryptographic material associated with the\n key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or\n Encrypt/Decrypt operations. This operation requires the keys/delete\n permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param key_name [String] The name of the key to delete.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeletedKeyBundle] operation results.", "Requests that a backup of the specified key be downloaded to the client.\n\n The Key Backup operation exports a key from Azure Key Vault in a protected\n form. Note that this operation does NOT return key material in a form that\n can be used outside the Azure Key Vault system, the returned key material is\n either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The\n intent of this operation is to allow a client to GENERATE a key in one Azure\n Key Vault instance, BACKUP the key, and then RESTORE it into another Azure\n Key Vault instance. The BACKUP operation may be used to export, in protected\n form, any key type from Azure Key Vault. Individual versions of a key cannot\n be backed up. BACKUP / RESTORE can be performed within geographical\n boundaries only; meaning that a BACKUP from one geographical area cannot be\n restored to another geographical area. For example, a backup from the US\n geographical area cannot be restored in an EU geographical area. This\n operation requires the key/backup permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param key_name [String] The name of the key.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [BackupKeyResult] operation results.", "Restores a backed up key to a vault.\n\n Imports a previously backed up key into Azure Key Vault, restoring the key,\n its key identifier, attributes and access control policies. The RESTORE\n operation may be used to import a previously backed up key. Individual\n versions of a key cannot be restored. The key is restored in its entirety\n with the same key name as it had when it was backed up. If the key name is\n not available in the target Key Vault, the RESTORE operation will be\n rejected. While the key name is retained during restore, the final key\n identifier will change if the key is restored to a different vault. Restore\n will restore all versions and preserve version identifiers. The RESTORE\n operation is subject to security constraints: The target Key Vault must be\n owned by the same Microsoft Azure Subscription as the source Key Vault The\n user must have RESTORE permission in the target Key Vault. This operation\n requires the keys/restore permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param key_bundle_backup The backup blob associated with a key bundle.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [KeyBundle] operation results.", "Gets the public part of a deleted key.\n\n The Get Deleted Key operation is applicable for soft-delete enabled vaults.\n While the operation can be invoked on any vault, it will return an error if\n invoked on a non soft-delete enabled vault. This operation requires the\n keys/get permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param key_name [String] The name of the key.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeletedKeyBundle] operation results.", "Permanently deletes the specified key.\n\n The Purge Deleted Key operation is applicable for soft-delete enabled vaults.\n While the operation can be invoked on any vault, it will return an error if\n invoked on a non soft-delete enabled vault. This operation requires the\n keys/purge permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param key_name [String] The name of the key\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Recovers the deleted key to its latest version.\n\n The Recover Deleted Key operation is applicable for deleted keys in\n soft-delete enabled vaults. It recovers the deleted key back to its latest\n version under /keys. An attempt to recover an non-deleted key will return an\n error. Consider this the inverse of the delete operation on soft-delete\n enabled vaults. This operation requires the keys/recover permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param key_name [String] The name of the deleted key.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [KeyBundle] operation results.", "Deletes a secret from a specified key vault.\n\n The DELETE operation applies to any secret stored in Azure Key Vault. DELETE\n cannot be applied to an individual version of a secret. This operation\n requires the secrets/delete permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param secret_name [String] The name of the secret.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeletedSecretBundle] operation results.", "Gets the specified deleted secret.\n\n The Get Deleted Secret operation returns the specified deleted secret along\n with its attributes. This operation requires the secrets/get permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param secret_name [String] The name of the secret.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeletedSecretBundle] operation results.", "Permanently deletes the specified secret.\n\n The purge deleted secret operation removes the secret permanently, without\n the possibility of recovery. This operation can only be enabled on a\n soft-delete enabled vault. This operation requires the secrets/purge\n permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param secret_name [String] The name of the secret.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Recovers the deleted secret to the latest version.\n\n Recovers the deleted secret in the specified vault. This operation can only\n be performed on a soft-delete enabled vault. This operation requires the\n secrets/recover permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param secret_name [String] The name of the deleted secret.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SecretBundle] operation results.", "Backs up the specified secret.\n\n Requests that a backup of the specified secret be downloaded to the client.\n All versions of the secret will be downloaded. This operation requires the\n secrets/backup permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param secret_name [String] The name of the secret.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [BackupSecretResult] operation results.", "Restores a backed up secret to a vault.\n\n Restores a backed up secret, and all its versions, to a vault. This operation\n requires the secrets/restore permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param secret_bundle_backup The backup blob associated with a secret bundle.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SecretBundle] operation results.", "Deletes a certificate from a specified key vault.\n\n Deletes all versions of a certificate object along with its associated\n policy. Delete certificate cannot be used to remove individual versions of a\n certificate object. This operation requires the certificates/delete\n permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param certificate_name [String] The name of the certificate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeletedCertificateBundle] operation results.", "Sets the certificate contacts for the specified key vault.\n\n Sets the certificate contacts for the specified key vault. This operation\n requires the certificates/managecontacts permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param contacts [Contacts] The contacts for the key vault certificate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Contacts] operation results.", "Lists the certificate contacts for a specified key vault.\n\n The GetCertificateContacts operation returns the set of certificate contact\n resources in the specified key vault. This operation requires the\n certificates/managecontacts permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Contacts] operation results.", "Deletes the certificate contacts for a specified key vault.\n\n Deletes the certificate contacts for a specified key vault certificate. This\n operation requires the certificates/managecontacts permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Contacts] operation results.", "Lists the specified certificate issuer.\n\n The GetCertificateIssuer operation returns the specified certificate issuer\n resources in the specified key vault. This operation requires the\n certificates/manageissuers/getissuers permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param issuer_name [String] The name of the issuer.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [IssuerBundle] operation results.", "Deletes the specified certificate issuer.\n\n The DeleteCertificateIssuer operation permanently removes the specified\n certificate issuer from the vault. This operation requires the\n certificates/manageissuers/deleteissuers permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param issuer_name [String] The name of the issuer.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [IssuerBundle] operation results.", "Lists the policy for a certificate.\n\n The GetCertificatePolicy operation returns the specified certificate policy\n resources in the specified key vault. This operation requires the\n certificates/get permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param certificate_name [String] The name of the certificate in a given key\n vault.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CertificatePolicy] operation results.", "Gets the creation operation of a certificate.\n\n Gets the creation operation associated with a specified certificate. This\n operation requires the certificates/get permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param certificate_name [String] The name of the certificate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CertificateOperation] operation results.", "Deletes the creation operation for a specific certificate.\n\n Deletes the creation operation for a specified certificate that is in the\n process of being created. The certificate is no longer created. This\n operation requires the certificates/update permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param certificate_name [String] The name of the certificate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CertificateOperation] operation results.", "Retrieves information about the specified deleted certificate.\n\n The GetDeletedCertificate operation retrieves the deleted certificate\n information plus its attributes, such as retention interval, scheduled\n permanent deletion and the current deletion recovery level. This operation\n requires the certificates/get permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param certificate_name [String] The name of the certificate\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeletedCertificateBundle] operation results.", "Permanently deletes the specified deleted certificate.\n\n The PurgeDeletedCertificate operation performs an irreversible deletion of\n the specified certificate, without possibility for recovery. The operation is\n not available if the recovery level does not specify 'Purgeable'. This\n operation requires the certificate/purge permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param certificate_name [String] The name of the certificate\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Deletes a database.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database to be deleted.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns database metric definitions.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Resumes a data warehouse.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the data warehouse to resume.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the email template specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param template_name [TemplateName] Email Template Name Identifier. Possible\n values include: 'applicationApprovedNotificationMessage',\n 'accountClosedDeveloper',\n 'quotaLimitApproachingDeveloperNotificationMessage',\n 'newDeveloperNotificationMessage', 'emailChangeIdentityDefault',\n 'inviteUserNotificationMessage', 'newCommentNotificationMessage',\n 'confirmSignUpIdentityDefault', 'newIssueNotificationMessage',\n 'purchaseDeveloperNotificationMessage', 'passwordResetIdentityDefault',\n 'passwordResetByAdminNotificationMessage',\n 'rejectDeveloperNotificationMessage', 'requestDeveloperNotificationMessage'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists a collection of properties defined within a service instance.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EmailTemplateCollection] operation results.", "Gets the properties of the specified volume container name.\n\n @param device_name [String] The device name\n @param volume_container_name [String] The name of the volume container.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the metric definitions for the specified volume container.\n\n @param device_name [String] The device name\n @param volume_container_name [String] The volume container name.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MetricDefinitionList] operation results.", "Deletes the volume container.\n\n @param device_name [String] The device name\n @param volume_container_name [String] The name of the volume container.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates an application security group.\n\n @param resource_group_name [String] The name of the resource group.\n @param application_security_group_name [String] The name of the application\n security group.\n @param parameters [ApplicationSecurityGroup] Parameters supplied to the\n create or update ApplicationSecurityGroup operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates an application security group's tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param application_security_group_name [String] The name of the application\n security group.\n @param parameters [TagsObject] Parameters supplied to update application\n security group tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List all load balancers in a network interface.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_interface_name [String] The name of the network interface.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<LoadBalancer>] operation results.", "Create a job of the runbook.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param job_id The job id.\n @param parameters [JobCreateParameters] The parameters supplied to the create\n job operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a virtual machine from a VM scale set.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_scale_set_name [String] The name of the VM scale set.\n @param instance_id [String] The instance ID of the virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a virtual machine from a VM scale set.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_scale_set_name [String] The name of the VM scale set.\n @param instance_id [String] The instance ID of the virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Starts a virtual machine in a VM scale set.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_scale_set_name [String] The name of the VM scale set.\n @param instance_id [String] The instance ID of the virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Redeploys a virtual machine in a VM scale set.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_scale_set_name [String] The name of the VM scale set.\n @param instance_id [String] The instance ID of the virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Performs maintenance on a virtual machine in a VM scale set.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_scale_set_name [String] The name of the VM scale set.\n @param instance_id [String] The instance ID of the virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve the job schedule identified by job schedule name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param job_schedule_id The job schedule name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a job schedule.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param job_schedule_id The job schedule name.\n @param parameters [JobScheduleCreateParameters] The parameters supplied to\n the create job schedule operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the properties of a specified build task.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param build_task_name [String] The name of the container registry build\n task.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a storage insight instance.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Log Analytics Workspace name that contains the\n storageInsightsConfigs resource\n @param storage_insight_name [String] Name of the storageInsightsConfigs\n resource\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a storageInsightsConfigs resource\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Log Analytics Workspace name that contains the\n storageInsightsConfigs resource\n @param storage_insight_name [String] Name of the storageInsightsConfigs\n resource\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Validate operation for specified backed up item. This is a synchronous\n operation.\n\n @param vault_name [String] The name of the recovery services vault.\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param parameters [ValidateOperationRequest] resource validate operation\n request\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get batch operation status\n\n @param user_name [String] The name of the user.\n @param operation_batch_status_payload [OperationBatchStatusPayload] Payload\n to get the status of an operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationBatchStatusResponse] operation results.", "Gets the status of long running operation\n\n @param user_name [String] The name of the user.\n @param operation_status_payload [OperationStatusPayload] Payload to get the\n status of an operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatusResponse] operation results.", "Get personal preferences for a user\n\n @param user_name [String] The name of the user.\n @param personal_preferences_operations_payload\n [PersonalPreferencesOperationsPayload] Represents payload for any Environment\n operations like get, start, stop, connect\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [GetPersonalPreferencesResponse] operation results.", "List Environments for the user\n\n @param user_name [String] The name of the user.\n @param list_environments_payload [ListEnvironmentsPayload] Represents the\n payload to list environments owned by a user\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ListEnvironmentsResponse] operation results.", "List labs for the user.\n\n @param user_name [String] The name of the user.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ListLabsResponse] operation results.", "Register a user to a managed lab\n\n @param user_name [String] The name of the user.\n @param register_payload [RegisterPayload] Represents payload for Register\n action.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Deletes the specified network profile.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_profile_name [String] The name of the NetworkProfile.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the specified network profile in a specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_profile_name [String] The name of the public IP prefix.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve the usage for the account id.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [UsageListResult] operation results.", "Gets an elastic pool.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param elastic_pool_name [String] The name of the elastic pool.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an elastic pool.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param elastic_pool_name [String] The name of the elastic pool.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves the description for the specified rule.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param topic_name [String] The topic name.\n @param subscription_name [String] The subscription name.\n @param rule_name [String] The rule name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets an integration account partner.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param partner_name [String] The integration account partner name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified public IP address in a specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param public_ip_address_name [String] The name of the subnet.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a static or dynamic public IP address.\n\n @param resource_group_name [String] The name of the resource group.\n @param public_ip_address_name [String] The name of the public IP address.\n @param parameters [PublicIPAddress] Parameters supplied to the create or\n update public IP address operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get cluster code versions by environment\n\n Get cluster code versions by environment\n\n\n @param location [String] The location for the cluster code versions, this is\n different from cluster location\n @param environment [Enum] Cluster operating system, the default means all.\n Possible values include: 'Windows', 'Linux'\n @param api_version [String] The version of the API.\n @param subscription_id [String] The customer subscription identifier\n @param cluster_version [String] The cluster code version\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List cluster code versions by location\n\n List cluster code versions by location\n\n\n @param location [String] The location for the cluster code versions, this is\n different from cluster location\n @param api_version [String] The version of the API.\n @param subscription_id [String] The customer subscription identifier\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a role assignment.\n\n @param scope [String] The scope of the role assignment to create. The scope\n can be any REST resource instance. For example, use\n '/subscriptions/{subscription-id}/' for a subscription,\n '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a\n resource group, and\n '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}'\n for a resource.\n @param role_assignment_name [String] The name of the role assignment to\n create. It can be any valid GUID.\n @param parameters [RoleAssignmentCreateParameters] Parameters for the role\n assignment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the specified role assignment.\n\n @param scope [String] The scope of the role assignment.\n @param role_assignment_name [String] The name of the role assignment to get.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RoleAssignment] operation results.", "Gets role assignments for a resource.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RoleAssignmentListResult] operation results.", "Retrieves the details of a vpn connection.\n\n @param resource_group_name [String] The resource group name of the\n VpnGateway.\n @param gateway_name [String] The name of the gateway.\n @param connection_name [String] The name of the vpn connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Checks whether resource group exists.\n\n @param resource_group_name [String] The name of the resource group to check.\n The name is case insensitive.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Boolean] operation results.", "Captures the specified resource group as a template.\n\n @param resource_group_name [String] The name of the resource group to be\n created or updated.\n @param parameters [ExportTemplateRequest] Parameters supplied to the export\n template resource group operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ResourceGroupExportResult] operation results.", "Returns all versions for the specified application type.\n\n @param subscription_id [String] The customer subscription identifier\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster resource\n @param application_type_name [String] The name of the application type name\n resource\n @param api_version [String] The version of the API.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Provisions an application type version resource.\n\n @param subscription_id [String] The customer subscription identifier\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster resource\n @param application_type_name [String] The name of the application type name\n resource\n @param version [String] The application type version.\n @param api_version [String] The version of the API.\n @param parameters [VersionResource] The application type version resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified rule from a route filter.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_filter_name [String] The name of the route filter.\n @param rule_name [String] The name of the rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets details about the specified transformation.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param transformation_name [String] The name of the transformation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Generates a Uri for use in creating a webhook.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [String] operation results.", "Retrieve the webhook identified by webhook name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param webhook_name [String] The webhook name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create the webhook identified by webhook name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param webhook_name [String] The webhook name.\n @param parameters [WebhookCreateOrUpdateParameters] The create or update\n parameters for webhook.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update the webhook identified by webhook name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param webhook_name [String] The webhook name.\n @param parameters [WebhookUpdateParameters] The update parameters for\n webhook.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a specific trigger by name.\n\n @param device_name [String] The device name.\n @param name [String] The trigger name.\n @param resource_group_name [String] The resource group name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a trigger.\n\n @param device_name [String] Creates or updates a trigger\n @param name [String] The trigger name.\n @param trigger [Trigger] The trigger.\n @param resource_group_name [String] The resource group name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists the vulnerability assessment scans of a database.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VulnerabilityAssessmentScanRecordListResult] operation results.", "Gets all peerings in a specified ExpressRouteCrossConnection.\n\n @param resource_group_name [String] The name of the resource group.\n @param cross_connection_name [String] The name of the\n ExpressRouteCrossConnection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<ExpressRouteCrossConnectionPeering>] operation results.", "Gets the specified peering for the ExpressRouteCrossConnection.\n\n @param resource_group_name [String] The name of the resource group.\n @param cross_connection_name [String] The name of the\n ExpressRouteCrossConnection.\n @param peering_name [String] The name of the peering.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an output from the streaming job.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param output_name [String] The name of the output.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets details about the specified output.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param output_name [String] The name of the output.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a protection container.\n\n Operation to create a protection container.\n\n @param fabric_name [String] Unique fabric ARM name.\n @param protection_container_name [String] Unique protection container ARM\n name.\n @param creation_input [CreateProtectionContainerInput] Creation input.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of a protectable item.\n\n The operation to get the details of a protectable item.\n\n @param fabric_name [String] Fabric name.\n @param protection_container_name [String] Protection container name.\n @param protectable_item_name [String] Protectable item name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve Azure Advisor configurations.\n\n @param resource_group [String] The name of the Azure resource group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ConfigurationListResult] operation results.", "List event types\n\n List event types for a topic type\n\n @param topic_type_name [String] Name of the topic type\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EventTypesListResult] operation results.", "Deletes the specified load balancer.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates or updates a load balancer.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param parameters [LoadBalancer] Parameters supplied to the create or update\n load balancer operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a load balancer tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param parameters [TagsObject] Parameters supplied to update load balancer\n tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Checks whether a domain name in the cloudapp.net zone is available for use.\n\n @param location [String] The location of the domain name.\n @param domain_name_label [String] The domain name to be verified. It must\n conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DnsNameAvailabilityResult] operation results.", "Retrieve a hybrid runbook worker group.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param hybrid_runbook_worker_group_name [String] The hybrid runbook worker\n group name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update a hybrid runbook worker group.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param hybrid_runbook_worker_group_name [String] The hybrid runbook worker\n group name\n @param parameters [HybridRunbookWorkerGroupUpdateParameters] The hybrid\n runbook worker group\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Detect anomalies for the entire series in batch.\n\n This operation generates a model using an entire series, each point is\n detected with the same model. With this method, points before and after a\n certain point are used to determine whether it is an anomaly. The entire\n detection can give user an overall status of the time series.\n\n @param body [Request] Time series points and period if needed. Advanced model\n parameters can also be set in the request.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EntireDetectResponse] operation results.", "Detect anomaly status of the latest point in time series.\n\n This operation generates a model using points before the latest one. With\n this method, only historical points are used to determine whether the target\n point is an anomaly. The latest point detecting operation matches the\n scenario of real-time monitoring of business metrics.\n\n @param body [Request] Time series points and period if needed. Advanced model\n parameters can also be set in the request.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [LastDetectResponse] operation results.", "Gets the specified network interface ip configuration.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_interface_name [String] The name of the network interface.\n @param ip_configuration_name [String] The name of the ip configuration name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gives the supported security providers for the virtual wan.\n\n @param resource_group_name [String] The resource group name.\n @param virtual_wanname [String] The name of the VirtualWAN for which\n supported security providers are needed.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VirtualWanSecurityProviders] operation results.", "Deletes a Media Service.\n\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param media_service_name [String] Name of the Media Service.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Updates a Media Service.\n\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param media_service_name [String] Name of the Media Service.\n @param parameters [MediaService] Media Service properties needed for update.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Regenerates a primary or secondary key for a Media Service.\n\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param media_service_name [String] Name of the Media Service.\n @param parameters [RegenerateKeyInput] Properties needed to regenerate the\n Media Service key.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all available virtual machine sizes to which the specified virtual\n machine can be resized.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_name [String] The name of the virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VirtualMachineSizeListResult] operation results.", "The operation to create or update a virtual machine.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_name [String] The name of the virtual machine.\n @param parameters [VirtualMachine] Parameters supplied to the Create Virtual\n Machine operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a virtual network gateway in the specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_gateway_name [String] The name of the virtual network\n gateway.\n @param parameters [VirtualNetworkGateway] Parameters supplied to create or\n update virtual network gateway operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a existing Live Event.\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param live_event_name [String] The name of the Live Event.\n @param parameters [LiveEvent] Live Event properties needed for creation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the Diagnostic specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param diagnostic_id [String] Diagnostic identifier. Must be unique in the\n current API Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Generates VPN profile for P2S client of the virtual network gateway in the\n specified resource group. Used for IKEV2 and radius based authentication.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_gateway_name [String] The name of the virtual network\n gateway.\n @param parameters [VpnClientParameters] Parameters supplied to the generate\n virtual network gateway VPN client package operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a xml format representation for supported vpn devices.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_gateway_name [String] The name of the virtual network\n gateway.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [String] operation results.", "Updates a virtual network gateway tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_gateway_name [String] The name of the virtual network\n gateway.\n @param parameters [TagsObject] Parameters supplied to update virtual network\n gateway tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete cluster resource\n\n Delete cluster resource\n\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster resource\n @param api_version [String] The version of the API.\n @param subscription_id [String] The customer subscription identifier\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a ServiceFabric cluster\n\n Create cluster resource\n\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster resource\n @param api_version [String] The version of the API.\n @param subscription_id [String] The customer subscription identifier\n @param parameters [Cluster] The cluster resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update cluster configuration\n\n Update cluster configuration\n\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster resource\n @param api_version [String] The version of the API.\n @param subscription_id [String] The customer subscription identifier\n @param parameters [ClusterUpdateParameters] The parameters which contains the\n property value and property name which used to update the cluster\n configuration.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a workflow run action repetition.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param run_name [String] The workflow run name.\n @param action_name [String] The workflow action name.\n @param repetition_name [String] The workflow repetition.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Check if the probe path is a valid path and the file can be accessed. Probe\n path is the path to a file hosted on the origin server to help accelerate the\n delivery of dynamic content via the CDN endpoint. This path is relative to\n the origin path specified in the endpoint configuration.\n\n @param validate_probe_input [ValidateProbeInput] Input to check.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ValidateProbeOutput] operation results.", "Update a key vault in the specified subscription.\n\n @param resource_group_name [String] The name of the Resource Group to which\n the server belongs.\n @param vault_name [String] Name of the vault\n @param parameters [VaultPatchParameters] Parameters to patch the vault\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "The List operation gets information about the vaults associated with the\n subscription.\n\n @param top [Integer] Maximum number of results to return.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<Vault>] operation results.", "Gets the deleted Azure key vault.\n\n @param vault_name [String] The name of the vault.\n @param location [String] The location of the deleted vault.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeletedVault] operation results.", "Checks that the vault name is valid and is not already in use.\n\n @param vault_name [VaultCheckNameAvailabilityParameters] The name of the\n vault.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CheckNameAvailabilityResult] operation results.", "Create or update a key vault in the specified subscription.\n\n @param resource_group_name [String] The name of the Resource Group to which\n the server belongs.\n @param vault_name [String] Name of the vault\n @param parameters [VaultCreateOrUpdateParameters] Parameters to create or\n update the vault\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "It will validate if given feature with resource properties is supported in\n service\n\n @param azure_region [String] Azure region to hit Api\n @param parameters [FeatureSupportRequest] Feature support request object\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AzureVMResourceFeatureSupportResponse] operation results.", "Checks that the storage account name is valid and is not already in use.\n\n @param account_name [StorageAccountCheckNameAvailabilityParameters] The name\n of the storage account within the specified resource group. Storage account\n names must be between 3 and 24 characters in length and use numbers and\n lower-case letters only.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CheckNameAvailabilityResult] operation results.", "Regenerates one of the access keys for the specified storage account.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription. The name is case insensitive.\n @param account_name [String] The name of the storage account within the\n specified resource group. Storage account names must be between 3 and 24\n characters in length and use numbers and lower-case letters only.\n @param regenerate_key [StorageAccountRegenerateKeyParameters] Specifies name\n of the key which should be regenerated -- key1 or key2.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Revoke user delegation keys.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription. The name is case insensitive.\n @param account_name [String] The name of the storage account within the\n specified resource group. Storage account names must be between 3 and 24\n characters in length and use numbers and lower-case letters only.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets a KPI in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param kpi_name [String] The name of the KPI.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a KPI or updates an existing KPI in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param kpi_name [String] The name of the KPI.\n @param parameters [KpiResourceFormat] Parameters supplied to the\n create/update KPI operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a KPI in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param kpi_name [String] The name of the KPI.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all the KPIs in the specified hub.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [KpiListResult] operation results.", "Creates or updates a SQL virtual machine group.\n\n @param resource_group_name [String] Name of the resource group that contains\n the resource. You can obtain this value from the Azure Resource Manager API\n or the portal.\n @param sql_virtual_machine_group_name [String] Name of the SQL virtual\n machine group.\n @param parameters [SqlVirtualMachineGroup] The SQL virtual machine group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates SQL virtual machine group tags.\n\n @param resource_group_name [String] Name of the resource group that contains\n the resource. You can obtain this value from the Azure Resource Manager API\n or the portal.\n @param sql_virtual_machine_group_name [String] Name of the SQL virtual\n machine group.\n @param parameters [SqlVirtualMachineGroupUpdate] The SQL virtual machine\n group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates the Data Lake Analytics account object specified by the accountName\n with the contents of the account object.\n\n @param resource_group_name [String] The name of the Azure resource group that\n contains the Data Lake Analytics account.\n @param name [String] The name of the Data Lake Analytics account to update.\n @param parameters [DataLakeAnalyticsAccount] Parameters supplied to the\n update Data Lake Analytics account operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets messaging plan for specified namespace.\n\n @param resource_group_name [String] Name of the resource group within the\n azure subscription.\n @param namespace_name [String] The Namespace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MessagingPlan] operation results.", "Get the current Service Fabric cluster version.\n\n If a cluster upgrade is happening, then this API will return the lowest\n (older) version of the current and target cluster runtime versions.\n\n @param timeout [Integer] The server timeout for performing the operation in\n seconds. This timeout specifies the time duration that the client is willing\n to wait for the requested operation to complete. The default value for this\n parameter is 60 seconds.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ClusterVersion] operation results.", "Creates or updates a Virtual Network Tap.\n\n @param resource_group_name [String] The name of the resource group.\n @param tap_name [String] The name of the virtual network tap.\n @param parameters [VirtualNetworkTap] Parameters supplied to the create or\n update virtual network tap operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates and initialize new instance of the TopicCredentials class.\n @param topic_key [String] topic key", "Enables Serial Console for a subscription\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SetDisabledResult] operation results.", "Disables Serial Console for a subscription\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SetDisabledResult] operation results.", "Patch a volume\n\n @param body [VolumePatch] Volume object supplied in the body of the\n operation.\n @param resource_group_name [String] The name of the resource group.\n @param account_name [String] The name of the NetApp account\n @param pool_name [String] The name of the capacity pool\n @param volume_name [String] The name of the volume\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update a volume\n\n @param body [Volume] Volume object supplied in the body of the operation.\n @param resource_group_name [String] The name of the resource group.\n @param account_name [String] The name of the NetApp account\n @param pool_name [String] The name of the capacity pool\n @param volume_name [String] The name of the volume\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Volume] operation results.", "Update a VM scale set.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_scale_set_name [String] The name of the VM scale set to create or\n update.\n @param parameters [VirtualMachineScaleSetUpdate] The scale set object.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets an integration account session.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param session_name [String] The integration account session name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an integration account session.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param session_name [String] The integration account session name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Sets the managementpolicy to the specified storage account.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription. The name is case insensitive.\n @param account_name [String] The name of the storage account within the\n specified resource group. Storage account names must be between 3 and 24\n characters in length and use numbers and lower-case letters only.\n @param properties [ManagementPolicy] The ManagementPolicy set to a storage\n account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified authorization from the specified express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the express route circuit.\n @param authorization_name [String] The name of the authorization.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all authorizations in an express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the circuit.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<ExpressRouteCircuitAuthorization>] operation results.", "Deletes the specified authorization from the specified express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the express route circuit.\n @param authorization_name [String] The name of the authorization.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the data policy rules associated with the specified storage account.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription. The name is case insensitive.\n @param account_name [String] The name of the storage account within the\n specified resource group. Storage account names must be between 3 and 24\n characters in length and use numbers and lower-case letters only.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [StorageAccountManagementPolicies] operation results.", "Deletes the data policy rules associated with the specified storage account.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription. The name is case insensitive.\n @param account_name [String] The name of the storage account within the\n specified resource group. Storage account names must be between 3 and 24\n characters in length and use numbers and lower-case letters only.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the detailed information for a given build.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param build_id [String] The build ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve the connection identified by connection name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param connection_name [String] The name of connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update a connection.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param connection_name [String] The parameters supplied to the create or\n update connection operation.\n @param parameters [ConnectionCreateOrUpdateParameters] The parameters\n supplied to the create or update connection operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve a list of connections.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ConnectionListResult] which provide lazy access to pages of the\n response.", "Creates or updates an application resource.\n\n Creates an application with the specified name and description. If an\n application with the same name already exists, then its description are\n updated to the one indicated in this request.\n\n @param application_resource_name [String] Service Fabric application resource\n name.\n @param application_resource_description [ApplicationResourceDescription]\n Description for creating an application resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the application with the given name.\n\n Gets the application with the given name. This includes the information about\n the application's services and other runtime information.\n\n @param application_resource_name [String] Service Fabric application resource\n name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplicationResourceDescription] operation results.", "Gets all the services in the application resource.\n\n The operation returns the service descriptions of all the services in the\n application resource.\n\n @param application_resource_name [String] Service Fabric application resource\n name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PagedServiceResourceDescriptionList] operation results.", "Gets the description of the specified service in an application resource.\n\n Gets the description of the service resource.\n\n @param application_resource_name [String] Service Fabric application resource\n name.\n @param service_resource_name [String] Service Fabric service resource name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ServiceResourceDescription] operation results.", "Gets replicas of a given service in an application resource.\n\n Gets the information about all replicas of a given service of an application.\n The information includes the runtime properties of the replica instance.\n\n @param application_resource_name [String] Service Fabric application resource\n name.\n @param service_resource_name [String] Service Fabric service resource name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PagedServiceResourceReplicaDescriptionList] operation results.", "Creates or updates a volume resource.\n\n Creates a volume resource with the specified name and description. If a\n volume with the same name already exists, then its description is updated to\n the one indicated in this request.\n\n @param volume_resource_name [String] Service Fabric volume resource name.\n @param volume_resource_description [VolumeResourceDescription] Description\n for creating a volume resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the volume resource.\n\n Gets the information about the volume resource with a given name. This\n information includes the volume description and other runtime information.\n\n @param volume_resource_name [String] Service Fabric volume resource name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VolumeResourceDescription] operation results.", "Retrieves the details of a P2SVpnServerConfiguration.\n\n @param resource_group_name [String] The resource group name of the\n P2SVpnServerConfiguration.\n @param virtual_wan_name [String] The name of the VirtualWan.\n @param p2svpn_server_configuration_name [String] The name of the\n P2SVpnServerConfiguration.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a new SignalR service and update an exiting SignalR service.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param resource_name [String] The name of the SignalR resource.\n @param parameters [SignalRCreateParameters] Parameters for the create or\n update operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Operation to update an exiting SignalR service.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param resource_name [String] The name of the SignalR resource.\n @param parameters [SignalRUpdateParameters] Parameters for the update\n operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a list of virtual machine extension image types.\n\n @param location [String] The name of a supported Azure region.\n @param publisher_name [String]\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Deletes the specified  value of the named secret resource.\n\n Deletes the secret value resource identified by the name. The name of the\n resource is typically the version associated with that value. Deletion will\n fail if the specified value is in use.\n\n @param secret_resource_name [String] The name of the secret resource.\n @param secret_value_resource_name [String] The name of the secret resource\n value which is typically the version identifier for the value.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Lists the specified value of the secret resource.\n\n Lists the decrypted value of the specified named value of the secret\n resource. This is a privileged operation.\n\n @param secret_resource_name [String] The name of the secret resource.\n @param secret_value_resource_name [String] The name of the secret resource\n value which is typically the version identifier for the value.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SecretValue] operation results.", "Gets the Web Service Definition as specified by a subscription, resource\n group, and name. Note that the storage credentials and web service keys are\n not returned by this call. To get the web service access keys, call List\n Keys.\n\n @param resource_group_name [String] Name of the resource group in which the\n web service is located.\n @param web_service_name [String] The name of the web service.\n @param region [String] The region for which encrypted credential parameters\n are valid.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get IP addresses assigned to an App Service Environment.\n\n Get IP addresses assigned to an App Service Environment.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service Environment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AddressResponse] operation results.", "Get diagnostic information for an App Service Environment.\n\n Get diagnostic information for an App Service Environment.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service Environment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Get global metric definitions of an App Service Environment.\n\n Get global metric definitions of an App Service Environment.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service Environment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MetricDefinition] operation results.", "Get properties of a multi-role pool.\n\n Get properties of a multi-role pool.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service Environment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkerPoolResource] operation results.", "List all currently running operations on the App Service Environment.\n\n List all currently running operations on the App Service Environment.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service Environment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Delete an App Service Environment.\n\n Delete an App Service Environment.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service Environment.\n @param force_delete [Boolean] Specify <code>true</code> to force the deletion\n even if the App Service Environment contains resources. The default is\n <code>false</code>.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes all images from the list with list Id equal to list Id passed.\n\n @param list_id [String] List Id of the image list.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [String] operation results.", "Gets all image Ids from the list with list Id equal to list Id passed.\n\n @param list_id [String] List Id of the image list.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ImageIds] operation results.", "Deletes an image from the list with list Id and image Id passed.\n\n @param list_id [String] List Id of the image list.\n @param image_id [String] Id of the image.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [String] operation results.", "Check if an IoT Central application name is available.\n\n @param operation_inputs [OperationInputs] Set the name parameter in the\n OperationInputs structure to the name of the IoT Central application to\n check.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AppNameAvailabilityInfo] operation results.", "Create or update the metadata of an IoT Central application. The usual\n pattern to modify a property is to retrieve the IoT Central application\n metadata and security metadata, and then combine them with the modified\n values in a new body to update the IoT Central application.\n\n @param resource_group_name [String] The name of the resource group that\n contains the IoT Central application.\n @param resource_name [String] The ARM resource name of the IoT Central\n application.\n @param app [App] The IoT Central application metadata and security metadata.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update the metadata of an IoT Central application.\n\n @param resource_group_name [String] The name of the resource group that\n contains the IoT Central application.\n @param resource_name [String] The ARM resource name of the IoT Central\n application.\n @param app_patch [AppPatch] The IoT Central application metadata and security\n metadata.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a role definition by ID.\n\n @param role_definition_id [String] The fully qualified role definition ID.\n Use the format,\n /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}\n for subscription level role definitions, or\n /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for\n tenant level role definitions.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RoleDefinition] operation results.", "Gets a connection monitor by name.\n\n @param resource_group_name [String] The name of the resource group containing\n Network Watcher.\n @param network_watcher_name [String] The name of the Network Watcher\n resource.\n @param connection_monitor_name [String] The name of the connection monitor.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the property specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param prop_id [String] Identifier of the property.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a property.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param prop_id [String] Identifier of the property.\n @param parameters [PropertyContract] Create parameters.\n @param if_match [String] ETag of the Entity. Not required when creating an\n entity, but required when updating an entity.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the Single-Sign-On token for the API Management Service which is valid\n for 5 Minutes.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApiManagementServiceGetSsoTokenResult] operation results.", "Upload Custom Domain SSL certificate for an API Management service.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param parameters [ApiManagementServiceUploadCertificateParameters]\n Parameters supplied to the Upload SSL certificate for an API Management\n service operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates an existing API Management service.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param parameters [ApiManagementServiceUpdateParameters] Parameters supplied\n to the CreateOrUpdate API Management service operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Starts an existing CDN endpoint that is on a stopped state.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param endpoint_name [String] Name of the endpoint under the profile which is\n unique globally.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Endpoint] operation results.", "Removes a content from CDN.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param endpoint_name [String] Name of the endpoint under the profile which is\n unique globally.\n @param content_file_paths [PurgeParameters] The path to the content to be\n purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a\n single file, or a directory with a wildcard, e.g. '/pictures/*' which removes\n all folders and files in the directory.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Pre-loads a content to CDN. Available for Verizon Profiles.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param endpoint_name [String] Name of the endpoint under the profile which is\n unique globally.\n @param content_file_paths [LoadParameters] The path to the content to be\n loaded. Path should be a full URL, e.g. \u2018/pictures/city.png' which loads a\n single file\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates a new CDN endpoint with the specified endpoint name under the\n specified subscription, resource group and profile.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param endpoint_name [String] Name of the endpoint under the profile which is\n unique globally.\n @param endpoint [Endpoint] Endpoint properties\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an existing CDN endpoint with the specified endpoint name under the\n specified subscription, resource group and profile.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param endpoint_name [String] Name of the endpoint under the profile which is\n unique globally.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get list of applicable `Reservation`s.\n\n Get applicable `Reservation`s that are applied to this subscription.\n\n @param subscription_id [String] Id of the subscription\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AppliedReservations] operation results.", "Delete an existing person from a person group. All stored person data, and\n face features in the person entry will be deleted.\n\n @param person_group_id [String] Id referencing a particular person group.\n @param person_id Id referencing a particular person.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Deletes a job agent.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param job_agent_name [String] The name of the job agent to be deleted.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a list of job agents in a server.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [JobAgentListResult] which provide lazy access to pages of the\n response.", "Get the specified tap configuration on a network interface.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_interface_name [String] The name of the network interface.\n @param tap_configuration_name [String] The name of the tap configuration.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a new person in a specified large person group.\n\n @param large_person_group_id [String] Id referencing a particular large\n person group.\n @param name [String] User defined name, maximum length is 128.\n @param user_data [String] User specified data. Length should not exceed 16KB.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Person] operation results.", "Delete an existing person from a large person group. All stored person data,\n and face features in the person entry will be deleted.\n\n @param large_person_group_id [String] Id referencing a particular large\n person group.\n @param person_id Id referencing a particular person.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Retrieve a person's information, including registered persisted faces, name\n and userData.\n\n @param large_person_group_id [String] Id referencing a particular large\n person group.\n @param person_id Id referencing a particular person.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Person] operation results.", "Update name or userData of a person.\n\n @param large_person_group_id [String] Id referencing a particular large\n person group.\n @param person_id Id referencing a particular person.\n @param name [String] User defined name, maximum length is 128.\n @param user_data [String] User specified data. Length should not exceed 16KB.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the Search service with the given name in the given resource group.\n\n @param resource_group_name [String] The name of the resource group within the\n current subscription. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param search_service_name [String] The name of the Azure Search service\n associated with the specified resource group.\n @param search_management_request_options [SearchManagementRequestOptions]\n Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the built in policy set definition.\n\n @param policy_set_definition_name [String] The name of the policy set\n definition to get.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PolicySetDefinition] operation results.", "Creates or updates a policy set definition at management group level.\n\n @param policy_set_definition_name [String] The name of the policy set\n definition to create.\n @param parameters [PolicySetDefinition] The policy set definition properties.\n @param management_group_id [String] The ID of the management group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a policy set definition at management group level.\n\n @param policy_set_definition_name [String] The name of the policy set\n definition to delete.\n @param management_group_id [String] The ID of the management group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates or updates a Secret resource.\n\n Creates a Secret resource with the specified name, description and\n properties. If Secret resource with the same name exists, then it is updated\n with the specified description and properties. Once created, the kind and\n contentType of a secret resource cannot be updated.\n\n @param secret_resource_name [String] The name of the secret resource.\n @param secret_resource_description [SecretResourceDescription] Description\n for creating a secret resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SecretResourceDescription] operation results.", "Lists a collection of Identity Provider configured in the specified service\n instance.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<IdentityProviderContract>] operation results.", "Gets the configuration details of the identity Provider configured in\n specified service instance.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param identity_provider_name [IdentityProviderType] Identity Provider Type\n identifier. Possible values include: 'facebook', 'google', 'microsoft',\n 'twitter', 'aad', 'aadB2C'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates an existing LogProfilesResource. To update other fields use the\n CreateOrUpdate method.\n\n @param log_profile_name [String] The name of the log profile.\n @param log_profiles_resource [LogProfileResourcePatch] Parameters supplied to\n the operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [LogProfileResource] operation results.", "Get a Media Services account\n\n Get the details of a Media Services account\n\n @param account_name [String] The Media Services account name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SubscriptionMediaService] operation results.", "Gets an availability group listener.\n\n @param resource_group_name [String] Name of the resource group that contains\n the resource. You can obtain this value from the Azure Resource Manager API\n or the portal.\n @param sql_virtual_machine_group_name [String] Name of the SQL virtual\n machine group.\n @param availability_group_listener_name [String] Name of the availability\n group listener.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an availability group listener.\n\n @param resource_group_name [String] Name of the resource group that contains\n the resource. You can obtain this value from the Azure Resource Manager API\n or the portal.\n @param sql_virtual_machine_group_name [String] Name of the SQL virtual\n machine group.\n @param availability_group_listener_name [String] Name of the availability\n group listener.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all available geo-locations.\n\n This operation provides all the locations that are available for resource\n providers; however, each resource provider may support a subset of this list.\n\n @param subscription_id [String] The ID of the target subscription.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [LocationListResult] operation results.", "Grants access to a snapshot.\n\n @param resource_group_name [String] The name of the resource group.\n @param snapshot_name [String] The name of the snapshot that is being created.\n The name can't be changed after the snapshot is created. Supported characters\n for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.\n @param grant_access_data [GrantAccessData] Access data object supplied in the\n body of the get snapshot access operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves the specified ExpressRouteLink resource.\n\n @param resource_group_name [String] The name of the resource group.\n @param express_route_port_name [String] The name of the ExpressRoutePort\n resource.\n @param link_name [String] The name of the ExpressRouteLink resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort\n resource.\n\n @param resource_group_name [String] The name of the resource group.\n @param express_route_port_name [String] The name of the ExpressRoutePort\n resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<ExpressRouteLink>] operation results.", "Deletes the elastic pool.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param elastic_pool_name [String] The name of the elastic pool to be deleted.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns elastic pool  metrics.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param elastic_pool_name [String] The name of the elastic pool.\n @param filter [String] An OData filter expression that describes a subset of\n metrics to return.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a collection that contains the object IDs of the groups of which the\n user is a member.\n\n @param object_id [String] The object ID of the user for which to get group\n membership.\n @param parameters [UserGetMemberGroupsParameters] User filtering parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [UserGetMemberGroupsResult] operation results.", "Gets a list of users for the current tenant.\n\n @param next_link [String] Next link for the list operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<User>] operation results.", "Retrieve the Dsc node configurations by node configuration.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param node_configuration_name [String] The Dsc node configuration name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create the node configuration identified by node configuration name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param node_configuration_name [String] The create or update parameters for\n configuration.\n @param parameters [DscNodeConfigurationCreateOrUpdateParameters] The create\n or update parameters for configuration.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a disaster recovery configuration.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param disaster_recovery_configuration_name [String] The name of the disaster\n recovery configuration.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a disaster recovery configuration.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param disaster_recovery_configuration_name [String] The name of the disaster\n recovery configuration to be created/updated.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets information about the specified application.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param application_id [String] The ID of the application.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all of the applications in the specified account.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param maxresults [Integer] The maximum number of items to return in the\n response.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a HybridConnection .\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The Namespace Name\n @param hybrid_connection_name [String] The hybrid connection name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns the description for the specified HybridConnection.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The Namespace Name\n @param hybrid_connection_name [String] The hybrid connection name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a HybridConnection authorization rule\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The Namespace Name\n @param hybrid_connection_name [String] The hybrid connection name.\n @param authorization_rule_name [String] The authorizationRule name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete an activity log alert.\n\n @param resource_group_name [String] The name of the resource group.\n @param activity_log_alert_name [String] The name of the activity log alert.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get a list of all activity log alerts in a subscription.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ActivityLogAlertList] operation results.", "Gets a list of agent pools in the specified managed cluster.\n\n Gets a list of agent pools in the specified managed cluster. The operation\n returns properties of each agent pool.\n\n @param resource_group_name [String] The name of the resource group.\n @param managed_cluster_name [String] The name of the managed cluster\n resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<AgentPool>] operation results.", "Gets the agent pool.\n\n Gets the details of the agent pool by managed cluster and resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param managed_cluster_name [String] The name of the managed cluster\n resource.\n @param agent_pool_name [String] The name of the agent pool.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Regenerate key for a topic\n\n Regenerate a shared access key for a topic\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription.\n @param topic_name [String] Name of the topic\n @param regenerate_key_request [TopicRegenerateKeyRequest] Request body to\n regenerate key\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List topics under an Azure subscription\n\n List all the topics under an Azure subscription\n\n @param filter [String] Filter the results using OData syntax.\n @param top [Integer] The number of results to return.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TopicsListResult] which provide lazy access to pages of the\n response.", "List topics under a resource group\n\n List all the topics under a resource group\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription.\n @param filter [String] Filter the results using OData syntax.\n @param top [Integer] The number of results to return.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TopicsListResult] which provide lazy access to pages of the\n response.", "Deletes the specified service endpoint policy.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_endpoint_policy_name [String] The name of the service endpoint\n policy.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the specified service Endpoint Policies in a specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_endpoint_policy_name [String] The name of the service endpoint\n policy.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a service Endpoint Policies.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_endpoint_policy_name [String] The name of the service endpoint\n policy.\n @param parameters [ServiceEndpointPolicy] Parameters supplied to the create\n or update service endpoint policy operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates service Endpoint Policies.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_endpoint_policy_name [String] The name of the service endpoint\n policy.\n @param parameters [TagsObject] Parameters supplied to update service endpoint\n policy tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "The Web Search API lets you send a search query to Bing and get back search\n results that include links to webpages, images, and more.\n\n @param query [String] The user's search query term. The term may not be\n empty. The term may contain Bing Advanced Operators. For example, to limit\n results to a specific domain, use the site: operator.\n @param accept_language [String] A comma-delimited list of one or more\n languages to use for user interface strings. The list is in decreasing order\n of preference. For additional information, including expected format, see\n [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This\n header and the setLang query parameter are mutually exclusive; do not specify\n both. If you set this header, you must also specify the cc query parameter.\n Bing will use the first supported language it finds from the list, and\n combine that language with the cc parameter value to determine the market to\n return results for. If the list does not include a supported language, Bing\n will find the closest language and market that supports the request, and may\n use an aggregated or default market for the results instead of a specified\n one. You should use this header and the cc query parameter only if you\n specify multiple languages; otherwise, you should use the mkt and setLang\n query parameters. A user interface string is a string that's used as a label\n in a user interface. There are very few user interface strings in the JSON\n response objects. Any links in the response objects to Bing.com properties\n will apply the specified language.\n @param pragma [String] By default, Bing returns cached content, if available.\n To prevent Bing from returning cached content, set the Pragma header to\n no-cache (for example, Pragma: no-cache).\n @param user_agent [String] The user agent originating the request. Bing uses\n the user agent to provide mobile users with an optimized experience. Although\n optional, you are strongly encouraged to always specify this header. The\n user-agent should be the same string that any commonly used browser would\n send. For information about user agents, see [RFC\n 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).\n @param client_id [String] Bing uses this header to provide users with\n consistent behavior across Bing API calls. Bing often flights new features\n and improvements, and it uses the client ID as a key for assigning traffic on\n different flights. If you do not use the same client ID for a user across\n multiple requests, then Bing may assign the user to multiple conflicting\n flights. Being assigned to multiple conflicting flights can lead to an\n inconsistent user experience. For example, if the second request has a\n different flight assignment than the first, the experience may be unexpected.\n Also, Bing can use the client ID to tailor web results to that client ID\u2019s\n search history, providing a richer experience for the user. Bing also uses\n this header to help improve result rankings by analyzing the activity\n generated by a client ID. The relevance improvements help with better quality\n of results delivered by Bing APIs and in turn enables higher click-through\n rates for the API consumer. IMPORTANT: Although optional, you should consider\n this header required. Persisting the client ID across multiple requests for\n the same end user and device combination enables 1) the API consumer to\n receive a consistent user experience, and 2) higher click-through rates via\n better quality of results from the Bing APIs. Each user that uses your\n application on the device must have a unique, Bing generated client ID. If\n you do not include this header in the request, Bing generates an ID and\n returns it in the X-MSEdge-ClientID response header. The only time that you\n should NOT include this header in a request is the first time the user uses\n your app on that device. Use the client ID for each Bing API request that\n your app makes for this user on the device. Persist the client ID. To persist\n the ID in a browser app, use a persistent HTTP cookie to ensure the ID is\n used across all sessions. Do not use a session cookie. For other apps such as\n mobile apps, use the device's persistent storage to persist the ID. The next\n time the user uses your app on that device, get the client ID that you\n persisted. Bing responses may or may not include this header. If the response\n includes this header, capture the client ID and use it for all subsequent\n Bing requests for the user on that device. If you include the\n X-MSEdge-ClientID, you must not include cookies in the request.\n @param client_ip [String] The IPv4 or IPv6 address of the client device. The\n IP address is used to discover the user's location. Bing uses the location\n information to determine safe search behavior. Although optional, you are\n encouraged to always specify this header and the X-Search-Location header. Do\n not obfuscate the address (for example, by changing the last octet to 0).\n Obfuscating the address results in the location not being anywhere near the\n device's actual location, which may result in Bing serving erroneous results.\n @param location [String] A semicolon-delimited list of key/value pairs that\n describe the client's geographical location. Bing uses the location\n information to determine safe search behavior and to return relevant local\n content. Specify the key/value pair as <key>:<value>. The following are the\n keys that you use to specify the user's location. lat (required): The\n latitude of the client's location, in degrees. The latitude must be greater\n than or equal to -90.0 and less than or equal to +90.0. Negative values\n indicate southern latitudes and positive values indicate northern latitudes.\n long (required): The longitude of the client's location, in degrees. The\n longitude must be greater than or equal to -180.0 and less than or equal to\n +180.0. Negative values indicate western longitudes and positive values\n indicate eastern longitudes. re (required): The radius, in meters, which\n specifies the horizontal accuracy of the coordinates. Pass the value returned\n by the device's location service. Typical values might be 22m for GPS/Wi-Fi,\n 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts\n (optional): The UTC UNIX timestamp of when the client was at the location.\n (The UNIX timestamp is the number of seconds since January 1, 1970.) head\n (optional): The client's relative heading or direction of travel. Specify the\n direction of travel as degrees from 0 through 360, counting clockwise\n relative to true north. Specify this key only if the sp key is nonzero. sp\n (optional): The horizontal velocity (speed), in meters per second, that the\n client device is traveling. alt (optional): The altitude of the client\n device, in meters. are (optional): The radius, in meters, that specifies the\n vertical accuracy of the coordinates. Specify this key only if you specify\n the alt key. Although many of the keys are optional, the more information\n that you provide, the more accurate the location results are. Although\n optional, you are encouraged to always specify the user's geographical\n location. Providing the location is especially important if the client's IP\n address does not accurately reflect the user's physical location (for\n example, if the client uses VPN). For optimal results, you should include\n this header and the X-MSEdge-ClientIP header, but at a minimum, you should\n include this header.\n @param answer_count [Integer] The number of answers that you want the\n response to include. The answers that Bing returns are based on ranking. For\n example, if Bing returns webpages, images, videos, and relatedSearches for a\n request and you set this parameter to two (2), the response includes webpages\n and images.If you included the responseFilter query parameter in the same\n request and set it to webpages and news, the response would include only\n webpages.\n @param country_code [String] A 2-character country code of the country where\n the results come from. This API supports only the United States market. If\n you specify this query parameter, it must be set to us. If you set this\n parameter, you must also specify the Accept-Language header. Bing uses the\n first supported language it finds from the languages list, and combine that\n language with the country code that you specify to determine the market to\n return results for. If the languages list does not include a supported\n language, Bing finds the closest language and market that supports the\n request, or it may use an aggregated or default market for the results\n instead of a specified one. You should use this query parameter and the\n Accept-Language query parameter only if you specify multiple languages;\n otherwise, you should use the mkt and setLang query parameters. This\n parameter and the mkt query parameter are mutually exclusive\u2014do not specify\n both.\n @param count [Integer] The number of search results to return in the\n response. The default is 10 and the maximum value is 50. The actual number\n delivered may be less than requested.Use this parameter along with the offset\n parameter to page results.For example, if your user interface displays 10\n search results per page, set count to 10 and offset to 0 to get the first\n page of results. For each subsequent page, increment offset by 10 (for\n example, 0, 10, 20). It is possible for multiple pages to include some\n overlap in results.\n @param freshness [Freshness] Filter search results by the following age\n values: Day\u2014Return webpages that Bing discovered within the last 24 hours.\n Week\u2014Return webpages that Bing discovered within the last 7 days.\n Month\u2014Return webpages that discovered within the last 30 days. This filter\n applies only to webpage results and not to the other results such as news and\n images. Possible values include: 'Day', 'Week', 'Month'\n @param market [String] The market where the results come from. Typically, mkt\n is the country where the user is making the request from. However, it could\n be a different country if the user is not located in a country where Bing\n delivers results. The market must be in the form <language code>-<country\n code>. For example, en-US. The string is case insensitive. If known, you are\n encouraged to always specify the market. Specifying the market helps Bing\n route the request and return an appropriate and optimal response. If you\n specify a market that is not listed in Market Codes, Bing uses a best fit\n market code based on an internal mapping that is subject to change. This\n parameter and the cc query parameter are mutually exclusive\u2014do not specify\n both.\n @param offset [Integer] The zero-based offset that indicates the number of\n search results to skip before returning results. The default is 0. The offset\n should be less than (totalEstimatedMatches - count). Use this parameter along\n with the count parameter to page results. For example, if your user interface\n displays 10 search results per page, set count to 10 and offset to 0 to get\n the first page of results. For each subsequent page, increment offset by 10\n (for example, 0, 10, 20). it is possible for multiple pages to include some\n overlap in results.\n @param promote [Array<AnswerType>] A comma-delimited list of answers that you\n want the response to include regardless of their ranking. For example, if you\n set answerCount) to two (2) so Bing returns the top two ranked answers, but\n you also want the response to include news, you'd set promote to news. If the\n top ranked answers are webpages, images, videos, and relatedSearches, the\n response includes webpages and images because news is not a ranked answer.\n But if you set promote to video, Bing would promote the video answer into the\n response and return webpages, images, and videos. The answers that you want\n to promote do not count against the answerCount limit. For example, if the\n ranked answers are news, images, and videos, and you set answerCount to 1 and\n promote to news, the response contains news and images. Or, if the ranked\n answers are videos, images, and news, the response contains videos and news.\n Possible values are Computation, Images, News, RelatedSearches,\n SpellSuggestions, TimeZone, Videos, Webpages. Use only if you specify\n answerCount.\n @param response_filter [Array<AnswerType>] A comma-delimited list of answers\n to include in the response. If you do not specify this parameter, the\n response includes all search answers for which there's relevant data.\n Possible filter values are Computation, Images, News, RelatedSearches,\n SpellSuggestions, TimeZone, Videos, Webpages. Although you may use this\n filter to get a single answer, you should instead use the answer-specific\n endpoint in order to get richer results. For example, to receive only images,\n send the request to one of the Image Search API endpoints. The\n RelatedSearches and SpellSuggestions answers do not support a separate\n endpoint like the Image Search API does (only the Web Search API returns\n them). To include answers that would otherwise be excluded because of\n ranking, see the promote query parameter.\n @param safe_search [SafeSearch] A filter used to filter adult content. Off:\n Return webpages with adult text, images, or videos. Moderate: Return webpages\n with adult text, but not adult images or videos. Strict: Do not return\n webpages with adult text, images, or videos. The default is Moderate. If the\n request comes from a market that Bing's adult policy requires that safeSearch\n is set to Strict, Bing ignores the safeSearch value and uses Strict. If you\n use the site: query operator, there is the chance that the response may\n contain adult content regardless of what the safeSearch query parameter is\n set to. Use site: only if you are aware of the content on the site and your\n scenario supports the possibility of adult content. Possible values include:\n 'Off', 'Moderate', 'Strict'\n @param set_lang [String] The language to use for user interface strings.\n Specify the language using the ISO 639-1 2-letter language code. For example,\n the language code for English is EN. The default is EN (English). Although\n optional, you should always specify the language. Typically, you set setLang\n to the same language specified by mkt unless the user wants the user\n interface strings displayed in a different language. This parameter and the\n Accept-Language header are mutually exclusive; do not specify both. A user\n interface string is a string that's used as a label in a user interface.\n There are few user interface strings in the JSON response objects. Also, any\n links to Bing.com properties in the response objects apply the specified\n language.\n @param text_decorations [Boolean] A Boolean value that determines whether\n display strings should contain decoration markers such as hit highlighting\n characters. If true, the strings may include markers. The default is false.\n To specify whether to use Unicode characters or HTML tags as the markers, see\n the textFormat query parameter.\n @param text_format [TextFormat] The type of markers to use for text\n decorations (see the textDecorations query parameter). Possible values are\n Raw\u2014Use Unicode characters to mark content that needs special formatting. The\n Unicode characters are in the range E000 through E019. For example, Bing uses\n E000 and E001 to mark the beginning and end of query terms for hit\n highlighting. HTML\u2014Use HTML tags to mark content that needs special\n formatting. For example, use <b> tags to highlight query terms in display\n strings. The default is Raw. For display strings that contain escapable HTML\n characters such as <, >, and &, if textFormat is set to HTML, Bing escapes\n the characters as appropriate (for example, < is escaped to &lt;). Possible\n values include: 'Raw', 'Html'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SearchResponse] operation results.", "Returns the list of databases of the given Kusto cluster.\n\n @param resource_group_name [String] The name of the resource group containing\n the Kusto cluster.\n @param cluster_name [String] The name of the Kusto cluster.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DatabaseListResult] operation results.", "Updates a database.\n\n @param resource_group_name [String] The name of the resource group containing\n the Kusto cluster.\n @param cluster_name [String] The name of the Kusto cluster.\n @param database_name [String] The name of the database in the Kusto cluster.\n @param parameters [DatabaseUpdate] The database parameters supplied to the\n Update operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all the storage account credentials in a manager.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [StorageAccountCredentialList] operation results.", "Gets the properties of the specified storage account credential name.\n\n @param storage_account_credential_name [String] The name of storage account\n credential to be fetched.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List all recommendations for a subscription.\n\n List all recommendations for a subscription.\n\n @param featured [Boolean] Specify <code>true</code> to return only the most\n critical recommendations. The default is <code>false</code>, which returns\n all recommendations.\n @param filter [String] Filter is specified by using OData syntax. Example:\n $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq\n 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq\n duration'[PT1H|PT1M|P1D]\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Disable all recommendations for an app.\n\n Disable all recommendations for an app.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param site_name [String] Name of the app.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Reset all recommendation opt-out settings for an app.\n\n Reset all recommendation opt-out settings for an app.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param site_name [String] Name of the app.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Retrieve the content of runbook identified by runbook name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param runbook_name [String] The runbook name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve the runbook identified by runbook name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param runbook_name [String] The runbook name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create the runbook identified by runbook name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param runbook_name [String] The runbook name.\n @param parameters [RunbookCreateOrUpdateParameters] The create or update\n parameters for runbook. Provide either content link for a published runbook\n or draft, not both.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update the runbook identified by runbook name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param runbook_name [String] The runbook name.\n @param parameters [RunbookUpdateParameters] The update parameters for\n runbook.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of a storage classification mapping.\n\n Gets the details of the specified storage classification mapping.\n\n @param fabric_name [String] Fabric name.\n @param storage_classification_name [String] Storage classification name.\n @param storage_classification_mapping_name [String] Storage classification\n mapping name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the labeled example utterances with the specified ID from a version\n of the application.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param example_id [Integer] The example ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all permissions the caller has for a resource group.\n\n @param resource_group_name [String] The name of the resource group to get the\n permissions for. The name is case insensitive.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PermissionGetResult] which provide lazy access to pages of the\n response.", "Gets upgrade profile for a managed cluster.\n\n Gets the details of the upgrade profile for a managed cluster with a\n specified resource group and name.\n\n @param resource_group_name [String] The name of the resource group.\n @param resource_name [String] The name of the managed cluster resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ManagedClusterUpgradeProfile] operation results.", "Gets cluster admin credential of a managed cluster.\n\n Gets cluster admin credential of the managed cluster with a specified\n resource group and name.\n\n @param resource_group_name [String] The name of the resource group.\n @param resource_name [String] The name of the managed cluster resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CredentialResults] operation results.", "Gets cluster user credential of a managed cluster.\n\n Gets cluster user credential of the managed cluster with a specified resource\n group and name.\n\n @param resource_group_name [String] The name of the resource group.\n @param resource_name [String] The name of the managed cluster resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CredentialResults] operation results.", "Updates tags on a managed cluster.\n\n Updates a managed cluster with the specified tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param resource_name [String] The name of the managed cluster resource.\n @param parameters [TagsObject] Parameters supplied to the Update Managed\n Cluster Tags operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a container service.\n\n Creates or updates a container service with the specified configuration of\n orchestrator, masters, and agents.\n\n @param resource_group_name [String] The name of the resource group.\n @param container_service_name [String] The name of the container service in\n the specified subscription and resource group.\n @param parameters [ContainerService] Parameters supplied to the Create or\n Update a Container Service operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a list of workflow runs.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param top [Integer] The number of items to be included in the result.\n @param filter [String] The filter to apply on the operation. Options for\n filters include: Status, StartTime, and ClientTrackingId.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<WorkflowRun>] operation results.", "Gets a workflow run.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param run_name [String] The workflow run name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the group specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param group_id [String] Group identifier. Must be unique in the current API\n Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all of the available subnet delegations for this resource group in this\n region.\n\n @param location [String] The location of the domain name.\n @param resource_group_name [String] The name of the resource group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<AvailableDelegation>] operation results.", "Gets a list of virtual machine image offers for the specified location and\n publisher.\n\n @param location [String] The name of a supported Azure region.\n @param publisher_name [String] A valid image publisher.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets a list of virtual machine image publishers for the specified Azure\n location.\n\n @param location [String] The name of a supported Azure region.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Cancels a remediation at management group scope.\n\n @param management_group_id [String] Management group ID.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Creates or updates a remediation at management group scope.\n\n @param management_group_id [String] Management group ID.\n @param remediation_name [String] The name of the remediation.\n @param parameters [Remediation] The remediation parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets an existing remediation at management group scope.\n\n @param management_group_id [String] Management group ID.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Deletes an existing remediation at management group scope.\n\n @param management_group_id [String] Management group ID.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Cancels a remediation at subscription scope.\n\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Creates or updates a remediation at subscription scope.\n\n @param remediation_name [String] The name of the remediation.\n @param parameters [Remediation] The remediation parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Gets an existing remediation at subscription scope.\n\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Deletes an existing remediation at subscription scope.\n\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Cancels a remediation at resource group scope.\n\n @param resource_group_name [String] Resource group name.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Gets an existing remediation at resource group scope.\n\n @param resource_group_name [String] Resource group name.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Deletes an existing remediation at resource group scope.\n\n @param resource_group_name [String] Resource group name.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Cancel a remediation at resource scope.\n\n @param resource_id [String] Resource ID.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Gets an existing remediation at resource scope.\n\n @param resource_id [String] Resource ID.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Deletes an existing remediation at individual resource scope.\n\n @param resource_id [String] Resource ID.\n @param remediation_name [String] The name of the remediation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Remediation] operation results.", "Checks whether the container registry name is available for use. The name\n must contain only alphanumeric characters, be globally unique, and between 5\n and 60 characters in length.\n\n @param registry_name_check_request [RegistryNameCheckRequest] The object\n containing information for the availability request.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RegistryNameStatus] operation results.", "Gets the administrator login credentials for the specified container\n registry.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RegistryCredentials] operation results.", "Regenerates the administrator login credentials for the specified container\n registry.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RegistryCredentials] operation results.", "Delete a subscription resource tag value.\n\n @param tag_name [String] The name of the tag.\n @param tag_value [String] The value of the tag.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Create a subscription resource tag value.\n\n @param tag_name [String] The name of the tag.\n @param tag_value [String] The value of the tag.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TagValue] operation results.", "Create a subscription resource tag.\n\n @param tag_name [String] The name of the tag.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TagDetails] operation results.", "Retrieve the Dsc configuration compilation job identified by job id.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param compilation_job_id The Dsc configuration compilation job id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists the login credentials for the specified container registry.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RegistryListCredentialsResult] operation results.", "List the quantity of available pre-provisioned Event Hubs Clusters, indexed\n by Azure region.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AvailableClustersList] operation results.", "List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.\n\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param cluster_name [String] The name of the Event Hubs Cluster.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EHNamespaceIdListResult] operation results.", "Stops all containers in a container group.\n\n Stops all containers in a contaienr group. Compute resources will be\n deallocated and billing will stop.\n\n @param resource_group_name [String] The name of the resource group.\n @param container_group_name [String] The name of the container group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get the callback URL for a workflow trigger.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param trigger_name [String] The workflow trigger name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get full URL of an event subscription\n\n Get the full endpoint URL for an event subscription\n\n @param scope [String] The scope of the event subscription. The scope can be a\n subscription, or a resource group, or a top level resource belonging to a\n resource provider namespace, or an EventGrid topic. For example, use\n '/subscriptions/{subscriptionId}/' for a subscription,\n '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a\n resource group, and\n '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'\n for a resource, and\n '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}'\n for an EventGrid topic.\n @param event_subscription_name [String] Name of the event subscription\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EventSubscriptionFullUrl] operation results.", "Directory objects that are owners of this service principal.\n\n The owners are a set of non-admin users who are allowed to modify this\n object.\n\n @param object_id [String] The object ID of the service principal for which to\n get owners.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DirectoryObjectListResult] operation results.", "Get the keyCredentials associated with the specified service principal.\n\n @param object_id [String] The object ID of the service principal for which to\n get keyCredentials.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [KeyCredentialListResult] operation results.", "Update the keyCredentials associated with a service principal.\n\n @param object_id [String] The object ID for which to get service principal\n information.\n @param parameters [KeyCredentialsUpdateParameters] Parameters to update the\n keyCredentials of an existing service principal.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the passwordCredentials associated with a service principal.\n\n @param object_id [String] The object ID of the service principal.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PasswordCredentialListResult] operation results.", "Updates the passwordCredentials associated with a service principal.\n\n @param object_id [String] The object ID of the service principal.\n @param parameters [PasswordCredentialsUpdateParameters] Parameters to update\n the passwordCredentials of an existing service principal.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Check the availability of name for resource\n\n @param name_availability_request [NameAvailabilityRequest] The required\n parameters for checking if resource name is available.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [NameAvailability] operation results.", "Gets computes in specified workspace.\n\n @param resource_group_name [String] Name of the resource group in which\n workspace is located.\n @param workspace_name [String] Name of Azure Machine Learning workspace.\n @param skiptoken [String] Continuation token for pagination.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates compute. This call will overwrite a compute if it exists.\n This is a nonrecoverable operation. If your intent is to create a new\n compute, do a GET first to verify that it does not exist yet.\n\n @param resource_group_name [String] Name of the resource group in which\n workspace is located.\n @param workspace_name [String] Name of Azure Machine Learning workspace.\n @param compute_name [String] Name of the Azure Machine Learning compute.\n @param parameters [ComputeResource] Payload with Machine Learning compute\n definition.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a queue from the specified namespace in a resource group.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param queue_name [String] The queue name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns a description for the specified queue.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param queue_name [String] The queue name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all authorization rules for a queue.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param queue_name [String] The queue name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Primary and secondary connection strings to the queue.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param queue_name [String] The queue name.\n @param authorization_rule_name [String] The authorization rule name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ResourceListKeys] operation results.", "Gets the queues within a namespace.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [QueueListResult] which provide lazy access to pages of the response.", "Retrieves information about the run-time state of a virtual machine.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_name [String] The name of the virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VirtualMachineInstanceView] operation results.", "The operation to update a virtual machine.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_name [String] The name of the virtual machine.\n @param parameters [VirtualMachineUpdate] Parameters supplied to the Update\n Virtual Machine operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all the virtual machines under the specified subscription for the\n specified location.\n\n @param location [String] The location for which virtual machines under the\n subscription are queried.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VirtualMachineListResult] which provide lazy access to pages of the\n response.", "Creates a new Server Active Directory Administrator or updates an existing\n server Active Directory Administrator.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param properties [ServerAzureADAdministrator] The required parameters for\n creating or updating an Active Directory Administrator.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the Cache specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param cache_id [String] Identifier of the Cache entity. Cache identifier\n (should be either 'default' or valid Azure region identifier).\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create Intent for Enabling backup of an item. This is a synchronous\n operation.\n\n @param vault_name [String] The name of the recovery services vault.\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param fabric_name [String] Fabric name associated with the backup item.\n @param intent_object_name [String] Intent object name.\n @param parameters [ProtectionIntentResource] resource backed up item\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the network settings of the specified device.\n\n @param device_name [String] The device name\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns calling user identity information.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CurrentUserIdentity] operation results.", "Get the ETag of the policy configuration at the Product level.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param product_id [String] Product identifier. Must be unique in the current\n API Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates an autoscale setting.\n\n @param resource_group_name [String] The name of the resource group.\n @param autoscale_setting_name [String] The autoscale setting name.\n @param parameters [AutoscaleSettingResource] Parameters supplied to the\n operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes and autoscale setting\n\n @param resource_group_name [String] The name of the resource group.\n @param autoscale_setting_name [String] The autoscale setting name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets a server key.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param key_name [String] The name of the server key to be retrieved.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a virtual wan p2s vpn gateway.\n\n @param resource_group_name [String] The resource group name of the\n P2SVpnGateway.\n @param gateway_name [String] The name of the gateway.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets a connector in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param connector_name [String] The name of the connector.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a connector or updates an existing connector in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param connector_name [String] The name of the connector.\n @param parameters [ConnectorResourceFormat] Parameters supplied to the\n CreateOrUpdate Connector operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a connector in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param connector_name [String] The name of the connector.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the properties of a specified task.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param task_name [String] The name of the container registry task.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets information about the specified certificate.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param certificate_name [String] The identifier for the certificate. This\n must be made up of algorithm and thumbprint separated by a dash, and must\n match the certificate data in the request. For example SHA1-a3d1c5.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified certificate.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param certificate_name [String] The identifier for the certificate. This\n must be made up of algorithm and thumbprint separated by a dash, and must\n match the certificate data in the request. For example SHA1-a3d1c5.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes all terms from the list with list Id equal to the list Id passed.\n\n @param list_id [String] List Id of the image list.\n @param language [String] Language of the terms.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [String] operation results.", "Lists a collection of current quota counter periods associated with the\n counter-key configured in the policy on the specified service instance. The\n api does not support paging yet.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param quota_counter_key [String] Quota counter key identifier.This is the\n result of expression defined in counter-key attribute of the quota-by-key\n policy.For Example, if you specify counter-key=\"boo\" in the policy, then it\u2019s\n accessible by \"boo\" counter key. But if it\u2019s defined as\n counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a network watcher in the specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_watcher_name [String] The name of the network watcher.\n @param parameters [NetworkWatcher] Parameters that define the network watcher\n resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a network watcher tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_watcher_name [String] The name of the network watcher.\n @param parameters [TagsObject] Parameters supplied to update network watcher\n tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all network watchers by subscription.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [NetworkWatcherListResult] operation results.", "Deletes the specified network watcher resource.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_watcher_name [String] The name of the network watcher.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates or updates a firewall rule.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param firewall_rule_name [String] The name of the firewall rule.\n @param parameters [FirewallRule] The required parameters for creating or\n updating a firewall rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a firewall rule.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param firewall_rule_name [String] The name of the firewall rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a firewall rule.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param firewall_rule_name [String] The name of the firewall rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a Hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the Hub.\n @param parameters [Hub] Parameters supplied to the Update Hub operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the backup policy associated with the Recovery Services\n vault. This is an asynchronous operation. Use the GetPolicyOperationResult\n API to Get the operation status.\n\n @param vault_name [String] The name of the Recovery Services vault.\n @param resource_group_name [String] The name of the resource group associated\n with the Recovery Services vault.\n @param policy_name [String] The backup policy name used in this GET\n operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified backup policy from your Recovery Services vault. This\n is an asynchronous operation. Use the GetPolicyOperationResult API to Get the\n operation status.\n\n @param vault_name [String] The name of the Recovery Services vault.\n @param resource_group_name [String] The name of the resource group associated\n with the Recovery Services vault.\n @param policy_name [String] The name of the backup policy to be deleted.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a DDoS custom policy.\n\n @param resource_group_name [String] The name of the resource group.\n @param ddos_custom_policy_name [String] The name of the DDoS custom policy.\n @param parameters [DdosCustomPolicy] Parameters supplied to the create or\n update operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update a DDoS custom policy tags\n\n @param resource_group_name [String] The name of the resource group.\n @param ddos_custom_policy_name [String] The name of the DDoS custom policy.\n @param parameters [TagsObject] Parameters supplied to the update DDoS custom\n policy resource tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the managed application.\n\n @param application_id [String] The fully qualified ID of the managed\n application, including the managed application name and the managed\n application resource type. Use the format,\n /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name}\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Application] operation results.", "Gets a list of workflows by subscription.\n\n @param top [Integer] The number of items to be included in the result.\n @param filter [String] The filter to apply on the operation. Options for\n filters include: State, Trigger, and ReferencedResourceId.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Disables a workflow.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Enables a workflow.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets an OpenAPI definition for the workflow.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Object] operation results.", "Get the number of iot hubs in the subscription\n\n Get the number of free and paid iot hubs in the subscription\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [UserSubscriptionQuotaListResult] operation results.", "Gets the specified route table.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_table_name [String] The name of the route table.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified route table.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_table_name [String] The name of the route table.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Create or updates a route table in a specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_table_name [String] The name of the route table.\n @param parameters [RouteTable] Parameters supplied to the create or update\n route table operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a route table tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_table_name [String] The name of the route table.\n @param parameters [TagsObject] Parameters supplied to update route table\n tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the specified job name.\n\n @param device_name [String] The device name\n @param job_name [String] The job Name.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a local network gateway in the specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param local_network_gateway_name [String] The name of the local network\n gateway.\n @param parameters [LocalNetworkGateway] Parameters supplied to the create or\n update local network gateway operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a local network gateway tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param local_network_gateway_name [String] The name of the local network\n gateway.\n @param parameters [TagsObject] Parameters supplied to update local network\n gateway tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the managed application definition.\n\n @param application_definition_id [String] The fully qualified ID of the\n managed application definition, including the managed application name and\n the managed application definition resource type. Use the format,\n /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplicationDefinition] operation results.", "Creates a new managed application definition.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param application_definition_name [String] The name of the managed\n application definition.\n @param parameters [ApplicationDefinition] Parameters supplied to the create\n or update an managed application definition.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a capacity pool\n\n @param resource_group_name [String] The name of the resource group.\n @param account_name [String] The name of the NetApp account\n @param pool_name [String] The name of the capacity pool\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns backup management server registered to Recovery Services Vault.\n\n @param vault_name [String] The name of the recovery services vault.\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param backup_engine_name [String] Name of the backup management server.\n @param filter [String] OData filter options.\n @param skip_token [String] skipToken Filter.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [BackupEngineBaseResource] operation results.", "Replace all specified Event Hubs Cluster settings with those contained in the\n request body. Leaves the settings not specified in the request body\n unmodified.\n\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param cluster_name [String] The name of the Event Hubs Cluster.\n @param parameters [ClusterQuotaConfigurationProperties] Parameters for\n creating an Event Hubs Cluster resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns the list of devices for the specified manager.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param expand [String] Specify $expand=details to populate additional fields\n related to the device or $expand=rolloverdetails to populate additional\n fields related to the service data encryption key rollover on device\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns the properties of the specified device.\n\n @param device_name [String] The device name\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param expand [String] Specify $expand=details to populate additional fields\n related to the device or $expand=rolloverdetails to populate additional\n fields related to the service data encryption key rollover on device\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Patches the device.\n\n @param device_name [String] The device name\n @param parameters [DevicePatch] Patch representation of the device.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the metric definitions for the specified device.\n\n @param device_name [String] The device name\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns the update summary of the specified device name.\n\n @param device_name [String] The device name\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Synchronizes access keys for the auto storage account configured for the\n specified Batch account.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Regenerates the specified account key for the Batch account.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the account.\n @param parameters [BatchAccountRegenerateKeyParameters] The type of key to\n regenerate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all default security rules in a network security group.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_security_group_name [String] The name of the network security\n group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<SecurityRule>] operation results.", "Get the specified default network security rule.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_security_group_name [String] The name of the network security\n group.\n @param default_security_rule_name [String] The name of the default security\n rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a Recovery Services vault.\n\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param vault_name [String] The name of the recovery services vault.\n @param vault [Vault] Recovery Services Vault to be created.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates the vault.\n\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param vault_name [String] The name of the recovery services vault.\n @param vault [PatchVault] Recovery Services Vault to be created.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a machine learning workspace with the specified parameters.\n\n @param resource_group_name [String] Name of the resource group in which\n workspace is located.\n @param workspace_name [String] Name of Azure Machine Learning workspace.\n @param parameters [WorkspaceUpdateParameters] The parameters for updating a\n machine learning workspace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Resync all the keys associated with this workspace. This includes keys for\n the storage account, app insights and password for container registry\n\n @param resource_group_name [String] Name of the resource group in which\n workspace is located.\n @param workspace_name [String] Name of Azure Machine Learning workspace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Lists all the available machine learning workspaces under the specified\n subscription.\n\n @param skiptoken [String] Continuation token for pagination.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<Workspace>] operation results.", "Updates the given recovery plan.\n\n The operation to update a recovery plan.\n\n @param recovery_plan_name [String] Recovery plan name.\n @param input [UpdateRecoveryPlanInput] Update recovery plan input\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RecoveryPlan] operation results.", "Retrieves the details of a HubVirtualNetworkConnection.\n\n @param resource_group_name [String] The resource group name of the\n VirtualHub.\n @param virtual_hub_name [String] The name of the VirtualHub.\n @param connection_name [String] The name of the vpn connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves the details of all HubVirtualNetworkConnections.\n\n @param resource_group_name [String] The resource group name of the\n VirtualHub.\n @param virtual_hub_name [String] The name of the VirtualHub.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<HubVirtualNetworkConnection>] operation results.", "Get a list of workspaces which the current user has administrator privileges\n and are not associated with an Azure Subscription. The subscriptionId\n parameter in the Url is ignored.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets the schema for a given workspace.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Log Analytics workspace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SearchGetSchemaResponse] operation results.", "Purges data in an Log Analytics workspace by a set of user-defined filters.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Log Analytics workspace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkspacePurgeResponse] operation results.", "Gets status of an ongoing purge operation.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Log Analytics workspace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkspacePurgeStatusResponse] operation results.", "Gets a job.\n\n @param resource_group_name [String] The resource group name.\n @param job_collection_name [String] The job collection name.\n @param job_name [String] The job name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates an instance pool.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param instance_pool_name [String] The name of the instance pool to be\n created or updated.\n @param parameters [InstancePool] The requested instance pool resource state.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates an instance pool.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param instance_pool_name [String] The name of the instance pool to be\n updated.\n @param parameters [InstancePoolUpdate] The requested instance pool resource\n state.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the specified network security rule.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_security_group_name [String] The name of the network security\n group.\n @param security_rule_name [String] The name of the security rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified network security rule.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_security_group_name [String] The name of the network security\n group.\n @param security_rule_name [String] The name of the security rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or Update the module identified by module name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param module_name [String] The name of module.\n @param parameters [ModuleCreateOrUpdateParameters] The create or update\n parameters for module.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update the module identified by module name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param module_name [String] The name of module.\n @param parameters [ModuleUpdateParameters] The update parameters for module.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a list of the available domains.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Get information about a specific domain.\n\n @param domain_id The id of the domain to get information about.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Domain] operation results.", "Gets the number of untagged images.\n\n This API returns the images which have no tags for a given project and\n optionally an iteration. If no iteration is specified the\n current workspace is used.\n\n @param project_id The project id.\n @param iteration_id The iteration id. Defaults to workspace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Number] operation results.", "Associate a set of images with a set of tags.\n\n @param project_id The project id.\n @param batch [ImageTagCreateBatch] Batch of image tags. Limited to 128 tags\n per batch.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ImageTagCreateSummary] operation results.", "Create a set of image regions.\n\n This API accepts a batch of image regions, and optionally tags, to update\n existing images with region information.\n There is a limit of 64 entries in the batch.\n\n @param project_id The project id.\n @param batch [ImageRegionCreateBatch] Batch of image regions which include a\n tag and bounding box. Limited to 64.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ImageRegionCreateSummary] operation results.", "Delete a set of image regions.\n\n @param project_id The project id.\n @param region_ids Regions to delete. Limited to 64.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Delete images from the set of training images.\n\n @param project_id The project id.\n @param image_ids Ids of the images to be deleted. Limited to 256 images per\n batch.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Add the provided batch of images to the set of training images.\n\n This API accepts a batch of files, and optionally tags, to create images.\n There is a limit of 64 images and 20 tags.\n\n @param project_id The project id.\n @param batch [ImageFileCreateBatch] The batch of image files to add. Limited\n to 64 images and 20 tags per batch.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ImageCreateSummary] operation results.", "Add the provided images urls to the set of training images.\n\n This API accepts a batch of urls, and optionally tags, to create images.\n There is a limit of 64 images and 20 tags.\n\n @param project_id The project id.\n @param batch [ImageUrlCreateBatch] Image urls and tag ids. Limited to 64\n images and 20 tags per batch.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ImageCreateSummary] operation results.", "Add the specified predicted images to the set of training images.\n\n This API creates a batch of images from predicted images specified. There is\n a limit of 64 images and 20 tags.\n\n @param project_id The project id.\n @param batch [ImageIdCreateBatch] Image and tag ids. Limited to 64 images and\n 20 tags per batch.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ImageCreateSummary] operation results.", "Get region proposals for an image. Returns empty array if no proposals are\n found.\n\n This API will get region proposals for an image along with confidences for\n the region. It returns an empty array if no proposals are found.\n\n @param project_id The project id.\n @param image_id The image id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ImageRegionProposal] operation results.", "Delete a set of predicted images and their associated prediction results.\n\n @param project_id The project id.\n @param ids The prediction ids. Limited to 64.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get images that were sent to your prediction endpoint.\n\n @param project_id The project id.\n @param query [PredictionQueryToken] Parameters used to query the predictions.\n Limited to combining 2 tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PredictionQueryResult] operation results.", "Get your projects.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Create a project.\n\n @param name [String] Name of the project.\n @param description [String] The description of the project.\n @param domain_id The id of the domain to use for this project. Defaults to\n General.\n @param classification_type [Enum] The type of classifier to create for this\n project. Possible values include: 'Multiclass', 'Multilabel'\n @param target_export_platforms [Array<Enum>] List of platforms the trained\n model is intending exporting to.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a specific project.\n\n @param project_id The id of the project to get.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Project] operation results.", "Update a specific project.\n\n @param project_id The id of the project to update.\n @param updated_project [Project] The updated project model.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Project] operation results.", "Get iterations for the project.\n\n @param project_id The project id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Get a specific iteration.\n\n @param project_id The id of the project the iteration belongs to.\n @param iteration_id The id of the iteration to get.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Iteration] operation results.", "Delete a specific iteration of a project.\n\n @param project_id The project id.\n @param iteration_id The iteration id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Unpublish a specific iteration.\n\n @param project_id The project id.\n @param iteration_id The iteration id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get the list of exports for a specific iteration.\n\n @param project_id The project id.\n @param iteration_id The iteration id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Delete a tag from the project.\n\n @param project_id The project id.\n @param tag_id Id of the tag to be deleted.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get the tags for a given project and iteration.\n\n @param project_id The project id.\n @param iteration_id The iteration id. Defaults to workspace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets an integration account agreement.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param agreement_name [String] The integration account agreement name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an integration account agreement.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param agreement_name [String] The integration account agreement name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "De-associates subscription from the management group.\n\n @param group_id [String] Management Group ID.\n @param subscription_id [String] Subscription ID.\n @param cache_control [String] Indicates that the request shouldn't utilize\n any caches.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a database's vulnerability assessment rule baseline.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param database_name [String] The name of the database for which the\n vulnerability assessment rule baseline is defined.\n @param rule_id [String] The vulnerability assessment rule ID.\n @param baseline_name [VulnerabilityAssessmentPolicyBaselineName] The name of\n the vulnerability assessment rule baseline (default implies a baseline on a\n database level rule and master for server level rule). Possible values\n include: 'master', 'default'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Removes the database's vulnerability assessment rule baseline.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param database_name [String] The name of the database for which the\n vulnerability assessment rule baseline is defined.\n @param rule_id [String] The vulnerability assessment rule ID.\n @param baseline_name [VulnerabilityAssessmentPolicyBaselineName] The name of\n the vulnerability assessment rule baseline (default implies a baseline on a\n database level rule and master for server level rule). Possible values\n include: 'master', 'default'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all available server variables.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Lists all available request headers.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Lists all available response headers.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Lists all available web application firewall rule sets.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplicationGatewayAvailableWafRuleSetsResult] operation results.", "Lists available Ssl options for configuring Ssl policy.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplicationGatewayAvailableSslOptions] operation results.", "Gets Ssl predefined policy with the specified policy name.\n\n @param predefined_policy_name [String] Name of Ssl predefined policy.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplicationGatewaySslPredefinedPolicy] operation results.", "Creates or updates the specified application gateway.\n\n @param resource_group_name [String] The name of the resource group.\n @param application_gateway_name [String] The name of the application gateway.\n @param parameters [ApplicationGateway] Parameters supplied to the create or\n update application gateway operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all the available prebuilt entities in a version of the application.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets information about customizable prebuilt intents added to a version of\n the application.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets all prebuilt entities used in a version of the application.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets all prebuilt intent and entity model information used in a version of\n this application.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets details about the specified Analysis Services server.\n\n @param resource_group_name [String] The name of the Azure Resource group of\n which a given Analysis Services server is part. This name must be at least 1\n character in length, and no more than 90.\n @param server_name [String] The name of the Analysis Services server. It must\n be a minimum of 3 characters, and a maximum of 63.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AnalysisServicesServer] operation results.", "Lists eligible SKUs for Analysis Services resource provider.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SkuEnumerationForNewResourceResult] operation results.", "Lists eligible SKUs for an Analysis Services resource.\n\n @param resource_group_name [String] The name of the Azure Resource group of\n which a given Analysis Services server is part. This name must be at least 1\n character in length, and no more than 90.\n @param server_name [String] The name of the Analysis Services server. It must\n be at least 3 characters in length, and no more than 63.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SkuEnumerationForExistingResourceResult] operation results.", "Return the gateway status of the specified Analysis Services server instance.\n\n @param resource_group_name [String] The name of the Azure Resource group of\n which a given Analysis Services server is part. This name must be at least 1\n character in length, and no more than 90.\n @param server_name [String] The name of the Analysis Services server.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [GatewayListStatusLive] operation results.", "Dissociates a Unified Gateway associated with the server.\n\n @param resource_group_name [String] The name of the Azure Resource group of\n which a given Analysis Services server is part. This name must be at least 1\n character in length, and no more than 90.\n @param server_name [String] The name of the Analysis Services server. It must\n be at least 3 characters in length, and no more than 63.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "List the result of the specified operation.\n\n @param location [String] The region name which the operation will lookup\n into.\n @param operation_id [String] The target operation Id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "List the status of operation.\n\n @param location [String] The region name which the operation will lookup\n into.\n @param operation_id [String] The target operation Id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatus] operation results.", "Provisions the specified Analysis Services server based on the configuration\n specified in the request.\n\n @param resource_group_name [String] The name of the Azure Resource group of\n which a given Analysis Services server is part. This name must be at least 1\n character in length, and no more than 90.\n @param server_name [String] The name of the Analysis Services server. It must\n be a minimum of 3 characters, and a maximum of 63.\n @param server_parameters [AnalysisServicesServer] Contains the information\n used to provision the Analysis Services server.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates the current state of the specified Analysis Services server.\n\n @param resource_group_name [String] The name of the Azure Resource group of\n which a given Analysis Services server is part. This name must be at least 1\n character in length, and no more than 90.\n @param server_name [String] The name of the Analysis Services server. It must\n be at least 3 characters in length, and no more than 63.\n @param server_update_parameters [AnalysisServicesServerUpdateParameters]\n Request object that contains the updated information for the server.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Resumes operation of the specified Analysis Services server instance.\n\n @param resource_group_name [String] The name of the Azure Resource group of\n which a given Analysis Services server is part. This name must be at least 1\n character in length, and no more than 90.\n @param server_name [String] The name of the Analysis Services server. It must\n be at least 3 characters in length, and no more than 63.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get a Content Key Policy\n\n Get the details of a Content Key Policy in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param content_key_policy_name [String] The Content Key Policy name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a Content Key Policy\n\n Deletes a Content Key Policy in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param content_key_policy_name [String] The Content Key Policy name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets load balancer backend address pool.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param backend_address_pool_name [String] The name of the backend address\n pool.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a sync agent.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server on which the sync agent is\n hosted.\n @param sync_agent_name [String] The name of the sync agent.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a sync agent.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server on which the sync agent is\n hosted.\n @param sync_agent_name [String] The name of the sync agent.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets specific OpenID Connect Provider.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param opid [String] Identifier of the OpenID Connect Provider.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the value of the quota counter associated with the counter-key in the\n policy for the specific period in service instance.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param quota_counter_key [String] Quota counter key identifier.This is the\n result of expression defined in counter-key attribute of the quota-by-key\n policy.For Example, if you specify counter-key=\"boo\" in the policy, then it\u2019s\n accessible by \"boo\" counter key. But if it\u2019s defined as\n counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key\n @param quota_period_key [String] Quota period key identifier.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates an existing quota counter value in the specified service instance.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param quota_counter_key [String] Quota counter key identifier.This is the\n result of expression defined in counter-key attribute of the quota-by-key\n policy.For Example, if you specify counter-key=\"boo\" in the policy, then it\u2019s\n accessible by \"boo\" counter key. But if it\u2019s defined as\n counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key\n @param quota_period_key [String] Quota period key identifier.\n @param parameters [QuotaCounterValueContractProperties] The value of the\n Quota counter to be applied on the specified period.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets an integration account schema.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param schema_name [String] The integration account schema name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an integration account schema.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param schema_name [String] The integration account schema name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a SQL virtual machine.\n\n @param resource_group_name [String] Name of the resource group that contains\n the resource. You can obtain this value from the Azure Resource Manager API\n or the portal.\n @param sql_virtual_machine_name [String] Name of the SQL virtual machine.\n @param expand [String] The child resources to include in the response.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a SQL virtual machine.\n\n @param resource_group_name [String] Name of the resource group that contains\n the resource. You can obtain this value from the Azure Resource Manager API\n or the portal.\n @param sql_virtual_machine_name [String] Name of the SQL virtual machine.\n @param parameters [SqlVirtualMachine] The SQL virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a SQL virtual machine.\n\n @param resource_group_name [String] Name of the resource group that contains\n the resource. You can obtain this value from the Azure Resource Manager API\n or the portal.\n @param sql_virtual_machine_name [String] Name of the SQL virtual machine.\n @param parameters [SqlVirtualMachineUpdate] The SQL virtual machine.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List available SKUs for the requested Cognitive Services account\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription.\n @param account_name [String] The name of the cognitive services account\n within the specified resource group. Cognitive Services account names must be\n between 3 and 24 characters in length and use numbers and lower-case letters\n only.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CognitiveServicesAccountEnumerateSkusResult] operation results.", "Checks the availability of the given service namespace across all Azure\n subscriptions. This is useful because the domain name is created based on the\n service namespace name.\n\n @param parameters [CheckAvailabilityParameters] The namespace name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CheckAvailabilityResult] operation results.", "Patches the existing namespace\n\n @param resource_group_name [String] The name of the resource group.\n @param namespace_name [String] The namespace name.\n @param parameters [NamespacePatchParameters] Parameters supplied to patch a\n Namespace Resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists the policies for the specified container registry.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RegistryPolicies] operation results.", "Updates the properties of an existing pool.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param pool_name [String] The pool name. This must be unique within the\n account.\n @param parameters [Pool] Pool properties that should be updated. Properties\n that are supplied will be updated, any property not supplied will be\n unchanged.\n @param if_match [String] The entity state (ETag) version of the pool to\n update. This value can be omitted or set to \"*\" to apply the operation\n unconditionally.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a new pool inside the specified account.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param pool_name [String] The pool name. This must be unique within the\n account.\n @param parameters [Pool] Additional parameters for pool creation.\n @param if_match [String] The entity state (ETag) version of the pool to\n update. A value of \"*\" can be used to apply the operation only if the pool\n already exists. If omitted, this operation will always be applied.\n @param if_none_match [String] Set to '*' to allow a new pool to be created,\n but to prevent updating an existing pool. Other values will be ignored.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Pool] operation results.", "Creates an application package record.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param application_id [String] The ID of the application.\n @param version [String] The version of the application.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an application package record and its associated binary file.\n\n @param resource_group_name [String] The name of the resource group that\n contains the Batch account.\n @param account_name [String] The name of the Batch account.\n @param application_id [String] The ID of the application.\n @param version [String] The version of the application to delete.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified Data Lake Analytics firewall rule.\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Analytics account.\n @param firewall_rule_name [String] The name of the firewall rule to retrieve.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified firewall rule from the specified Data Lake Analytics\n account\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Analytics account.\n @param firewall_rule_name [String] The name of the firewall rule to delete.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "The configuration object for the specified cluster. This API is not\n recommended and might be removed in the future. Please consider using List\n configurations API instead.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster.\n @param configuration_name [String] The name of the cluster configuration.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates the specified ExpressRoutePort resource.\n\n @param resource_group_name [String] The name of the resource group.\n @param express_route_port_name [String] The name of the ExpressRoutePort\n resource.\n @param parameters [ExpressRoutePort] Parameters supplied to the create\n ExpressRoutePort operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update ExpressRoutePort tags\n\n @param resource_group_name [String] The name of the resource group.\n @param express_route_port_name [String] The name of the ExpressRoutePort\n resource.\n @param parameters [TagsObject] Parameters supplied to update ExpressRoutePort\n resource tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the tag specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param tag_id [String] Tag identifier. Must be unique in the current API\n Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all Tags associated with the Operation.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TagCollection] operation results.", "Checks whether the specified user, group, contact, or service principal is a\n direct or transitive member of the specified group.\n\n @param parameters [CheckGroupMembershipParameters] The check group membership\n parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CheckGroupMembershipResult] operation results.", "Remove a member from a group.\n\n @param group_object_id [String] The object ID of the group from which to\n remove the member.\n @param member_object_id [String] Member object id\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Add a member to a group.\n\n @param group_object_id [String] The object ID of the group to which to add\n the member.\n @param parameters [GroupAddMemberParameters] The URL of the member object,\n such as\n https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets endpoint keys for an endpoint\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EndpointKeysDTO] operation results.", "Re-generates an endpoint key.\n\n @param key_type [String] Type of Key\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EndpointKeysDTO] operation results.", "Discovers all the containers in the subscription that can be backed up to\n Recovery Services Vault. This is an\n asynchronous operation. To know the status of the operation, call\n GetRefreshOperationResult API.\n\n @param vault_name [String] The name of the recovery services vault.\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param fabric_name [String] Fabric name associated the container.\n @param filter [String] OData filter options.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Lists existing CDN endpoints within a profile.\n\n @param profile_name [String] Name of the CDN profile within the resource\n group.\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EndpointListResult] operation results.", "Deletes an existing CDN endpoint with the specified parameters.\n\n @param endpoint_name [String] Name of the endpoint within the CDN profile.\n @param profile_name [String] Name of the CDN profile within the resource\n group.\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates virtual wan vpn gateway tags.\n\n @param resource_group_name [String] The resource group name of the\n VpnGateway.\n @param gateway_name [String] The name of the gateway.\n @param vpn_gateway_parameters [TagsObject] Parameters supplied to update a\n virtual wan vpn gateway tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Cancels the asynchronous operation on the database.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database.\n @param operation_id The operation identifier.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a database service objective.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param service_objective_name [String] The name of the service objective to\n retrieve.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets details of a specific long running operation.\n\n @param operation_id [String] Operation id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Operation] operation results.", "Creates a new CDN profile with the specified parameters.\n\n @param profile_name [String] Name of the CDN profile within the resource\n group.\n @param profile_properties [ProfileCreateParameters] Profile properties needed\n for creation.\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get lab account\n\n @param resource_group_name [String] The name of the resource group.\n @param lab_account_name [String] The name of the lab Account.\n @param expand [String] Specify the $expand query. Example:\n 'properties($expand=sizeConfiguration)'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete lab account. This operation can take a while to complete\n\n @param resource_group_name [String] The name of the resource group.\n @param lab_account_name [String] The name of the lab Account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get regional availability information for each size category configured under\n a lab account\n\n @param resource_group_name [String] The name of the resource group.\n @param lab_account_name [String] The name of the lab Account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [GetRegionalAvailabilityResponse] operation results.", "Updates an existing AlertRuleResource. To update other fields use the\n CreateOrUpdate method.\n\n @param resource_group_name [String] The name of the resource group.\n @param rule_name [String] The name of the rule.\n @param alert_rules_resource [AlertRuleResourcePatch] Parameters supplied to\n the operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a job collection.\n\n @param resource_group_name [String] The resource group name.\n @param job_collection_name [String] The job collection name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets a deleted database that can be restored\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param restorable_droppeded_database_id [String] The id of the deleted\n database in the form of databaseName,deletionTimeInFileTimeFormat\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified route filter.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_filter_name [String] The name of the route filter.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the specified route filter.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_filter_name [String] The name of the route filter.\n @param expand [String] Expands referenced express route bgp peering\n resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a specified persisted script action of the cluster.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster.\n @param script_name [String] The name of the script.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the Api Version Set specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param version_set_id [String] Api Version Set identifier. Must be unique in\n the current API Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a server.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param parameters [Server] The requested server resource state.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update an identity in the specified subscription and resource\n group.\n\n @param resource_group_name [String] The name of the Resource Group to which\n the identity belongs.\n @param resource_name [String] The name of the identity resource.\n @param parameters [Identity] Parameters to create or update the identity\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update an identity in the specified subscription and resource group.\n\n @param resource_group_name [String] The name of the Resource Group to which\n the identity belongs.\n @param resource_name [String] The name of the identity resource.\n @param parameters [Identity] Parameters to update the identity\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified nat gateway in a specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param nat_gateway_name [String] The name of the nat gateway.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates nat gateway tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param nat_gateway_name [String] The name of the nat gateway.\n @param parameters [TagsObject] Parameters supplied to update nat gateway\n tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a nat gateway.\n\n @param resource_group_name [String] The name of the resource group.\n @param nat_gateway_name [String] The name of the nat gateway.\n @param parameters [NatGateway] Parameters supplied to the create or update\n nat gateway operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates the specified Azure Firewall.\n\n @param resource_group_name [String] The name of the resource group.\n @param azure_firewall_name [String] The name of the Azure Firewall.\n @param parameters [AzureFirewall] Parameters supplied to the create or update\n Azure Firewall operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get an Asset\n\n Get the details of an Asset in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param asset_name [String] The Asset name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete an Asset.\n\n Deletes an Asset in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param asset_name [String] The Asset name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified load balancer load balancing rule.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param load_balancing_rule_name [String] The name of the load balancing rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates the policy.\n\n The operation to create a replication policy\n\n @param policy_name [String] Replication policy name\n @param input [CreatePolicyInput] Create policy input\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Policy] operation results.", "Updates the protection profile.\n\n The operation to update a replication policy.\n\n @param policy_name [String] Protection profile Id.\n @param input [UpdatePolicyInput] Update Protection Profile Input\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Policy] operation results.", "Gets an existing custom domain within an endpoint.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param endpoint_name [String] Name of the endpoint under the profile which is\n unique globally.\n @param custom_domain_name [String] Name of the custom domain within an\n endpoint.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the management lock of a resource group.\n\n @param resource_group_name [String] The resource group name.\n @param lock_name [String] The name of lock.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets a management lock at the resource group level.\n\n @param resource_group_name [String] The resource group name.\n @param lock_name [String] The lock name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ManagementLockObject] operation results.", "Create or update a management lock at the subscription level.\n\n @param lock_name [String] The name of lock.\n @param parameters [ManagementLockObject] The management lock parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ManagementLockObject] operation results.", "Gets an authorization policy in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param authorization_policy_name [String] The name of the policy.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets subscription-level properties and limits for Data Lake Analytics\n specified by resource location.\n\n @param location [String] The resource location without whitespace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CapabilityInformation] operation results.", "Gets a list of supported orchestrators in the specified subscription.\n\n Gets a list of supported orchestrators in the specified subscription. The\n operation returns properties of each orchestrator including version and\n available upgrades.\n\n @param location [String] The name of a supported Azure region.\n @param resource_type [String] resource type for which the list of\n orchestrators needs to be returned\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OrchestratorVersionProfileListResult] operation results.", "Delete a Spatial Anchors Account.\n\n @param resource_group_name [String] Name of an Azure resource group.\n @param spatial_anchors_account_name [String] Name of an Mixed Reality Spatial\n Anchors Account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get Both of the 2 Keys of a Spatial Anchors Account\n\n @param resource_group_name [String] Name of an Azure resource group.\n @param spatial_anchors_account_name [String] Name of an Mixed Reality Spatial\n Anchors Account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SpatialAnchorsAccountKeys] operation results.", "Deletes the specified logger.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param logger_id [String] Logger identifier. Must be unique in the API\n Management service instance.\n @param if_match [String] ETag of the Entity. ETag should match the current\n entity state from the header response of the GET request or it should be *\n for unconditional update.\n @param force [Boolean] Force deletion even if diagnostic is attached.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Obtains the details of a suppression.\n\n @param resource_uri [String] The fully qualified Azure Resource Manager\n identifier of the resource to which the recommendation applies.\n @param recommendation_id [String] The recommendation ID.\n @param name [String] The name of the suppression.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a list of all extensions in a VM scale set.\n\n @param resource_group_name [String] The name of the resource group.\n @param vm_scale_set_name [String] The name of the VM scale set containing the\n extension.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<VirtualMachineScaleSetExtension>] operation results.", "Delete the dsc node identified by node id.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param node_id [String] The node id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update the dsc node.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param node_id [String] Parameters supplied to the update dsc node.\n @param parameters [DscNodeUpdateParameters] Parameters supplied to the update\n dsc node.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve all the job streams for the compilation Job.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param job_id The job id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [JobStreamListResult] operation results.", "Deletes an existing CDN profile with the specified parameters. Deleting a\n profile will result in the deletion of all of the sub-resources including\n endpoints, origins and custom domains.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal.\n Supplemental portal is used to configure advanced feature capabilities that\n are not yet available in the Azure portal, such as core reports in a standard\n profile; rules engine, advanced HTTP reports, and real-time stats and alerts\n in a premium profile. The SSO URI changes approximately every 10 minutes.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SsoUri] operation results.", "Updates an existing CDN profile with the specified profile name under the\n specified subscription and resource group.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param profile_name [String] Name of the CDN profile which is unique within\n the resource group.\n @param profile_update_parameters [ProfileUpdateParameters] Profile properties\n needed to update an existing profile.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates the manager.\n\n @param parameters [Manager] The manager.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns the encryption settings of the manager.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [EncryptionSettings] operation results.", "Returns the extended information of the specified manager name.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ManagerExtendedInfo] operation results.", "Deletes the extended info of the manager.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Returns the activation key of the manager.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Key] operation results.", "Returns the symmetric encrypted public encryption key of the manager.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SymmetricEncryptedSecret] operation results.", "Re-generates and returns the activation key of the manager.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Key] operation results.", "Deletes the specified virtual network.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_name [String] The name of the virtual network.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates or updates a virtual network in the specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_name [String] The name of the virtual network.\n @param parameters [VirtualNetwork] Parameters supplied to the create or\n update virtual network operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a virtual network tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_name [String] The name of the virtual network.\n @param parameters [TagsObject] Parameters supplied to update virtual network\n tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the specified service endpoint policy definitions from service endpoint\n policy.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_endpoint_policy_name [String] The name of the service endpoint\n policy name.\n @param service_endpoint_policy_definition_name [String] The name of the\n service endpoint policy definition name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all service endpoint policy definitions in a service end point policy.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_endpoint_policy_name [String] The name of the service endpoint\n policy name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<ServiceEndpointPolicyDefinition>] operation results.", "Returns the provisioning status of the resource\n\n @return [String] provisioning status of the resource", "Returns the amount of time in seconds for long running operation polling delay.\n\n @return [Integer] Amount of time in seconds for long running operation polling delay.", "Updates the polling state from the fields of given response object.\n @param response [Net::HTTPResponse] the HTTP response.", "Gets the specified Data Lake Store trusted identity provider.\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Store account.\n @param trusted_id_provider_name [String] The name of the trusted identity\n provider to retrieve.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified trusted identity provider from the specified Data Lake\n Store account\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Store account.\n @param trusted_id_provider_name [String] The name of the trusted identity\n provider to delete.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Summarizes policy states for the resources under the management group.\n\n @param management_group_name [String] Management group name.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SummarizeResults] operation results.", "Queries policy states for the resources under the subscription.\n\n @param policy_states_resource [PolicyStatesResource] The virtual resource\n under PolicyStates resource type. In a given time range, 'latest' represents\n the latest policy state(s), whereas 'default' represents all policy state(s).\n Possible values include: 'default', 'latest'\n @param subscription_id [String] Microsoft Azure subscription ID.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Summarizes policy states for the resources under the subscription.\n\n @param subscription_id [String] Microsoft Azure subscription ID.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SummarizeResults] operation results.", "Summarizes policy states for the resource.\n\n @param resource_id [String] Resource ID.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SummarizeResults] operation results.", "Queries policy states for the subscription level policy set definition.\n\n @param policy_states_resource [PolicyStatesResource] The virtual resource\n under PolicyStates resource type. In a given time range, 'latest' represents\n the latest policy state(s), whereas 'default' represents all policy state(s).\n Possible values include: 'default', 'latest'\n @param subscription_id [String] Microsoft Azure subscription ID.\n @param policy_set_definition_name [String] Policy set definition name.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PolicyStatesQueryResults] operation results.", "Queries policy states for the subscription level policy definition.\n\n @param policy_states_resource [PolicyStatesResource] The virtual resource\n under PolicyStates resource type. In a given time range, 'latest' represents\n the latest policy state(s), whereas 'default' represents all policy state(s).\n Possible values include: 'default', 'latest'\n @param subscription_id [String] Microsoft Azure subscription ID.\n @param policy_definition_name [String] Policy definition name.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PolicyStatesQueryResults] operation results.", "Gets OData metadata XML document.\n\n @param scope [String] A valid scope, i.e. management group, subscription,\n resource group, or resource ID. Scope used has no effect on metadata\n returned.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [String] operation results.", "Creates and initialize new instance of the DeserializationError class.\n @param [String] message message the human readable description of error.\n @param [String] exception_message the inner exception stacktrace.\n @param [String] exception_stacktrace the inner exception stacktrace.\n @param [MsRest::HttpOperationResponse] the request and response", "Gets the current usage count and the limit for the resources of the location\n under the subscription.\n\n @param location [String] The location of the Azure Storage resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [UsageListResult] operation results.", "Returns review details for the review Id passed.\n\n @param team_name [String] Your Team Name.\n @param review_id [String] Id of the review.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Review] operation results.", "Get the Job Details for a Job Id.\n\n @param team_name [String] Your Team Name.\n @param job_id [String] Id of the job.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Job] operation results.", "Publish video review to make it available for review.\n\n @param team_name [String] Your team name.\n @param review_id [String] Id of the review.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets information about the specified network interface.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_interface_name [String] The name of the network interface.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the capabilities for the specified location.\n\n @param location [String] The location.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CapabilitiesResult] operation results.", "Lists the usages for the specified location.\n\n @param location [String] The location.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [UsagesListResult] operation results.", "Regenerate a primary or secondary agent registration key\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param parameters [AgentRegistrationRegenerateKeyParameter] The name of the\n agent registration key to be regenerated\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a workflow access key.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param access_key_name [String] The workflow access key name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a Private DNS zone. Does not modify virtual network links or DNS\n records within the zone.\n\n @param resource_group_name [String] The name of the resource group.\n @param private_zone_name [String] The name of the Private DNS zone (without a\n terminating dot).\n @param parameters [PrivateZone] Parameters supplied to the Update operation.\n @param if_match [String] The ETag of the Private DNS zone. Omit this value to\n always overwrite the current zone. Specify the last-seen ETag value to\n prevent accidentally overwriting any concurrent changes.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PrivateZone] operation results.", "Creates a view or updates an exisiting view in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param view_name [String] The name of the view.\n @param parameters [ViewResourceFormat] Parameters supplied to the\n CreateOrUpdate View operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a view in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param view_name [String] The name of the view.\n @param user_id [String] The user ID. Use * to retreive hub level view.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Calculate price for a `ReservationOrder`.\n\n Calculate price for placing a `ReservationOrder`.\n\n @param body [PurchaseRequest] Information needed for calculate or purchase\n reservation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CalculatePriceResponse] operation results.", "Creates a connector mapping or updates an existing connector mapping in the\n connector.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param connector_name [String] The name of the connector.\n @param mapping_name [String] The name of the connector mapping.\n @param parameters [ConnectorMappingResourceFormat] Parameters supplied to the\n CreateOrUpdate Connector Mapping operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a connector mapping in the connector.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param connector_name [String] The name of the connector.\n @param mapping_name [String] The name of the connector mapping.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update log search Rule.\n\n @param resource_group_name [String] The name of the resource group.\n @param rule_name [String] The name of the rule.\n @param parameters [LogSearchRuleResourcePatch] The parameters of the rule to\n update.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List the Log Search rules within a subscription group.\n\n @param filter [String] The filter to apply on the operation. For more\n information please see\n https://msdn.microsoft.com/en-us/library/azure/dn931934.aspx\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [LogSearchRuleResourceCollection] operation results.", "Attempts to enable a user managed key vault for encryption of the specified\n Data Lake Store account.\n\n @param resource_group_name [String] The name of the Azure resource group that\n contains the Data Lake Store account.\n @param account_name [String] The name of the Data Lake Store account to\n attempt to enable the Key Vault for.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets a workflow version.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param version_id [String] The workflow versionId.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the callback url for a trigger of a workflow version.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param version_id [String] The workflow versionId.\n @param trigger_name [String] The workflow trigger name.\n @param parameters [GetCallbackUrlParameters] The callback URL parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets information about the specified interaction.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param interaction_name [String] The name of the interaction.\n @param locale_code [String] Locale of interaction to retrieve, default is\n en-us.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates an interaction or updates an existing interaction within a hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param interaction_name [String] The name of the interaction.\n @param parameters [InteractionResourceFormat] Parameters supplied to the\n CreateOrUpdate Interaction operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Queries policy events for the resources under the subscription.\n\n @param subscription_id [String] Microsoft Azure subscription ID.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PolicyEventsQueryResults] operation results.", "Deletes the specified Logger from Diagnostic.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param diagnostic_id [String] Diagnostic identifier. Must be unique in the\n current API Management service instance.\n @param loggerid [String] Logger identifier. Must be unique in the API\n Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves the subscription's current quota information in a particular\n region.\n\n @param location [String] The region in which to retrieve the subscription's\n quota information. You can find out which regions Azure Stream Analytics is\n supported in here: https://azure.microsoft.com/en-us/regions/\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SubscriptionQuotasListResult] operation results.", "Create vault extended info.\n\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param vault_name [String] The name of the recovery services vault.\n @param resource_resource_extended_info_details [VaultExtendedInfoResource]\n Details of ResourceExtendedInfo\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update vault extended info.\n\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param vault_name [String] The name of the recovery services vault.\n @param resource_resource_extended_info_details [VaultExtendedInfoResource]\n Details of ResourceExtendedInfo\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all of the available CDN REST API operations.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationListResult] operation results.", "Gets the properties of the specified replication.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param replication_name [String] The name of the replication.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a replication from a container registry.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param replication_name [String] The name of the replication.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified interface endpoint by resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param interface_endpoint_name [String] The name of the interface endpoint.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates an interface endpoint in the specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param interface_endpoint_name [String] The name of the interface endpoint.\n @param parameters [InterfaceEndpoint] Parameters supplied to the create or\n update interface endpoint operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete environment. This operation can take a while to complete\n\n @param resource_group_name [String] The name of the resource group.\n @param lab_account_name [String] The name of the lab Account.\n @param lab_name [String] The name of the lab.\n @param environment_setting_name [String] The name of the environment Setting.\n @param environment_name [String] The name of the environment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update a role.\n\n @param device_name [String] The device name.\n @param name [String] The role name.\n @param role [Role] The role properties.\n @param resource_group_name [String] The resource group name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the status of the most recent synchronization between the configuration\n database and the Git repository.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TenantConfigurationSyncStateContract] operation results.", "List database schemas\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database.\n @param filter [String] An OData filter expression that filters elements in\n the collection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves information about a gallery Image Definition.\n\n @param resource_group_name [String] The name of the resource group.\n @param gallery_name [String] The name of the Shared Image Gallery from which\n the Image Definitions are to be retrieved.\n @param gallery_image_name [String] The name of the gallery Image Definition\n to be retrieved.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets an image.\n\n @param resource_group_name [String] The name of the resource group.\n @param image_name [String] The name of the image.\n @param expand [String] The expand expression to apply on the operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update an image.\n\n @param resource_group_name [String] The name of the resource group.\n @param image_name [String] The name of the image.\n @param parameters [Image] Parameters supplied to the Create Image operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update an image.\n\n @param resource_group_name [String] The name of the resource group.\n @param image_name [String] The name of the image.\n @param parameters [ImageUpdate] Parameters supplied to the Update Image\n operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update the specified ExpressRouteCrossConnection.\n\n @param resource_group_name [String] The name of the resource group.\n @param cross_connection_name [String] The name of the\n ExpressRouteCrossConnection.\n @param parameters [ExpressRouteCrossConnection] Parameters supplied to the\n update express route crossConnection operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the currently advertised ARP table associated with the express route\n cross connection in a resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param cross_connection_name [String] The name of the\n ExpressRouteCrossConnection.\n @param peering_name [String] The name of the peering.\n @param device_path [String] The path of the device\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a DDoS protection plan.\n\n @param resource_group_name [String] The name of the resource group.\n @param ddos_protection_plan_name [String] The name of the DDoS protection\n plan.\n @param parameters [DdosProtectionPlan] Parameters supplied to the create or\n update operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update a DDoS protection plan tags\n\n @param resource_group_name [String] The name of the resource group.\n @param ddos_protection_plan_name [String] The name of the DDoS protection\n plan.\n @param parameters [TagsObject] Parameters supplied to the update DDoS\n protection plan resource tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the capabilities available for the specified location.\n\n @param location_id [String] The location id whose capabilities are retrieved.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [LocationCapabilities] operation results.", "Discovers the containers in the subscription that can be protected in a\n Recovery Services vault. This is an asynchronous operation. To learn the\n status of the operation, use the GetRefreshOperationResult API.\n\n @param vault_name [String] The name of the Recovery Services vault.\n @param resource_group_name [String] The name of the resource group associated\n with the Recovery Services vault.\n @param fabric_name [String] The fabric name associated with the container.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves\n information about the specified virtual network gateway connection shared key\n through Network resource provider.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_gateway_connection_name [String] The virtual network\n gateway connection shared key name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ConnectionSharedKey] operation results.", "Creates or updates a virtual network gateway connection in the specified\n resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_gateway_connection_name [String] The name of the\n virtual network gateway connection.\n @param parameters [VirtualNetworkGatewayConnection] Parameters supplied to\n the create or update virtual network gateway connection operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a virtual network gateway connection tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_gateway_connection_name [String] The name of the\n virtual network gateway connection.\n @param parameters [TagsObject] Parameters supplied to update virtual network\n gateway connection tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a linked service instance.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Name of the Log Analytics Workspace that\n contains the linkedServices resource\n @param linked_service_name [String] Name of the linked service.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a linked service instance.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Name of the Log Analytics Workspace that\n contains the linkedServices resource\n @param linked_service_name [String] Name of the linked service.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the linked services instances in a workspace.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Name of the Log Analytics Workspace that\n contains the linked services.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [LinkedServiceListResult] operation results.", "Retrieve the Dsc node report data by node id and report id.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param node_id [String] The Dsc node id.\n @param report_id [String] The report id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets network mapping by name.\n\n Gets the details of an ASR network mapping\n\n @param fabric_name [String] Primary fabric name.\n @param network_name [String] Primary network name.\n @param network_mapping_name [String] Network mapping name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates network mapping.\n\n The operation to create an ASR network mapping.\n\n @param fabric_name [String] Primary fabric name.\n @param network_name [String] Primary network name.\n @param network_mapping_name [String] Network mapping name.\n @param input [CreateNetworkMappingInput] Create network mapping input.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves a built-in policy definition.\n\n This operation retrieves the built-in policy definition with the given name.\n\n @param policy_definition_name [String] The name of the built-in policy\n definition to get.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PolicyDefinition] operation results.", "Deletes a policy definition in a management group.\n\n This operation deletes the policy definition in the given management group\n with the given name.\n\n @param policy_definition_name [String] The name of the policy definition to\n delete.\n @param management_group_id [String] The ID of the management group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Deletes an existing CDN origin within an endpoint.\n\n @param origin_name [String] Name of the origin. Must be unique within\n endpoint.\n @param endpoint_name [String] Name of the endpoint within the CDN profile.\n @param profile_name [String] Name of the CDN profile within the resource\n group.\n @param resource_group_name [String] Name of the resource group within the\n Azure subscription.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Origin] operation results.", "List managed database schemas\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param database_name [String] The name of the database.\n @param filter [String] An OData filter expression that filters elements in\n the collection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DatabaseSchemaListResult] which provide lazy access to pages of the\n response.", "Returns list Id details of the term list with list Id equal to list Id\n passed.\n\n @param list_id [String] List Id of the image list.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TermList] operation results.", "Deletes term list with the list Id equal to list Id passed.\n\n @param list_id [String] List Id of the image list.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [String] operation results.", "Creates a Term List\n\n @param content_type [String] The content type.\n @param body [Body] Schema of the body.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TermList] operation results.", "gets all the Term Lists\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Refreshes the index of the list with list Id equal to list ID passed.\n\n @param list_id [String] List Id of the image list.\n @param language [String] Language of the terms.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RefreshIndex] operation results.", "Gets the specified route from a route table.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_table_name [String] The name of the route table.\n @param route_name [String] The name of the route.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all routes in a route table.\n\n @param resource_group_name [String] The name of the resource group.\n @param route_table_name [String] The name of the route table.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<Route>] operation results.", "Retrieves the VM Insights onboarding status for the specified resource or\n resource scope.\n\n @param resource_uri [String] The fully qualified Azure Resource manager\n identifier of the resource, or scope, whose status to retrieve.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VMInsightsOnboardingStatus] operation results.", "Create a variable.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param variable_name [String] The variable name.\n @param parameters [VariableCreateOrUpdateParameters] The parameters supplied\n to the create or update variable operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update a variable.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param variable_name [String] The variable name.\n @param parameters [VariableUpdateParameters] The parameters supplied to the\n update variable operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve the variable identified by variable name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param variable_name [String] The name of variable.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified public IP prefix in a specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param public_ip_prefix_name [String] The name of the Public IP Prefix.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a static or dynamic public IP prefix.\n\n @param resource_group_name [String] The name of the resource group.\n @param public_ip_prefix_name [String] The name of the public IP prefix.\n @param parameters [PublicIPPrefix] Parameters supplied to the create or\n update public IP prefix operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates public IP prefix tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param public_ip_prefix_name [String] The name of the public IP prefix.\n @param parameters [TagsObject] Parameters supplied to update public IP prefix\n tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets load balancer probe.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param probe_name [String] The name of the probe.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified peering from the specified express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the express route circuit.\n @param peering_name [String] The name of the peering.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete gallery image.\n\n @param resource_group_name [String] The name of the resource group.\n @param lab_account_name [String] The name of the lab Account.\n @param gallery_image_name [String] The name of the gallery Image.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a path from the path template and the path_params and skip_encoding_path_params\n @return [URI] body the HTTP response body.", "Gets publishing user\n\n Gets publishing user\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [User] operation results.", "Updates publishing user\n\n Updates publishing user\n\n @param user_details [User] Details of publishing user\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [User] operation results.", "Gets source control token\n\n Gets source control token\n\n @param source_control_type [String] Type of source control\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SourceControl] operation results.", "Updates source control token\n\n Updates source control token\n\n @param source_control_type [String] Type of source control\n @param request_message [SourceControl] Source control token information\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SourceControl] operation results.", "Gets list of available geo regions plus ministamps\n\n Gets list of available geo regions plus ministamps\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeploymentLocations] operation results.", "List all SKUs.\n\n List all SKUs.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SkuInfos] operation results.", "Verifies if this VNET is compatible with an App Service Environment by\n analyzing the Network Security Group rules.\n\n Verifies if this VNET is compatible with an App Service Environment by\n analyzing the Network Security Group rules.\n\n @param parameters [VnetParameters] VNET information\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VnetValidationFailureDetails] operation results.", "Move resources between resource groups.\n\n Move resources between resource groups.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param move_resource_envelope [CsmMoveResourceEnvelope] Object that\n represents the resource to move.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Validate if a resource can be created.\n\n Validate if a resource can be created.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param validate_request [ValidateRequest] Request with the resources to\n validate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ValidateResponse] operation results.", "Validate whether a resource can be moved.\n\n Validate whether a resource can be moved.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param move_resource_envelope [CsmMoveResourceEnvelope] Object that\n represents the resource to move.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the source controls available for Azure websites.\n\n Gets the source controls available for Azure websites.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SourceControlCollection] operation results.", "List all apps that are assigned to a hostname.\n\n List all apps that are assigned to a hostname.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [IdentifierCollection] operation results.", "List all premier add-on offers.\n\n List all premier add-on offers.\n\n @param next_page_link [String] The NextLink from the previous successful call\n to List operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PremierAddOnOfferCollection] operation results.", "Lists supported cloud appliance models and supported configurations.\n\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CloudApplianceConfigurationList] operation results.", "Gets an incident associated to an alert rule\n\n @param resource_group_name [String] The name of the resource group.\n @param rule_name [String] The name of the rule.\n @param incident_name [String] The name of the incident to retrieve.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a list of incidents associated to an alert rule\n\n @param resource_group_name [String] The name of the resource group.\n @param rule_name [String] The name of the rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [IncidentListResult] operation results.", "Gets the detailed information for a given run.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param run_id [String] The run ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all issues associated with the specified API.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param api_id [String] API identifier. Must be unique in the current API\n Management service instance.\n @param filter [String] |   Field     |     Usage     |     Supported\n operators     |     Supported functions\n |</br>|-------------|-------------|-------------|-------------|</br>| name |\n filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith\n | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains,\n startswith, endswith | </br>| state | filter | eq |     | </br>\n @param expand_comments_attachments [Boolean] Expand the comment attachments.\n @param top [Integer] Number of records to return.\n @param skip [Integer] Number of records to skip.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [IssueCollection] which provide lazy access to pages of the response.", "Lists all subscriptions of the API Management service instance.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param filter [String] | Field        | Supported operators    | Supported\n functions                         |\n |--------------|------------------------|---------------------------------------------|\n | id           | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | name         | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | userId       | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | productId    | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | state        | eq                     |\n |\n @param top [Integer] Number of records to return.\n @param skip [Integer] Number of records to skip.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified Subscription entity.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param sid [String] Subscription entity Identifier. The entity represents the\n association between a user and a product in API Management.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates the subscription of specified user to the specified\n product.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param sid [String] Subscription entity Identifier. The entity represents the\n association between a user and a product in API Management.\n @param parameters [SubscriptionCreateParameters] Create parameters.\n @param notify [Boolean] Notify change in Subscription State.\n - If false, do not send any email notification for change of state of\n subscription\n - If true, send email notification of change of state of subscription\n @param if_match [String] ETag of the Entity. Not required when creating an\n entity, but required when updating an entity.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SubscriptionContract] operation results.", "Get projects in a service\n\n The project resource is a nested resource representing a stored migration\n project. This method returns a list of projects owned by a service resource.\n\n @param group_name [String] Name of the resource group\n @param service_name [String] Name of the service\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<Project>] operation results.", "Get project information\n\n The project resource is a nested resource representing a stored migration\n project. The GET method retrieves information about a project.\n\n @param group_name [String] Name of the resource group\n @param service_name [String] Name of the service\n @param project_name [String] Name of the project\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a data source instance.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Name of the Log Analytics Workspace that\n contains the datasource.\n @param data_source_name [String] Name of the datasource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a datasource instance.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Name of the Log Analytics Workspace that\n contains the datasource.\n @param data_source_name [String] Name of the datasource\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete lab. This operation can take a while to complete\n\n @param resource_group_name [String] The name of the resource group.\n @param lab_account_name [String] The name of the lab Account.\n @param lab_name [String] The name of the lab.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets provider operations metadata for all resource providers.\n\n @param api_version [String] The API version to use for this operation.\n @param expand [String] Specifies whether to expand the values.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Provides the details of the backed up item. This is an asynchronous\n operation. To know the status of the operation,\n call the GetItemOperationResult API.\n\n @param vault_name [String] The name of the recovery services vault.\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param fabric_name [String] Fabric name associated with the backed up item.\n @param container_name [String] Container name associated with the backed up\n item.\n @param protected_item_name [String] Backed up item name whose details are to\n be fetched.\n @param filter [String] OData filter options.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Enables backup of an item or to modifies the backup policy information of an\n already backed up item. This is an\n asynchronous operation. To know the status of the operation, call the\n GetItemOperationResult API.\n\n @param vault_name [String] The name of the recovery services vault.\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param fabric_name [String] Fabric name associated with the backup item.\n @param container_name [String] Container name associated with the backup\n item.\n @param protected_item_name [String] Item name to be backed up.\n @param parameters [ProtectedItemResource] resource backed up item\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Returns the properties of the specified bandwidth setting name.\n\n @param bandwidth_setting_name [String] The name of bandwidth setting to be\n fetched.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the upload location for the user to be able to upload the source.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SourceUploadDefinition] operation results.", "Get Live Output\n\n Gets a Live Output.\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param live_event_name [String] The name of the Live Event.\n @param live_output_name [String] The name of the Live Output.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete Live Output\n\n Deletes a Live Output.\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param live_event_name [String] The name of the Live Event.\n @param live_output_name [String] The name of the Live Output.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a new server, or will overwrite an existing server.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param parameters [ServerForCreate] The required parameters for creating or\n updating a server.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Check service health status\n\n The services resource is the top-level resource that represents the Data\n Migration Service. This action performs a health check and returns the status\n of the service and virtual machine size.\n\n @param group_name [String] Name of the resource group\n @param service_name [String] Name of the service\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DataMigrationServiceStatusResponse] operation results.", "Create or update DMS Instance\n\n The services resource is the top-level resource that represents the Data\n Migration Service. The PUT method creates a new service or updates an\n existing one. When a service is updated, existing child resources (i.e.\n tasks) are unaffected. Services currently support a single kind, \"vm\", which\n refers to a VM-based service, although other kinds may be added in the\n future. This method can change the kind, SKU, and network of the service, but\n if tasks are currently running (i.e. the service is busy), this will fail\n with 400 Bad Request (\"ServiceIsBusy\"). The provider will reply when\n successful with 200 OK or 201 Created. Long-running operations use the\n provisioningState property.\n\n @param parameters [DataMigrationService] Information about the service\n @param group_name [String] Name of the resource group\n @param service_name [String] Name of the service\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update DMS Service Instance\n\n The services resource is the top-level resource that represents the Data\n Migration Service. The PATCH method updates an existing service. This method\n can change the kind, SKU, and network of the service, but if tasks are\n currently running (i.e. the service is busy), this will fail with 400 Bad\n Request (\"ServiceIsBusy\").\n\n @param parameters [DataMigrationService] Information about the service\n @param group_name [String] Name of the resource group\n @param service_name [String] Name of the service\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Queues project for training\n\n @param project_id The project id\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Iteration] operation results.", "Create a project\n\n @param name [String] Name of the project\n @param description [String] The description of the project\n @param domain_id The id of the domain to use for this project. Defaults to\n General\n @param classification_type [Enum] The type of classifier to create for this\n project. Possible values include: 'Multiclass', 'Multilabel'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Project] operation results.", "Queries the resources managed by Azure Resource Manager for all subscriptions\n specified in the request.\n\n @param query [QueryRequest] Request specifying query and its options.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [QueryResponse] operation results.", "Get task information\n\n The tasks resource is a nested, proxy-only resource representing work\n performed by a DMS instance. The GET method retrieves information about a\n task.\n\n @param group_name [String] Name of the resource group\n @param service_name [String] Name of the service\n @param project_name [String] Name of the project\n @param task_name [String] Name of the Task\n @param expand [String] Expand the response\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Provides the list of records from the activity logs.\n\n @param filter [String] Reduces the set of data collected.<br>The **$filter**\n argument is very restricted and allows only the following patterns.<br>-\n *List events for a resource group*: $filter=eventTimestamp ge\n '2014-07-16T04:36:37.6407898Z' and eventTimestamp le\n '2014-07-20T04:36:37.6407898Z' and resourceGroupName eq\n 'resourceGroupName'.<br>- *List events for resource*: $filter=eventTimestamp\n ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le\n '2014-07-20T04:36:37.6407898Z' and resourceUri eq 'resourceURI'.<br>- *List\n events for a subscription in a time range*: $filter=eventTimestamp ge\n '2014-07-16T04:36:37.6407898Z' and eventTimestamp le\n '2014-07-20T04:36:37.6407898Z'.<br>- *List events for a resource provider*:\n $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp\n le '2014-07-20T04:36:37.6407898Z' and resourceProvider eq\n 'resourceProviderName'.<br>- *List events for a correlation Id*:\n $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp\n le '2014-07-20T04:36:37.6407898Z' and correlationId eq\n 'correlationID'.<br><br>**NOTE**: No other syntax is allowed.\n @param select [String] Used to fetch events with only the given\n properties.<br>The **$select** argument is a comma separated list of property\n names to be returned. Possible values are: *authorization*, *claims*,\n *correlationId*, *description*, *eventDataId*, *eventName*, *eventTimestamp*,\n *httpRequest*, *level*, *operationId*, *operationName*, *properties*,\n *resourceGroupName*, *resourceProviderName*, *resourceId*, *status*,\n *submissionTimestamp*, *subStatus*, *subscriptionId*\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Backs up the specified certificate.\n\n Requests that a backup of the specified certificate be downloaded to the\n client. All versions of the certificate will be downloaded. This operation\n requires the certificates/backup permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param certificate_name [String] The name of the certificate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [BackupCertificateResult] operation results.", "Restores a backed up certificate to a vault.\n\n Restores a backed up certificate, and all its versions, to a vault. This\n operation requires the certificates/restore permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param certificate_bundle_backup The backup blob associated with a\n certificate bundle.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CertificateBundle] operation results.", "Gets the specified deleted storage account.\n\n The Get Deleted Storage Account operation returns the specified deleted\n storage account along with its attributes. This operation requires the\n storage/get permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param storage_account_name [String] The name of the storage account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeletedStorageBundle] operation results.", "Permanently deletes the specified storage account.\n\n The purge deleted storage account operation removes the secret permanently,\n without the possibility of recovery. This operation can only be performed on\n a soft-delete enabled vault. This operation requires the storage/purge\n permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param storage_account_name [String] The name of the storage account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Recovers the deleted storage account.\n\n Recovers the deleted storage account in the specified vault. This operation\n can only be performed on a soft-delete enabled vault. This operation requires\n the storage/recover permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param storage_account_name [String] The name of the storage account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [StorageBundle] operation results.", "Backs up the specified storage account.\n\n Requests that a backup of the specified storage account be downloaded to the\n client. This operation requires the storage/backup permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param storage_account_name [String] The name of the storage account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [BackupStorageResult] operation results.", "Restores a backed up storage account to a vault.\n\n Restores a backed up storage account to a vault. This operation requires the\n storage/restore permission.\n\n @param vault_base_url [String] The vault name, for example\n https://myvault.vault.azure.net.\n @param storage_bundle_backup The backup blob associated with a storage\n account.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [StorageBundle] operation results.", "Gets the specified Peer Express Route Circuit Connection from the specified\n express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the express route circuit.\n @param peering_name [String] The name of the peering.\n @param connection_name [String] The name of the peer express route circuit\n connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets all global reach peer connections associated with a private peering in\n an express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the circuit.\n @param peering_name [String] The name of the peering.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a virtual network link to the specified Private DNS zone.\n\n @param resource_group_name [String] The name of the resource group.\n @param private_zone_name [String] The name of the Private DNS zone (without a\n terminating dot).\n @param virtual_network_link_name [String] The name of the virtual network\n link.\n @param parameters [VirtualNetworkLink] Parameters supplied to the\n CreateOrUpdate operation.\n @param if_match [String] The ETag of the virtual network link to the Private\n DNS zone. Omit this value to always overwrite the current virtual network\n link. Specify the last-seen ETag value to prevent accidentally overwriting\n any concurrent changes.\n @param if_none_match [String] Set to '*' to allow a new virtual network link\n to the Private DNS zone to be created, but to prevent updating an existing\n link. Other values will be ignored.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VirtualNetworkLink] operation results.", "Gets a virtual network link to the specified Private DNS zone.\n\n @param resource_group_name [String] The name of the resource group.\n @param private_zone_name [String] The name of the Private DNS zone (without a\n terminating dot).\n @param virtual_network_link_name [String] The name of the virtual network\n link.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists the virtual network links to the specified Private DNS zone.\n\n @param resource_group_name [String] The name of the resource group.\n @param private_zone_name [String] The name of the Private DNS zone (without a\n terminating dot).\n @param top [Integer] The maximum number of virtual network links to return.\n If not specified, returns up to 100 virtual network links.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<VirtualNetworkLink>] operation results.", "Implements Csm operations Api to exposes the list of available Csm Apis under\n the resource provider\n\n Implements Csm operations Api to exposes the list of available Csm Apis under\n the resource provider\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CsmOperationCollection] which provide lazy access to pages of the\n response.", "Deletes a notification hub associated with a namespace.\n\n @param resource_group_name [String] The name of the resource group.\n @param namespace_name [String] The namespace name.\n @param notification_hub_name [String] The notification hub name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists the notification hubs associated with a namespace.\n\n @param resource_group_name [String] The name of the resource group.\n @param namespace_name [String] The namespace name.\n @param notification_hub_name [String] The notification hub name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an Event Hub from the specified Namespace and resource group.\n\n @param resource_group_name [String] Name of the resource group within the\n azure subscription.\n @param namespace_name [String] The Namespace name\n @param event_hub_name [String] The Event Hub name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets an Event Hubs description for the specified Event Hub.\n\n @param resource_group_name [String] Name of the resource group within the\n azure subscription.\n @param namespace_name [String] The Namespace name\n @param event_hub_name [String] The Event Hub name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the authorization rules for an Event Hub.\n\n @param resource_group_name [String] Name of the resource group within the\n azure subscription.\n @param namespace_name [String] The Namespace name\n @param event_hub_name [String] The Event Hub name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the ACS and SAS connection strings for the Event Hub.\n\n @param resource_group_name [String] Name of the resource group within the\n azure subscription.\n @param namespace_name [String] The Namespace name\n @param event_hub_name [String] The Event Hub name\n @param authorization_rule_name [String] The authorization rule name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Cancel a currently running template deployment.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param deployment_name [String] The name of the deployment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get a list of deployments.\n\n @param resource_group_name [String] The name of the resource group to filter\n by. The name is case insensitive.\n @param filter [String] The filter to apply on the operation.\n @param top [Integer] Query parameters. If null is passed returns all\n deployments.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a named template deployment using a template.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param deployment_name [String] The name of the deployment.\n @param parameters [Deployment] Additional parameters supplied to the\n operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the authorization server specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param authsid [String] Identifier of the authorization server.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates an existing sync member.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database on which the sync\n group is hosted.\n @param sync_group_name [String] The name of the sync group on which the sync\n member is hosted.\n @param sync_member_name [String] The name of the sync member.\n @param parameters [SyncMember] The requested sync member resource state.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a Service Fabric cluster resource.\n\n Create or update a Service Fabric cluster resource with the specified name.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster resource.\n @param parameters [Cluster] The cluster resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified Express Route Circuit Connection from the specified\n express route circuit.\n\n @param resource_group_name [String] The name of the resource group.\n @param circuit_name [String] The name of the express route circuit.\n @param peering_name [String] The name of the peering.\n @param connection_name [String] The name of the express route circuit\n connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "List keys for a domain\n\n List the two keys used to publish to a domain\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription.\n @param domain_name [String] Name of the domain\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DomainSharedAccessKeys] operation results.", "Checks that Group entity specified by identifier is associated with the\n Product entity.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param product_id [String] Product identifier. Must be unique in the current\n API Management service instance.\n @param group_id [String] Group identifier. Must be unique in the current API\n Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Checks the availability of a Traffic Manager Relative DNS name.\n\n @param parameters [CheckTrafficManagerRelativeDnsNameAvailabilityParameters]\n The Traffic Manager name parameters supplied to the\n CheckTrafficManagerNameAvailability operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TrafficManagerNameAvailability] operation results.", "Lists all Traffic Manager profiles within a resource group.\n\n @param resource_group_name [String] The name of the resource group containing\n the Traffic Manager profiles to be listed.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ProfileListResult] operation results.", "Create or update a Traffic Manager profile.\n\n @param resource_group_name [String] The name of the resource group containing\n the Traffic Manager profile.\n @param profile_name [String] The name of the Traffic Manager profile.\n @param parameters [Profile] The Traffic Manager profile parameters supplied\n to the CreateOrUpdate operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update a Traffic Manager profile.\n\n @param resource_group_name [String] The name of the resource group containing\n the Traffic Manager profile.\n @param profile_name [String] The name of the Traffic Manager profile.\n @param parameters [Profile] The Traffic Manager profile parameters supplied\n to the Update operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the certificate list.\n\n Returns the list of certificates.\n\n @param resource_group_name [String] The name of the resource group that\n contains the IoT hub.\n @param resource_name [String] The name of the IoT hub.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CertificateListDescription] operation results.", "Get the certificate.\n\n Returns the certificate.\n\n @param resource_group_name [String] The name of the resource group that\n contains the IoT hub.\n @param resource_name [String] The name of the IoT hub.\n @param certificate_name [String] The name of the certificate\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates new or updates existing specified API of the API Management service\n instance.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param api_id [String] API revision identifier. Must be unique in the current\n API Management service instance. Non-current revision has ;rev=n as a suffix\n where n is the revision number.\n @param parameters [ApiCreateOrUpdateParameter] Create or update parameters.\n @param if_match [String] ETag of the Entity. Not required when creating an\n entity, but required when updating an entity.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete guest diagnostics association settings.\n\n @param resource_uri [String] The fully qualified ID of the resource,\n including the resource name and resource type.\n @param association_name [String] The name of the diagnostic settings\n association.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Lists a collection of operations associated with tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param api_id [String] API revision identifier. Must be unique in the current\n API Management service instance. Non-current revision has ;rev=n as a suffix\n where n is the revision number.\n @param filter [String] | Field       | Supported operators    | Supported\n functions                         |\n |-------------|------------------------|---------------------------------------------|\n | id          | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | name        | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | apiName     | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | method      | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n | urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith,\n endswith |\n @param top [Integer] Number of records to return.\n @param skip [Integer] Number of records to skip.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the role assignment in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param assignment_name [String] The name of the role assignment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the role assignment in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param assignment_name [String] The name of the role assignment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a role assignment in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param assignment_name [String] The assignment name\n @param parameters [RoleAssignmentResourceFormat] Parameters supplied to the\n CreateOrUpdate RoleAssignment operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets an integration account map.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param map_name [String] The integration account map name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an integration account map.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param map_name [String] The integration account map name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete the container instance service association link for the subnet.\n\n Delete the container instance service association link for the subnet. This\n operation unblocks user from deleting subnet.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_name [String] The name of the virtual network.\n @param subnet_name [String] The name of the subnet.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Check if a domain is available for registration.\n\n Check if a domain is available for registration.\n\n @param identifier [NameIdentifier] Name of the domain.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DomainAvailablilityCheckResult] operation results.", "Generate a single sign-on request for the domain management portal.\n\n Generate a single sign-on request for the domain management portal.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DomainControlCenterSsoRequest] operation results.", "Delete a domain.\n\n Delete a domain.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param domain_name [String] Name of the domain.\n @param force_hard_delete_domain [Boolean] Specify <code>true</code> to delete\n the domain immediately. The default is <code>false</code> which deletes the\n domain after 24 hours.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Renew a domain.\n\n Renew a domain.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param domain_name [String] Name of the domain.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Deletes a function from the streaming job.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param function_name [String] The name of the function.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets details about the specified function.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param function_name [String] The name of the function.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a management lock by scope.\n\n @param scope [String] The scope for the lock.\n @param lock_name [String] The name of lock.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get a management lock by scope.\n\n @param scope [String] The scope for the lock.\n @param lock_name [String] The name of lock.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ManagementLockObject] operation results.", "Gets a management lock at the subscription level.\n\n @param lock_name [String] The name of the lock to get.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ManagementLockObject] operation results.", "Gets the Batch service quotas for the specified subscription at the given\n location.\n\n @param location_name [String] The desired region for the quotas.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [BatchLocationQuota] operation results.", "Update a Traffic Manager endpoint.\n\n @param resource_group_name [String] The name of the resource group containing\n the Traffic Manager endpoint to be updated.\n @param profile_name [String] The name of the Traffic Manager profile.\n @param endpoint_type [String] The type of the Traffic Manager endpoint to be\n updated.\n @param endpoint_name [String] The name of the Traffic Manager endpoint to be\n updated.\n @param parameters [Endpoint] The Traffic Manager endpoint parameters supplied\n to the Update operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update a Traffic Manager endpoint.\n\n @param resource_group_name [String] The name of the resource group containing\n the Traffic Manager endpoint to be created or updated.\n @param profile_name [String] The name of the Traffic Manager profile.\n @param endpoint_type [String] The type of the Traffic Manager endpoint to be\n created or updated.\n @param endpoint_name [String] The name of the Traffic Manager endpoint to be\n created or updated.\n @param parameters [Endpoint] The Traffic Manager endpoint parameters supplied\n to the CreateOrUpdate operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a Traffic Manager endpoint.\n\n @param resource_group_name [String] The name of the resource group containing\n the Traffic Manager endpoint to be deleted.\n @param profile_name [String] The name of the Traffic Manager profile.\n @param endpoint_type [String] The type of the Traffic Manager endpoint to be\n deleted.\n @param endpoint_name [String] The name of the Traffic Manager endpoint to be\n deleted.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets load balancer frontend IP configuration.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param frontend_ipconfiguration_name [String] The name of the frontend IP\n configuration.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the backup.\n\n @param device_name [String] The device name\n @param backup_name [String] The backup name.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Retrieve the configuration identified by configuration name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param configuration_name [String] The configuration name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Details of a specific setting\n\n @param setting_name [String] Auto provisioning setting key\n @param setting [AutoProvisioningSetting] Auto provisioning setting key\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AutoProvisioningSetting] operation results.", "Gets information about the specified relationship Link.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param relationship_link_name [String] The name of the relationship link.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a relationship link within a hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param relationship_link_name [String] The name of the relationship.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all the intelligence packs possible and whether they are enabled or\n disabled for a given workspace.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Name of the Log Analytics Workspace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets the shared keys for a workspace.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Name of the Log Analytics Workspace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SharedKeys] operation results.", "Gets a list of usage metrics for a workspace.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] The name of the workspace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkspaceListUsagesResult] operation results.", "Gets a list of management groups connected to a workspace.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] The name of the workspace.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkspaceListManagementGroupsResult] operation results.", "This operation enables an item to be backed up, or modifies the existing\n backup policy information for an item that has been backed up. This is an\n asynchronous operation. To learn the status of the operation, call the\n GetItemOperationResult API.\n\n @param vault_name [String] The name of the Recovery Services vault.\n @param resource_group_name [String] The name of the resource group associated\n with the Recovery Services vault.\n @param fabric_name [String] The fabric name associated with the backup item.\n @param container_name [String] The container name associated with the backup\n item.\n @param protected_item_name [String] The name of the backup item.\n @param resource_protected_item [ProtectedItemResource] The resource backup\n item.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets information about the specified relationship.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param relationship_name [String] The name of the relationship.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a relationship or updates an existing relationship within a hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param relationship_name [String] The name of the Relationship.\n @param parameters [RelationshipResourceFormat] Parameters supplied to the\n CreateOrUpdate Relationship operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get all App Service plans for a subcription.\n\n Get all App Service plans for a subcription.\n\n @param detailed [Boolean] Specify <code>true</code> to return all App Service\n plan properties. The default is <code>false</code>, which returns a subset of\n the properties.\n Retrieval of all properties may increase the API latency.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<AppServicePlan>] operation results.", "List all capabilities of an App Service plan.\n\n List all capabilities of an App Service plan.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service plan.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Get the maximum number of Hybrid Connections allowed in an App Service plan.\n\n Get the maximum number of Hybrid Connections allowed in an App Service plan.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service plan.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [HybridConnectionLimits] operation results.", "Gets all selectable sku's for a given App Service Plan\n\n Gets all selectable sku's for a given App Service Plan\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of App Service Plan\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Object] operation results.", "Get all Virtual Networks associated with an App Service plan.\n\n Get all Virtual Networks associated with an App Service plan.\n\n @param resource_group_name [String] Name of the resource group to which the\n resource belongs.\n @param name [String] Name of the App Service plan.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Update automatic tuning properties for target database.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database.\n @param parameters [DatabaseAutomaticTuning] The requested automatic tuning\n resource state.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified network security group.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_security_group_name [String] The name of the network security\n group.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a network security group in the specified resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_security_group_name [String] The name of the network security\n group.\n @param parameters [NetworkSecurityGroup] Parameters supplied to the create or\n update network security group operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a network security group tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_security_group_name [String] The name of the network security\n group.\n @param parameters [TagsObject] Parameters supplied to update network security\n group tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the properties of the specified backup policy name.\n\n @param device_name [String] The device name\n @param backup_policy_name [String] The name of backup policy to be fetched.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates the backup policy.\n\n @param device_name [String] The device name\n @param backup_policy_name [String] The name of the backup policy to be\n created/updated.\n @param parameters [BackupPolicy] The backup policy.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an input from the streaming job.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param input_name [String] The name of the input.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets details about the specified input.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param input_name [String] The name of the input.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a Volume resource.\n\n Creates a Volume resource with the specified name, description and\n properties. If Volume resource with the same name exists, then it is updated\n with the specified description and properties.\n\n @param volume_resource_name [String] The identity of the volume.\n @param volume_resource_description [VolumeResourceDescription] Description\n for creating a Volume resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VolumeResourceDescription] operation results.", "Gets a widget type in the specified hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param widget_type_name [String] The name of the widget type.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "This operation Completes Migration of entities by pointing the connection\n strings to Premium namespace and any entities created after the operation\n will be under Premium Namespace. CompleteMigration operation will fail when\n entity migration is in-progress.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "This operation reverts Migration\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates or update policy with specified rule set name within a resource\n group.\n\n @param resource_group_name [String] The name of the resource group.\n @param policy_name [String] The name of the policy.\n @param parameters [WebApplicationFirewallPolicy] Policy to be created.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Pauses a database.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database to be paused.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Database] operation results.", "Resumes a database.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database to be resumed.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Database] operation results.", "Deletes the database.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get Workflows resource\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param workflow_id [String] workflow Id\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update a proximity placement group.\n\n @param resource_group_name [String] The name of the resource group.\n @param proximity_placement_group_name [String] The name of the proximity\n placement group.\n @param parameters [ProximityPlacementGroup] Parameters supplied to the Create\n Proximity Placement Group operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update a proximity placement group.\n\n @param resource_group_name [String] The name of the resource group.\n @param proximity_placement_group_name [String] The name of the proximity\n placement group.\n @param parameters [ProximityPlacementGroupUpdate] Parameters supplied to the\n Update Proximity Placement Group operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a proximity placement group.\n\n @param resource_group_name [String] The name of the resource group.\n @param proximity_placement_group_name [String] The name of the proximity\n placement group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Retrieve the certificate identified by certificate name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param certificate_name [String] The name of certificate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a certificate.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param certificate_name [String] The parameters supplied to the create or\n update certificate operation.\n @param parameters [CertificateCreateOrUpdateParameters] The parameters\n supplied to the create or update certificate operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update a certificate.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param certificate_name [String] The parameters supplied to the update\n certificate operation.\n @param parameters [CertificateUpdateParameters] The parameters supplied to\n the update certificate operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Checks whether the deployment exists.\n\n @param deployment_name [String] The name of the deployment to check.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Boolean] operation results.", "Validates whether the specified template is syntactically correct and will be\n accepted by Azure Resource Manager..\n\n @param deployment_name [String] The name of the deployment.\n @param parameters [Deployment] Parameters to validate.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeploymentValidateResult] operation results.", "Exports the template used for specified deployment.\n\n @param deployment_name [String] The name of the deployment from which to get\n the template.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DeploymentExportResult] operation results.", "Gets a list of Serial Console API operations.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [SerialConsoleOperations] operation results.", "Creates or updates global policy configuration for the tenant.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param parameters The policy content details.\n @param if_match [String] The entity state (Etag) version of the tenant policy\n to update. A value of \"*\" can be used for If-Match to unconditionally apply\n the operation.\n @param [Hash{String => String}] A hash of custom headers that will be added\n to the HTTP request.\n\n @return [Concurrent::Promise] Promise object which holds the HTTP response.", "Gets information about the specified profile.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param profile_name [String] The name of the profile.\n @param locale_code [String] Locale of profile to retrieve, default is en-us.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a profile within a Hub, or updates an existing profile.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param profile_name [String] The name of the profile.\n @param parameters [ProfileResourceFormat] Parameters supplied to the\n create/delete Profile type operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the appliance.\n\n @param appliance_id [String] The fully qualified ID of the appliance,\n including the appliance name and the appliance resource type. Use the format,\n /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name}\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Appliance] operation results.", "apps - Assign a LUIS Azure account to an application\n\n Assigns an Azure account to the application.\n\n @param app_id The application ID.\n @param azure_account_info_object [AzureAccountInfoObject] The Azure account\n information object.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatus] operation results.", "apps - Get LUIS Azure accounts assigned to the application\n\n Gets the LUIS Azure accounts assigned to the application for the user using\n his ARM token.\n\n @param app_id The application ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "apps - Removes an assigned LUIS Azure account from an application\n\n Removes assigned Azure account from the application.\n\n @param app_id The application ID.\n @param azure_account_info_object [AzureAccountInfoObject] The Azure account\n information object.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatus] operation results.", "user - Get LUIS Azure accounts\n\n Gets the LUIS Azure accounts for the user using his ARM token.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Create or update the metadata of an IoT hub.\n\n Create or update the metadata of an Iot hub. The usual pattern to modify a\n property is to retrieve the IoT hub metadata and security metadata, and then\n combine them with the modified values in a new body to update the IoT hub.\n\n @param resource_group_name [String] The name of the resource group that\n contains the IoT hub.\n @param resource_name [String] The name of the IoT hub.\n @param iot_hub_description [IotHubDescription] The IoT hub metadata and\n security metadata.\n @param if_match [String] ETag of the IoT Hub. Do not specify for creating a\n brand new IoT Hub. Required to update an existing IoT Hub.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update an existing IoT Hubs tags.\n\n Update an existing IoT Hub tags. to update other fields use the\n CreateOrUpdate method\n\n @param resource_group_name [String] Resource group identifier.\n @param resource_name [String] Name of iot hub to update.\n @param iot_hub_tags [TagsResource] Updated tag information to set into the\n iot hub instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List all the build steps for a given build task.\n\n @param resource_group_name [String] The name of the resource group to which\n the container registry belongs.\n @param registry_name [String] The name of the container registry.\n @param build_task_name [String] The name of the container registry build\n task.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a Prediction in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param prediction_name [String] The name of the Prediction.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a Prediction or updates an existing Prediction in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param prediction_name [String] The name of the Prediction.\n @param parameters [PredictionResourceFormat] Parameters supplied to the\n create/update Prediction operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a Prediction in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param prediction_name [String] The name of the Prediction.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists report records by Product.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param filter [String] |   Field     |     Usage     |     Supported\n operators     |     Supported functions\n |</br>|-------------|-------------|-------------|-------------|</br>|\n timestamp | filter | ge, le |     | </br>| displayName | select, orderBy |\n |     | </br>| apiRegion | filter | eq |     | </br>| userId | filter | eq |\n | </br>| productId | select, filter | eq |     | </br>| subscriptionId |\n filter | eq |     | </br>| callCountSuccess | select, orderBy |     |     |\n </br>| callCountBlocked | select, orderBy |     |     | </br>|\n callCountFailed | select, orderBy |     |     | </br>| callCountOther |\n select, orderBy |     |     | </br>| callCountTotal | select, orderBy |     |\n | </br>| bandwidth | select, orderBy |     |     | </br>| cacheHitsCount |\n select |     |     | </br>| cacheMissCount | select |     |     | </br>|\n apiTimeAvg | select, orderBy |     |     | </br>| apiTimeMin | select |     |\n | </br>| apiTimeMax | select |     |     | </br>| serviceTimeAvg | select |\n |     | </br>| serviceTimeMin | select |     |     | </br>| serviceTimeMax |\n select |     |     | </br>\n @param top [Integer] Number of records to return.\n @param skip [Integer] Number of records to skip.\n @param orderby [String] OData order by query option.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ReportCollection] which provide lazy access to pages of the\n response.", "Gets if Serial Console is disabled for a subscription.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [GetDisabledResult] operation results.", "Gets information about the availability of updates based on the last scan of\n the device. It also gets information about any ongoing download or install\n jobs on the device.\n\n @param device_name [String] The device name.\n @param resource_group_name [String] The resource group name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [UpdateSummary] operation results.", "Gets the extension properties for the specified HDInsight cluster extension.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster.\n @param extension_name [String] The name of the cluster extension.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Regenerates the specified account key for the specified Cognitive Services\n account.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription.\n @param account_name [String] The name of Cognitive Services account.\n @param key_name [KeyName] key name to generate (Key1|Key2). Possible values\n include: 'Key1', 'Key2'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update a NetApp account\n\n @param body [NetAppAccount] NetApp Account object supplied in the body of the\n operation.\n @param resource_group_name [String] The name of the resource group.\n @param account_name [String] The name of the NetApp account\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "The delete subnet operation deletes the specified subnet.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_name [String] The name of the virtual network.\n @param subnet_name [String] The name of the subnet.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Validates a workflow.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param workflow [Workflow] The workflow.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Checks by ID whether a resource exists.\n\n @param resource_id [String] The fully qualified ID of the resource, including\n the resource name and resource type. Use the format,\n /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}\n @param api_version [String] The API version to use for the operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Boolean] operation results.", "Gets a resource by ID.\n\n @param resource_id [String] The fully qualified ID of the resource, including\n the resource name and resource type. Use the format,\n /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}\n @param api_version [String] The API version to use for the operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [GenericResource] operation results.", "Patch HDInsight cluster with the specified parameters.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster.\n @param parameters [ClusterPatchParameters] The cluster patch request.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the gateway settings for the specified cluster.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [GatewaySettings] operation results.", "Gets the details for the currently logged-in user.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AADObject] operation results.", "Creates or updates diagnostic settings for the specified resource.\n\n @param resource_uri [String] The identifier of the resource.\n @param parameters [DiagnosticSettingsResource] Parameters supplied to the\n operation.\n @param name [String] The name of the diagnostic setting.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the user specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param user_id [String] User identifier. Must be unique in the current API\n Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the given replica of the service of an application.\n\n Gets the information about the service replica with the given name. The\n information include the description and other properties of the service\n replica.\n\n @param application_resource_name [String] The identity of the application.\n @param service_resource_name [String] The identity of the service.\n @param replica_name [String] Service Fabric replica name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all the replicas of a service.\n\n Gets the information about all replicas of a service. The information include\n the description and other properties of the service replica.\n\n @param application_resource_name [String] The identity of the application.\n @param service_resource_name [String] The identity of the service.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PagedServiceReplicaDescriptionList] operation results.", "Create or update an availability set.\n\n @param resource_group_name [String] The name of the resource group.\n @param availability_set_name [String] The name of the availability set.\n @param parameters [AvailabilitySet] Parameters supplied to the Create\n Availability Set operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update an availability set.\n\n @param resource_group_name [String] The name of the resource group.\n @param availability_set_name [String] The name of the availability set.\n @param parameters [AvailabilitySetUpdate] Parameters supplied to the Update\n Availability Set operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete an availability set.\n\n @param resource_group_name [String] The name of the resource group.\n @param availability_set_name [String] The name of the availability set.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Updates an application resource with the specified name.\n\n @param subscription_id [String] The customer subscription identifier\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster resource\n @param application_name [String] The name of the application resource.\n @param api_version [String] The version of the API.\n @param parameters [ApplicationResourceUpdate] The application resource for\n patch operations.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplicationResourceUpdate] operation results.", "Lists the failover groups in a location.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param location_name [String] The name of the region where the resource is\n located.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<InstanceFailoverGroup>] operation results.", "Creates or updates a failover group.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param location_name [String] The name of the region where the resource is\n located.\n @param failover_group_name [String] The name of the failover group.\n @param parameters [InstanceFailoverGroup] The failover group parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create or update a domain topic\n\n Asynchronously creates or updates a new domain topic with the specified\n parameters.\n\n @param resource_group_name [String] The name of the resource group within the\n user's subscription.\n @param domain_name [String] Name of the domain\n @param domain_topic_name [String] Name of the domain topic\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a link in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param link_name [String] The name of the link.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a link or updates an existing link in the hub.\n\n @param resource_group_name [String] The name of the resource group.\n @param hub_name [String] The name of the hub.\n @param link_name [String] The name of the link.\n @param parameters [LinkResourceFormat] Parameters supplied to the\n CreateOrUpdate Link operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a managed database.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param database_name [String] The name of the database.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List Asset Filters\n\n List Asset Filters associated with the specified Asset.\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param asset_name [String] The Asset name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified Data Lake Store virtual network rule.\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Store account.\n @param virtual_network_rule_name [String] The name of the virtual network\n rule to retrieve.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified virtual network rule from the specified Data Lake Store\n account.\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Store account.\n @param virtual_network_rule_name [String] The name of the virtual network\n rule to delete.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified saved search in a given workspace.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Log Analytics workspace name\n @param saved_search_name [String] Name of the saved search.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified saved search for a given workspace.\n\n @param resource_group_name [String] The name of the resource group to get.\n The name is case insensitive.\n @param workspace_name [String] Log Analytics workspace name\n @param saved_search_name [String] The id of the saved search.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists the marketplaces for a scope by billing period and billingAccountId.\n Marketplaces are available via this API only for May 1, 2014 or later.\n\n @param billing_account_id [String] BillingAccount ID\n @param billing_period_name [String] Billing Period Name.\n @param filter [String] May be used to filter marketplaces by\n properties/usageEnd (Utc time), properties/usageStart (Utc time),\n properties/resourceGroup, properties/instanceName or properties/instanceId.\n The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not\n currently support 'ne', 'or', or 'not'.\n @param top [Integer] May be used to limit the number of results to the most\n recent N marketplaces.\n @param skiptoken [String] Skiptoken is only used if a previous operation\n returned a partial result. If a previous response contains a nextLink\n element, the value of the nextLink element will include a skiptoken parameter\n that specifies a starting point to use for subsequent calls.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates and initialize new instance of the ServiceClient class.\n\n @param credentials [MsRest::ServiceClientCredentials] credentials to authorize\n HTTP requests made by the service client.\n @param options additional parameters for the HTTP request (not implemented yet).\n\n\n @param base_url [String] the base url for the request.\n @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.\n @param path [String] the path, relative to {base_url}.\n @param options [Hash{String=>String}] specifying any request options like :credentials, :body, etc.\n @return [Concurrent::Promise] Promise object which holds the HTTP response.", "Get an assembly for an integration account.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param assembly_artifact_name [String] The assembly artifact name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete an assembly for an integration account.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param assembly_artifact_name [String] The assembly artifact name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the content callback url for an integration account assembly.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param assembly_artifact_name [String] The assembly artifact name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Adds a user to the allowed list of users to access this LUIS application.\n Users are added using their email address.\n\n @param app_id The application ID.\n @param user_to_add [UserCollaborator] A model containing the user's email\n address.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatus] operation results.", "Removes a user from the allowed list of users to access this LUIS\n application. Users are removed using their email address.\n\n @param app_id The application ID.\n @param user_to_delete [UserCollaborator] A model containing the user's email\n address.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatus] operation results.", "Creates a role assignment by ID.\n\n @param role_assignment_id [String] The fully qualified ID of the role\n assignment, including the scope, resource name and resource type. Use the\n format,\n /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.\n Example:\n /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.\n @param parameters [RoleAssignmentCreateParameters] Parameters for the role\n assignment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [RoleAssignment] operation results.", "Delete an action group.\n\n @param resource_group_name [String] The name of the resource group.\n @param action_group_name [String] The name of the action group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Deletes a job credential.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param job_agent_name [String] The name of the job agent.\n @param credential_name [String] The name of the credential.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a step execution of a job execution.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param job_agent_name [String] The name of the job agent.\n @param job_name [String] The name of the job to get.\n @param job_execution_id The unique id of the job execution\n @param step_name [String] The name of the step.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a virtual network rule.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param virtual_network_rule_name [String] The name of the virtual network\n rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the virtual network rule with the given name.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param virtual_network_rule_name [String] The name of the virtual network\n rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve the connectiontype identified by connectiontype name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param connection_type_name [String] The name of connectiontype.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a connectiontype.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param connection_type_name [String] The parameters supplied to the create or\n update connectiontype operation.\n @param parameters [ConnectionTypeCreateOrUpdateParameters] The parameters\n supplied to the create or update connectiontype operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates the specified compute policy. During update, the compute\n policy with the specified name will be replaced with this new compute policy.\n An account supports, at most, 50 policies\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Analytics account.\n @param compute_policy_name [String] The name of the compute policy to create\n or update.\n @param parameters [CreateOrUpdateComputePolicyParameters] Parameters supplied\n to create or update the compute policy. The max degree of parallelism per job\n property, min priority per job property, or both must be present.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified Data Lake Analytics compute policy.\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Analytics account.\n @param compute_policy_name [String] The name of the compute policy to\n retrieve.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified compute policy from the specified Data Lake Analytics\n account\n\n @param resource_group_name [String] The name of the Azure resource group.\n @param account_name [String] The name of the Data Lake Analytics account.\n @param compute_policy_name [String] The name of the compute policy to delete.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a batch configuration for an integration account.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param batch_configuration_name [String] The batch configuration name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a batch configuration for an integration account.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param batch_configuration_name [String] The batch configuration name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a Application resource.\n\n Creates a Application resource with the specified name, description and\n properties. If Application resource with the same name exists, then it is\n updated with the specified description and properties.\n\n @param application_resource_name [String] The identity of the application.\n @param application_resource_description [ApplicationResourceDescription]\n Description for creating a Application resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplicationResourceDescription] operation results.", "Deletes a WCFRelays .\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The Namespace Name\n @param relay_name [String] The relay name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns the description for the specified WCFRelays.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The Namespace Name\n @param relay_name [String] The relay name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates the settings in a version of the application.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param list_of_app_version_setting_object [Array<AppVersionSettingObject>] A\n list of the updated application version settings.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a new LUIS app.\n\n @param application_create_object [ApplicationCreateObject] An application\n containing Name, Description (optional), Culture, Usage Scenario (optional),\n Domain (optional) and initial version ID (optional) of the application.\n Default value for the version ID is \"0.1\". Note: the culture cannot be\n changed after the app is created.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Uuid] operation results.", "Lists all of the user's applications.\n\n @param skip [Integer] The number of entries to skip. Default value is 0.\n @param take [Integer] The number of entries to return. Maximum page size is\n 500. Default is 100.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Imports an application to LUIS, the application's structure is included in\n the request body.\n\n @param luis_app [LuisApp] A LUIS application structure.\n @param app_name [String] The application name to create. If not specified,\n the application name will be read from the imported object. If the\n application name already exists, an error is returned.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Uuid] operation results.", "Gets the endpoint URLs for the prebuilt Cortana applications.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PersonalAssistantsResponse] operation results.", "Gets the available application domains.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets the application available usage scenarios.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets a list of supported cultures. Cultures are equivalent to the written\n language and locale. For example,\"en-us\" represents the U.S. variation of\n English.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Gets the logs of the past month's endpoint queries for the application.\n\n @param app_id The application ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [NOT_IMPLEMENTED] operation results.", "Updates the name or description of the application.\n\n @param app_id The application ID.\n @param application_update_object [ApplicationUpdateObject] A model containing\n Name and Description of the application.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatus] operation results.", "Publishes a specific version of the application.\n\n @param app_id The application ID.\n @param application_publish_object [ApplicationPublishObject] The application\n publish object. The region is the target region that the application is\n published to.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ProductionOrStagingEndpointInfo] operation results.", "Get the application settings including 'UseAllTrainingData'.\n\n @param app_id The application ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplicationSettings] operation results.", "Updates the application settings including 'UseAllTrainingData'.\n\n @param app_id The application ID.\n @param application_setting_update_object [ApplicationSettingUpdateObject] An\n object containing the new application settings.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatus] operation results.", "Get the application publish settings including 'UseAllTrainingData'.\n\n @param app_id The application ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PublishSettings] operation results.", "Updates the application publish settings including 'UseAllTrainingData'.\n\n @param app_id The application ID.\n @param publish_setting_update_object [PublishSettingUpdateObject] An object\n containing the new publish application settings.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationStatus] operation results.", "Returns the available endpoint deployment regions and URLs.\n\n @param app_id The application ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Hash] operation results.", "Gets all the available custom prebuilt domains for all cultures.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "Adds a prebuilt domain along with its intent and entity models as a new\n application.\n\n @param prebuilt_domain_create_object [PrebuiltDomainCreateObject] A prebuilt\n domain create object containing the name and culture of the domain.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Uuid] operation results.", "Gets all the available prebuilt domains for a specific culture.\n\n @param culture [String] Culture.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "package - Gets published LUIS application package in binary stream GZip\n format\n\n Packages a published LUIS application as a GZip file to be used in the LUIS\n container.\n\n @param app_id The application ID.\n @param slot_name [String] The publishing slot name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [NOT_IMPLEMENTED] operation results.", "package - Gets trained LUIS application package in binary stream GZip format\n\n Packages trained LUIS application as GZip file to be used in the LUIS\n container.\n\n @param app_id The application ID.\n @param version_id [String] The version ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [NOT_IMPLEMENTED] operation results.", "Gets all the Image Lists.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array] operation results.", "configures configurable options to default values", "Updates an Azure Dev Spaces Controller.\n\n Updates the properties of an existing Azure Dev Spaces Controller with the\n specified update parameters.\n\n @param resource_group_name [String] Resource group to which the resource\n belongs.\n @param name [String] Name of the resource.\n @param controller_update_parameters [ControllerUpdateParameters]\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists connection details for an Azure Dev Spaces Controller.\n\n Lists connection details for the underlying container resources of an Azure\n Dev Spaces Controller.\n\n @param resource_group_name [String] Resource group to which the resource\n belongs.\n @param name [String] Name of the resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ControllerConnectionDetailsList] operation results.", "Creates an Azure Dev Spaces Controller.\n\n Creates an Azure Dev Spaces Controller with the specified create parameters.\n\n @param resource_group_name [String] Resource group to which the resource\n belongs.\n @param name [String] Name of the resource.\n @param controller [Controller] Controller create parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "List a workflow run request history.\n\n @param resource_group_name [String] The resource group name.\n @param workflow_name [String] The workflow name.\n @param run_name [String] The workflow run name.\n @param action_name [String] The workflow action name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<RequestHistory>] operation results.", "Deletes the data connection with the given name.\n\n @param resource_group_name [String] The name of the resource group containing\n the Kusto cluster.\n @param cluster_name [String] The name of the Kusto cluster.\n @param database_name [String] The name of the database in the Kusto cluster.\n @param data_connection_name [String] The name of the data connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets the details of a Replication protected item.\n\n Gets the details of an ASR replication protected item.\n\n @param fabric_name [String] Fabric unique name.\n @param protection_container_name [String] Protection container name.\n @param replicated_protected_item_name [String] Replication protected item\n name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the list of replication protected items.\n\n Gets the list of ASR replication protected items in the vault.\n\n @param skip_token [String] The pagination token. Possible values: \"FabricId\"\n or \"FabricId_CloudId\" or null\n @param filter [String] OData filter options.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a given SyncGroup.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param sync_group_name [String] Name of Sync Group resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the container backup status\n\n @param azure_region [String] Azure region to hit Api\n @param parameters [BackupStatusRequest] Container Backup Status Request\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [BackupStatusResponse] operation results.", "Check the give Namespace name availability.\n\n @param resource_group_name [String] Name of the resource group within the\n azure subscription.\n @param namespace_name [String] The Namespace name\n @param parameters [CheckNameAvailabilityParameter] Parameters to check\n availability of the given Alias name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a target group.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param job_agent_name [String] The name of the job agent.\n @param target_group_name [String] The name of the target group.\n @param parameters [JobTargetGroup] The requested state of the target group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a target group.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param job_agent_name [String] The name of the job agent.\n @param target_group_name [String] The name of the target group.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Security pricing configuration in the subscriptionSecurity pricing\n configuration in the subscription\n\n @param pricing_name [String] name of the pricing configuration\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Pricing] operation results.", "Security pricing configuration in the subscription\n\n @param pricing_name [String] name of the pricing configuration\n @param pricing [Pricing] Pricing object\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Pricing] operation results.", "Gets the specified subnet by virtual network and resource group.\n\n @param resource_group_name [String] The name of the resource group.\n @param virtual_network_name [String] The name of the virtual network.\n @param subnet_name [String] The name of the subnet.\n @param expand [String] Expands referenced resources.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a server communication link.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param communication_link_name [String] The name of the server communication\n link.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns a server communication link.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param communication_link_name [String] The name of the server communication\n link.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Lists all of the applications for the HDInsight cluster.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Array<Application>] operation results.", "Lists properties of the specified application.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster.\n @param application_name [String] The constant value for the application name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the specified application on the HDInsight cluster.\n\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster.\n @param application_name [String] The constant value for the application name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a Gateway resource.\n\n Creates a Gateway resource with the specified name, description and\n properties. If Gateway resource with the same name exists, then it is updated\n with the specified description and properties. Use Gateway resource to\n provide public connectivity to application services.\n\n @param gateway_resource_name [String] The identity of the gateway.\n @param gateway_resource_description [GatewayResourceDescription] Description\n for creating a Gateway resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [GatewayResourceDescription] operation results.", "Gets the budget for a resource group under a subscription by budget name.\n\n @param resource_group_name [String] Azure Resource Group Name.\n @param budget_name [String] Budget Name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Budget] operation results.", "The operation to delete a budget.\n\n @param resource_group_name [String] Azure Resource Group Name.\n @param budget_name [String] Budget Name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "creating settings about where we should store your security data and logs\n\n @param workspace_setting_name [String] Name of the security setting\n @param workspace_setting [WorkspaceSetting] Security data setting object\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkspaceSetting] operation results.", "Settings about where we should store your security data and logs\n\n @param workspace_setting_name [String] Name of the security setting\n @param workspace_setting [WorkspaceSetting] Security data setting object\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkspaceSetting] operation results.", "Indicates which operations can be performed by the Power BI Resource\n Provider.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [OperationList] operation results.", "Gets details of a specific knowledgebase.\n\n @param kb_id [String] Knowledgebase id.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [KnowledgebaseDTO] operation results.", "Asynchronous operation to modify a knowledgebase.\n\n @param kb_id [String] Knowledgebase id.\n @param update_kb [UpdateKbOperationDTO] Post body of the request.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Operation] operation results.", "Asynchronous operation to create a new knowledgebase.\n\n @param create_kb_payload [CreateKbDTO] Post body of the request.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Operation] operation results.", "Download the knowledgebase.\n\n @param kb_id [String] Knowledgebase id.\n @param environment [EnvironmentType] Specifies whether environment is Test or\n Prod. Possible values include: 'Prod', 'Test'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [QnADocumentsDTO] operation results.", "Checks if the specified management group name is valid and unique\n\n @param check_name_availability_request [CheckNameAvailabilityRequest]\n Management group name availability check parameters.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CheckNameAvailabilityResult] operation results.", "Starts backfilling subscriptions for the Tenant.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TenantBackfillStatusResult] operation results.", "Gets tenant backfill status\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TenantBackfillStatusResult] operation results.", "Retrieve the credential identified by credential name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param credential_name [String] The name of credential.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a credential.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param credential_name [String] The parameters supplied to the create or\n update credential operation.\n @param parameters [CredentialCreateOrUpdateParameters] The parameters\n supplied to the create or update credential operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update a credential.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param credential_name [String] The parameters supplied to the Update\n credential operation.\n @param parameters [CredentialUpdateParameters] The parameters supplied to the\n Update credential operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the details of the certificate specified by its identifier.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param certificate_id [String] Identifier of the certificate entity. Must be\n unique in the current API Management service instance.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Serialize the object to JSON\n @param options [Hash] hash map contains options to convert to json.\n @return [String] JSON serialized version of the object", "Deserialize the object from JSON\n @param json [String] JSON string representation of the object\n @return [JSONable] object built from json input", "Retrieve the activity in the module identified by module name and activity\n name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param module_name [String] The name of module.\n @param activity_name [String] The name of activity.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a schedule.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param schedule_name [String] The schedule name.\n @param parameters [ScheduleCreateOrUpdateParameters] The parameters supplied\n to the create or update schedule operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Update the schedule identified by schedule name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param schedule_name [String] The schedule name.\n @param parameters [ScheduleUpdateParameters] The parameters supplied to the\n update schedule operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieve the schedule identified by schedule name.\n\n @param resource_group_name [String] Name of an Azure Resource group.\n @param automation_account_name [String] The name of the automation account.\n @param schedule_name [String] The schedule name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves information about a gallery Image Version.\n\n @param resource_group_name [String] The name of the resource group.\n @param gallery_name [String] The name of the Shared Image Gallery in which\n the Image Definition resides.\n @param gallery_image_name [String] The name of the gallery Image Definition\n in which the Image Version resides.\n @param gallery_image_version_name [String] The name of the gallery Image\n Version to be retrieved.\n @param expand [ReplicationStatusTypes] The expand expression to apply on the\n operation. Possible values include: 'ReplicationStatus'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a recommended elastic pool.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param recommended_elastic_pool_name [String] The name of the recommended\n elastic pool to be retrieved.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a Streaming Locator\n\n Get the details of a Streaming Locator in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param streaming_locator_name [String] The Streaming Locator name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a Streaming Locator\n\n Deletes a Streaming Locator in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param streaming_locator_name [String] The Streaming Locator name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets latest heatmap for Traffic Manager profile.\n\n @param resource_group_name [String] The name of the resource group containing\n the Traffic Manager endpoint.\n @param profile_name [String] The name of the Traffic Manager profile.\n @param top_left [Array<Float>] The top left latitude,longitude pair of the\n rectangular viewport to query for.\n @param bot_right [Array<Float>] The bottom right latitude,longitude pair of\n the rectangular viewport to query for.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a dropped database's short term retention policy.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param restorable_dropped_database_id [String]\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Sets a database's long term retention policy.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param restorable_dropped_database_id [String]\n @param parameters [ManagedBackupShortTermRetentionPolicy] The long term\n retention policy info.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves an existing Power BI Workspace Collection.\n\n @param resource_group_name [String] Azure resource group\n @param workspace_collection_name [String] Power BI Embedded Workspace\n Collection name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkspaceCollection] operation results.", "Update an existing Power BI Workspace Collection with the specified\n properties.\n\n @param resource_group_name [String] Azure resource group\n @param workspace_collection_name [String] Power BI Embedded Workspace\n Collection name\n @param body [UpdateWorkspaceCollectionRequest] Update workspace collection\n request\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Retrieves the primary and secondary access keys for the specified Power BI\n Workspace Collection.\n\n @param resource_group_name [String] Azure resource group\n @param workspace_collection_name [String] Power BI Embedded Workspace\n Collection name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [WorkspaceCollectionAccessKeys] operation results.", "Returns the properties of the specified access control record name.\n\n @param access_control_record_name [String] Name of access control record to\n be fetched.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or Updates an access control record.\n\n @param access_control_record_name [String] The name of the access control\n record.\n @param parameters [AccessControlRecord] The access control record to be added\n or updated.\n @param resource_group_name [String] The resource group name\n @param manager_name [String] The manager name\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns an application type name resource.\n\n @param subscription_id [String] The customer subscription identifier\n @param resource_group_name [String] The name of the resource group.\n @param cluster_name [String] The name of the cluster resource\n @param application_type_name [String] The name of the application type name\n resource\n @param api_version [String] The version of the API.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a server firewall rule.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param firewall_rule_name [String] The name of the server firewall rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets details about the specified streaming job.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param expand [String] The $expand OData query parameter. This is a\n comma-separated list of additional streaming job properties to include in the\n response, beyond the default set returned when this parameter is absent. The\n default set is all streaming job properties other than 'inputs',\n 'transformation', 'outputs', and 'functions'.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a streaming job.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param job_name [String] The name of the streaming job.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Create a new StorageSyncService.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param parameters [StorageSyncServiceCreateParameters] Storage Sync Service\n resource name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Patch a given StorageSyncService.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param parameters [StorageSyncServiceUpdateParameters] Storage Sync Service\n resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a given StorageSyncService.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param storage_sync_service_name [String] Name of Storage Sync Service\n resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Removes the database's vulnerability assessment.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param database_name [String] The name of the database for which the\n vulnerability assessment is defined.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates an API Management service. This is long running operation\n and could take several minutes to complete.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param parameters [ApiManagementServiceResource] Parameters supplied to the\n CreateOrUpdate API Management service operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Checks that API entity specified by identifier is associated with the Product\n entity.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param product_id [String] Product identifier. Must be unique in the current\n API Management service instance.\n @param api_id [String] API revision identifier. Must be unique in the current\n API Management service instance. Non-current revision has ;rev=n as a suffix\n where n is the revision number.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the sensitivity label of a given column\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server.\n @param database_name [String] The name of the database.\n @param schema_name [String] The name of the schema.\n @param table_name [String] The name of the table.\n @param column_name [String] The name of the column.\n @param sensitivity_label_source [SensitivityLabelSource] The source of the\n sensitivity label. Possible values include: 'current', 'recommended'\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get a Streaming Policy\n\n Get the details of a Streaming Policy in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param streaming_policy_name [String] The Streaming Policy name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Create a Streaming Policy\n\n Create a Streaming Policy in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param streaming_policy_name [String] The Streaming Policy name.\n @param parameters [StreamingPolicy] The request parameters\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete a Streaming Policy\n\n Deletes a Streaming Policy in the Media Services account\n\n @param resource_group_name [String] The name of the resource group within the\n Azure subscription.\n @param account_name [String] The Media Services account name.\n @param streaming_policy_name [String] The Streaming Policy name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the default Geographic Hierarchy used by the Geographic traffic routing\n method.\n\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [TrafficManagerGeographicHierarchy] operation results.", "Gets a list of managed instance keys.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param filter [String] An OData filter expression that filters elements in\n the collection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a managed instance key.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param key_name [String] The name of the managed instance key to be\n retrieved.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a managed instance key.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param key_name [String] The name of the managed instance key to be operated\n on (updated or created).\n @param parameters [ManagedInstanceKey] The requested managed instance key\n resource state.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the managed instance key with the given name.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param key_name [String] The name of the managed instance key to be deleted.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates guest diagnostics settings.\n\n @param resource_group_name [String] The name of the resource group.\n @param diagnostic_settings_name [String] The name of the diagnostic setting.\n @param parameters [GuestDiagnosticSettingsPatchResource] The configuration to\n patch.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Delete guest diagnostics settings.\n\n @param resource_group_name [String] The name of the resource group.\n @param diagnostic_settings_name [String] The name of the diagnostic setting.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Creates and initialize new instance of the HttpOperationException class.\n @param [Hash] the HTTP request data (uri, body, headers).\n @param [Faraday::Response] the HTTP response object.\n @param [String] body the HTTP response body.\n @param [String] error message.", "Check Name Availability for global uniqueness\n\n @param location [String] The location in which uniqueness will be verified.\n @param check_name_availability [CheckNameAvailabilityRequest] Check Name\n Availability Request.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [CheckNameAvailabilityResponse] operation results.", "Gets a recoverable managed database.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param managed_instance_name [String] The name of the managed instance.\n @param recoverable_database_name [String]\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns the SKUs available for the provided resource.\n\n @param resource_group_name [String] The name of the resource group containing\n the Kusto cluster.\n @param cluster_name [String] The name of the Kusto cluster.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ListResourceSkusResult] operation results.", "Create or update a Kusto cluster.\n\n @param resource_group_name [String] The name of the resource group containing\n the Kusto cluster.\n @param cluster_name [String] The name of the Kusto cluster.\n @param parameters [Cluster] The Kusto cluster parameters supplied to the\n CreateOrUpdate operation.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a virtual cluster.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param virtual_cluster_name [String] The name of the virtual cluster.\n @param parameters [VirtualClusterUpdate] The requested managed instance\n resource state.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets a server DNS alias.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server that the alias is pointing\n to.\n @param dns_alias_name [String] The name of the server DNS alias.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a server dns alias.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server that the alias is pointing\n to.\n @param dns_alias_name [String] The name of the server DNS alias.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the server DNS alias with the given name.\n\n @param resource_group_name [String] The name of the resource group that\n contains the resource. You can obtain this value from the Azure Resource\n Manager API or the portal.\n @param server_name [String] The name of the server that the alias is pointing\n to.\n @param dns_alias_name [String] The name of the server DNS alias.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the appliance definition.\n\n @param appliance_definition_id [String] The fully qualified ID of the\n appliance definition, including the appliance name and the appliance\n definition resource type. Use the format,\n /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applianceDefinitions/{applianceDefinition-name}\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [ApplianceDefinition] operation results.", "Creates a new appliance definition.\n\n @param resource_group_name [String] The name of the resource group. The name\n is case insensitive.\n @param appliance_definition_name [String] The name of the appliance\n definition.\n @param parameters [ApplianceDefinition] Parameters supplied to the create or\n update an appliance definition.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns an Event Hub connection.\n\n @param resource_group_name [String] The name of the resource group containing\n the Kusto cluster.\n @param cluster_name [String] The name of the Kusto cluster.\n @param database_name [String] The name of the database in the Kusto cluster.\n @param event_hub_connection_name [String] The name of the event hub\n connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes the Event Hub connection with the given name.\n\n @param resource_group_name [String] The name of the resource group containing\n the Kusto cluster.\n @param cluster_name [String] The name of the Kusto cluster.\n @param database_name [String] The name of the database in the Kusto cluster.\n @param event_hub_connection_name [String] The name of the event hub\n connection.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get cluster code versions by environment and version\n\n @param location [String] The location for the cluster code versions, this is\n different from cluster location\n @param environment [Enum] Cluster operating system, the default means all.\n Possible values include: 'Windows', 'Linux'\n @param cluster_version [String] The cluster code version\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Get the policy configuration at the API level.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param api_id [String] API revision identifier. Must be unique in the current\n API Management service instance. Non-current revision has ;rev=n as a suffix\n where n is the revision number.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PolicyCollection] operation results.", "Fetches the usages of the vault.\n\n @param resource_group_name [String] The name of the resource group where the\n recovery services vault is present.\n @param vault_name [String] The name of the recovery services vault.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [VaultUsageList] operation results.", "Queries policy events for the subscription level policy set definition.\n\n @param subscription_id [String] Microsoft Azure subscription ID.\n @param policy_set_definition_name [String] Policy set definition name.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Queries policy events for the subscription level policy definition.\n\n @param subscription_id [String] Microsoft Azure subscription ID.\n @param policy_definition_name [String] Policy definition name.\n @param query_options [QueryOptions] Additional parameters for the operation\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a topic from the specified namespace and resource group.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param topic_name [String] The topic name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets authorization rules for a topic.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param topic_name [String] The topic name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Returns the specified authorization rule.\n\n @param resource_group_name [String] Name of the Resource group within the\n Azure subscription.\n @param namespace_name [String] The namespace name\n @param topic_name [String] The topic name.\n @param authorization_rule_name [String] The authorization rule name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates or updates a Network resource.\n\n Creates a Network resource with the specified name, description and\n properties. If Network resource with the same name exists, then it is updated\n with the specified description and properties. Network resource provides\n connectivity between application services.\n\n @param network_resource_name [String] The identity of the network.\n @param network_resource_description [NetworkResourceDescription] Description\n for creating a Network resource.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [NetworkResourceDescription] operation results.", "Update an existing application.\n\n @param application_object_id [String] Application object ID.\n @param parameters [ApplicationUpdateParameters] Parameters to update an\n existing application.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Directory objects that are owners of the application.\n\n The owners are a set of non-admin users who are allowed to modify this\n object.\n\n @param application_object_id [String] The object ID of the application for\n which to get owners.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DirectoryObjectListResult] operation results.", "Get the keyCredentials associated with an application.\n\n @param application_object_id [String] Application object ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [KeyCredentialListResult] operation results.", "Update the keyCredentials associated with an application.\n\n @param application_object_id [String] Application object ID.\n @param parameters [KeyCredentialsUpdateParameters] Parameters to update the\n keyCredentials of an existing application.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Get the passwordCredentials associated with an application.\n\n @param application_object_id [String] Application object ID.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PasswordCredentialListResult] operation results.", "Update passwordCredentials associated with an application.\n\n @param application_object_id [String] Application object ID.\n @param parameters [PasswordCredentialsUpdateParameters] Parameters to update\n passwordCredentials of an existing application.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.", "Gets a deny assignment by ID.\n\n @param deny_assignment_id [String] The fully qualified deny assignment ID.\n For example, use the format,\n /subscriptions/{guid}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}\n for subscription level deny assignments, or\n /providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} for\n tenant level deny assignments.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [DenyAssignment] operation results.", "Check if an IoT Central application subdomain is available.\n\n @param operation_inputs [OperationInputs] Set the name parameter in the\n OperationInputs structure to the subdomain of the IoT Central application to\n check.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [AppAvailabilityInfo] operation results.", "Determine if Notification Recipient Email subscribed to the notification.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param notification_name [NotificationName] Notification Name Identifier.\n Possible values include: 'RequestPublisherNotificationMessage',\n 'PurchasePublisherNotificationMessage', 'NewApplicationNotificationMessage',\n 'BCC', 'NewIssuePublisherNotificationMessage', 'AccountClosedPublisher',\n 'QuotaLimitApproachingPublisherNotificationMessage'\n @param email [String] Email identifier.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Adds the Email address to the list of Recipients for the Notification.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param notification_name [NotificationName] Notification Name Identifier.\n Possible values include: 'RequestPublisherNotificationMessage',\n 'PurchasePublisherNotificationMessage', 'NewApplicationNotificationMessage',\n 'BCC', 'NewIssuePublisherNotificationMessage', 'AccountClosedPublisher',\n 'QuotaLimitApproachingPublisherNotificationMessage'\n @param email [String] Email identifier.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Removes the email from the list of Notification.\n\n @param resource_group_name [String] The name of the resource group.\n @param service_name [String] The name of the API Management service.\n @param notification_name [NotificationName] Notification Name Identifier.\n Possible values include: 'RequestPublisherNotificationMessage',\n 'PurchasePublisherNotificationMessage', 'NewApplicationNotificationMessage',\n 'BCC', 'NewIssuePublisherNotificationMessage', 'AccountClosedPublisher',\n 'QuotaLimitApproachingPublisherNotificationMessage'\n @param email [String] Email identifier.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Updates a network interface tags.\n\n @param resource_group_name [String] The name of the resource group.\n @param network_interface_name [String] The name of the network interface.\n @param parameters [TagsObject] Parameters supplied to update network\n interface tags.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Unregisters provider from a subscription.\n\n @param resource_provider_namespace [String] Namespace of the resource\n provider.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Provider] operation results.", "Registers provider to be used with a subscription.\n\n @param resource_provider_namespace [String] Namespace of the resource\n provider.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [Provider] operation results.", "Gets a resource provider.\n\n @param resource_provider_namespace [String] Namespace of the resource\n provider.\n @param expand [String] The $expand query parameter. e.g. To include property\n aliases in response, use $expand=resourceTypes/aliases.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets an integration account certificate.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param certificate_name [String] The integration account certificate name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes an integration account certificate.\n\n @param resource_group_name [String] The resource group name.\n @param integration_account_name [String] The integration account name.\n @param certificate_name [String] The integration account certificate name.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Gets the specified load balancer outbound rule.\n\n @param resource_group_name [String] The name of the resource group.\n @param load_balancer_name [String] The name of the load balancer.\n @param outbound_rule_name [String] The name of the outbound rule.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Creates a policy assignment.\n\n Policy assignments are inherited by child resources. For example, when you\n apply a policy to a resource group that policy is assigned to all resources\n in the group.\n\n @param scope [String] The scope of the policy assignment.\n @param policy_assignment_name [String] The name of the policy assignment.\n @param parameters [PolicyAssignment] Parameters for the policy assignment.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [MsRestAzure::AzureOperationResponse] HTTP response information.", "Deletes a policy assignment by ID.\n\n When providing a scope for the assignment, use\n '/subscriptions/{subscription-id}/' for subscriptions,\n '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for\n resource groups, and\n '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}'\n for resources.\n\n @param policy_assignment_id [String] The ID of the policy assignment to\n delete. Use the format\n '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PolicyAssignment] operation results.", "Gets a policy assignment by ID.\n\n When providing a scope for the assignment, use\n '/subscriptions/{subscription-id}/' for subscriptions,\n '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for\n resource groups, and\n '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}'\n for resources.\n\n @param policy_assignment_id [String] The ID of the policy assignment to get.\n Use the format\n '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'.\n @param custom_headers [Hash{String => String}] A hash of custom headers that\n will be added to the HTTP request.\n\n @return [PolicyAssignment] operation results.", "Sets up the numeric value tracker. It will check whether the value and category\n options are set that are used to extract and categorize the values during\n parsing. Two lambda procedures are created for these tasks", "Get the value information from the request and store it in the respective categories.\n\n If a request can contain multiple usable values for this tracker, the :multiple option\n should be set to true. In this case, all the values and respective categories will be\n read from the request using the #every method from the fields given in the :value and\n :category option.\n\n If the request contains only one suitable value and the :multiple is not set, it will\n read the single value and category from the fields provided in the :value and :category\n option, or calculate it with any lambda procedure that is assigned to these options. The\n request will be passed to procedure as input for the calculation.\n\n @param [RequestLogAnalyzer::Request] request The request to get the information from.", "Display a value", "Returns the title of this tracker for reports", "Returns all the categories and the tracked duration as a hash than can be exported to YAML", "Returns the bucket index for a value", "Returns a single value representing a bucket.", "Returns the upper bound value that would include x% of the hits.", "Returns a percentile interval, i.e. the lower bound and the upper bound of the values\n that represent the x%-interval for the bucketized dataset.\n\n A 90% interval means that 5% of the values would have been lower than the lower bound and\n 5% would have been higher than the upper bound, leaving 90% of the values within the bounds.\n You can also provide a Range to specify the lower bound and upper bound percentages (e.g. 5..95).", "Returns the column header for a statistics table to report on the statistics result", "Returns a row of statistics information for a report table, given a category", "Check if a file has a compressed extention in the filename.\n If recognized, return the command string used to decompress the file", "Parses a log file. Creates an IO stream for the provided file, and sends it to parse_io for\n further handling. This method supports progress updates that can be used to display a progressbar\n\n If the logfile is compressed, it is uncompressed to stdout and read.\n TODO: Check if IO.popen encounters problems with the given command line.\n TODO: Fix progress bar that is broken for IO.popen, as it returns a single string.\n\n <tt>file</tt>:: The file that should be parsed.\n <tt>options</tt>:: A Hash of options that will be pased to parse_io.", "Combines the different lines of a request into a single Request object. It will start a\n new request when a header line is encountered en will emit the request when a footer line\n is encountered.\n\n Combining the lines is done using heuristics. Problems can occur in this process. The\n current parse strategy defines how these cases are handled.\n\n When using the 'assume-correct' parse strategy (default):\n - Every line that is parsed before a header line is ignored as it cannot be included in\n   any request. It will emit a :no_current_request warning.\n - If a header line is found before the previous requests was closed, the previous request\n   will be yielded and a new request will be started.\n\n When using the 'cautious' parse strategy:\n - Every line that is parsed before a header line is ignored as it cannot be included in\n   any request. It will emit a :no_current_request warning.\n - A header line that is parsed before a request is closed by a footer line, is a sign of\n   an unproperly ordered file. All data that is gathered for the request until then is\n   discarded and the next request is ignored as well. An :unclosed_request warning is\n   emitted.\n\n <tt>request_data</tt>:: A hash of data that was parsed from the last line.", "Handles the parsed request by sending it into the pipeline.\n\n - It will call RequestLogAnalyzer::Request#validate on the request instance\n - It will send the request into the pipeline, checking whether it was accepted by all the filters.\n - It will update the parsed_requests and skipped_requests variables accordingly\n\n <tt>request</tt>:: The parsed request instance (RequestLogAnalyzer::Request)", "Creates a regular expression to match a hostname or ip address", "Create a regular expression for a timestamp, generated by a strftime call.\n Provide the format string to construct a matching regular expression.\n Set blank to true to allow and empty string, or set blank to a string to set\n a substitute for the nil value.", "Allow the field to be blank if this option is given. This can be true to\n allow an empty string or a string alternative for the nil value.", "Checks whether the line definitions form a valid language.\n A file format should have at least a header and a footer line type", "Parses a line by trying to parse it using every line definition in this file format", "Exports all the tracker results to YAML. It will call the to_yaml_object method\n for every tracker and combines these into a single YAML export.", "Check if categories are set up", "Initialize the class\n Note that the options are only applicable if should_update? is not overwritten\n by the inheriting class.\n\n === Options\n * <tt>:if</tt> Handle request if this proc is true for the handled request.\n * <tt>:unless</tt> Handle request if this proc is false for the handled request.\n * <tt>:line_type</tt> Line type this tracker will accept.\n Sets up the tracker's should_update? checks.", "Creates a lambda expression to return a static field from a request. If the\n argument already is a lambda exprssion, it will simply return the argument.", "matches the line and converts the captured values using the request's\n convert_value function.", "Adds another line to the request when it is parsed in the LogParser.\n\n The line should be provided as a hash with the attributes line_definition, :captures,\n :lineno and :source set. This function is called from LogParser.", "Adds another line to the request using a plain hash.\n\n The line should be provides as a hash of the fields parsed from the line.", "Checks whether the given line type was parsed from the log file for this request", "Returns an array of all the \"field\" values that were captured for this request", "Checks whether this request is completed. A completed request contains both a parsed header\n line and a parsed footer line. Not that calling this function in single line mode will always\n return false.", "Check if duration and catagory option have been received,", "Keep request if @mode == :select and request has the field and value.\n Drop request if @mode == :reject and request has the field and value.\n Returns nil otherwise.\n <tt>request</tt> Request Object", "Genrate HTML header and associated stylesheet", "Source change handler", "Adds a request filter to the controller.", "Push a request through the entire filterchain (@filters).\n <tt>request</tt> The request to filter.\n Returns the filtered request or nil.", "Push a request to all the aggregators (@aggregators).\n <tt>request</tt> The request to push to the aggregators.", "Runs RequestLogAnalyzer\n 1. Call prepare on every aggregator\n 2. Generate requests from source object\n 3. Filter out unwanted requests\n 4. Call aggregate for remaning requests on every aggregator\n 4. Call finalize on every aggregator\n 5. Call report on every aggregator\n 6. Finalize Source", "Display a duration", "Establishes a connection to the database and creates the necessary database schema for the\n current file format", "Aggregates a request into the database\n This will create a record in the requests table and create a record for every line that has been parsed,\n in which the captured values will be stored.", "Records w warining in the warnings table.", "Records source changes in the sources table", "Prints a short report of what has been inserted into the database", "the way to add items to the set.", "the way to remove items from the set.", "Determines whether the given attributes hash is \"empty\".\n This isn't a literal emptiness - it's an attempt to discern whether the user intended it to be empty or not.", "The actual \"add_existing\" algorithm", "Adds two rendering options.\n\n ==render :super\n\n This syntax skips all template overrides and goes directly to the provided ActiveScaffold templates.\n Useful if you want to wrap an existing template. Just call super!\n\n ==render :active_scaffold => #{controller.to_s}, options = {}+\n\n Lets you embed an ActiveScaffold by referencing the controller where it's configured.\n\n You may specify options[:constraints] for the embedded scaffold. These constraints have three effects:\n   * the scaffold's only displays records matching the constraint\n   * all new records created will be assigned the constrained values\n   * constrained columns will be hidden (they're pretty boring at this point)\n\n You may also specify options[:conditions] for the embedded scaffold. These only do 1/3 of what\n constraints do (they only limit search results). Any format accepted by ActiveRecord::Base.find is valid.\n\n Defining options[:label] lets you completely customize the list title for the embedded scaffold.\n\n options[:xhr] force to load embedded scaffold with AJAX even when render_component gem is installed.", "provides a quick way to set any property of the object from a hash", "Add a nested ActionLink", "A somewhat complex method to actually create a new record. The complexity is from support for subforms and associated records.\n If you want to customize this behavior, consider using the +before_create_save+ and +after_create_save+ callbacks.", "To be called after your finished configuration", "add a clause to the sorting, assuming the column is sortable", "builds an order-by clause", "possibly converts the given argument into a column object from @columns (if it's not already)", "the way to add columns to the set. this is primarily useful for virtual columns.\n note that this also makes columns inheritable", "associate an action_link with this column", "adds an ActionLink, creating one from the arguments if need be", "adds a link to a specific group\n groups are represented as a string separated by a dot\n eg member.crud", "finds an ActionLink by matching the action", "iterates over the links, possibly by type", "nests a subgroup in the column set", "A simple method to handle the actual destroying of a record\n May be overridden to customize the behavior", "Returns search conditions based on the current scaffold constraints.\n\n Supports constraints based on either a column name (in which case it checks for an association\n or just uses the search_sql) or a database field name.\n\n All of this work is primarily to support nested scaffolds in a manner generally useful for other\n embedded scaffolds.", "We do NOT want to use .search_sql. If anything, search_sql will refer\n to a human-searchable value on the associated record.", "Applies constraints to the given record.\n\n Searches through the known columns for association columns. If the given constraint is an association,\n it assumes that the constraint value is an id. It then does a association.klass.find with the value\n and adds the associated object to the record.\n\n For some operations ActiveRecord will automatically update the database. That's not always ok.\n If it *is* ok (e.g. you're in a transaction), then set :allow_autosave to true.", "Returns an enumerator for iterating over timestamps in the schedule\n\n @example Return the events\n   schedule = Montrose::Schedule.build do |s|\n     s << { every: :day }\n   end\n   schedule.events\n\n @return [Enumerator] an enumerator of recurrence timestamps", "Given a time instance, advances state of when all\n recurrence rules on the stack match, and yielding\n time to the block, otherwise, invokes break? on\n non-matching rules.\n\n @param [Time] time - time instance candidate for recurrence", "Add campaign IDs to message. Limit of 3 per message.\n\n @param [String] campaign_id A defined campaign ID to add to the message.\n @return [void]", "Add tags to message. Limit of 3 per message.\n\n @param [String] tag A defined campaign ID to add to the message.\n @return [void]", "Add custom data to the message. The data should be either a hash or JSON\n encoded. The custom data will be added as a header to your message.\n\n @param [string] name A name for the custom data. (Ex. X-Mailgun-<Name of Data>: {})\n @param [Hash] data Either a hash or JSON string.\n @return [void]", "Converts boolean type to string\n\n @param [String] value The item to convert\n @return [void]", "This method initiates a batch send to the API. It formats the recipient\n variables, posts to the API, gathers the message IDs, then flushes that data\n to prepare for the next batch. This method implements the Mailgun Client, thus,\n an exception will be thrown if a communication error occurs.\n\n @return [Boolean]", "This method stores recipient variables for each recipient added, if\n variables exist.", "Return response as Yaml\n\n @return [String] A string containing response as YAML", "Initialize the Railgun mailer.\n\n @param [Hash] config Hash of config values, typically from `app_config.action_mailer.mailgun_config`", "Simple Message Sending\n\n @param [String] working_domain This is the domain you wish to send from.\n @param [Hash] data This should be a standard Hash\n containing required parameters for the requested resource.\n @return [Mailgun::Response] A Mailgun::Response object.", "Generic Mailgun POST Handler\n\n @param [String] resource_path This is the API resource you wish to interact\n with. Be sure to include your domain, where necessary.\n @param [Hash] data This should be a standard Hash\n containing required parameters for the requested resource.\n @param [Hash] headers Additional headers to pass to the resource.\n @return [Mailgun::Response] A Mailgun::Response object.", "Generic Mailgun GET Handler\n\n @param [String] resource_path This is the API resource you wish to interact\n with. Be sure to include your domain, where necessary.\n @param [Hash] params This should be a standard Hash\n containing required parameters for the requested resource.\n @param [String] accept Acceptable Content-Type of the response body.\n @return [Mailgun::Response] A Mailgun::Response object.", "Generic Mailgun PUT Handler\n\n @param [String] resource_path This is the API resource you wish to interact\n with. Be sure to include your domain, where necessary.\n @param [Hash] data This should be a standard Hash\n containing required parameters for the requested resource.\n @return [Mailgun::Response] A Mailgun::Response object.", "Generic Mailgun DELETE Handler\n\n @param [String] resource_path This is the API resource you wish to interact\n with. Be sure to include your domain, where necessary.\n @return [Mailgun::Response] A Mailgun::Response object.", "Converts MIME string to file for easy uploading to API\n\n @param [String] string MIME string to post to API\n @return [File] File object", "Raises CommunicationError and stores response in it if present\n\n @param [StandardException] e upstream exception object", "Move ansible's default interface first in the list of interfaces since\n Foreman picks the first one that is usable. If ansible has no\n preference otherwise at least sort the list.\n\n This method overrides app/services/fact_parser.rb on Foreman and returns\n an array of interface names, ['eth0', 'wlan1', etc...]", "Constructor\n Download a file or resource\n @param options [Hash]\n @param target [String, nil] system path to the downloaded file (defaults to a temporary file)", "Retrieve the resource from the storage service\n @param options [Hash]", "Extract and parse options used to download a file or resource from an HTTP API\n @param options [Hash]\n @return [Hash]", "Retrieve the file from the file system\n @param options [Hash]", "Retrieve a resource over the HTTP\n @param options [Hash]", "Retrieve the file size\n @param options [Hash]\n @return [Integer] the size of the requested file", "Create a new empty packet\n Set packet attributes from a hash of attribute names and values", "Serialise the packet", "Remove 8 bits from the front of buffer", "Remove string from the front of buffer", "Set a path to a file containing a PEM-format client private key", "Set to a PEM-format client private key", "Set a path to a file containing a PEM-format CA certificate and enable peer verification", "Set the Will for the client\n\n The will is a message that will be delivered by the server when the client dies.\n The Will must be set before establishing a connection to the server", "Connect to the MQTT server\n If a block is given, then yield to that block and then disconnect again.", "Disconnect from the MQTT server.\n If you don't want to say goodbye to the server, set send_msg to false.", "Publish a message on a particular topic to the MQTT server.", "Return the next message received from the MQTT server.\n An optional topic can be given to subscribe to.\n\n The method either returns the topic and message as an array:\n   topic,message = client.get\n\n Or can be used with a block to keep processing messages:\n   client.get('test') do |topic,payload|\n     # Do stuff here\n   end", "Return the next packet object received from the MQTT server.\n An optional topic can be given to subscribe to.\n\n The method either returns a single packet:\n   packet = client.get_packet\n   puts packet.topic\n\n Or can be used with a block to keep processing messages:\n   client.get_packet('test') do |packet|\n     # Do stuff here\n     puts packet.topic\n   end", "Send a unsubscribe message for one or more topics on the MQTT server", "Try to read a packet from the server\n Also sends keep-alive ping packets.", "Read and check a connection acknowledgement packet", "Send a packet to server", "Create a new MQTT Proxy instance.\n\n Possible argument keys:\n\n  :local_host      Address to bind listening socket to.\n  :local_port      Port to bind listening socket to.\n  :server_host     Address of upstream server to send packets upstream to.\n  :server_port     Port of upstream server to send packets upstream to.\n  :select_timeout  Time in seconds before disconnecting a connection.\n  :logger          Ruby Logger object to send informational messages to.\n\n NOTE: be careful not to connect to yourself!\n Start accepting connections and processing packets.", "load the hosts into a Queue for thread safety", "merges URI options into opts", "When this future is completed match against result.\n\n If the future has already been completed,\n this will either be applied immediately or be scheduled asynchronously.\n @yieldparam [Fear::TryPatternMatch]\n @return [self]\n\n @example\n   Fear.future { }.on_complete_match do |m|\n     m.success { |result| }\n     m.failure { |error| }\n   end", "Creates a new future by applying the +success+ function to the successful\n result of this future, or the +failure+ function to the failed result.\n If there is any non-fatal error raised when +success+ or +failure+ is\n applied, that error will be propagated to the resulting future.\n\n @yieldparam success [#get] function that transforms a successful result of the\n   receiver into a successful result of the returned future\n @yieldparam failure [#exception] function that transforms a failure of the\n   receiver into a failure of the returned future\n @return [Fear::Future] a future that will be completed with the\n   transformed value\n\n @example\n   Fear.future { open('http://example.com').read }\n     .transform(\n        ->(value) { ... },\n        ->(error) { ... },\n     )", "Creates a new future by applying a block to the successful result of\n this future. If this future is completed with an error then the new\n future will also contain this error.\n\n @return [Fear::Future]\n\n @example\n   future = Fear.future { 2 }\n   future.map { |v| v * 2 } #=> the same as Fear.future { 2 * 2 }", "Creates a new future by applying a block to the successful result of\n this future, and returns the result of the function as the new future.\n If this future is completed with an exception then the new future will\n also contain this exception.\n\n @yieldparam [any]\n @return [Fear::Future]\n\n @example\n   f1 = Fear.future { 5 }\n   f2 = Fear.future { 3 }\n   f1.flat_map do |v1|\n     f1.map do |v2|\n       v2 * v1\n     end\n   end", "Zips the values of +self+ and +other+ future, and creates\n a new future holding the array of their results.\n\n If +self+ future fails, the resulting future is failed\n with the error stored in +self+.\n Otherwise, if +other+ future fails, the resulting future is failed\n with the error stored in +other+.\n\n @param other [Fear::Future]\n @return [Fear::Future]\n\n @example\n   future1 = Fear.future { call_service1 }\n   future1 = Fear.future { call_service2 }\n   future1.zip(future2) #=> returns the same result as Fear.future { [call_service1, call_service2] },\n     # but it performs two calls asynchronously", "Creates a new future which holds the result of +self+ future if it\n was completed successfully, or, if not, the result of the +fallback+\n future if +fallback+ is completed successfully.\n If both futures are failed, the resulting future holds the error\n object of the first future.\n\n @param fallback [Fear::Future]\n @return [Fear::Future]\n\n @example\n   f = Fear.future { fail 'error' }\n   g = Fear.future { 5 }\n   f.fallback_to(g) # evaluates to 5\n\n rubocop: disable Metrics/MethodLength", "Match against Some\n\n @param conditions [<#==>]\n @return [Fear::OptionPatternMatch]", "Returns array of images used in content", "Finds images used in an articles content and associates each\n image to the blog article", "Refreshes the sitemap and pings the search engines", "Lists all published articles.\n Responds to html and atom", "Shows specific article", "Renders the teaser for an article.", "Returns formatted and highlighted code fragments", "Returns links in active or inactive state for highlighting current page", "Returns HTML with all authors of an article", "Renders the navigation bar for logged in users", "Returns site name for actionbar, dependend on current site", "Sets +rest_digest+ and +reset_sent_at+ for password reset.", "Authenticate user and create a new session.", "this types +text+ on the server", "This types +text+ on the server, but it holds the shift key down when necessary.\n It will also execute key_press for tabs and returns.", "Traverses path to see which exist or not\n and checks if available", "We put a long name to not clash with any function in the Veewee file itself", "This function takes a hash of options and injects them into the definition", "Retrieve the first mac address for a vm\n This will only retrieve the first auto generate mac address", "Retrieve the ip address for a vm.\n This will only look for dynamically assigned ip address via vmware dhcp", "Fetch all definitions", "Runs given block on a thread or fiber and returns result.\n If eventmachine is running on another thread, the fiber\n must be on the same thread, hence EM.schedule and the\n restriction that the given block cannot include rspec matchers.", "if required and optional arrays are given, extra params are an error", "adds data to the request, returns true if request is complete", "Convert the specified column type to a SQL string.\n @override", "default schema owner", "holy moly batman! all this to tell AS400 \"yes i am sure\"", "disable all schemas browsing when default schema is specified", "Support for executing a stored procedure.", "AR-SQLServer-Adapter naming\n @override", "Configures the encoding, verbosity, schema search path, and time zone of the connection.\n This is called on `connection.connect` and should not be called manually.", "while methods have moved around this has been the implementation\n since ActiveRecord 3.0", "Get the maintenance state of a host\n @param n [String] the node\n @param options [Hash] :dc string for dc specific query\n @return [Hash] { :enabled => true, :reason => 'foo' }", "Enable or disable maintenance mode.  This endpoint only works\n on the local agent.\n @param enable enable or disable maintenance mode\n @param reason [String] the reason for enabling maintenance mode\n @param options [Hash] :dc string for dc specific query\n @return true if call is successful", "Create a new session\n @param value [Object] hash or json representation of the session arguments\n @param options [Hash] session options\n @return [String] The sesssion id", "Destroy a session\n @param id [String] session id\n @param options [Hash] session options\n @return [String] Success or failure of the session destruction", "Create a prepared query or prepared query template\n @param definition [Hash] Hash containing definition of prepared query\n @param options [Hash] :dc Consul datacenter to query\n @return [String] the ID of the prepared query created", "Delete a prepared query or prepared query template\n @param key [String] the prepared query ID\n @param options [Hash] :dc Consul datacenter to query\n @return [Boolean]", "Update a prepared query or prepared query template\n @param key [String] the prepared query ID\n @param definition [Hash] Hash containing updated definition of prepared query\n @param options [Hash] :dc Consul datacenter to query\n @return [Boolean]", "Execute a prepared query or prepared query template\n @param key [String] the prepared query ID or name\n @param options [Hash] prepared query execution options\n @option dc [String] :dc Consul datacenter to query\n @option near [String] node name to sort the resulting list in ascending order based on the\n   estimated round trip time from that node\n @option limit [Integer] to limit the size of the return list to the given number of results\n @return [OpenStruct] the list of results from the prepared query or prepared query template\n rubocop:disable PerceivedComplexity", "Register a check\n @param check_id [String] the unique id of the check\n @param name [String] the name\n @param notes [String] notes about the check\n @param args [String[]] command to be run for check\n @param interval [String] frequency (with units) of the check execution\n @param options [Hash] options parameter hash\n @return [Integer] Status code\n rubocop:disable ParameterLists", "Update a TTL check\n @param check_id [String] the unique id of the check\n @param status [String] status of the check. Valid values are \"passing\", \"warning\", and \"critical\"\n @param output [String] human-readable message will be passed through to the check's Output field\n @param options [Hash] options parameter hash\n @return [Integer] Status code", "Get a value by its key, potentially blocking for the first or next value\n @param key [String] the key\n @param options [Hash] the query params\n @option options [Boolean] :recurse If to make recursive get or not\n @option options [String] :consistency The read consistency type\n @option options [String] :dc Target datacenter\n @option options [Boolean] :keys Only return key names.\n @option options [Boolean] :modify_index Only return ModifyIndex value.\n @option options [Boolean] :session Only return Session value.\n @option options [Boolean] :decode_values Return consul response with decoded values.\n @option options [String] :separator List only up to a given separator.\n   Only applies when combined with :keys option.\n @option options [Boolean] :nil_values If to return keys/dirs with nil values\n @option options [Boolean] :convert_to_hash Take the data returned from consul and build a hash\n @option options [Callable] :transformation funnction to invoke on keys values\n @param not_found [Symbol] behaviour if the key doesn't exist;\n   :reject with exception, :return degenerate value, or :wait for it to appear\n @param found [Symbol] behaviour if the key does exist;\n   :reject with exception, :return its current value, or :wait for its next value\n @return [String] The base64-decoded value associated with the key\n @note\n   When trying to access a key, there are two possibilites:\n   - The key doesn't (yet) exist\n   - The key exists. This may be its first value, there is no way to tell\n   The combination of not_found and found behaviour gives maximum possible\n   flexibility. For X: reject, R: return, W: wait\n   - X X - meaningless; never return a value\n   - X R - \"normal\" non-blocking get operation. Default\n   - X W - get the next value only (must have a current value)\n   - R X - meaningless; never return a meaningful value\n   - R R - \"safe\" non-blocking, non-throwing get-or-default operation\n   - R W - get the next value or a default\n   - W X - get the first value only (must not have a current value)\n   - W R - get the first or current value; always return something, but\n           block only when necessary\n   - W W - get the first or next value; wait until there is an update\n rubocop:disable PerceivedComplexity, MethodLength, LineLength, CyclomaticComplexity", "Delete a value by its key\n @param key [String] the key\n @param options [Hash] the query params\n @option options [String] :dc Target datacenter\n @option options [Boolean] :recurse If to make recursive get or not\n @return [OpenStruct]", "Send an event\n @param name [String] the event name\n @param value [String] the payload of the event\n @param service [String] the target service name\n @param node [String] the target node name\n @param tag [String] the target tag name, must only be used with service\n @param dc [String] the dc to target\n @param options [Hash] options parameter hash\n @return [nil]\n rubocop:disable Metrics/ParameterLists", "Get a specific event in the sequence matching name\n @param name [String] the name of the event (regex)\n @param token [String|Symbol] the ordinate of the event in the sequence;\n   String are tokens returned by previous calls to this function\n   Symbols are the special tokens :first, :last, and :next\n @param not_found [Symbol] behaviour if there is no matching event;\n   :reject with exception, :return degenerate value, or :wait for event\n @param found [Symbol] behaviour if there is a matching event;\n   :reject with exception, or :return its current value\n @return [hash] A hash with keys :value and :token;\n   :value is a further hash of the :name and :payload of the event,\n   :token is the event's ordinate in the sequence and can be passed to future calls to get the subsequent event\n @param options [Hash] options parameter hash\n @note\n   Whereas the consul API for events returns all past events that match\n   name, this method allows retrieval of individual events from that\n   sequence. However, because consul's API isn't conducive to this, we can\n   offer first, last, next (last + 1) events, or arbitrary events in the\n   middle, though these can only be identified relative to the preceding\n   event. However, this is ideal for iterating through the sequence of\n   events (while being sure that none are missed).\n rubocop:disable PerceivedComplexity", "Get a service by it's key\n @param key [String] the key\n @param scope [Symbol] :first or :all results\n @param options [Hash] options parameter hash\n @param meta [Hash] output structure containing header information about the request (index)\n @return [OpenStruct] all data associated with the service\n rubocop:disable PerceivedComplexity", "Register a service\n @param definition [Hash] Hash containing definition of service\n @param options [Hash] options parameter hash\n @return [Boolean]", "Enable or disable maintenance for a service\n @param service_id [String] id of the service\n @param options [Hash] opts the options for enabling or disabling maintenance for a service\n @options opts [Boolean] :enable (true) whether to enable or disable maintenance\n @options opts [String] :reason reason for the service maintenance\n @raise [Diplomat::PathNotFound] if the request fails\n @return [Boolean] if the request was successful or not", "Get node health\n @param n [String] the node\n @param options [Hash] :dc string for dc specific query\n @return [OpenStruct] all data associated with the node", "Get service checks\n @param s [String] the service\n @param options [Hash] :dc string for dc specific query\n @return [OpenStruct] all data associated with the node", "Get service health\n @param s [String] the service\n @param options [Hash] options parameter hash\n @return [OpenStruct] all data associated with the node\n rubocop:disable PerceivedComplexity", "Acquire a lock\n @param key [String] the key\n @param session [String] the session, generated from Diplomat::Session.create\n @param value [String] the value for the key\n @param options [Hash] options parameter hash\n @return [Boolean] If the lock was acquired", "wait to aquire a lock\n @param key [String] the key\n @param session [String] the session, generated from Diplomat::Session.create\n @param value [String] the value for the key\n @param check_interval [Integer] number of seconds to wait between retries\n @param options [Hash] options parameter hash\n @return [Boolean] If the lock was acquired", "Release a lock\n @param key [String] the key\n @param session [String] the session, generated from Diplomat::Session.create\n @param options [Hash] :dc string for dc specific query\n @return [nil]\n rubocop:disable AbcSize", "Assemble a url from an array of parts.\n @param parts [Array] the url chunks to be assembled\n @return [String] the resultant url string", "Get Acl info by ID\n @param id [String] ID of the Acl to get\n @param options [Hash] options parameter hash\n @return [Hash]\n rubocop:disable PerceivedComplexity", "Update an Acl definition, create if not present\n @param value [Hash] Acl definition, ID field is mandatory\n @param options [Hash] options parameter hash\n @return [Hash] The result Acl", "Create an Acl definition\n @param value [Hash] Acl definition, ID field is mandatory\n @param options [Hash] options parameter hash\n @return [Hash] The result Acl", "Get an array of all avaliable datacenters accessible by the local consul agent\n @param meta [Hash] output structure containing header information about the request (index)\n @param options [Hash] options parameter hash\n @return [OpenStruct] all datacenters avaliable to this consul agent", "Update the metadata properties of this resource. The +props+ will be\n merged with any existing properties. Nested hashes in the properties will\n also be merged.\n\n @param props [Hash] the properties to add\n @return [Gemstash::Resource] self for chaining purposes", "Check if the metadata properties includes the +keys+. The +keys+ represent\n a nested path in the properties to check.\n\n Examples:\n\n   resource = Gemstash::Storage.for(\"x\").resource(\"y\")\n   resource.save({ file: \"content\" }, foo: \"one\", bar: { baz: \"qux\" })\n   resource.has_property?(:foo)       # true\n   resource.has_property?(:bar, :baz) # true\n   resource.has_property?(:missing)   # false\n   resource.has_property?(:foo, :bar) # false\n\n @param keys [Array<Object>] one or more keys pointing to a property\n @return [Boolean] whether the nested keys points to a valid property", "The serializable hash is the Entity's primary output. It is the transformed\n hash for the given data model and is used as the basis for serialization to\n JSON and other formats.\n\n @param runtime_options [Hash] Any options you pass in here will be known to the entity\n   representation, this is where you can trigger things from conditional options\n   etc.", "Logs the queries run inside the block, and return them.", "Return a Hash of strings => ints. Each word in the string is stemmed,\n interned, and indexes to its frequency in the document.", "Return the classification without the score", "Overwrites the default stopwords for current language with supplied list of stopwords or file", "This function rebuilds the index if needs_rebuild? returns true.\n For very large document spaces, this indexing operation may take some\n time to complete, so it may be wise to place the operation in another\n thread.\n\n As a rule, indexing will be fairly swift on modern machines until\n you have well over 500 documents indexed, or have an incredibly diverse\n vocabulary for your documents.\n\n The optional parameter \"cutoff\" is a tuning parameter. When the index is\n built, a certain number of s-values are discarded from the system. The\n cutoff parameter tells the indexer how many of these values to keep.\n A value of 1 for cutoff means that no semantic analysis will take place,\n turning the LSI class into a simple vector search engine.", "This method returns max_chunks entries, ordered by their average semantic rating.\n Essentially, the average distance of each entry from all other entries is calculated,\n the highest are returned.\n\n This can be used to build a summary service, or to provide more information about\n your dataset's general content. For example, if you were to use categorize on the\n results of this data, you could gather information on what your dataset is generally\n about.", "This function is the primitive that find_related and classify\n build upon. It returns an array of 2-element arrays. The first element\n of this array is a document, and the second is its \"score\", defining\n how \"close\" it is to other indexed items.\n\n These values are somewhat arbitrary, having to do with the vector space\n created by your content, so the magnitude is interpretable but not always\n meaningful between indexes.\n\n The parameter doc is the content to compare. If that content is not\n indexed, you can pass an optional block to define how to create the\n text data. See add_item for examples of how this works.", "Similar to proximity_array_for_content, this function takes similar\n arguments and returns a similar array. However, it uses the normalized\n calculated vectors instead of their full versions. This is useful when\n you're trying to perform operations on content that is much smaller than\n the text you're working with. search uses this primitive.", "This function allows for text-based search of your index. Unlike other functions\n like find_related and classify, search only takes short strings. It will also ignore\n factors like repeated words. It is best for short, google-like search terms.\n A search will first priortize lexical relationships, then semantic ones.\n\n While this may seem backwards compared to the other functions that LSI supports,\n it is actually the same algorithm, just applied on a smaller document.", "This function takes content and finds other documents\n that are semantically \"close\", returning an array of documents sorted\n from most to least relavant.\n max_nearest specifies the number of documents to return. A value of\n 0 means that it returns all the indexed documents, sorted by relavence.\n\n This is particularly useful for identifing clusters in your document space.\n For example you may want to identify several \"What's Related\" items for weblog\n articles, or find paragraphs that relate to each other in an essay.", "Return the most obvious category without the score", "This function uses a voting system to categorize documents, based on\n the categories of other documents. It uses the same logic as the\n find_related function to find related documents, then returns the\n list of sorted categories.\n\n cutoff signifies the number of documents to consider when clasifying\n text. A cutoff of 1 means that every document in the index votes on\n what category the document is in. This may not always make sense.", "Prototype, only works on indexed documents.\n I have no clue if this is going to work, but in theory\n it's supposed to.", "Creates the raw vector out of word_hash using word_list as the\n key for mapping the vector space.", "Rotate the table horizontally\n\n @api private", "Return a row number at the index of the table as an Array.\n When a block is given, the elements of that Array are iterated over.\n\n @example\n   rows  = [['a1', 'a2'], ['b1', 'b2']]\n   table = TTY::Table.new rows: rows\n   table.row(1) { |row| ... }\n\n @param [Integer] index\n\n @yield []\n   optional block to execute in the iteration operation\n\n @return [self]\n\n @api public", "Return a column number at the index of the table as an Array.\n If the table has a header then column can be searched by header name.\n When a block is given, the elements of that Array are iterated over.\n\n @example\n   header = [:h1, :h2]\n   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]\n   table = TTY::Table.new :rows => rows, :header => header\n   table.column(1)\n   table.column(1)   { |element| ... }\n   table.column(:h1)\n   table.column(:h1) { |element| ... }\n\n @param [Integer, String, Symbol] index\n\n @yield []\n   optional block to execute in the iteration operation\n\n @return [self]\n\n @api public", "Add row to table\n\n @param [Array] row\n\n @return [self]\n\n @api public", "Render a given table using custom border class.\n\n @param [TTY::Table::Border] border_class\n\n @param [Symbol] renderer_type\n\n @param [Hash] options\n\n @yield [renderer]\n\n @yieldparam [TTY::Table::Renderer] renderer\n   the renderer for the table\n\n @return [String]\n\n @api public", "Coerce an Enumerable into a Table\n This coercion mechanism is used by Table to handle Enumerable types\n and force them into array type.\n\n @param [Enumerable] rows\n    the object to coerce\n\n @return [Array]\n\n @api public", "Adds execution duration instrumentation to a method as a timing.\n\n @param method [Symbol] The name of the method to instrument.\n @param name [String, #call] The name of the metric to use. You can also pass in a\n    callable to dynamically generate a metric name\n @param metric_options (see StatsD#measure)\n @return [void]", "Adds execution duration instrumentation to a method as a distribution.\n\n @param method [Symbol] The name of the method to instrument.\n @param name [String, #call] The name of the metric to use. You can also pass in a\n    callable to dynamically generate a metric name\n @param metric_options (see StatsD#measure)\n @return [void]\n @note Supported by the datadog implementation only (in beta)", "Adds counter instrumentation to a method.\n\n The metric will be incremented for every call of the instrumented method, no matter\n whether what the method returns, or whether it raises an exception.\n\n @param method (see #statsd_measure)\n @param name (see #statsd_measure)\n @param metric_options (see #statsd_measure)\n @return [void]", "Creates a String showing the output of the command, including a banner\n showing the exact command executed. Used by +invalid!+ to show command\n results when the command exited with an unexpected status.", "Normalizes the comment block to ignore any consistent preceding\n whitespace. Consistent means the same amount of whitespace on every line\n of the comment block. Also strips any whitespace at the start and end of\n the whole block.\n\n Returns a String of normalized text.", "Executes a transition of the state machine for the given line.\n Returns false if the line does not match any transition rule and the\n state machine was reset to the initial state.", "override add method", "Check if the local KB is packet or not.\n\n Returns true if at least one KB tarball file it has been found in the\n local DB path", "Output stuff - START\n\n Creates the directory name where dawnscanner results will be saved\n\n Examples\n   engine.create_output_dir\n   # => /Users/thesp0nge/dawnscanner/results/railsgoat/20151123\n   # => /Users/thesp0nge/dawnscanner/results/railsgoat/20151123_1 (if\n               previous directory name exists)", "Output stuff - END\n\n Security stuff applies here\n\n Public it applies a single security check given by its name\n\n name - the security check to be applied\n\n Examples\n\n   engine.apply(\"CVE-2013-1800\")\n   # => boolean\n\n Returns a true value if the security check was successfully applied or false\n otherwise", "called when loading the rel from the database\n @param [Neo4j::Embedded::EmbeddedRelationship, Neo4j::Server::CypherRelationship] persisted_rel properties of this relationship\n @param [Neo4j::Relationship] from_node_id The neo_id of the starting node of this rel\n @param [Neo4j::Relationship] to_node_id The neo_id of the ending node of this rel\n @param [String] type the relationship type", "Gives support for Rails date_select, datetime_select, time_select helpers.", "During object wrap, a hash is needed that contains each declared property with a nil value.\n The active_attr dependency is capable of providing this but it is expensive and calculated on the fly\n each time it is called. Rather than rely on that, we build this progressively as properties are registered.\n When the node or rel is loaded, this is used as a template.", "During object wrapping, a props hash is built with string keys but Neo4j-core provides symbols.\n Rather than a `to_s` or `symbolize_keys` during every load, we build a map of symbol-to-string\n to speed up the process. This increases memory used by the gem but reduces object allocation and GC, so it is faster\n in practice.", "Node callbacks only need to be executed if the node is not persisted. We let the `conditional_callback` method do the work,\n   we only have to give it the type of callback we expect to be run and the condition which, if true, will prevent it from executing.", "Updates this resource with all the attributes from the passed-in Hash and requests that the record be saved.\n If saving fails because the resource is invalid then false will be returned.", "Loads a node from the database or returns the node if already laoded", "Modifies a hash's values to be of types acceptable to Neo4j or matching what the user defined using `type` in property definitions.\n @param [Neo4j::Shared::Property] obj A node or rel that mixes in the Property module\n @param [Symbol] medium Indicates the type of conversion to perform.\n @param [Hash] properties A hash of symbol-keyed properties for conversion.", "Converts a single property from its current format to its db- or Ruby-expected output type.\n @param [Symbol] key A property declared on the model\n @param value The value intended for conversion\n @param [Symbol] direction Either :to_ruby or :to_db, indicates the type of conversion to perform", "If the attribute is to be typecast using a custom converter, which converter should it use? If no, returns the type to find a native serializer.", "Returns true if the property isn't defined in the model or if it is nil", "Determines if the resources content matches the expected content.\n\n @param [Chef::Resource] resource\n\n @return [true, false]", "Shortcut method for loading data into Chef Zero.\n\n @param [String] name\n   the name or id of the item to load\n @param [String, Symbol] key\n   the key to load\n @param [Hash] data\n   the data for the object, which will be converted to JSON and uploaded\n   to the server", "Remove all the data we just loaded from the ChefZero server", "Really reset everything and reload the configuration", "Upload the cookbooks to the Chef Server.", "Instantiate a new SoloRunner to run examples with.\n\n @example Instantiate a new Runner\n   ChefSpec::SoloRunner.new\n\n @example Specifying the platform and version\n   ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '18.04')\n\n @example Specifying the cookbook path\n   ChefSpec::SoloRunner.new(cookbook_path: ['/cookbooks'])\n\n @example Specifying the log level\n   ChefSpec::SoloRunner.new(log_level: :info)\n\n\n @param [Hash] options\n   The options for the new runner\n\n @option options [Symbol] :log_level\n   The log level to use (default is :warn)\n @option options [String] :platform\n   The platform to load Ohai attributes from (must be present in fauxhai)\n @option options [String] :version\n   The version of the platform to load Ohai attributes from (must be present in fauxhai)\n @option options [String] :path\n   Path of a json file that will be passed to fauxhai as :path option\n @option options [Array<String>] :step_into\n   The list of LWRPs to evaluate\n @option options String] :file_cache_path\n   File caching path, if absent ChefSpec will use a temporary directory generated on the fly\n\n @yield [node] Configuration block for Chef::Node\n\n\n Execute the given `run_list` on the node, without actually converging\n the node. Each time {#converge} is called, the `run_list` is reset to the\n new value (it is **not** additive).\n\n @example Converging a single recipe\n   chef_run.converge('example::default')\n\n @example Converging multiple recipes\n   chef_run.converge('example::default', 'example::secondary')\n\n\n @param [Array] recipe_names\n   The names of the recipe or recipes to converge\n\n @return [ChefSpec::SoloRunner]\n   A reference to the calling Runner (for chaining purposes)", "Execute a block of recipe code.\n\n @param [Proc] block\n   A block containing Chef recipe code\n\n @return [ChefSpec::SoloRunner]", "Find the resource with the declared type and resource name, and optionally match a performed action.\n\n If multiples match it returns the last (which more or less matches the chef last-inserter-wins semantics)\n\n @example Find a template at `/etc/foo`\n   chef_run.find_resource(:template, '/etc/foo') #=> #<Chef::Resource::Template>\n\n\n @param [Symbol] type\n   The type of resource (sometimes called `resource_name`) such as `file`\n   or `directory`.\n @param [String, Regexp] name\n   The value of the name attribute or identity attribute for the resource.\n @param [Symbol] action\n   (optional) match only resources that performed the action.\n\n @return [Chef::Resource, nil]\n   The matching resource, or nil if one is not found", "Find the resource with the declared type.\n\n @example Find all template resources\n   chef_run.find_resources(:template) #=> [#<Chef::Resource::Template>, #...]\n\n\n @param [Symbol] type\n   The type of resource such as `:file` or `:directory`.\n\n @return [Array<Chef::Resource>]\n   The matching resources", "Determines if the runner should step into the given resource. The\n +step_into+ option takes a string, but this method coerces everything\n to symbols for safety.\n\n This method also substitutes any dashes (+-+) with underscores (+_+),\n because that's what Chef does under the hood. (See GitHub issue #254\n for more background)\n\n @param [Chef::Resource] resource\n   the Chef resource to try and step in to\n\n @return [true, false]", "Respond to custom matchers defined by the user.", "Set the default options, with the given options taking precedence.\n\n @param [Hash] options\n   the list of options to take precedence\n\n @return [Hash] options", "The inferred cookbook root from the calling spec.\n\n @param [Hash<Symbol, Object>] options\n   initial runner options\n @param [Array<String>] kaller\n   the calling trace\n\n @return [String]", "The inferred path from the calling spec.\n\n @param [Hash<Symbol, Object>] options\n   initial runner options\n @param [Array<String>] kaller\n   the calling trace\n\n @return [String]", "The inferred path to roles.\n\n @return [String, nil]", "Create a new coverage object singleton.\n\n\n Start the coverage reporting analysis. This method also adds the the\n +at_exit+ handler for printing the coverage report.", "Add a filter to the coverage analysis.\n\n @param [Filter, String, Regexp] filter\n   the filter to add\n @param [Proc] block\n   the block to use as a filter\n\n @return [true]", "Change the template for reporting of converage analysis.\n\n @param [string] path\n   The template file to use for the output of the report\n\n @return [true]", "Remove the temporary directory and restore the librarian-chef cookbook path.", "Setup and install the necessary  dependencies in the temporary directory", "Calculate the name of a resource, replacing dashes with underscores\n and converting symbols to strings and back again.\n\n @param [String, Chef::Resource] thing\n\n @return [Symbol]", "Failed to load node data from the server", "Error expanding the run list", "Called when there is an error getting the cookbook collection from the\n server.", "Called when an error occurs during cookbook sync", "Called when a recipe cannot be resolved", "Called when a resource fails and will not be retried.", "Create a new Renderer for the given Chef run and resource.\n\n @param [Chef::Runner] chef_run\n   the Chef run containing the resources\n @param [Chef::Resource] resource\n   the resource to render content from\n\n\n The content of the resource (this method delegates to the)\n various private rendering methods.\n\n @return [String, nil]\n   the contents of the file as a string, or nil if the resource\n   does not contain or respond to a content renderer.", "Compute the contents of a template using Chef's templating logic.\n\n @param [Chef::RunContext] chef_run\n   the run context for the node\n @param [Chef::Provider::Template] template\n   the template resource\n\n @return [String]", "Get the contents of a cookbook file using Chef.\n\n @param [Chef::RunContext] chef_run\n   the run context for the node\n @param [Chef::Provider::CookbookFile] cookbook_file\n   the file resource", "The cookbook collection for the current Chef run context. Handles\n the differing cases between Chef 10 and Chef 11.\n\n @param [Chef::Node] node\n   the Chef node to get the cookbook collection from\n\n @return [Array<Chef::Cookbook>]", "Return a new instance of the TemplateFinder if we are running on Chef 11.\n\n @param [Chef::RunContext] chef_run\n   the run context for the noe\n @param [String] cookbook_name\n   the name of the cookbook\n\n @return [Chef::Provider::TemplateFinder, nil]", "Sends notification email to the target.\n\n @param [Hash] options Options for notification email\n @option options [Boolean]        :send_later            If it sends notification email asynchronously\n @option options [String, Symbol] :fallback   (:default) Fallback template to use when MissingTemplate is raised\n @return [Mail::Message, ActionMailer::DeliveryJob] Email message or its delivery job", "Publishes notification to the optional targets.\n\n @param [Hash] options Options for optional targets\n @return [Hash] Result of publishing to optional target", "Opens the notification.\n\n @param [Hash] options Options for opening notifications\n @option options [DateTime] :opened_at   (Time.current) Time to set to opened_at of the notification record\n @option options [Boolean] :with_members (true)         If it opens notifications including group members\n @return [Integer] Number of opened notification records", "Returns count of group member notifiers including group owner notifier.\n It always returns 0 if group owner notifier is blank.\n This method is designed to cache group by query result to avoid N+1 call.\n\n @param [Integer] limit Limit to query for opened notifications\n @return [Integer] Count of group notifications including owner and members", "Remove from notification group and make a new group owner.\n\n @return [Notificaion] New group owner instance of the notification group", "Returns notifiable_path to move after opening notification with notifiable.notifiable_path.\n\n @return [String] Notifiable path URL to move after opening notification", "Returns notifications_path for the target\n\n @param [Object] target Target instance\n @param [Hash] params Request parameters\n @return [String] notifications_path for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns notification_path for the notification\n\n @param [Notification] notification Notification instance\n @param [Hash] params Request parameters\n @return [String] notification_path for the notification\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns move_notification_path for the target of specified notification\n\n @param [Notification] notification Notification instance\n @param [Hash] params Request parameters\n @return [String] move_notification_path for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns open_notification_path for the target of specified notification\n\n @param [Notification] notification Notification instance\n @param [Hash] params Request parameters\n @return [String] open_notification_path for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns open_all_notifications_path for the target\n\n @param [Object] target Target instance\n @param [Hash] params Request parameters\n @return [String] open_all_notifications_path for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns notifications_url for the target\n\n @param [Object] target Target instance\n @param [Hash] params Request parameters\n @return [String] notifications_url for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns notification_url for the target of specified notification\n\n @param [Notification] notification Notification instance\n @param [Hash] params Request parameters\n @return [String] notification_url for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns move_notification_url for the target of specified notification\n\n @param [Notification] notification Notification instance\n @param [Hash] params Request parameters\n @return [String] move_notification_url for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns open_notification_url for the target of specified notification\n\n @param [Notification] notification Notification instance\n @param [Hash] params Request parameters\n @return [String] open_notification_url for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns open_all_notifications_url for the target of specified notification\n\n @param [Target] target Target instance\n @param [Hash] params Request parameters\n @return [String] open_all_notifications_url for the target\n @todo Needs any other better implementation\n @todo Must handle devise namespace", "Returns subscriptions_path for the target\n\n @param [Object] target Target instance\n @param [Hash] params Request parameters\n @return [String] subscriptions_path for the target\n @todo Needs any other better implementation", "Returns subscription_path for the subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_path for the subscription\n @todo Needs any other better implementation", "Returns subscribe_subscription_path for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_path for the subscription\n @todo Needs any other better implementation", "Returns unsubscribe_subscription_path for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_path for the subscription\n @todo Needs any other better implementation", "Returns subscribe_to_email_subscription_path for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_path for the subscription\n @todo Needs any other better implementation", "Returns unsubscribe_to_email_subscription_path for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_path for the subscription\n @todo Needs any other better implementation", "Returns subscribe_to_optional_target_subscription_path for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_path for the subscription\n @todo Needs any other better implementation", "Returns unsubscribe_to_optional_target_subscription_path for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_path for the subscription\n @todo Needs any other better implementation", "Returns subscriptions_url for the target\n\n @param [Object] target Target instance\n @param [Hash] params Request parameters\n @return [String] subscriptions_url for the target\n @todo Needs any other better implementation", "Returns subscription_url for the subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_url for the subscription\n @todo Needs any other better implementation", "Returns subscribe_subscription_url for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_url for the subscription\n @todo Needs any other better implementation", "Returns unsubscribe_subscription_url for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_url for the subscription\n @todo Needs any other better implementation", "Returns subscribe_to_email_subscription_url for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_url for the subscription\n @todo Needs any other better implementation", "Returns unsubscribe_to_email_subscription_url for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_url for the subscription\n @todo Needs any other better implementation", "Returns subscribe_to_optional_target_subscription_url for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_url for the subscription\n @todo Needs any other better implementation", "Returns unsubscribe_to_optional_target_subscription_url for the target of specified subscription\n\n @param [Subscription] subscription Subscription instance\n @param [Hash] params Request parameters\n @return [String] subscription_url for the subscription\n @todo Needs any other better implementation", "Returns path of the target view templates.\n Do not make this method public unless Rendarable module calls controller's target_view_path method to render resources.\n @api protected", "Returns JavaScript view for ajax request or redirects to back as default.\n @api protected\n @return [Responce] JavaScript view for ajax request or redirects to back as default", "Redirect to back.\n @api protected\n @return [Boolean] True", "Includes notify_to method for routes, which is responsible to generate all necessary routes for notifications of activity_notification.\n\n When you have an User model configured as a target (e.g. defined acts_as_target),\n you can create as follows in your routes:\n   notify_to :users\n This method creates the needed routes:\n   # Notification routes\n     user_notifications          GET    /users/:user_id/notifications(.:format)\n       { controller:\"activity_notification/notifications\", action:\"index\", target_type:\"users\" }\n     user_notification           GET    /users/:user_id/notifications/:id(.:format)\n       { controller:\"activity_notification/notifications\", action:\"show\", target_type:\"users\" }\n     user_notification           DELETE /users/:user_id/notifications/:id(.:format)\n       { controller:\"activity_notification/notifications\", action:\"destroy\", target_type:\"users\" }\n     open_all_user_notifications POST   /users/:user_id/notifications/open_all(.:format)\n       { controller:\"activity_notification/notifications\", action:\"open_all\", target_type:\"users\" }\n     move_user_notification      GET    /users/:user_id/notifications/:id/move(.:format)\n       { controller:\"activity_notification/notifications\", action:\"move\", target_type:\"users\" }\n     open_user_notification      POST   /users/:user_id/notifications/:id/open(.:format)\n       { controller:\"activity_notification/notifications\", action:\"open\", target_type:\"users\" }\n\n You can also configure notification routes with scope like this:\n   scope :myscope, as: :myscope do\n     notify_to :users, routing_scope: :myscope\n   end\n This routing_scope option creates the needed routes with specified scope like this:\n   # Notification routes\n     myscope_user_notifications          GET    /myscope/users/:user_id/notifications(.:format)\n       { controller:\"activity_notification/notifications\", action:\"index\", target_type:\"users\", routing_scope: :myscope }\n     myscope_user_notification           GET    /myscope/users/:user_id/notifications/:id(.:format)\n       { controller:\"activity_notification/notifications\", action:\"show\", target_type:\"users\", routing_scope: :myscope }\n     myscope_user_notification           DELETE /myscope/users/:user_id/notifications/:id(.:format)\n       { controller:\"activity_notification/notifications\", action:\"destroy\", target_type:\"users\", routing_scope: :myscope }\n     open_all_myscope_user_notifications POST   /myscope/users/:user_id/notifications/open_all(.:format)\n       { controller:\"activity_notification/notifications\", action:\"open_all\", target_type:\"users\", routing_scope: :myscope }\n     move_myscope_user_notification      GET    /myscope/users/:user_id/notifications/:id/move(.:format)\n       { controller:\"activity_notification/notifications\", action:\"move\", target_type:\"users\", routing_scope: :myscope }\n     open_myscope_user_notification      POST   /myscope/users/:user_id/notifications/:id/open(.:format)\n       { controller:\"activity_notification/notifications\", action:\"open\", target_type:\"users\", routing_scope: :myscope }\n\n When you use devise authentication and you want make notification targets assciated with devise,\n you can create as follows in your routes:\n   notify_to :users, with_devise: :users\n This with_devise option creates the needed routes assciated with devise authentication:\n   # Notification with devise routes\n     user_notifications          GET    /users/:user_id/notifications(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"index\", target_type:\"users\", devise_type:\"users\" }\n     user_notification           GET    /users/:user_id/notifications/:id(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"show\", target_type:\"users\", devise_type:\"users\" }\n     user_notification           DELETE /users/:user_id/notifications/:id(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"destroy\", target_type:\"users\", devise_type:\"users\" }\n     open_all_user_notifications POST   /users/:user_id/notifications/open_all(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"open_all\", target_type:\"users\", devise_type:\"users\" }\n     move_user_notification      GET    /users/:user_id/notifications/:id/move(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"move\", target_type:\"users\", devise_type:\"users\" }\n     open_user_notification      POST   /users/:user_id/notifications/:id/open(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"open\", target_type:\"users\", devise_type:\"users\" }\n\n When you use with_devise option and you want to make simple default routes as follows, you can use devise_default_routes option:\n   notify_to :users, with_devise: :users, devise_default_routes: true\n These with_devise and devise_default_routes options create the needed routes assciated with authenticated devise resource as the default target\n   # Notification with default devise routes\n     user_notifications          GET    /notifications(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"index\", target_type:\"users\", devise_type:\"users\" }\n     user_notification           GET    /notifications/:id(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"show\", target_type:\"users\", devise_type:\"users\" }\n     user_notification           DELETE /notifications/:id(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"destroy\", target_type:\"users\", devise_type:\"users\" }\n     open_all_user_notifications POST   /notifications/open_all(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"open_all\", target_type:\"users\", devise_type:\"users\" }\n     move_user_notification      GET    /notifications/:id/move(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"move\", target_type:\"users\", devise_type:\"users\" }\n     open_user_notification      POST   /notifications/:id/open(.:format)\n       { controller:\"activity_notification/notifications_with_devise\", action:\"open\", target_type:\"users\", devise_type:\"users\" }\n\n When you would like to define subscription management paths with notification paths,\n you can create as follows in your routes:\n   notify_to :users, with_subscription: true\n or you can also set options for subscription path:\n   notify_to :users, with_subscription: { except: [:index] }\n If you configure this :with_subscription option with :with_devise option, with_subscription paths are also automatically configured with devise authentication as the same as notifications\n   notify_to :users, with_devise: :users, with_subscription: true\n\n @example Define notify_to in config/routes.rb\n   notify_to :users\n @example Define notify_to with options\n   notify_to :users, only: [:open, :open_all, :move]\n @example Integrated with Devise authentication\n   notify_to :users, with_devise: :users\n @example Define notification paths including subscription paths\n   notify_to :users, with_subscription: true\n @example Integrated with Devise authentication as simple default routes including subscription management\n   notify_to :users, with_devise: :users, devise_default_routes: true, with_subscription: true\n @example Integrated with Devise authentication as simple default routes with scope including subscription management\n   scope :myscope, as: :myscope do\n     notify_to :myscope, with_devise: :users, devise_default_routes: true, with_subscription: true, routing_scope: :myscope\n   end\n\n @overload notify_to(*resources, *options)\n   @param          [Symbol]       resources Resources to notify\n   @option options [String]       :routing_scope         (nil)            Routing scope for notification routes\n   @option options [Symbol]       :with_devise           (false)          Devise resources name for devise integration. Devise integration will be enabled by this option.\n   @option options [Boolean]      :devise_default_routes (false)          Whether you will create routes as device default routes assciated with authenticated devise resource as the default target\n   @option options [Hash|Boolean] :with_subscription     (false)          Subscription path options to define subscription management paths with notification paths. Calls subscribed_by routing when truthy value is passed as this option.\n   @option options [String]       :model                 (:notifications) Model name of notifications\n   @option options [String]       :controller            (\"activity_notification/notifications\" | activity_notification/notifications_with_devise\") :controller option as resources routing\n   @option options [Symbol]       :as                    (nil)            :as option as resources routing\n   @option options [Array]        :only                  (nil)            :only option as resources routing\n   @option options [Array]        :except                (nil)            :except option as resources routing\n @return [ActionDispatch::Routing::Mapper] Routing mapper instance", "Includes subscribed_by method for routes, which is responsible to generate all necessary routes for subscriptions of activity_notification.\n\n When you have an User model configured as a target (e.g. defined acts_as_target),\n you can create as follows in your routes:\n   subscribed_by :users\n This method creates the needed routes:\n   # Subscription routes\n     user_subscriptions                                GET    /users/:user_id/subscriptions(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"index\", target_type:\"users\" }\n     user_subscription                                 GET    /users/:user_id/subscriptions/:id(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"show\", target_type:\"users\" }\n     open_all_user_subscriptions                       POST   /users/:user_id/subscriptions(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"create\", target_type:\"users\" }\n     user_subscription                                 DELETE /users/:user_id/subscriptions/:id(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"destroy\", target_type:\"users\" }\n     subscribe_user_subscription                       POST   /users/:user_id/subscriptions/:id/subscribe(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"subscribe\", target_type:\"users\" }\n     unsubscribe_user_subscription                     POST   /users/:user_id/subscriptions/:id/unsubscribe(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"unsubscribe\", target_type:\"users\" }\n     subscribe_to_email_user_subscription              POST   /users/:user_id/subscriptions/:id/subscribe_to_email(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"subscribe_to_email\", target_type:\"users\" }\n     unsubscribe_to_email_user_subscription            POST   /users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"unsubscribe_to_email\", target_type:\"users\" }\n     subscribe_to_optional_target_user_subscription    POST   /users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"subscribe_to_optional_target\", target_type:\"users\" }\n     unsubscribe_to_optional_target_user_subscription  POST   /users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"unsubscribe_to_optional_target\", target_type:\"users\" }\n\n You can also configure notification routes with scope like this:\n   scope :myscope, as: :myscope do\n     subscribed_by :users, routing_scope: :myscope\n   end\n This routing_scope option creates the needed routes with specified scope like this:\n   # Subscription routes\n     myscope_user_subscriptions                                GET    /myscope/users/:user_id/subscriptions(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"index\", target_type:\"users\", routing_scope: :myscope }\n     myscope_user_subscription                                 GET    /myscope/users/:user_id/subscriptions/:id(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"show\", target_type:\"users\", routing_scope: :myscope }\n     open_all_myscope_user_subscriptions                       POST   /myscope/users/:user_id/subscriptions(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"create\", target_type:\"users\", routing_scope: :myscope }\n     myscope_user_subscription                                 DELETE /myscope/users/:user_id/subscriptions/:id(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"destroy\", target_type:\"users\", routing_scope: :myscope }\n     subscribe_myscope_user_subscription                       POST   /myscope/users/:user_id/subscriptions/:id/subscribe(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"subscribe\", target_type:\"users\", routing_scope: :myscope }\n     unsubscribe_myscope_user_subscription                     POST   /myscope/users/:user_id/subscriptions/:id/unsubscribe(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"unsubscribe\", target_type:\"users\", routing_scope: :myscope }\n     subscribe_to_email_myscope_user_subscription              POST   /myscope/users/:user_id/subscriptions/:id/subscribe_to_email(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"subscribe_to_email\", target_type:\"users\", routing_scope: :myscope }\n     unsubscribe_to_email_myscope_user_subscription            POST   /myscope/users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"unsubscribe_to_email\", target_type:\"users\", routing_scope: :myscope }\n     subscribe_to_optional_target_myscope_user_subscription    POST   /myscope/users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"subscribe_to_optional_target\", target_type:\"users\", routing_scope: :myscope }\n     unsubscribe_to_optional_target_myscope_user_subscription  POST   /myscope/users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)\n       { controller:\"activity_notification/subscriptions\", action:\"unsubscribe_to_optional_target\", target_type:\"users\", routing_scope: :myscope }\n\n When you use devise authentication and you want make subscription targets assciated with devise,\n you can create as follows in your routes:\n   subscribed_by :users, with_devise: :users\n This with_devise option creates the needed routes assciated with devise authentication:\n   # Subscription with devise routes\n     user_subscriptions                                GET    /users/:user_id/subscriptions(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"index\", target_type:\"users\", devise_type:\"users\" }\n     user_subscription                                 GET    /users/:user_id/subscriptions/:id(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"show\", target_type:\"users\", devise_type:\"users\" }\n     open_all_user_subscriptions                       POST   /users/:user_id/subscriptions(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"create\", target_type:\"users\", devise_type:\"users\" }\n     user_subscription                                 DELETE /users/:user_id/subscriptions/:id(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"destroy\", target_type:\"users\", devise_type:\"users\" }\n     subscribe_user_subscription                       POST   /users/:user_id/subscriptions/:id/subscribe(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"subscribe\", target_type:\"users\", devise_type:\"users\" }\n     unsubscribe_user_subscription                     POST   /users/:user_id/subscriptions/:id/unsubscribe(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"unsubscribe\", target_type:\"users\", devise_type:\"users\" }\n     subscribe_to_email_user_subscription              POST   /users/:user_id/subscriptions/:id/subscribe_to_email(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"subscribe_to_email\", target_type:\"users\", devise_type:\"users\" }\n     unsubscribe_to_email_user_subscription            POST   /users/:user_id/subscriptions/:id/unsubscribe_to_email(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"unsubscribe_to_email\", target_type:\"users\", devise_type:\"users\" }\n     subscribe_to_optional_target_user_subscription    POST   /users/:user_id/subscriptions/:id/subscribe_to_optional_target(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"subscribe_to_optional_target\", target_type:\"users\", devise_type:\"users\" }\n     unsubscribe_to_optional_target_user_subscription  POST   /users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"unsubscribe_to_optional_target\", target_type:\"users\", devise_type:\"users\" }\n\n When you use with_devise option and you want to make simple default routes as follows, you can use devise_default_routes option:\n   subscribed_by :users, with_devise: :users, devise_default_routes: true\n These with_devise and devise_default_routes options create the needed routes assciated with authenticated devise resource as the default target\n   # Subscription with devise routes\n     user_subscriptions                                GET    /subscriptions(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"index\", target_type:\"users\", devise_type:\"users\" }\n     user_subscription                                 GET    /subscriptions/:id(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"show\", target_type:\"users\", devise_type:\"users\" }\n     open_all_user_subscriptions                       POST   /subscriptions(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"create\", target_type:\"users\", devise_type:\"users\" }\n     user_subscription                                 DELETE /subscriptions/:id(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"destroy\", target_type:\"users\", devise_type:\"users\" }\n     subscribe_user_subscription                       POST   /subscriptions/:id/subscribe(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"subscribe\", target_type:\"users\", devise_type:\"users\" }\n     unsubscribe_user_subscription                     POST   /subscriptions/:id/unsubscribe(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"unsubscribe\", target_type:\"users\", devise_type:\"users\" }\n     subscribe_to_email_user_subscription              POST   /subscriptions/:id/subscribe_to_email(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"subscribe_to_email\", target_type:\"users\", devise_type:\"users\" }\n     unsubscribe_to_email_user_subscription            POST   /subscriptions/:id/unsubscribe_to_email(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"unsubscribe_to_email\", target_type:\"users\", devise_type:\"users\" }\n     subscribe_to_optional_target_user_subscription    POST   /subscriptions/:id/subscribe_to_optional_target(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"subscribe_to_optional_target\", target_type:\"users\", devise_type:\"users\" }\n     unsubscribe_to_optional_target_user_subscription  POST   /subscriptions/:id/unsubscribe_to_optional_target(.:format)\n       { controller:\"activity_notification/subscriptions_with_devise\", action:\"unsubscribe_to_optional_target\", target_type:\"users\", devise_type:\"users\" }\n\n @example Define subscribed_by in config/routes.rb\n   subscribed_by :users\n @example Define subscribed_by with options\n   subscribed_by :users, except: [:index, :show]\n @example Integrated with Devise authentication\n   subscribed_by :users, with_devise: :users\n\n @overload subscribed_by(*resources, *options)\n   @param          [Symbol]       resources Resources to notify\n   @option options [String]       :routing_scope         (nil)            Routing scope for subscription routes\n   @option options [Symbol]       :with_devise           (false)          Devise resources name for devise integration. Devise integration will be enabled by this option.\n   @option options [Boolean]      :devise_default_routes (false)          Whether you will create routes as device default routes assciated with authenticated devise resource as the default target\n   @option options [String]       :model                 (:subscriptions) Model name of subscriptions\n   @option options [String]       :controller            (\"activity_notification/subscriptions\" | activity_notification/subscriptions_with_devise\") :controller option as resources routing\n   @option options [Symbol]       :as                    (nil)            :as option as resources routing\n   @option options [Array]        :only                  (nil)            :only option as resources routing\n   @option options [Array]        :except                (nil)            :except option as resources routing\n @return [ActionDispatch::Routing::Mapper] Routing mapper instance", "Virtual attribute returning text description of the notification\n using the notification's key to translate using i18n.\n\n @param [Hash] params Parameters for rendering notification text\n @option params [String] :target Target type name to use as i18n text key\n @option params [Hash] others Parameters to be referred in i18n text\n @return [String] Rendered text", "Renders notification from views.\n\n The preferred way of rendering notifications is\n to provide a template specifying how the rendering should be happening.\n However, you can choose using _i18n_ based approach when developing\n an application that supports plenty of languages.\n\n If partial view exists that matches the \"target\" type and \"key\" attribute\n renders that partial with local variables set to contain both\n Notification and notification_parameters (hash with indifferent access).\n\n If the partial view does not exist and you wish to fallback to rendering\n through the i18n translation, you can do so by passing in a :fallback\n parameter whose value equals :text.\n\n If you do not want to define a partial view, and instead want to have\n all missing views fallback to a default, you can define the :fallback\n value equal to the partial you wish to use when the partial defined\n by the notification key does not exist.\n\n Render a list of all notifications of @target from a view (erb):\n   <ul>\n     <% @target.notifications.each do |notification|  %>\n       <li><%= render_notification notification %></li>\n     <% end %>\n   </ul>\n\n Fallback to the i18n text translation if the view is missing:\n   <ul>\n     <% @target.notifications.each do |notification|  %>\n       <li><%= render_notification notification, fallback: :text %></li>\n     <% end %>\n   </ul>\n\n Fallback to a default view if the view for the current notification key is missing:\n   <ul>\n     <% @target.notifications.each do |notification|  %>\n       <li><%= render_notification notification, fallback: 'default' %></li>\n     <% end %>\n   </ul>\n\n = Layouts\n\n You can supply a layout that will be used for notification partials\n with :layout param.\n Keep in mind that layouts for partials are also partials.\n\n Supply a layout:\n   # in views:\n   # All examples look for a layout in app/views/layouts/_notification.erb\n   render_notification @notification, layout: \"notification\"\n   render_notification @notification, layout: \"layouts/notification\"\n   render_notification @notification, layout: :notification\n\n   # app/views/layouts/_notification.erb\n   <p><%= notification.created_at %></p>\n   <%= yield %>\n\n == Custom Layout Location\n\n You can customize the layout directory by supplying :layout_root\n or by using an absolute path.\n\n Declare custom layout location:\n   # Both examples look for a layout in \"app/views/custom/_layout.erb\"\n   render_notification @notification, layout_root: \"custom\"\n   render_notification @notification, layout: \"/custom/layout\"\n\n = Creating a template\n\n To use templates for formatting how the notification should render,\n create a template based on target type and notification key, for example:\n\n Given a target type users and key _notification.article.create_, create directory tree\n _app/views/activity_notification/notifications/users/article/_ and create the _create_ partial there\n\n Note that if a key consists of more than three parts splitted by commas, your\n directory structure will have to be deeper, for example:\n   notification.article.comment.reply => app/views/activity_notification/notifications/users/article/comment/_reply.html.erb\n\n == Custom Directory\n\n You can override the default `activity_notification/notifications/#{target}` template root with the :partial_root parameter.\n\n Custom template root:\n    # look for templates inside of /app/views/custom instead of /app/views/public_directory/activity_notification/notifications/#{target}\n    render_notification @notification, partial_root: \"custom\"\n\n == Variables in templates\n\n From within a template there are three variables at your disposal:\n * notification\n * controller\n * parameters [converted into a HashWithIndifferentAccess]\n\n Template for key: _notification.article.create_ (erb):\n   <p>\n     Article <strong><%= parameters[:title] %></strong>\n     was posted by <em><%= parameters[\"author\"] %></em>\n     <%= distance_of_time_in_words_to_now(notification.created_at) %>\n   </p>\n\n @param [ActionView::Base] context\n @param [Hash] params Parameters for rendering notifications\n @option params [String, Symbol] :target       (nil)                     Target type name to find template or i18n text\n @option params [String]         :partial_root (\"activity_notification/notifications/#{target}\", controller.target_view_path, 'activity_notification/notifications/default') Partial template name\n @option params [String]         :partial      (self.key.tr('.', '/'))   Root path of partial template\n @option params [String]         :layout       (nil)                     Layout template name\n @option params [String]         :layout_root  ('layouts')               Root path of layout template\n @option params [String, Symbol] :fallback     (nil)                     Fallback template to use when MissingTemplate is raised. Set :text to use i18n text as fallback.\n @option params [Hash]           others                                  Parameters to be set as locals\n @return [String] Rendered view or text as string", "Returns partial path from options\n\n @param [String] path Partial template name\n @param [String] root Root path of partial template\n @param [String, Symbol] target Target type name to find template\n @return [String] Partial template path", "Used to transform value from metadata to data which belongs model instance.\n Accepts Symbols, which it will send against this instance,\n Accepts Procs, which it will execute with this instance.\n Both Symbols and Procs will be passed arguments of this method.\n Also accepts Hash of these Symbols or Procs.\n If any other value will be passed, returns original value.\n\n @param [Symbol, Proc, Hash, Object] thing Symbol or Proc to resolve parameter\n @param [Array] args Arguments to pass to thing as method\n @return [Object] Resolved parameter value", "Shows notification index of the target.\n\n GET /:target_type/:target_id/notifications\n @overload index(params)\n   @param [Hash] params Request parameter options for notification index\n   @option params [String] :filter                 (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')\n   @option params [String] :limit                  (nil)     Limit to query for notifications\n   @option params [String] :reverse                ('false') If notification index will be ordered as earliest first\n   @option params [String] :without_grouping       ('false') If notification index will include group members\n   @option params [String] :with_group_members     ('false') If notification index will include group members\n   @option params [String] :filtered_by_type       (nil)     Notifiable type for filter\n   @option params [String] :filtered_by_group_type (nil)     Group type for filter, valid with :filtered_by_group_id\n   @option params [String] :filtered_by_group_id   (nil)     Group instance id for filter, valid with :filtered_by_group_type\n   @option params [String] :filtered_by_key        (nil)     Key of the notification for filter\n   @option params [String] :reload                 ('true')  Whether notification index will be reloaded\n   @return [Responce] HTML view as default or JSON of notification index with json format parameter", "Opens a notification.\n\n POST /:target_type/:target_id/notifications/:id/open\n @overload open(params)\n   @param [Hash] params Request parameters\n   @option params [String] :move               ('false') Whether redirects to notifiable_path after the notification is opened\n   @option params [String] :filter             (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')\n   @option params [String] :limit              (nil)     Limit to query for notifications\n   @option params [String] :reload             ('true')  Whether notification index will be reloaded\n   @option params [String] :without_grouping   ('false') If notification index will include group members\n   @option params [String] :with_group_members ('false') If notification index will include group members\n   @return [Responce] JavaScript view for ajax request or redirects to back as default", "Sets options to load notification index from request parameters.\n @api protected\n @return [Hash] options to load notification index", "Returns if current resource signed in with Devise is authenticated for the notification.\n This method is able to be overriden.\n\n @param [Object] current_resource Current resource signed in with Devise\n @return [Boolean] If current resource signed in with Devise is authenticated for the notification", "Sends batch notification email to the target.\n\n @param [Array<Notification>] notifications Target notifications to send batch notification email\n @param [Hash]                options       Options for notification email\n @option options [Boolean]        :send_later  (false)          If it sends notification email asynchronously\n @option options [String, Symbol] :fallback    (:batch_default) Fallback template to use when MissingTemplate is raised\n @option options [String]         :batch_key   (nil)            Key of the batch notification email, a key of the first notification will be used if not specified\n @return [Mail::Message|ActionMailer::DeliveryJob|NilClass] Email message or its delivery job, return NilClass for wrong target", "Returns if the target subscribes to the notification.\n It also returns true when the subscription management is not allowed for the target.\n\n @param [String]  key                  Key of the notification\n @param [Boolean] subscribe_as_default Default subscription value to use when the subscription record does not configured\n @return [Boolean] If the target subscribes the notification or the subscription management is not allowed for the target", "Returns if the target subscribes to the notification email.\n It also returns true when the subscription management is not allowed for the target.\n\n @param [String]  key                  Key of the notification\n @param [Boolean] subscribe_as_default Default subscription value to use when the subscription record does not configured\n @return [Boolean] If the target subscribes the notification email or the subscription management is not allowed for the target", "Returns if the target subscribes to the specified optional target.\n It also returns true when the subscription management is not allowed for the target.\n\n @param [String]         key                  Key of the notification\n @param [String, Symbol] optional_target_name Class name of the optional target implementation (e.g. :amazon_sns, :slack)\n @param [Boolean]        subscribe_as_default Default subscription value to use when the subscription record does not configured\n @return [Boolean] If the target subscribes the notification email or the subscription management is not allowed for the target", "Gets opened notification index of the target as ActiveRecord.\n\n @param [Hash] options Options for notification index\n @option options [Integer]    :limit                  (nil)   Limit to query for notifications\n @option options [Boolean]    :reverse                (false) If notification index will be ordered as earliest first\n @option options [Boolean]    :with_group_members     (false) If notification index will include group members\n @option options [String]     :filtered_by_type       (nil)   Notifiable type for filter\n @option options [Object]     :filtered_by_group      (nil)   Group instance for filter\n @option options [String]     :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id\n @option options [String]     :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type\n @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter\n @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. [\"created_at >= ?\", time.hour.ago])\n @return [Array<Notificaion>] Opened notification index of the target", "Subscribes to the notification and notification email.\n\n @param [Hash] options Options for subscribing to the notification\n @option options [DateTime] :subscribed_at           (Time.current) Time to set to subscribed_at and subscribed_to_email_at of the subscription record\n @option options [Boolean]  :with_email_subscription (true)         If the subscriber also subscribes notification email\n @option options [Boolean]  :with_optional_targets   (true)         If the subscriber also subscribes optional_targets\n @return [Boolean] If successfully updated subscription instance", "Unsubscribes to the notification and notification email.\n\n @param [Hash] options Options for unsubscribing to the notification\n @option options [DateTime] :unsubscribed_at (Time.current) Time to set to unsubscribed_at and unsubscribed_to_email_at of the subscription record\n @return [Boolean] If successfully updated subscription instance", "Subscribes to the notification email.\n\n @param [Hash] options Options for subscribing to the notification email\n @option options [DateTime] :subscribed_to_email_at (Time.current) Time to set to subscribed_to_email_at of the subscription record\n @return [Boolean] If successfully updated subscription instance", "Unsubscribes to the notification email.\n\n @param [Hash] options Options for unsubscribing the notification email\n @option options [DateTime] :subscribed_to_email_at (Time.current) Time to set to subscribed_to_email_at of the subscription record\n @return [Boolean] If successfully updated subscription instance", "Returns if the target subscribes to the specified optional target.\n\n @param [Symbol]  optional_target_name Symbol class name of the optional target implementation (e.g. :amazon_sns, :slack)\n @param [Boolean] subscribe_as_default Default subscription value to use when the subscription record does not configured\n @return [Boolean] If the target subscribes to the specified optional target", "Subscribes to the specified optional target.\n\n @param [String, Symbol]  optional_target_name Symbol class name of the optional target implementation (e.g. :amazon_sns, :slack)\n @param [Hash]            options              Options for unsubscribing to the specified optional target\n @option options [DateTime] :subscribed_at (Time.current) Time to set to subscribed_[optional_target_name]_at in optional_targets hash of the subscription record\n @return [Boolean] If successfully updated subscription instance", "Unsubscribes to the specified optional target.\n\n @param [String, Symbol] optional_target_name Class name of the optional target implementation (e.g. :amazon_sns, :slack)\n @param [Hash]           options              Options for unsubscribing to the specified optional target\n @option options [DateTime] :unsubscribed_at (Time.current) Time to set to unsubscribed_[optional_target_name]_at in optional_targets hash of the subscription record\n @return [Boolean] If successfully updated subscription instance", "Returns optional_target names of the subscription from optional_targets field.\n @return [Array<Symbol>] Array of optional target names", "Returns notification targets from configured field or overriden method.\n This method is able to be overriden.\n\n @param [String] target_type Target type to notify\n @param [Hash] options Options for notifications\n @option options [String]                  :key                      (notifiable.default_notification_key) Key of the notification\n @option options [Hash]                    :parameters               ({})                                  Additional parameters of the notifications\n @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of the notification targets", "Returns if sending notification email is allowed for the notifiable from configured field or overriden method.\n This method is able to be overriden.\n\n @param [Object] target Target instance to notify\n @param [String] key Key of the notification\n @return [Boolean] If sending notification email is allowed for the notifiable", "Returns notifiable_path to move after opening notification from configured field or overriden method.\n This method is able to be overriden.\n\n @param [String] target_type Target type to notify\n @param [String] key Key of the notification\n @return [String] Notifiable path URL to move after opening notification", "Returns printable notifiable model name to show in view or email.\n @return [String] Printable notifiable model name", "Returns optional_target names of the notification from configured field or overriden method.\n This method is able to be overriden.\n\n @param [String] target_type Target type to notify\n @param [String] key Key of the notification\n @return [Array<Symbol>] Array of optional target names", "Gets generated notifications for specified target type.\n @api private\n @param [String] target_type Target type of generated notifications", "Destroies generated notifications for specified target type with dependency.\n This method is intended to be called before destroy this notifiable as dependent configuration.\n @api private\n @param [Symbol]  dependent         Has_many dependency, [:delete_all, :destroy, :restrict_with_error, :restrict_with_exception] are available\n @param [String]  target_type       Target type of generated notifications\n @param [Boolean] remove_from_group Whether it removes generated notifications from notification group before destroy", "Shows subscription index of the target.\n\n GET /:target_type/:target_id/subscriptions\n @overload index(params)\n   @param [Hash] params Request parameter options for subscription index\n   @option params [String] :filter          (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')\n   @option params [String] :limit           (nil)     Limit to query for subscriptions\n   @option params [String] :reverse         ('false') If subscription index and unconfigured notification keys will be ordered as earliest first\n   @option params [String] :filtered_by_key (nil)     Key of the subscription for filter\n   @return [Responce] HTML view as default or JSON of subscription index with json format parameter", "Subscribes to the notification.\n\n POST /:target_type/:target_id/subscriptions/:id/subscribe\n @overload open(params)\n   @param [Hash] params Request parameters\n   @option params [String] :with_email_subscription ('true')  If the subscriber also subscribes notification email\n   @option params [String] :with_optional_targets   ('true')  If the subscriber also subscribes optional targets\n   @option params [String] :filter                  (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')\n   @option params [String] :limit                   (nil)     Limit to query for subscriptions\n   @option params [String] :reverse                 ('false') If subscription index and unconfigured notification keys will be ordered as earliest first\n   @option params [String] :filtered_by_key         (nil)     Key of the subscription for filter\n   @return [Responce] JavaScript view for ajax request or redirects to back as default", "Sets options to load subscription index from request parameters.\n @api protected\n @return [Hash] options to load subscription index", "Loads subscription index with request parameters.\n @api protected\n @return [Array] Array of subscription index", "Gets subscription of the target and notification key.\n\n @param [Hash] key                 Key of the notification for subscription\n @param [Hash] subscription_params Parameters to create subscription record\n @return [Subscription] Found or created subscription instance", "Creates new subscription of the target.\n\n @param [Hash] subscription_params Parameters to create subscription record\n @return [Subscription] Created subscription instance", "Gets configured subscription index of the target.\n\n @example Get configured subscription index of the @user\n   @subscriptions = @user.subscription_index\n\n @param [Hash] options Options for subscription index\n @option options [Integer]    :limit                  (nil)   Limit to query for subscriptions\n @option options [Boolean]    :reverse                (false) If subscription index will be ordered as earliest first\n @option options [String]     :filtered_by_key        (nil)   Key of the notification for filter\n @option options [Array|Hash] :custom_filter          (nil)   Custom subscription filter (e.g. [\"created_at >= ?\", time.hour.ago])\n @option options [Boolean]    :with_target            (false) If it includes target with subscriptions\n @return [Array<Notificaion>] Configured subscription index of the target", "Gets received notification keys of the target.\n\n @example Get unconfigured notification keys of the @user\n   @notification_keys = @user.notification_keys(filter: :unconfigured)\n\n @param [Hash] options Options for unconfigured notification keys\n @option options [Integer]       :limit                  (nil)   Limit to query for subscriptions\n @option options [Boolean]       :reverse                (false) If notification keys will be ordered as earliest first\n @option options [Symbol|String] :filter                 (nil)   Filter option to load notification keys (Nothing as all, 'configured' with configured subscriptions or 'unconfigured' without subscriptions)\n @option options [String]        :filtered_by_key        (nil)   Key of the notification for filter\n @option options [Array|Hash]    :custom_filter          (nil)   Custom subscription filter (e.g. [\"created_at >= ?\", time.hour.ago])\n @return [Array<Notificaion>] Unconfigured notification keys of the target", "Returns if the target subscribes.\n @api private\n @param [Boolean] record  Subscription record\n @param [Symbol]  field   Evaluating subscription field or method of the record\n @param [Boolean] default Default subscription value to use when the subscription record does not configured\n @param [Array]   args    Arguments of evaluating subscription method\n @return [Boolean] If the target subscribes", "Convert our resource to yaml for Hiera purposes.", "attribute names that are not title or namevars", "rubocop complains when this is named has_feature?", "validates a resource hash against its type schema", "Returns an array of keys that where not found in the type schema\n No longer modifies the resource passed in", "Returns a hash of keys and values that are not valid\n does not modify the resource passed in", "Parse the response body.\n\n Instead of overriding this method, consider using `define_parser`.", "faraday to rack-compatible", "rack to faraday-compatible", "Highlight matching characters within the matched string.\n\n Note that this is only approximate; it will highlight the first matching\n instances within the string, which may not actually be the instances that\n were used by the matching/scoring algorithm to determine the best score\n for the match.", "Print just the specified match.", "Print all matches.", "Take current matches and stick them in the quickfix window.", "Delete a character to the left of the current cursor position.", "Builds the local string according to configurations", "Returns a normalized version of the standard address parts.", "True if the part matches the conventional format", "Relaxed conventional is not so strict about character order.", "True if the part matches the RFC standard format", "Matches configured formated form against File glob strings given.\n Rules must end in @ to distinguish themselves from other email part matches.", "Returns the canonical email address according to the provider\n uniqueness rules. Usually, this downcases the address, removes\n spaves and comments and tags, and any extraneous part of the address\n not considered a unique account by the provider.", "Returns the provider name based on the MX-er host names, or nil if not matched", "Returns Array of domain names for the MX'ers, used to determine the Provider", "Using this to resolve only once per host", "Options for both the sync and async producers.", "Retrive the schedule configuration for the given name\n if the name is nil it returns a hash with all the\n names end their schedules.", "gets the schedule as it exists in redis", "Create or update a schedule with the provided name and configuration.\n\n Note: values for class and custom_job_class need to be strings,\n not constants.\n\n    Sidekiq.set_schedule('some_job', { :class => 'SomeJob',\n                                       :every => '15mins',\n                                       :queue => 'high',\n                                       :args => '/tmp/poop' })", "remove a given schedule by name", "Pulls the schedule from Sidekiq.schedule and loads it into the\n rufus scheduler instance", "Pushes the job into Sidekiq if not already pushed for the given time\n\n @param [String] job_name The job's name\n @param [Time] time The time when the job got cleared for triggering\n @param [Hash] config Job's config hash", "Enqueue a job based on a config hash\n\n @param job_config [Hash] the job configuration\n @param time [Time] time the job is enqueued", "Retrieves a schedule state\n\n @param name [String] with the schedule's name\n @return [Hash] with the schedule's state", "Adds a Hash with schedule metadata as the last argument to call the worker.\n It currently returns the schedule time as a Float number representing the milisencods\n since epoch.\n\n @example with hash argument\n   arguments_with_metadata({value: 1}, scheduled_at: Time.now)\n   #=> [{value: 1}, {scheduled_at: <miliseconds since epoch>}]\n\n @param args [Array|Hash]\n @param metadata [Hash]\n @return [Array] arguments with added metadata", "Returns true if the enqueuing needs to be done for an ActiveJob\n  class false otherwise.\n\n @param [Class] klass the class to check is decendant from ActiveJob\n\n @return [Boolean]", "Convert the given arguments in the format expected to be enqueued.\n\n @param [Hash] config the options to be converted\n @option config [String] class the job class\n @option config [Hash/Array] args the arguments to be passed to the job\n   class\n\n @return [Hash]", "Returns the next time execution for the job\n\n @return [String] with the job's next time", "Returns the last execution time for the job\n\n @return [String] with the job's last time", "Indicate that this endpoint is deprecated and will go away on the given date.\n\n gon_on: - date, as a string, when this endpoint will go away\n block - the contents of the endpoint\n\n Example:\n\n     def show\n       deprecated gone_on: \"2019-04-09\" do\n         render widgets: { Widget.find(params[:id]) }\n       end\n     end", "Generates a ASCII table with the given _options_.\n\n Align column _n_ to the given _alignment_ of :center, :left, or :right.", "Add a row.", "Return column _n_.", "Set the headings", "Render the table.", "Analyze rails codes.\n\n there are two steps to check rails codes,\n\n 1. prepare process, check all model and mailer files.\n 2. review process, check all files.\n\n if there are violations to rails best practices, output them.\n\n @param [String] path the directory of rails project\n @param [Hash] options", "process lexical, prepare or reivew.\n\n get all files for the process, analyze each file,\n and increment progress bar unless debug.\n\n @param [String] process the process name, lexical, prepare or review.", "get all files for parsing.\n\n @return [Array] all files for parsing", "expand all files with extenstion rb, erb, haml, slim, builder and rxml under the dirs\n\n @param [Array] dirs what directories to expand\n @return [Array] all files expanded", "sort files, models first, mailers, helpers, and then sort other files by characters.\n\n models and mailers first as for prepare process.\n\n @param [Array] files\n @return [Array] sorted files", "accept specific files.\n\n @param [Array] files\n @param [Regexp] patterns, files match any pattern will be accepted", "output errors with json format.", "plain output with color.\n\n @param [String] message to output\n @param [String] color", "analyze source codes.", "Hook to _run_callbacks asserting for conditions.", "A callback that runs if no user could be fetched, meaning there is now no user logged in.\n\n Parameters:\n <options> Some options which specify when the callback should be executed\n   scope  - Executes the callback only if it matches the scope(s) given\n <block> A block to contain logic for the callback\n   Block Parameters: |user, auth, scope|\n     user - The authenticated user for the current scope\n     auth - The warden proxy object\n     opts - any options passed into the authenticate call including :scope\n\n Example:\n   Warden::Manager.after_failed_fetch do |user, auth, opts|\n     I18n.locale = :en\n   end\n\n :api: public", "A callback that runs just prior to the logout of each scope.\n\n Parameters:\n <options> Some options which specify when the callback should be executed\n   scope  - Executes the callback only if it matches the scope(s) given\n <block> A block to contain logic for the callback\n   Block Parameters: |user, auth, scope|\n     user - The authenticated user for the current scope\n     auth - The warden proxy object\n     opts - any options passed into the authenticate call including :scope\n\n Example:\n   Warden::Manager.before_logout do |user, auth, opts|\n     user.forget_me!\n   end\n\n :api: public", "A callback that runs on each request, just after the proxy is initialized\n\n Parameters:\n <block> A block to contain logic for the callback\n   Block Parameters: |proxy|\n     proxy - The warden proxy object for the request\n\n Example:\n   user = \"A User\"\n   Warden::Manager.on_request do |proxy|\n     proxy.set_user = user\n   end\n\n :api: public", "Provides access to the user object in a given scope for a request.\n Will be nil if not logged in. Please notice that this method does not\n perform strategies.\n\n Example:\n   # without scope (default user)\n   env['warden'].user\n\n   # with scope\n   env['warden'].user(:admin)\n\n   # as a Hash\n   env['warden'].user(:scope => :admin)\n\n   # with default scope and run_callbacks option\n   env['warden'].user(:run_callbacks => false)\n\n  # with a scope and run_callbacks option\n  env['warden'].user(:scope => :admin, :run_callbacks => true)\n\n :api: public", "Provides logout functionality.\n The logout also manages any authenticated data storage and clears it when a user logs out.\n\n Parameters:\n   scopes - a list of scopes to logout\n\n Example:\n  # Logout everyone and clear the session\n  env['warden'].logout\n\n  # Logout the default user but leave the rest of the session alone\n  env['warden'].logout(:default)\n\n  # Logout the :publisher and :admin user\n  env['warden'].logout(:publisher, :admin)\n\n :api: public", "Run the strategies for a given scope", "Fetches strategies and keep them in a hash cache.", "Parse errors from the server respons, if any\n @raise [OverQueryLimitError] when server response object includes status 'OVER_QUERY_LIMIT'\n @raise [RequestDeniedError] when server response object includes 'REQUEST_DENIED'\n @raise [InvalidRequestError] when server response object includes 'INVALID_REQUEST'\n @raise [UnknownError] when server response object includes 'UNKNOWN_ERROR'\n @raise [NotFoundError] when server response object includes 'NOT_FOUND'\n @return [String] the response from the server as JSON", "Creates a new Client instance which proxies the requests to the certain classes\n\n @param [String] api_key The api key to use for the requests\n @param [Hash] options An options hash for requests. Is used as the query parameters on server requests\n @option options [String,Integer] lat\n   the latitude for the search\n @option options [String,Integer] lng\n   the longitude for the search\n @option options [Integer] :radius\n   Defines the distance (in meters) within which to return Place results.\n   The maximum allowed radius is 50,000 meters.\n   Note that radius must not be included if <b>:rankby</b> is specified\n @option options [String,Array] :types\n   Restricts the results to Spots matching at least one of the specified types\n @option options [String] :name\n   A term to be matched against the names of Places.\n   Results will be restricted to those containing the passed name value.\n @option options [String] :keyword\n   A term to be matched against all content that Google has indexed for this Spot,\n   including but not limited to name, type, and address,\n   as well as customer reviews and other third-party content.\n @option options [String] :language\n   The language code, indicating in which language the results should be returned, if possible.\n @option options [String,Array<String>] :exclude\n   A String or an Array of <b>types</b> to exclude from results\n\n @option options [Hash] :retry_options\n   A Hash containing parameters for search retries\n @option options [Object] :retry_options[:status]\n @option options [Integer] :retry_options[:max] the maximum retries\n @option options [Integer] :retry_options[:delay] the delay between each retry in seconds\n\n @see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1 List of supported languages\n @see https://developers.google.com/maps/documentation/places/supported_types List of supported types\n Search for Spots at the provided location\n\n @return [Array<Spot>]\n @param [String,Integer] lat the latitude for the search\n @param [String,Integer] lng the longitude for the search\n @param [Hash] options\n @option options [Integer] :radius (1000)\n   Defines the distance (in meters) within which to return Place results.\n   The maximum allowed radius is 50,000 meters.\n   Note that radius must not be included if :rankby => 'distance' (described below) is specified.\n   <b>Note that this is a mandatory parameter</b>\n @option options [String] :rankby\n   Specifies the order in which results are listed. Possible values are:\n   - prominence (default). This option sorts results based on their importance.\n     Ranking will favor prominent places within the specified area.\n     Prominence can be affected by a Place's ranking in Google's index,\n     the number of check-ins from your application, global popularity, and other factors.\n   - distance. This option sorts results in ascending order by their distance from the specified location.\n     Ranking results by distance will set a fixed search radius of 50km.\n     One or more of keyword, name, or types is required.\n @option options [String,Array] :types\n   Restricts the results to Spots matching at least one of the specified types\n @option options [String] :name\n   A term to be matched against the names of Places.\n   Results will be restricted to those containing the passed name value.\n @option options [String] :keyword\n   A term to be matched against all content that Google has indexed for this Spot,\n   including but not limited to name, type, and address,\n   as well as customer reviews and other third-party content.\n @option options [String] :language\n   The language code, indicating in which language the results should be returned, if possible.\n @option options [String,Array<String>] :exclude ([])\n   A String or an Array of <b>types</b> to exclude from results\n\n @option options [Hash] :retry_options ({})\n   A Hash containing parameters for search retries\n @option options [Object] :retry_options[:status] ([])\n @option options [Integer] :retry_options[:max] (0) the maximum retries\n @option options [Integer] :retry_options[:delay] (5) the delay between each retry in seconds\n\n @option options [Boolean] :detail\n   A boolean to return spots with full detail information(its complete address, phone number, user rating, reviews, etc)\n   Note) This makes an extra call for each spot for more information.\n\n @see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1 List of supported languages\n @see https://developers.google.com/maps/documentation/places/supported_types List of supported types", "Search for Spots with a query\n\n @return [Array<Spot>]\n @param [String] query the query to search for\n @param [Hash] options\n @option options [String,Integer] lat the latitude for the search\n @option options [String,Integer] lng the longitude for the search\n @option options [Integer] :radius (1000)\n   Defines the distance (in meters) within which to return Place results.\n   The maximum allowed radius is 50,000 meters.\n   Note that radius must not be included if :rankby => 'distance' (described below) is specified.\n   <b>Note that this is a mandatory parameter</b>\n @option options [String] :rankby\n   Specifies the order in which results are listed. Possible values are:\n   - prominence (default). This option sorts results based on their importance.\n     Ranking will favor prominent places within the specified area.\n     Prominence can be affected by a Place's ranking in Google's index,\n     the number of check-ins from your application, global popularity, and other factors.\n   - distance. This option sorts results in ascending order by their distance from the specified location.\n     Ranking results by distance will set a fixed search radius of 50km.\n     One or more of keyword, name, or types is required.                                                                                                                                                                                                                                                                                       distance. This option sorts results in ascending order by their distance from the specified location. Ranking results by distance will set a fixed search radius of 50km. One or more of keyword, name, or types is required.\n @option options [String,Array] :types\n   Restricts the results to Spots matching at least one of the specified types\n @option options [String] :language\n   The language code, indicating in which language the results should be returned, if possible.\n @option options [String,Array<String>] :exclude ([])\n   A String or an Array of <b>types</b> to exclude from results\n\n @option options [Hash] :retry_options ({})\n   A Hash containing parameters for search retries\n @option options [Object] :retry_options[:status] ([])\n @option options [Integer] :retry_options[:max] (0) the maximum retries\n @option options [Integer] :retry_options[:delay] (5) the delay between each retry in seconds\n @option options [Boolean] :detail\n   A boolean to return spots with full detail information(its complete address, phone number, user rating, reviews, etc)\n   Note) This makes an extra call for each spot for more information.\n\n @see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1 List of supported languages\n @see https://developers.google.com/maps/documentation/places/supported_types List of supported types", "Search for Spots within a give SW|NE bounds with query\n\n @return [Array<Spot>]\n @param [Hash] bounds\n @param [String] api_key the provided api key\n @param [Hash] options\n @option bounds [String, Array] :start_point\n   An array that contains the lat/lng pair for the first\n     point in the bounds (rectangle)\n @option bounds [:start_point][String, Integer] :lat\n   The starting point coordinates latitude value\n @option bounds [:start_point][String, Integer] :lng\n   The starting point coordinates longitude value\n @option bounds [String, Array] :end_point\n   An array that contains the lat/lng pair for the end\n     point in the bounds (rectangle)\n @option bounds [:end_point][String, Integer] :lat\n   The end point coordinates latitude value\n @option bounds [:end_point][String, Integer] :lng\n   The end point coordinates longitude value\n @option options [String,Array] :query\n   Restricts the results to Spots matching term(s) in the specified query\n @option options [String] :language\n   The language code, indicating in which language the results should be returned, if possible.\n @option options [String,Array<String>] :exclude ([])\n   A String or an Array of <b>types</b> to exclude from results\n @option options [Hash] :retry_options ({})\n   A Hash containing parameters for search retries\n @option options [Object] :retry_options[:status] ([])\n @option options [Integer] :retry_options[:max] (0) the maximum retries\n @option options [Integer] :retry_options[:delay] (5) the delay between each retry in seconds\n @option options [Boolean] :detail\n   A boolean to return spots with full detail information(its complete address, phone number, user rating, reviews, etc)\n   Note) This makes an extra call for each spot for more information.\n\n @see https://developers.google.com/maps/documentation/places/supported_types List of supported types", "Search for Spots with a pagetoken\n\n @return [Array<Spot>]\n @param [String] pagetoken the next page token to search for\n @param [Hash] options\n @option options [String,Array<String>] :exclude ([])\n   A String or an Array of <b>types</b> to exclude from results\n @option options [Hash] :retry_options ({})\n   A Hash containing parameters for search retries\n @option options [Object] :retry_options[:status] ([])\n @option options [Integer] :retry_options[:max] (0) the maximum retries\n @option options [Integer] :retry_options[:delay] (5) the delay between each retry in seconds\n @option options [Boolean] :detail\n   A boolean to return spots with full detail information(its complete address, phone number, user rating, reviews, etc)\n   Note) This makes an extra call for each spot for more information.\n\n @see https://developers.google.com/maps/documentation/places/supported_types List of supported types", "Radar Search Service allows you to search for up to 200 Places at once, but with less detail than is typically returned from a Text Search or Nearby Search request. The search response will include up to 200 Places, identified only by their geographic coordinates and reference. You can send a Place Details request for more information about any of them.\n\n @return [Array<Spot>]\n @param [String,Integer] lat the latitude for the search\n @param [String,Integer] lng the longitude for the search\n @param [Hash] options\n @option options [Integer] :radius (1000)\n   Defines the distance (in meters) within which to return Place results.\n   The maximum allowed radius is 50,000 meters.\n   <b>Note that this is a mandatory parameter</b>\n @option options [String,Array] :types\n   Restricts the results to Spots matching at least one of the specified types\n @option options [String] :name\n   A term to be matched against the names of Places.\n   Results will be restricted to those containing the passed name value.\n @option options [String] :keyword\n   A term to be matched against all content that Google has indexed for this Spot,\n   including but not limited to name, type, and address,\n   as well as customer reviews and other third-party content.\n @option options [Integer] :minprice\n   Restricts results to only those places within the specified price range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive.\n @option options [Integer] :maxprice\n   Restricts results to only those places within the specified price range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive.\n @option options [Boolean] :opennow\n   Retricts results to those Places that are open for business at the time the query is sent.\n   Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query.\n   Setting openNow to false has no effect.\n @option options [Boolean] :zagatselected\n   Restrict your search to only those locations that are Zagat selected businesses.\n   This parameter does not require a true or false value, simply including the parameter in the request is sufficient to restrict your search.\n   The zagatselected parameter is experimental, and only available to Places API enterprise customers.\n @option options [Boolean] :detail\n   A boolean to return spots with full detail information(its complete address, phone number, user rating, reviews, etc)\n   Note) This makes an extra call for each spot for more information.\n\n @see https://developers.google.com/places/documentation/search#RadarSearchRequests", "Search for a Photo's url with its reference key\n\n @return [URL]\n @param [String] api_key the provided api key\n @param [Hash] options\n @option options [Hash] :retry_options ({})\n   A Hash containing parameters for search retries\n @option options [Object] :retry_options[:status] ([])\n @option options [Integer] :retry_options[:max] (0) the maximum retries\n @option options [Integer] :retry_options[:delay] (5) the delay between each retry in seconds", "Hooks into const missing process to determine types of attributes\n\n @param [String] name\n\n @return [Class]\n\n @api private", "Initialize an AttributeSet\n\n @param [AttributeSet] parent\n @param [Array] attributes\n\n @return [undefined]\n\n @api private\n Iterate over each attribute in the set\n\n @example\n   attribute_set = AttributeSet.new(attributes, parent)\n   attribute_set.each { |attribute| ... }\n\n @yield [attribute]\n\n @yieldparam [Attribute] attribute\n   each attribute in the set\n\n @return [self]\n\n @api public", "Defines an attribute reader method\n\n @param [Attribute] attribute\n @param [Symbol] method_name\n @param [Symbol] visibility\n\n @return [undefined]\n\n @api private", "Defines an attribute writer method\n\n @param [Attribute] attribute\n @param [Symbol] method_name\n @param [Symbol] visibility\n\n @return [undefined]\n\n @api private", "Get values of all attributes defined for this class, ignoring privacy\n\n @return [Hash]\n\n @api private", "Mass-assign attribute values\n\n @see Virtus::InstanceMethods#attributes=\n\n @return [Hash]\n\n @api private", "Set default attributes\n\n @return [self]\n\n @api private", "Return the class given a primitive\n\n @param [Class] primitive\n\n @return [Class]\n\n @return [nil]\n   nil if the type cannot be determined by the primitive\n\n @api private", "Return the class given a string\n\n @param [String] string\n\n @return [Class]\n\n @return [nil]\n   nil if the type cannot be determined by the string\n\n @api private", "Extend an object with Virtus methods and define attributes\n\n @param [Object] object\n\n @return [undefined]\n\n @api private", "Extend a class with Virtus methods and define attributes\n\n @param [Object] object\n\n @return [undefined]\n\n @api private", "Adds the .included hook to the anonymous module which then defines the\n .attribute method to override the default.\n\n @return [Module]\n\n @api private", "Returns default options hash for a given attribute class\n\n @example\n   Virtus::Attribute::String.options\n   # => {:primitive => String}\n\n @return [Hash]\n   a hash of default option values\n\n @api public", "Defines which options are valid for a given attribute class\n\n @example\n   class MyAttribute < Virtus::Attribute\n     accept_options :foo, :bar\n   end\n\n @return [self]\n\n @api public", "Verifies the OTP passed in against the current time OTP\n and adjacent intervals up to +drift+.  Excludes OTPs\n from `after` and earlier.  Returns time value of\n matching OTP code for use in subsequent call.\n @param otp [String] the one time password to verify\n @param drift_behind [Integer] how many seconds to look back\n @param drift_ahead [Integer] how many seconds to look ahead\n @param after [Integer] prevent token reuse, last login timestamp\n @param at [Time] time at which to generate and verify a particular\n   otp. default Time.now\n @return [Integer, nil] the last successful timestamp\n   interval", "Get back an array of timecodes for a period", "A very simple param encoder", "constant-time compare the strings", "Verifies the OTP passed in against the current time OTP\n @param otp [String/Integer] the OTP to check against\n @param counter [Integer] the counter of the OTP\n @param retries [Integer] number of counters to incrementally retry", "EC2 Metadata server returns everything in one call. Store it after the\n first fetch to avoid making multiple calls.", "Set required variables like @project_id, @vm_id, @vm_name and @zone.", "1. Return the value if it is explicitly set in the config already.\n 2. If not, try to retrieve it by calling metadata servers directly.", "1. Return the value if it is explicitly set in the config already.\n 2. If not, try to retrieve it locally.", "Retrieve monitored resource via the legacy way.\n\n Note: This is just a failover plan if we fail to get metadata from\n Metadata Agent. Thus it should be equivalent to what Metadata Agent\n returns.", "Determine agent level monitored resource type.", "Determine agent level monitored resource labels based on the resource\n type. Each resource type has its own labels that need to be filled in.", "Determine the common labels that should be added to all log entries\n processed by this logging agent.", "Group the log entries by tag and local_resource_id pairs. Also filter out\n invalid non-Hash entries.", "Determine the group level monitored resource and common labels shared by a\n collection of entries.", "Take a locally unique resource id and convert it to the globally unique\n monitored resource.", "Extract entry level monitored resource and common labels that should be\n applied to individual entries.", "Issue a request to the Metadata Agent's local API and parse the response\n to JSON. Return nil in case of failure.", "Parse labels. Return nil if not set.", "Given a tag, returns the corresponding valid tag if possible, or nil if\n the tag should be rejected. If 'require_valid_tags' is false, non-string\n tags are converted to strings, and invalid characters are sanitized;\n otherwise such tags are rejected.", "For every original_label => new_label pair in the label_map, delete the\n original_label from the hash map if it exists, and extract the value to\n form a map with the new_label as the key.", "Encode as UTF-8. If 'coerce_to_utf8' is set to true in the config, any\n non-UTF-8 character would be replaced by the string specified by\n 'non_utf8_replacement_string'. If 'coerce_to_utf8' is set to false, any\n non-UTF-8 character would trigger the plugin to error out.", "Construct monitored resource locally for k8s resources.", "Exception-driven behavior to avoid synchronization errors.", "Initialize the Rack middleware for responding to serviceworker asset\n requests\n\n @app [#call] middleware stack\n @opts [Hash] options to inject\n @param opts [#match_route] :routes matches routes on PATH_INFO\n @param opts [Hash] :headers default headers to use for matched routes\n @param opts [#call] :handler resolves response from matched asset name\n @param opts [#info] :logger logs requests", "Find all keys in the source and return a forest with the keys in absolute form and their occurrences.\n\n @param key_filter [String] only return keys matching this pattern.\n @param strict [Boolean] if true, dynamic keys are excluded (e.g. `t(\"category.#{ category.key }\")`)\n @param include_raw_references [Boolean] if true, includes reference usages as they appear in the source\n @return [Data::Tree::Siblings]", "remove the leading colon and unwrap quotes from the key match\n @param literal [String] e.g: \"key\", 'key', or :key.\n @return [String] key", "Loads rails-i18n pluralization config for the given locale.", "keys present in compared_to, but not in locale", "keys used in the code missing translations in locale", "Extract i18n keys from file based on the pattern which must capture the key literal.\n @return [Array<[key, Results::Occurrence]>] each occurrence found in the file", "Convert 'es-ES' to 'es'", "Extract all occurrences of translate calls from the file at the given path.\n\n @return [Array<[key, Results::KeyOccurrence]>] each occurrence found in the file", "Extract a hash pair with a given literal key.\n\n @param node [AST::Node] a node of type `:hash`.\n @param key [String] node key as a string (indifferent symbol-string matching).\n @return [AST::Node, nil] a node of type `:pair` or nil.", "Extract an array as a single string.\n\n @param array_join_with [String] joiner of the array elements.\n @param array_flatten [Boolean] if true, nested arrays are flattened,\n     otherwise their source is copied and surrounded by #{}.\n @param array_reject_blank [Boolean] if true, empty strings and `nil`s are skipped.\n @return [String, nil] `nil` is returned only when a dynamic value is encountered in strict mode.", "Adds all the ancestors that only contain the given nodes as descendants to the given nodes.\n @param nodes [Set] Modified in-place.", "Sort keys by their attributes in order\n @param [Hash] order e.g. {locale: :asc, type: :desc, key: :asc}", "I18n data provider\n @see I18n::Tasks::Data::FileSystem", "Given a forest of references, merge trees into one tree, ensuring there are no conflicting references.\n @param roots [I18n::Tasks::Data::Tree::Siblings]\n @return [I18n::Tasks::Data::Tree::Siblings]", "Return the contents of the file at the given path.\n The file is read in the 'rb' mode and UTF-8 encoding.\n\n @param path [String] Path to the file, absolute or relative to the working directory.\n @return [String] file contents", "Returns positions given categories or positions\n @note If the argument does not a valid category it treats it as position\n   value and return it as it is.\n @param indexes [Array<object>] categories or positions\n @example\n   x = Daru::CategoricalIndex.new [:a, 1, :a, 1, :c]\n   x.pos :a, 1\n   # => [0, 1, 2, 3]", "Return subset given categories or positions\n @param indexes [Array<object>] categories or positions\n @return [Daru::CategoricalIndex] subset of the self containing the\n   mentioned categories or positions\n @example\n   idx = Daru::CategoricalIndex.new [:a, :b, :a, :b, :c]\n   idx.subset :a, :b\n   # => #<Daru::CategoricalIndex(4): {a, b, a, b}>", "Takes positional values and returns subset of the self\n   capturing the categories at mentioned positions\n @param positions [Array<Integer>] positional values\n @return [object] index object\n @example\n   idx = Daru::CategoricalIndex.new [:a, :b, :a, :b, :c]\n   idx.at 0, 1\n   # => #<Daru::CategoricalIndex(2): {a, b}>", "Array `name` must have same length as levels and labels.", "Get one or more elements with specified index or a range.\n\n == Usage\n   # For vectors employing single layer Index\n\n   v[:one, :two] # => Daru::Vector with indexes :one and :two\n   v[:one]       # => Single element\n   v[:one..:three] # => Daru::Vector with indexes :one, :two and :three\n\n   # For vectors employing hierarchial multi index", "Returns vector of values given positional values\n @param positions [Array<object>] positional values\n @return [object] vector\n @example\n   dv = Daru::Vector.new 'a'..'e'\n   dv.at 0, 1, 2\n   # => #<Daru::Vector(3)>\n   #   0   a\n   #   1   b\n   #   2   c", "Change value at given positions\n @param positions [Array<object>] positional values\n @param [object] val value to assign\n @example\n   dv = Daru::Vector.new 'a'..'e'\n   dv.set_at [0, 1], 'x'\n   dv\n   # => #<Daru::Vector(5)>\n   #   0   x\n   #   1   x\n   #   2   c\n   #   3   d\n   #   4   e", "Append an element to the vector by specifying the element and index", "Cast a vector to a new data type.\n\n == Options\n\n * +:dtype+ - :array for Ruby Array. :nmatrix for NMatrix.", "Delete element by index", "Get index of element", "Keep only unique elements of the vector alongwith their indexes.", "Sorts the vector according to it's`Index` values. Defaults to ascending\n order sorting.\n\n @param [Hash] opts the options for sort_by_index method.\n @option opts [Boolean] :ascending false, will sort `index` in\n  descending order.\n\n @return [Vector] new sorted `Vector` according to the index values.\n\n @example\n\n   dv = Daru::Vector.new [11, 13, 12], index: [23, 21, 22]\n   # Say you want to sort index in ascending order\n   dv.sort_by_index(ascending: true)\n   #=> Daru::Vector.new [13, 12, 11], index: [21, 22, 23]\n   # Say you want to sort index in descending order\n   dv.sort_by_index(ascending: false)\n   #=> Daru::Vector.new [11, 12, 13], index: [23, 22, 21]", "Destructive version of recode!", "Delete an element if block returns true. Destructive.", "Reports all values that doesn't comply with a condition.\n Returns a hash with the index of data and the invalid data.", "Lags the series by `k` periods.\n\n Lags the series by `k` periods, \"shifting\" data and inserting `nil`s\n from beginning or end of a vector, while preserving original vector's\n size.\n\n `k` can be positive or negative integer. If `k` is positive, `nil`s\n are inserted at the beginning of the vector, otherwise they are\n inserted at the end.\n\n @param [Integer] k \"shift\" the series by `k` periods. `k` can be\n   positive or negative. (default = 1)\n\n @return [Daru::Vector] a new vector with \"shifted\" inital values\n   and `nil` values inserted. The return vector is the same length\n   as the orignal vector.\n\n @example Lag a vector with different periods `k`\n\n   ts = Daru::Vector.new(1..5)\n               # => [1, 2, 3, 4, 5]\n\n   ts.lag      # => [nil, 1, 2, 3, 4]\n   ts.lag(1)   # => [nil, 1, 2, 3, 4]\n   ts.lag(2)   # => [nil, nil, 1, 2, 3]\n   ts.lag(-1)  # => [2, 3, 4, 5, nil]", "Convert Vector to a horizontal or vertical Ruby Matrix.\n\n == Arguments\n\n * +axis+ - Specify whether you want a *:horizontal* or a *:vertical* matrix.", "Convert vector to nmatrix object\n @param [Symbol] axis :horizontal or :vertical\n @return [NMatrix] NMatrix object containing all values of the vector\n @example\n   dv = Daru::Vector.new [1, 2, 3]\n   dv.to_nmatrix\n   # =>\n   # [\n   #   [1, 2, 3] ]", "Displays summary for an object type Vector\n @return [String] String containing object vector summary", "Displays summary for an numeric type Vector\n @return [String] String containing numeric vector summary", "Over rides original inspect for pretty printing in irb", "Sets new index for vector. Preserves index->value correspondence.\n Sets nil for new index keys absent from original index.\n @note Unlike #reorder! which takes positions as input it takes\n   index as an input to reorder the vector\n @param [Daru::Index, Daru::MultiIndex] new_index new index to order with\n @return [Daru::Vector] vector reindexed with new index", "Creates a new vector consisting only of non-nil data\n\n == Arguments\n\n @param as_a [Symbol] Passing :array will return only the elements\n as an Array. Otherwise will return a Daru::Vector.\n\n @param _duplicate [Symbol] In case no missing data is found in the\n vector, setting this to false will return the same vector.\n Otherwise, a duplicate will be returned irrespective of\n presence of missing data.", "Returns a Vector with only numerical data. Missing data is included\n but non-Numeric objects are excluded. Preserves index.", "Returns the database type for the vector, according to its content", "Converts a non category type vector to category type vector.\n @param [Hash] opts options to convert to category\n @option opts [true, false] :ordered Specify if vector is ordered or not.\n   If it is ordered, it can be sorted and min, max like functions would work\n @option opts [Array] :categories set categories in the specified order\n @return [Daru::Vector] vector with type category", "Partition a numeric variable into categories.\n @param [Array<Numeric>] partitions an array whose consecutive elements\n   provide intervals for categories\n @param [Hash] opts options to cut the partition\n @option opts [:left, :right] :close_at specifies whether the interval closes at\n   the right side of left side\n @option opts [Array] :labels names of the categories\n @return [Daru::Vector] numeric variable converted to categorical variable\n @example\n   heights = Daru::Vector.new [30, 35, 32, 50, 42, 51]\n   height_cat = heights.cut [30, 40, 50, 60], labels=['low', 'medium', 'high']\n   # => #<Daru::Vector(6)>\n   #       0    low\n   #       1    low\n   #       2    low\n   #       3   high\n   #       4 medium\n   #       5   high", "Helper method returning validity of arbitrary value", "For an array or hash of estimators methods, returns\n an array with three elements\n 1.- A hash with estimators names as keys and lambdas as values\n 2.- An array with estimators names\n 3.- A Hash with estimators names as keys and empty arrays as values", "coerce ranges, integers and array in appropriate ways", "Retrive rows by positions\n @param [Array<Integer>] positions of rows to retrive\n @return [Daru::Vector, Daru::DataFrame] vector for single position and dataframe for multiple positions\n @example\n   df = Daru::DataFrame.new({\n     a: [1, 2, 3],\n     b: ['a', 'b', 'c']\n   })\n   df.row_at 1, 2\n   # => #<Daru::DataFrame(2x2)>\n   #       a   b\n   #   1   2   b\n   #   2   3   c", "Set rows by positions\n @param [Array<Integer>] positions positions of rows to set\n @param [Array, Daru::Vector] vector vector to be assigned\n @example\n   df = Daru::DataFrame.new({\n     a: [1, 2, 3],\n     b: ['a', 'b', 'c']\n   })\n   df.set_row_at [0, 1], ['x', 'x']\n   df\n   #=> #<Daru::DataFrame(3x2)>\n   #       a   b\n   #   0   x   x\n   #   1   x   x\n   #   2   3   c", "Retrive vectors by positions\n @param [Array<Integer>] positions of vectors to retrive\n @return [Daru::Vector, Daru::DataFrame] vector for single position and dataframe for multiple positions\n @example\n   df = Daru::DataFrame.new({\n     a: [1, 2, 3],\n     b: ['a', 'b', 'c']\n   })\n   df.at 0\n   # => #<Daru::Vector(3)>\n   #       a\n   #   0   1\n   #   1   2\n   #   2   3", "Set vectors by positions\n @param [Array<Integer>] positions positions of vectors to set\n @param [Array, Daru::Vector] vector vector to be assigned\n @example\n   df = Daru::DataFrame.new({\n     a: [1, 2, 3],\n     b: ['a', 'b', 'c']\n   })\n   df.set_at [0], ['x', 'y', 'z']\n   df\n   #=> #<Daru::DataFrame(3x2)>\n   #       a   b\n   #   0   x   a\n   #   1   y   b\n   #   2   z   c", "Extract a dataframe given row indexes or positions\n @param keys [Array] can be positions (if by_position is true) or indexes (if by_position if false)\n @return [Daru::Dataframe]", "Creates a new duplicate dataframe containing only rows\n without a single missing value.", "Returns a dataframe in which rows with any of the mentioned values\n are ignored.\n @param [Array] values to reject to form the new dataframe\n @return [Daru::DataFrame] Data Frame with only rows which doesn't\n   contain the mentioned values\n @example\n   df = Daru::DataFrame.new({\n     a: [1,    2,          3,   nil,        Float::NAN, nil, 1,   7],\n     b: [:a,  :b,          nil, Float::NAN, nil,        3,   5,   8],\n     c: ['a',  Float::NAN, 3,   4,          3,          5,   nil, 7]\n   }, index: 11..18)\n   df.reject_values nil, Float::NAN\n   # => #<Daru::DataFrame(2x3)>\n   #       a   b   c\n   #   11   1   a   a\n   #   18   7   8   7", "Return unique rows by vector specified or all vectors\n\n @param vtrs [String][Symbol] vector names(s) that should be considered\n\n @example\n\n    => #<Daru::DataFrame(6x2)>\n         a   b\n     0   1   a\n     1   2   b\n     2   3   c\n     3   4   d\n     2   3   c\n     3   4   f\n\n    2.3.3 :> df.unique\n    => #<Daru::DataFrame(5x2)>\n         a   b\n     0   1   a\n     1   2   b\n     2   3   c\n     3   4   d\n     3   4   f\n\n    2.3.3 :> df.unique(:a)\n    => #<Daru::DataFrame(5x2)>\n         a   b\n     0   1   a\n     1   2   b\n     2   3   c\n     3   4   d", "Generate a matrix, based on vector names of the DataFrame.\n\n @return {::Matrix}\n :nocov:\n FIXME: Even not trying to cover this: I can't get, how it is expected\n to work.... -- zverok", "Delete a row", "Creates a DataFrame with the random data, of n size.\n If n not given, uses original number of rows.\n\n @return {Daru::DataFrame}", "creates a new vector with the data of a given field which the block returns true", "Iterates over each row and retains it in a new DataFrame if the block returns\n true for that row.", "Iterates over each vector and retains it in a new DataFrame if the block returns\n true for that vector.", "Reorder the vectors in a dataframe\n @param [Array] order_array new order of the vectors\n @example\n   df = Daru::DataFrame({\n     a: [1, 2, 3],\n     b: [4, 5, 6]\n   }, order: [:a, :b])\n   df.order = [:b, :a]\n   df\n   # => #<Daru::DataFrame(3x2)>\n   #       b   a\n   #   0   4   1\n   #   1   5   2\n   #   2   6   3", "Return a vector with the number of missing values in each row.\n\n == Arguments\n\n * +missing_values+ - An Array of the values that should be\n treated as 'missing'. The default missing value is *nil*.", "Return a nested hash using vector names as keys and an array constructed of\n hashes with other values. If block provided, is used to provide the\n values, with parameters +row+ of dataset, +current+ last hash on\n hierarchy and +name+ of the key to include", "Calculate mean of the rows of the dataframe.\n\n == Arguments\n\n * +max_missing+ - The maximum number of elements in the row that can be\n zero for the mean calculation to happen. Default to 0.", "Concatenate another DataFrame along corresponding columns.\n If columns do not exist in both dataframes, they are filled with nils", "Set a particular column as the new DF", "Renames the vectors\n\n == Arguments\n\n * name_map - A hash where the keys are the exising vector names and\n              the values are the new names.  If a vector is renamed\n              to a vector name that is already in use, the existing\n              one is overwritten.\n\n == Usage\n\n   df = Daru::DataFrame.new({ a: [1,2,3,4], b: [:a,:b,:c,:d], c: [11,22,33,44] })\n   df.rename_vectors :a => :alpha, :c => :gamma\n   df.vectors.to_a #=> [:alpha, :b, :gamma]", "Generate a summary of this DataFrame based on individual vectors in the DataFrame\n @return [String] String containing the summary of the DataFrame", "Pivots a data frame on specified vectors and applies an aggregate function\n to quickly generate a summary.\n\n == Options\n\n +:index+ - Keys to group by on the pivot table row index. Pass vector names\n contained in an Array.\n\n +:vectors+ - Keys to group by on the pivot table column index. Pass vector\n names contained in an Array.\n\n +:agg+ - Function to aggregate the grouped values. Default to *:mean*. Can\n use any of the statistics functions applicable on Vectors that can be found in\n the Daru::Statistics::Vector module.\n\n +:values+ - Columns to aggregate. Will consider all numeric columns not\n specified in *:index* or *:vectors*. Optional.\n\n == Usage\n\n   df = Daru::DataFrame.new({\n     a: ['foo'  ,  'foo',  'foo',  'foo',  'foo',  'bar',  'bar',  'bar',  'bar'],\n     b: ['one'  ,  'one',  'one',  'two',  'two',  'one',  'one',  'two',  'two'],\n     c: ['small','large','large','small','small','large','small','large','small'],\n     d: [1,2,2,3,3,4,5,6,7],\n     e: [2,4,4,6,6,8,10,12,14]\n   })\n   df.pivot_table(index: [:a], vectors: [:b], agg: :sum, values: :e)\n\n   #=>\n   # #<Daru::DataFrame:88342020 @name = 08cdaf4e-b154-4186-9084-e76dd191b2c9 @size = 2>\n   #            [:e, :one] [:e, :two]\n   #     [:bar]         18         26\n   #     [:foo]         10         12", "Creates a new dataset for one to many relations\n on a dataset, based on pattern of field names.\n\n for example, you have a survey for number of children\n with this structure:\n   id, name, child_name_1, child_age_1, child_name_2, child_age_2\n with\n   ds.one_to_many([:id], \"child_%v_%n\"\n the field of first parameters will be copied verbatim\n to new dataset, and fields which responds to second\n pattern will be added one case for each different %n.\n\n @example\n   cases=[\n     ['1','george','red',10,'blue',20,nil,nil],\n     ['2','fred','green',15,'orange',30,'white',20],\n     ['3','alfred',nil,nil,nil,nil,nil,nil]\n   ]\n   ds=Daru::DataFrame.rows(cases, order:\n     [:id, :name,\n      :car_color1, :car_value1,\n      :car_color2, :car_value2,\n      :car_color3, :car_value3])\n   ds.one_to_many([:id],'car_%v%n').to_matrix\n   #=> Matrix[\n   #   [\"red\", \"1\", 10],\n   #   [\"blue\", \"1\", 20],\n   #   [\"green\", \"2\", 15],\n   #   [\"orange\", \"2\", 30],\n   #   [\"white\", \"2\", 20]\n   #   ]", "Create a sql, basen on a given Dataset\n\n == Arguments\n\n * table - String specifying name of the table that will created in SQL.\n * charset - Character set. Default is \"UTF8\".\n\n @example\n\n  ds = Daru::DataFrame.new({\n   :id   => Daru::Vector.new([1,2,3,4,5]),\n   :name => Daru::Vector.new(%w{Alex Peter Susan Mary John})\n  })\n  ds.create_sql('names')\n   #=>\"CREATE TABLE names (id INTEGER,\\n name VARCHAR (255)) CHARACTER SET=UTF8;\"", "Convert to html for IRuby.", "Transpose a DataFrame, tranposing elements and row, column indexing.", "Function to use for aggregating the data.\n\n @param options [Hash] options for column, you want in resultant dataframe\n\n @return [Daru::DataFrame]\n\n @example\n   df = Daru::DataFrame.new(\n      {col: [:a, :b, :c, :d, :e], num: [52,12,07,17,01]})\n   => #<Daru::DataFrame(5x2)>\n        col num\n      0   a  52\n      1   b  12\n      2   c   7\n      3   d  17\n      4   e   1\n\n    df.aggregate(num_100_times: ->(df) { (df.num*100).first })\n   => #<Daru::DataFrame(5x1)>\n               num_100_ti\n             0       5200\n             1       1200\n             2        700\n             3       1700\n             4        100\n\n   When we have duplicate index :\n\n   idx = Daru::CategoricalIndex.new [:a, :b, :a, :a, :c]\n   df = Daru::DataFrame.new({num: [52,12,07,17,01]}, index: idx)\n   => #<Daru::DataFrame(5x1)>\n        num\n      a  52\n      b  12\n      a   7\n      a  17\n      c   1\n\n   df.aggregate(num: :mean)\n   => #<Daru::DataFrame(3x1)>\n                      num\n             a 25.3333333\n             b         12\n             c          1\n\n Note: `GroupBy` class `aggregate` method uses this `aggregate` method\n internally.", "Raises IndexError when one of the positions is not a valid position", "Accepts hash, enumerable and vector and align it properly so it can be added", "Returns true if all arguments are either a valid category or position\n @param indexes [Array<object>] categories or positions\n @return [true, false]\n @example\n   idx.valid? :a, 2\n   # => true\n   idx.valid? 3\n   # => false", "Sorts a `Index`, according to its values. Defaults to ascending order\n sorting.\n\n @param [Hash] opts the options for sort method.\n @option opts [Boolean] :ascending False, to get descending order.\n\n @return [Index] sorted `Index` according to its values.\n\n @example\n   di = Daru::Index.new [100, 99, 101, 1, 2]\n   # Say you want to sort in descending order\n   di.sort(ascending: false) #=> Daru::Index.new [101, 100, 99, 2, 1]\n   # Say you want to sort in ascending order\n   di.sort #=> Daru::Index.new [1, 2, 99, 100, 101]", "Retreive a slice or a an individual index number from the index.\n\n @param key [String, DateTime] Specify a date partially (as a String) or\n   completely to retrieve.", "Retrive a slice of the index by specifying first and last members of the slice.\n\n @param [String, DateTime] first Start of the slice as a string or DateTime.\n @param [String, DateTime] last End of the slice as a string or DateTime.", "Shift all dates in the index by a positive number in the future. The dates\n are shifted by the same amount as that specified in the offset.\n\n @param [Integer, Daru::DateOffset, Daru::Offsets::*] distance Distance by\n   which each date should be shifted. Passing an offset object to #shift\n   will offset each data point by the offset value. Passing a positive\n   integer will offset each data point by the same offset that it was\n   created with.\n @return [DateTimeIndex] Returns a new, shifted DateTimeIndex object.\n @example Using the shift method\n   index = Daru::DateTimeIndex.date_range(\n     :start => '2012', :periods => 10, :freq => 'YEAR')\n\n   # Passing a offset to shift\n   index.shift(Daru::Offsets::Hour.new(3))\n   #=>#<DateTimeIndex:84038960 offset=nil periods=10 data=[2012-01-01T03:00:00+00:00...2021-01-01T03:00:00+00:00]>\n\n   # Pass an integer to shift\n   index.shift(4)\n   #=>#<DateTimeIndex:83979630 offset=YEAR periods=10 data=[2016-01-01T00:00:00+00:00...2025-01-01T00:00:00+00:00]>", "Shift all dates in the index to the past. The dates are shifted by the same\n amount as that specified in the offset.\n\n @param [Integer, Daru::DateOffset, Daru::Offsets::*] distance Integer or\n   Daru::DateOffset. Distance by which each date should be shifted. Passing\n   an offset object to #lag will offset each data point by the offset value.\n   Passing a positive integer will offset each data point by the same offset\n   that it was created with.\n @return [DateTimeIndex] A new lagged DateTimeIndex object.", "Check if a date exists in the index. Will be inferred from string in case\n you pass a string. Recommened specifying the full date as a DateTime object.", "Initializes a vector to store categorical data.\n @note Base category is set to the first category encountered in the vector.\n @param [Array] data the categorical data\n @param [Hash] opts the options\n @option opts [Boolean] :ordered true if data is ordered, false otherwise\n @option opts [Array] :categories categories to associate with the vector.\n   It add extra categories if specified and provides order of categories also.\n @option opts [object] :index gives index to vector. By default its from 0 to size-1\n @return the categorical data created\n @example\n   dv = Daru::Vector.new [:a, 1, :a, 1, :c],\n     type: :category,\n     ordered: true,\n     categories: [:a, :b, :c, 1]\n   # => #<Daru::Vector(5)>\n   #   0   a\n   #   1   1\n   #   2   a\n   #   3   1\n   #   4   c", "Returns frequency of given category\n @param [object] category given category whose count has to be founded\n @return count/frequency of given category\n @example\n   dv = Daru::Vector.new [:a, 1, :a, 1, :c], type: :category\n   dv.count :a\n   # => 2\n   dv.count\n   # => 5", "Returns vector for positions specified.\n @param [Array] positions at which values to be retrived.\n @return vector containing values specified at specified positions\n @example\n   dv = Daru::Vector.new [:a, 1, :a, 1, :c], type: :category\n   dv.at 0..-2\n   # => #<Daru::Vector(4)>\n   #   0   a\n   #   1   1\n   #   2   a\n   #   3   1", "Modifies values at specified positions.\n @param [Array] positions positions at which to modify value\n @param [object] val value to assign at specific positions\n @return modified vector\n @example\n   dv = Daru::Vector.new [:a, 1, :a, 1, :c], type: :category\n   dv.add_category :b\n   dv.set_at [0, 1], :b\n   # => #<Daru::Vector(5)>\n   #   0   b\n   #   1   b\n   #   2   a\n   #   3   1\n   #   4   c", "Rename categories.\n @note The order of categories after renaming is preserved but new categories\n   are added at the end in the order. Also the base-category is reassigned\n   to new value if it is renamed\n @param [Hash] old_to_new a hash mapping categories whose name to be changed\n   to their new names\n @example\n   dv = Daru::Vector.new [:a, 1, :a, 1, :c], type: :category\n   dv.rename_categories :a => :b\n   dv\n   # => #<Daru::Vector(5)>\n   #   0   b\n   #   1   1\n   #   2   b\n   #   3   1\n   #   4   c", "Removes the unused categories\n @note If base category is removed, then the first occuring category in the\n   data is taken as base category. Order of the undeleted categories\n   remains preserved.\n @return [Daru::Vector] Makes changes in the vector itself i.e. deletes\n   the unused categories and returns itself\n @example\n   dv = Daru::Vector.new [:one, :two, :one], type: :category,\n     categories: [:three, :two, :one]\n   dv.remove_unused_categories\n   dv.categories\n   # => [:two, :one]", "Sorts the vector in the order specified.\n @note This operation will only work if vector is ordered.\n   To set the vector ordered, do `vector.ordered = true`\n @return [Daru::Vector] sorted vector\n @example\n   dv = Daru::Vector.new ['second', 'second', 'third', 'first'],\n     categories: ['first', 'second', 'thrid'],\n     type: :categories,\n     ordered: true\n   dv.sort!\n   # => #<Daru::Vector(4)>\n   #       3  first\n   #       0 second\n   #       1 second\n   #       2  third", "Sets new index for vector. Preserves index->value correspondence.\n @note Unlike #reorder! which takes positions as input it takes\n   index as an input to reorder the vector\n @param [Daru::Index, Daru::MultiIndex, Array] idx new index to order with\n @return [Daru::Vector] vector reindexed with new index\n @example\n   dv = Daru::Vector.new [3, 2, 1], index: ['c', 'b', 'a'], type: :category\n   dv.reindex! ['a', 'b', 'c']\n   # => #<Daru::Vector(3)>\n   #   a   1\n   #   b   2\n   #   c   3", "Count the number of values specified\n @param [Array] values to count for\n @return [Integer] the number of times the values mentioned occurs\n @example\n   dv = Daru::Vector.new [1, 2, 1, 2, 3, 4, nil, nil]\n   dv.count_values nil\n   # => 2", "Return indexes of values specified\n @param [Array] values to find indexes for\n @return [Array] array of indexes of values specified\n @example\n   dv = Daru::Vector.new [1, 2, nil, Float::NAN], index: 11..14\n   dv.indexes nil, Float::NAN\n   # => [13, 14]", "Displays a progress indicator for a given message. This progress report\n is only displayed on TTY displays, otherwise the message is passed to\n the +nontty_log+ level.\n\n @param [String] msg the message to log\n @param [Symbol, nil] nontty_log the level to log as if the output\n   stream is not a TTY. Use +nil+ for no alternate logging.\n @return [void]\n @since 0.8.2", "Prints the backtrace +exc+ to the logger as error data.\n\n @param [Array<String>] exc the backtrace list\n @param [Symbol] level_meth the level to log backtrace at\n @return [void]", "Backward compatibility to detect old tags that should be specified\n as directives in 0.8 and onward.", "Tests the expressions on the object.\n\n @note If the object is a {CodeObjects::Proxy} the result will always be true.\n @param [CodeObjects::Base] object the object to verify\n @return [Boolean] the result of the expressions", "Returns the inheritance tree of the object including self.\n\n @param [Boolean] include_mods whether or not to include mixins in the\n   inheritance tree.\n @return [Array<NamespaceObject>] the list of code objects that make up\n   the inheritance tree.", "Returns the list of methods matching the options hash. Returns\n all methods if hash is empty.\n\n @param [Hash] opts the options hash to match\n @option opts [Boolean] :inherited (true) whether inherited methods should be\n   included in the list\n @option opts [Boolean] :included (true) whether mixed in methods should be\n   included in the list\n @return [Array<MethodObject>] the list of methods that matched", "Returns only the methods that were inherited.\n\n @return [Array<MethodObject>] the list of inherited method objects", "Returns the list of constants matching the options hash.\n\n @param [Hash] opts the options hash to match\n @option opts [Boolean] :inherited (true) whether inherited constant should be\n   included in the list\n @option opts [Boolean] :included (true) whether mixed in constant should be\n   included in the list\n @return [Array<ConstantObject>] the list of constant that matched", "Returns only the constants that were inherited.\n\n @return [Array<ConstantObject>] the list of inherited constant objects", "Sets the superclass of the object\n\n @param [Base, Proxy, String, Symbol, nil] object the superclass value\n @return [void]", "Collects and returns all inherited namespaces for a given object", "Updates values from an options hash or options object on this object.\n All keys passed should be key names defined by attributes on the class.\n\n @example Updating a set of options on an Options object\n   opts.update(:template => :guide, :type => :fulldoc)\n @param [Hash, Options] opts\n @return [self]", "Yields over every option key and value\n @yield [key, value] every option key and value\n @yieldparam [Symbol] key the option key\n @yieldparam [Object] value the option value\n @return [void]", "Resets all values to their defaults.\n\n @abstract Subclasses should override this method to perform custom\n   value initialization if not using {default_attr}. Be sure to call\n   +super+ so that default initialization can take place.\n @return [void]", "Links to an object with an optional title\n\n @param [CodeObjects::Base] obj the object to link to\n @param [String] title the title to use for the link\n @return [String] the linked object", "Links to an extra file\n\n @param [String] filename the filename to link to\n @param [String] title the title of the link\n @param [String] anchor optional anchor\n @return [String] the link to the file\n @since 0.5.5", "Prepares the spec for documentation generation", "Creates a new method object in +namespace+ with +name+ and an instance\n or class +scope+\n\n If scope is +:module+, this object is instantiated as a public\n method in +:class+ scope, but also creates a new (empty) method\n as a private +:instance+ method on the same class or module.\n\n @param [NamespaceObject] namespace the namespace\n @param [String, Symbol] name the method name\n @param [Symbol] scope +:instance+, +:class+, or +:module+\n Changes the scope of an object from :instance or :class\n @param [Symbol] v the new scope", "Tests if the object is defined as an attribute in the namespace\n @return [Boolean] whether the object is an attribute", "Override separator to differentiate between class and instance\n methods.\n @return [String] \"#\" for an instance method, \".\" for class", "Associates an object with a path\n @param [String, Symbol] key the path name (:root or '' for root object)\n @param [CodeObjects::Base] value the object to store\n @return [CodeObjects::Base] returns +value+", "Loads all cached objects into memory\n @return [void]", "Saves the database to disk\n @param [Boolean] merge if true, merges the data in memory with the\n   data on disk, otherwise the data on disk is deleted.\n @param [String, nil] file if supplied, the name of the file to save to\n @return [Boolean] whether the database was saved", "Deletes the .yardoc database on disk\n\n @param [Boolean] force if force is not set to true, the file/directory\n   will only be removed if it ends with .yardoc. This helps with\n   cases where the directory might have been named incorrectly.\n @return [Boolean] true if the .yardoc database was deleted, false\n   otherwise.", "Gets the first line of a docstring to the period or the first paragraph.\n @return [String] The first line or paragraph of the docstring; always ends with a period.", "Reformats and returns a raw representation of the tag data using the\n current tag and docstring data, not the original text.\n\n @return [String] the updated raw formatted docstring data\n @since 0.7.0\n @todo Add Tags::Tag#to_raw and refactor", "Convenience method to return the first tag\n object in the list of tag objects of that name\n\n @example\n   doc = Docstring.new(\"@return zero when nil\")\n   doc.tag(:return).text  # => \"zero when nil\"\n\n @param [#to_s] name the tag name to return data for\n @return [Tags::Tag] the first tag in the list of {#tags}", "Returns a list of tags specified by +name+ or all tags if +name+ is not specified.\n\n @param [#to_s] name the tag name to return data for, or nil for all tags\n @return [Array<Tags::Tag>] the list of tags by the specified tag name", "Returns true if at least one tag by the name +name+ was declared\n\n @param [String] name the tag name to search for\n @return [Boolean] whether or not the tag +name+ was declared", "Returns true if the docstring has no content that is visible to a template.\n\n @param [Boolean] only_visible_tags whether only {Tags::Library.visible_tags}\n   should be checked, or if all tags should be considered.\n @return [Boolean] whether or not the docstring has content", "Maps valid reference tags\n\n @return [Array<Tags::RefTag>] the list of valid reference tags", "Parses out comments split by newlines into a new code object\n\n @param [String] comments\n   the newline delimited array of comments. If the comments\n   are passed as a String, they will be split by newlines.\n\n @return [String] the non-metadata portion of the comments to\n   be used as a docstring", "A stable sort_by method.\n\n @param list [Enumerable] the list to sort.\n @return [Array] a stable sorted list.", "Returns the inheritance tree of mixins.\n\n @param [Boolean] include_mods if true, will include mixed in\n   modules (which is likely what is wanted).\n @return [Array<NamespaceObject>] a list of namespace objects", "Looks for a child that matches the attributes specified by +opts+.\n\n @example Finds a child by name and scope\n   namespace.child(:name => :to_s, :scope => :instance)\n   # => #<yardoc method MyClass#to_s>\n @return [Base, nil] the first matched child object, or nil", "Returns all methods that match the attributes specified by +opts+. If\n no options are provided, returns all methods.\n\n @example Finds all private and protected class methods\n   namespace.meths(:visibility => [:private, :protected], :scope => :class)\n   # => [#<yardoc method MyClass.privmeth>, #<yardoc method MyClass.protmeth>]\n @option opts [Array<Symbol>, Symbol] :visibility ([:public, :private,\n   :protected]) the visibility of the methods to list. Can be an array or\n   single value.\n @option opts [Array<Symbol>, Symbol] :scope ([:class, :instance]) the\n   scope of the methods to list. Can be an array or single value.\n @option opts [Boolean] :included (true) whether to include mixed in\n   methods in the list.\n @return [Array<MethodObject>] a list of method objects", "Returns methods included from any mixins that match the attributes\n specified by +opts+. If no options are specified, returns all included\n methods.\n\n @option opts [Array<Symbol>, Symbol] :visibility ([:public, :private,\n   :protected]) the visibility of the methods to list. Can be an array or\n   single value.\n @option opts [Array<Symbol>, Symbol] :scope ([:class, :instance]) the\n   scope of the methods to list. Can be an array or single value.\n @option opts [Boolean] :included (true) whether to include mixed in\n   methods in the list.\n @see #meths", "Returns all constants in the namespace\n\n @option opts [Boolean] :included (true) whether or not to include\n   mixed in constants in list\n @return [Array<ConstantObject>] a list of constant objects", "Returns constants included from any mixins\n @return [Array<ConstantObject>] a list of constant objects", "performs uninstall based on sha1 hash provided in certfile", "end of ClassMethods", "Overides impressionist_count in order to provide mongoid compability", "creates a statment hash that contains default values for creating an impression via an AR relation.", "creates the query to check for uniqueness", "creates a statment hash that contains default values for creating an impression.", "Capitalizes the keys of a hash", "Execute the given request to the service\n\n @param [Symbol] call_sig The call signature being executed\n @param [Object] req (Optional) The protobuf request message to send\n @param [Hash] metadata (Optional) A hash of metadata key/values that are transported with the client request\n @param [Hash] opts (Optional) A hash of options to send to the gRPC request_response method\n @return [Array<Gruf::Timer::Result, GRPC::ActiveCall::Operation>]", "Get the appropriate protobuf request message for the given request method on the service being called\n\n @param [Symbol] request_method The method name being called on the remote service\n @param [Hash] params (Optional) A hash of parameters that will populate the request object\n @return [Class] The request object that corresponds to the method being called", "Build a sanitized, authenticated metadata hash for the given request\n\n @param [Hash] metadata A base metadata hash to build from\n @return [Hash] The compiled metadata hash that is ready to be transported over the wire", "Build a gRPC operation stub for testing", "Runs a server\n\n @param [Gruf::Server] server", "Initialize the error, setting default values\n\n @param [Hash] args (Optional) An optional hash of arguments that will set fields on the error object\n\n\n Add a field error to this error package\n\n @param [Symbol] field_name The field name for the error\n @param [Symbol] error_code The application error code for the error; e.g. :job_not_found\n @param [String] message The application error message for the error; e.g. \"Job not found with ID 123\"", "Update the trailing metadata on the given gRPC call, including the error payload if configured\n to do so.\n\n @param [GRPC::ActiveCall] active_call The marshalled gRPC call\n @return [Error] Return the error itself after updating metadata on the given gRPC call.\n                 In the case of a metadata overflow error, we replace the current error with\n                 a new one that won't cause a low-level http2 error.", "Return the error represented in Hash form\n\n @return [Hash] The error as a hash", "Return the error serializer being used for gruf\n\n @return [Gruf::Serializers::Errors::Base]", "Initialize the server and load and setup the services\n\n @param [Hash] opts\n\n\n @return [GRPC::RpcServer] The GRPC server running", "Start the gRPC server\n\n :nocov:", "Insert an interceptor before another in the currently registered order of execution\n\n @param [Class] before_class The interceptor that you want to add the new interceptor before\n @param [Class] interceptor_class The Interceptor to add to the registry\n @param [Hash] opts A hash of options for the interceptor", "Insert an interceptor after another in the currently registered order of execution\n\n @param [Class] after_class The interceptor that you want to add the new interceptor after\n @param [Class] interceptor_class The Interceptor to add to the registry\n @param [Hash] opts A hash of options for the interceptor", "Return the current configuration options as a Hash\n\n @return [Hash] The configuration for gruf, represented as a Hash", "Set the default configuration onto the extended class\n\n @return [Hash] options The reset options hash", "Notifies the failure of authentication to Warden in the same Devise does.\n Does result in an HTTP 401 response in a Devise context.", "Returns the correct host-key-verification option key to use depending\n on what version of net-ssh is in use. In net-ssh <= 4.1, the supported\n parameter is `paranoid` but in 4.2, it became `verify_host_key`\n\n `verify_host_key` does not work in <= 4.1, and `paranoid` throws\n deprecation warnings in >= 4.2.\n\n While the \"right thing\" to do would be to pin train's dependency on\n net-ssh to ~> 4.2, this will prevent InSpec from being used in\n Chef v12 because of it pinning to a v3 of net-ssh.", "Creates a new SSH Connection instance and save it for potential future\n reuse.\n\n @param options [Hash] conneciton options\n @return [Ssh::Connection] an SSH Connection instance\n @api private", "This pulls the content of the file to the machine running Train and uses\n Digest to perform the checksum. This is less efficient than using remote\n system binaries and can lead to incorrect results due to encoding.", "Creates a new WinRM Connection instance and save it for potential\n future reuse.\n\n @param options [Hash] conneciton options\n @return [WinRM::Connection] a WinRM Connection instance\n @api private", "Add a family connection. This will create a family\n if it does not exist and add a child relationship.", "wrap the cmd in a sudo command", "Wrap the cmd in an encoded command to allow pipes and quotes", "Main detect method to scan all platforms for a match\n\n @return Train::Platform instance or error if none found", "Add generic family? and platform methods to an existing platform\n\n This is done later to add any custom\n families/properties that were created", "reads os name and version from wmic\n @see https://msdn.microsoft.com/en-us/library/bb742610.aspx#EEAA\n Thanks to Matt Wrock (https://github.com/mwrock) for this hint", "`OSArchitecture` from `read_wmic` does not match a normal standard\n For example, `x86_64` shows as `64-bit`", "This method scans the target os for a unique uuid to use", "The method `platform` is called when platform detection is\n about to be performed.  Train core defines a sophisticated\n system for platform detection, but for most plugins, you'll\n only ever run on the special platform for which you are targeting.", "This takes a command from the platform detect block to run.\n We expect the command to return a unique identifier which\n we turn into a UUID.", "This hashes the passed string into SHA1.\n Then it downgrades the 160bit SHA1 to a 128bit\n then we format it as a valid UUIDv5.", "Get a list of Spotify playlists tagged with a particular category.\n\n @param limit  [Integer] Maximum number of playlists to return. Maximum: 50. Default: 20.\n @param offset [Integer] The index of the first playlist to return. Use with limit to get the next set of playlists. Default: 0.\n @param country [String] Optional. A country: an {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}. Provide this parameter if you want to narrow the list of returned playlists to those relevant to a particular country. If omitted, the returned playlists will be globally relevant.\n @return [Array<Playlist>]\n\n @example\n           playlists = category.playlists\n           playlists = category.playlists(country: 'BR')\n           playlists = category.playlists(limit: 10, offset: 20)", "Play the user's currently active player or specific device\n If `device_id` is not passed, the currently active spotify app will be triggered\n\n @example\n           player = user.player\n           player.play", "Toggle the current user's player repeat status.\n If `device_id` is not passed, the currently active spotify app will be triggered.\n If `state` is not passed, the currently active context will be set to repeat.\n\n @see https://developer.spotify.com/documentation/web-api/reference/player/set-repeat-mode-on-users-playback/\n\n @param [String] device_id the ID of the device to set the repeat state on.\n @param [String] state     the repeat state. Defaults to the current play context.\n\n @example\n          player = user.player\n          player.repeat(state: 'track')", "Toggle the current user's shuffle status.\n If `device_id` is not passed, the currently active spotify app will be triggered.\n If `state` is not passed, shuffle mode will be turned on.\n\n @see https://developer.spotify.com/documentation/web-api/reference/player/toggle-shuffle-for-users-playback/\n\n @param [String] device_id the ID of the device to set the shuffle state on.\n @param [String] state     the shuffle state. Defaults to turning the shuffle behavior on.\n\n @example\n          player = user.player\n          player.shuffle(state: false)", "Returns array of tracks from the album\n\n @param limit  [Integer] Maximum number of tracks to return. Maximum: 50. Default: 50.\n @param offset [Integer] The index of the first track to return. Use with limit to get the next set of objects. Default: 0.\n @param market [String] Optional. An {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}. Default: nil.\n @return [Array<Track>]\n\n @example\n           album = RSpotify::Album.find('41vPD50kQ7JeamkxQW7Vuy')\n           album.tracks.first.name #=> \"Do I Wanna Know?\"", "Returns array of albums from artist\n\n @param limit      [Integer] Maximum number of albums to return. Maximum: 50. Default: 20.\n @param offset     [Integer] The index of the first album to return. Use with limit to get the next set of albums. Default: 0.\n @param album_type [String]  Optional. A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned. Valid values are: album; single; appears_on; compilation.\n @param market     [String]  Optional. (synonym: country). An {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}. Supply this parameter to limit the response to one particular geographical market. If not supplied, results will be returned for all markets. Note if you do not provide this field, you are likely to get duplicate results per album, one for each market in which the album is available.\n @return [Array<Album>]\n\n @example\n           artist.albums\n           artist.albums(album_type: 'single,compilation')\n           artist.albums(limit: 50, country: 'US')", "Returns artist's 10 top tracks by country.\n\n @param country [Symbol] An {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}\n @return [Array<Track>]\n\n @example\n           top_tracks = artist.top_tracks(:US)\n           top_tracks.class       #=> Array\n           top_tracks.size        #=> 10\n           top_tracks.first.class #=> RSpotify::Track", "Returns array of tracks from the playlist\n\n @param limit  [Integer] Maximum number of tracks to return. Maximum: 100. Default: 100.\n @param offset [Integer] The index of the first track to return. Use with limit to get the next set of objects. Default: 0.\n @param market [String] Optional. An {https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}. Provide this parameter if you want to apply Track Relinking\n @return [Array<Track>]\n\n @example\n           playlist = RSpotify::Playlist.find('wizzler', '00wHcTN0zQiun4xri9pmvX')\n           playlist.tracks.first.name #=> \"Main Theme from Star Wars - Instrumental\"", "Returns all playlists from user\n\n @param limit  [Integer] Maximum number of playlists to return. Maximum: 50. Minimum: 1. Default: 20.\n @param offset [Integer] The index of the first playlist to return. Use with limit to get the next set of playlists. Default: 0.\n @return [Array<Playlist>]\n\n @example\n           playlists = user.playlists\n           playlists.class       #=> Array\n           playlists.first.class #=> RSpotify::Playlist\n           playlists.first.name  #=> \"Movie Soundtrack Masterpieces\"", "Returns a hash containing all user attributes", "Returns the user's available devices\n\n @return [Array<Device>]\n\n @example\n           devices = user.devices\n           devices.first.id #=> \"5fbb3ba6aa454b5534c4ba43a8c7e8e45a63ad0e\"", "Auxiliary methods\n Returns a relative path against `source_directory`.", "Returns project targets", "Load the user provided or default template for a new post or page.", "Render Liquid vars in YAML front-matter.", "Returns a string which is url compatible.", "Convert a Python dotted module name to a path.\n\n @param mod [String] Dotted module name.\n @param base [String] Optional base path to treat the file as relative to.\n @return [String]", "Deregister the given IO object from the selector", "Select which monitors are ready", "Set the position to the given value. New position must be less than limit.\n Preserves mark if it's less than the new position, otherwise clears it.\n\n @param new_position [Integer] position in the buffer\n\n @raise [ArgumentError] new position was invalid", "Set the limit to the given value. New limit must be less than capacity.\n Preserves limit and mark if they're less than the new limit, otherwise\n sets position to the new limit and clears the mark.\n\n @param new_limit [Integer] position in the buffer\n\n @raise [ArgumentError] new limit was invalid", "Obtain the requested number of bytes from the buffer, advancing the position.\n If no length is given, all remaining bytes are consumed.\n\n @raise [NIO::ByteBuffer::UnderflowError] not enough data remaining in buffer\n\n @return [String] bytes read from buffer", "Add a String to the buffer\n\n @param str [#to_str] data to add to the buffer\n\n @raise [TypeError] given a non-string type\n @raise [NIO::ByteBuffer::OverflowError] buffer is full\n\n @return [self]", "Perform a non-blocking read from the given IO object into the buffer\n Reads as much data as is immediately available and returns\n\n @param [IO] Ruby IO object to read from\n\n @return [Integer] number of bytes read (0 if none were available)", "Wraps block execution in a thread-safe transaction", "Sets the +query+ from +url+. Raises an +ArgumentError+ unless the +url+ is valid.", "Expects a Hash of +args+ to assign.", "Expects a +url+, validates its validity and returns a +URI+ object.", "Shift out bitfields for the first fields.", "Fetch big-endian lengths.", "Read in padded data.", "Returns the gzip decoded response body.", "Returns the DIME decoded response body.", "Loads files in application lib folder\n @return [Boolean] if files have been loaded (lib folder is configured to not nil and actually exists)", "Tag a call with an arbitrary label\n\n @param [String, Symbol] label String or Symbol with which to tag this call", "Wait for the call to end. Returns immediately if the call has already ended, else blocks until it does so.\n @param [Integer, nil] timeout a timeout after which to unblock, returning `:timeout`\n @return [Symbol] the reason for the call ending\n @raises [Celluloid::ConditionError] in case of a specified timeout expiring", "Registers a callback for when this call is joined to another call or a mixer\n\n @param [Call, String, Hash, nil] target the target to guard on. May be a Call object, a call ID (String, Hash) or a mixer name (Hash)\n @option target [String] call_uri The call ID to guard on\n @option target [String] mixer_name The mixer name to guard on", "Registers a callback for when this call is unjoined from another call or a mixer\n\n @param [Call, String, Hash, nil] target the target to guard on. May be a Call object, a call ID (String, Hash) or a mixer name (Hash)\n @option target [String] call_uri The call ID to guard on\n @option target [String] mixer_name The mixer name to guard on", "Redirect the call to some other target system.\n\n If the redirect is successful, the call will be released from the\n telephony engine and Adhearsion will lose control of the call.\n\n Note that for the common case, this will result in a SIP 302 or\n SIP REFER, which provides the caller with a new URI to dial. As such,\n the redirect target cannot be any telephony-engine specific address\n (such as sofia/gateway, agent/101, or SIP/mypeer); instead it should be a\n fully-qualified external SIP URI that the caller can independently reach.\n\n @param [String] to the target to redirect to, eg a SIP URI\n @param [Hash, optional] headers a set of headers to send along with the redirect instruction", "Joins this call to another call or a mixer\n\n @param [Call, String, Hash] target the target to join to. May be a Call object, a call ID (String, Hash) or a mixer name (Hash)\n @option target [String] call_uri The call ID to join to\n @option target [String] mixer_name The mixer to join to\n @param [Hash, Optional] options further options to be joined with\n\n @return [Hash] where :command is the issued command, :joined_waiter is a #wait responder which is triggered when the join is complete, and :unjoined_waiter is a #wait responder which is triggered when the entities are unjoined", "Unjoins this call from another call or a mixer\n\n @param [Call, String, Hash, nil] target the target to unjoin from. May be a Call object, a call ID (String, Hash), a mixer name (Hash) or missing to unjoin from every existing join (nil)\n @option target [String] call_uri The call ID to unjoin from\n @option target [String] mixer_name The mixer to unjoin from", "Sends a message to the caller\n\n @param [String] body The message text.\n @param [Hash, Optional] options The message options.\n @option options [String] subject The message subject.", "Execute a call controller asynchronously against this call.\n\n To block and wait until the controller completes, call `#join` on the result of this method.\n\n @param [Adhearsion::CallController] controller an instance of a controller initialized for this call\n @param [Proc] a callback to be executed when the controller finishes execution\n\n @yield execute the current block as the body of a controller by specifying no controller instance\n\n @return [Celluloid::ThreadHandle]", "Create a point-time dump of process statistics\n\n @return [Adhearsion::Statistics::Dump]", "Invoke another controller class within this controller, returning to this context on completion.\n\n @param [Class] controller_class The class of controller to execute\n @param [Hash] metadata generic key-value storage applicable to the controller\n @return The return value of the controller's run method", "Stop execution of all the components currently running in the controller.", "Wrapper to access to a specific configuration object\n\n Adhearsion.config.foo => returns the configuration object associated to the foo plugin", "Start the Adhearsion console", "Dial out an existing outbound call\n\n @param [String] to the URI of the party to dial\n @param [Hash] options modifier options\n @option options [String, Optional] :from what to set the Caller ID to\n @option options [Integer, Optional] :timeout in seconds\n @option options [Hash, Optional] :headers SIP headers to attach to\n   the new call.", "Compares the contents of two rules.\n\n @param other [Object] The object to compare with\n @return [Boolean] Whether or not this node and the other object\n   are the same\n Adds another {RuleNode}'s rules to this one's.\n\n @param node [RuleNode] The other node", "Maps the values in a hash according to a block.\n\n @example\n   map_values({:foo => \"bar\", :baz => \"bang\"}) {|v| v.to_sym}\n     #=> {:foo => :bar, :baz => :bang}\n @param hash [Hash] The hash to map\n @yield [value] A block in which the values are transformed\n @yieldparam value [Object] The value that should be mapped\n @yieldreturn [Object] The new value for the value\n @return [Hash] The mapped hash\n @see #map_keys\n @see #map_hash", "Maps the key-value pairs of a hash according to a block.\n\n @example\n   map_hash({:foo => \"bar\", :baz => \"bang\"}) {|k, v| [k.to_s, v.to_sym]}\n     #=> {\"foo\" => :bar, \"baz\" => :bang}\n @param hash [Hash] The hash to map\n @yield [key, value] A block in which the key-value pairs are transformed\n @yieldparam [key] The hash key\n @yieldparam [value] The hash value\n @yieldreturn [(Object, Object)] The new value for the `[key, value]` pair\n @return [Hash] The mapped hash\n @see #map_keys\n @see #map_vals", "Computes the powerset of the given array.\n This is the set of all subsets of the array.\n\n @example\n   powerset([1, 2, 3]) #=>\n     Set[Set[], Set[1], Set[2], Set[3], Set[1, 2], Set[2, 3], Set[1, 3], Set[1, 2, 3]]\n @param arr [Enumerable]\n @return [Set<Set>] The subsets of `arr`", "Restricts a number to falling within a given range.\n Returns the number if it falls within the range,\n or the closest value in the range if it doesn't.\n\n @param value [Numeric]\n @param range [Range<Numeric>]\n @return [Numeric]", "Concatenates all strings that are adjacent in an array,\n while leaving other elements as they are.\n\n @example\n   merge_adjacent_strings([1, \"foo\", \"bar\", 2, \"baz\"])\n     #=> [1, \"foobar\", 2, \"baz\"]\n @param arr [Array]\n @return [Array] The enumerable with strings merged", "Non-destructively replaces all occurrences of a subsequence in an array\n with another subsequence.\n\n @example\n   replace_subseq([1, 2, 3, 4, 5], [2, 3], [:a, :b])\n     #=> [1, :a, :b, 4, 5]\n\n @param arr [Array] The array whose subsequences will be replaced.\n @param subseq [Array] The subsequence to find and replace.\n @param replacement [Array] The sequence that `subseq` will be replaced with.\n @return [Array] `arr` with `subseq` replaced with `replacement`.", "Substitutes a sub-array of one array with another sub-array.\n\n @param ary [Array] The array in which to make the substitution\n @param from [Array] The sequence of elements to replace with `to`\n @param to [Array] The sequence of elements to replace `from` with", "Return an array of all possible paths through the given arrays.\n\n @param arrs [Array<Array>]\n @return [Array<Arrays>]\n\n @example\n   paths([[1, 2], [3, 4], [5]]) #=>\n     # [[1, 3, 5],\n     #  [2, 3, 5],\n     #  [1, 4, 5],\n     #  [2, 4, 5]]", "Computes a single longest common subsequence for `x` and `y`.\n If there are more than one longest common subsequences,\n the one returned is that which starts first in `x`.\n\n @param x [Array]\n @param y [Array]\n @yield [a, b] An optional block to use in place of a check for equality\n   between elements of `x` and `y`.\n @yieldreturn [Object, nil] If the two values register as equal,\n   this will return the value to use in the LCS array.\n @return [Array] The LCS", "Returns information about the caller of the previous method.\n\n @param entry [String] An entry in the `#caller` list, or a similarly formatted string\n @return [[String, Integer, (String, nil)]]\n   An array containing the filename, line, and method name of the caller.\n   The method name may be nil", "Returns whether one version string represents a more recent version than another.\n\n @param v1 [String] A version string.\n @param v2 [String] Another version string.\n @return [Boolean]", "Prints a deprecation warning for the caller method.\n\n @param obj [Object] `self`\n @param message [String] A message describing what to do instead.", "Silences all Sass warnings within a block.\n\n @yield A block in which no Sass warnings will be printed", "Cross Rails Version Compatibility\n Returns the root of the Rails application,\n if this is running in a Rails context.\n Returns `nil` if no such root is defined.\n\n @return [String, nil]", "Returns whether this environment is using ActionPack\n of a version greater than or equal to that specified.\n\n @param version [String] The string version number to check against.\n   Should be greater than or equal to Rails 3,\n   because otherwise ActionPack::VERSION isn't autoloaded\n @return [Boolean]", "Like `Dir.glob`, but works with backslash-separated paths on Windows.\n\n @param path [String]", "Returns `path` with all symlinks resolved.\n\n @param path [String, Pathname]\n @return [Pathname]", "Returns `path` relative to `from`.\n\n This is like `Pathname#relative_path_from` except it accepts both strings\n and pathnames, it handles Windows path separators correctly, and it throws\n an error rather than crashing if the paths use different encodings\n (https://github.com/ruby/ruby/pull/713).\n\n @param path [String, Pathname]\n @param from [String, Pathname]\n @return [Pathname?]", "Destructively removes all elements from an array that match a block, and\n returns the removed elements.\n\n @param array [Array] The array from which to remove elements.\n @yield [el] Called for each element.\n @yieldparam el [*] The element to test.\n @yieldreturn [Boolean] Whether or not to extract the element.\n @return [Array] The extracted elements.", "Allows modifications to be performed on the string form\n of an array containing both strings and non-strings.\n\n @param arr [Array] The array from which values are extracted.\n @yield [str] A block in which string manipulation can be done to the array.\n @yieldparam str [String] The string form of `arr`.\n @yieldreturn [String] The modified string.\n @return [Array] The modified, interpolated array.", "Escapes certain characters so that the result can be used\n as the JSON string value. Returns the original string if\n no escaping is necessary.\n\n @param s [String] The string to be escaped\n @return [String] The escaped string", "Converts the argument into a valid JSON value.\n\n @param v [Integer, String, Array, Boolean, nil]\n @return [String]", "This creates a temp file and yields it for writing. When the\n write is complete, the file is moved into the desired location.\n The atomicity of this operation is provided by the filesystem's\n rename operation.\n\n @param filename [String] The file to write to.\n @param perms [Integer] The permissions used for creating this file.\n   Will be masked by the process umask. Defaults to readable/writeable\n   by all users however the umask usually changes this to only be writable\n   by the process's user.\n @yieldparam tmpfile [Tempfile] The temp file that can be written to.\n @return The value returned by the block.", "Creates a new map.\n\n @param hash [Hash<Node, Node>]\n @see Value#options=", "Evaluates the node.\n\n \\{#perform} shouldn't be overridden directly;\n instead, override \\{#\\_perform}.\n\n @param environment [Sass::Environment] The environment in which to evaluate the SassScript\n @return [Sass::Script::Value] The SassScript object that is the value of the SassScript", "Evaluates the function call.\n\n @param environment [Sass::Environment] The environment in which to evaluate the SassScript\n @return [Sass::Script::Value] The SassScript object that is the value of the function call\n @raise [Sass::SyntaxError] if the function call raises an ArgumentError", "The read-only environment of the caller of this environment's mixin or function.\n\n @see BaseEnvironment#caller\n @return {ReadOnlyEnvironment}", "The content passed to this environment. If the content's environment isn't already\n read-only, it's made read-only.\n\n @see BaseEnvironment#content\n\n @return {[Array<Sass::Tree::Node>, ReadOnlyEnvironment]?} The content nodes and\n   the lexical environment of the content block.\n   Returns `nil` when there is no content in this environment.", "Converts a script node into a corresponding string interpolation\n expression.\n\n @param node_or_interp [Sass::Script::Tree::Node]\n @return [Sass::Script::Tree::StringInterpolation]", "Concatenates two string literals or string interpolation expressions.\n\n @param string_or_interp1 [Sass::Script::Tree::Literal|Sass::Script::Tree::StringInterpolation]\n @param string_or_interp2 [Sass::Script::Tree::Literal|Sass::Script::Tree::StringInterpolation]\n @return [Sass::Script::Tree::StringInterpolation]", "Returns a string literal with the given contents.\n\n @param string [String]\n @return string [Sass::Script::Tree::Literal]", "Processes the options set by the command-line arguments,\n and runs the Sass compiler appropriately.", "Prints `message` as a deprecation warning associated with `filename`,\n `line`, and optionally `column`.\n\n This ensures that only one message will be printed for each line of a\n given file.\n\n @overload warn(filename, line, message)\n   @param filename [String, nil]\n   @param line [Number]\n   @param message [String]\n @overload warn(filename, line, column, message)\n   @param filename [String, nil]\n   @param line [Number]\n   @param column [Number]\n   @param message [String]", "Updates out-of-date stylesheets.\n\n Checks each Sass/SCSS file in\n {file:SASS_REFERENCE.md#template_location-option `:template_location`}\n to see if it's been modified more recently than the corresponding CSS file\n in {file:SASS_REFERENCE.md#css_location-option `:css_location`}.\n If it has, it updates the CSS file.\n\n @param individual_files [Array<(String, String[, String])>]\n   A list of files to check for updates\n   **in addition to those specified by the\n   {file:SASS_REFERENCE.md#template_location-option `:template_location` option}.**\n   The first string in each pair is the location of the Sass/SCSS file,\n   the second is the location of the CSS file that it should be compiled to.\n   The third string, if provided, is the location of the Sourcemap file.", "Construct a list of files that might need to be compiled\n from the provided individual_files and the template_locations.\n\n Note: this method does not cache the results as they can change\n across invocations when sass files are added or removed.\n\n @param individual_files [Array<(String, String[, String])>]\n   A list of files to check for updates\n   **in addition to those specified by the\n   {file:SASS_REFERENCE.md#template_location-option `:template_location` option}.**\n   The first string in each pair is the location of the Sass/SCSS file,\n   the second is the location of the CSS file that it should be compiled to.\n   The third string, if provided, is the location of the Sourcemap file.\n @return [Array<(String, String, String)>]\n   A list of [sass_file, css_file, sourcemap_file] tuples similar\n   to what was passed in, but expanded to include the current state\n   of the directories being updated.", "Remove all output files that would be created by calling update_stylesheets, if they exist.\n\n This method runs the deleting_css and deleting_sourcemap callbacks for\n the files that are deleted.\n\n @param individual_files [Array<(String, String[, String])>]\n   A list of files to check for updates\n   **in addition to those specified by the\n   {file:SASS_REFERENCE.md#template_location-option `:template_location` option}.**\n   The first string in each pair is the location of the Sass/SCSS file,\n   the second is the location of the CSS file that it should be compiled to.\n   The third string, if provided, is the location of the Sourcemap file.", "Returns a copy of this color with one or more channels changed.\n RGB or HSL colors may be changed, but not both at once.\n\n For example:\n\n     Color.new([10, 20, 30]).with(:blue => 40)\n       #=> rgb(10, 40, 30)\n     Color.new([126, 126, 126]).with(:red => 0, :green => 255)\n       #=> rgb(0, 255, 126)\n     Color.new([255, 0, 127]).with(:saturation => 60)\n       #=> rgb(204, 51, 127)\n     Color.new([1, 2, 3]).with(:alpha => 0.4)\n       #=> rgba(1, 2, 3, 0.4)\n\n @param attrs [{Symbol => Numeric}]\n   A map of channel names (`:red`, `:green`, `:blue`,\n   `:hue`, `:saturation`, `:lightness`, or `:alpha`) to values\n @return [Color] The new Color object\n @raise [ArgumentError] if both RGB and HSL keys are specified", "Returns a string representation of the color.\n This is usually the color's hex value,\n but if the color has a name that's used instead.\n\n @return [String] The string representation", "Shifts all output source ranges forward one or more lines.\n\n @param delta [Integer] The number of lines to shift the ranges forward.", "Shifts any output source ranges that lie on the first line forward one or\n more characters on that line.\n\n @param delta [Integer] The number of characters to shift the ranges\n   forward.", "Returns the number of lines in the comment.\n\n @return [Integer]", "Updates all stylesheets, even those that aren't out-of-date.\n Ignores the cache.\n\n @param individual_files [Array<(String, String)>]\n   A list of files to check for updates\n   **in addition to those specified by the\n   {file:SASS_REFERENCE.md#template_location-option `:template_location` option}.**\n   The first string in each pair is the location of the Sass/SCSS file,\n   the second is the location of the CSS file that it should be compiled to.\n @see #update_stylesheets", "Converts a color into the format understood by IE filters.\n\n @example\n   ie-hex-str(#abc) => #FFAABBCC\n   ie-hex-str(#3322BB) => #FF3322BB\n   ie-hex-str(rgba(0, 255, 0, 0.5)) => #8000FF00\n @overload ie_hex_str($color)\n   @param $color [Sass::Script::Value::Color]\n @return [Sass::Script::Value::String] The IE-formatted string\n   representation of the color\n @raise [ArgumentError] if `$color` isn't a color", "Increases or decreases one or more properties of a color. This can change\n the red, green, blue, hue, saturation, value, and alpha properties. The\n properties are specified as keyword arguments, and are added to or\n subtracted from the color's current value for that property.\n\n All properties are optional. You can't specify both RGB properties\n (`$red`, `$green`, `$blue`) and HSL properties (`$hue`, `$saturation`,\n `$value`) at the same time.\n\n @example\n   adjust-color(#102030, $blue: 5) => #102035\n   adjust-color(#102030, $red: -5, $blue: 5) => #0b2035\n   adjust-color(hsl(25, 100%, 80%), $lightness: -30%, $alpha: -0.4) => hsla(25, 100%, 50%, 0.6)\n @overload adjust_color($color, [$red], [$green], [$blue], [$hue], [$saturation], [$lightness], [$alpha])\n   @param $color [Sass::Script::Value::Color]\n   @param $red [Sass::Script::Value::Number] The adjustment to make on the\n     red component, between -255 and 255 inclusive\n   @param $green [Sass::Script::Value::Number] The adjustment to make on the\n     green component, between -255 and 255 inclusive\n   @param $blue [Sass::Script::Value::Number] The adjustment to make on the\n     blue component, between -255 and 255 inclusive\n   @param $hue [Sass::Script::Value::Number] The adjustment to make on the\n     hue component, in degrees\n   @param $saturation [Sass::Script::Value::Number] The adjustment to make on\n     the saturation component, between `-100%` and `100%` inclusive\n   @param $lightness [Sass::Script::Value::Number] The adjustment to make on\n     the lightness component, between `-100%` and `100%` inclusive\n   @param $alpha [Sass::Script::Value::Number] The adjustment to make on the\n     alpha component, between -1 and 1 inclusive\n @return [Sass::Script::Value::Color]\n @raise [ArgumentError] if any parameter is the wrong type or out-of\n   bounds, or if RGB properties and HSL properties are adjusted at the\n   same time", "Changes one or more properties of a color. This can change the red, green,\n blue, hue, saturation, value, and alpha properties. The properties are\n specified as keyword arguments, and replace the color's current value for\n that property.\n\n All properties are optional. You can't specify both RGB properties\n (`$red`, `$green`, `$blue`) and HSL properties (`$hue`, `$saturation`,\n `$value`) at the same time.\n\n @example\n   change-color(#102030, $blue: 5) => #102005\n   change-color(#102030, $red: 120, $blue: 5) => #782005\n   change-color(hsl(25, 100%, 80%), $lightness: 40%, $alpha: 0.8) => hsla(25, 100%, 40%, 0.8)\n @overload change_color($color, [$red], [$green], [$blue], [$hue], [$saturation], [$lightness], [$alpha])\n   @param $color [Sass::Script::Value::Color]\n   @param $red [Sass::Script::Value::Number] The new red component for the\n     color, within 0 and 255 inclusive\n   @param $green [Sass::Script::Value::Number] The new green component for\n     the color, within 0 and 255 inclusive\n   @param $blue [Sass::Script::Value::Number] The new blue component for the\n     color, within 0 and 255 inclusive\n   @param $hue [Sass::Script::Value::Number] The new hue component for the\n     color, in degrees\n   @param $saturation [Sass::Script::Value::Number] The new saturation\n     component for the color, between `0%` and `100%` inclusive\n   @param $lightness [Sass::Script::Value::Number] The new lightness\n     component for the color, within `0%` and `100%` inclusive\n   @param $alpha [Sass::Script::Value::Number] The new alpha component for\n     the color, within 0 and 1 inclusive\n @return [Sass::Script::Value::Color]\n @raise [ArgumentError] if any parameter is the wrong type or out-of\n   bounds, or if RGB properties and HSL properties are adjusted at the\n   same time", "Mixes two colors together. Specifically, takes the average of each of the\n RGB components, optionally weighted by the given percentage. The opacity\n of the colors is also considered when weighting the components.\n\n The weight specifies the amount of the first color that should be included\n in the returned color. The default, `50%`, means that half the first color\n and half the second color should be used. `25%` means that a quarter of\n the first color and three quarters of the second color should be used.\n\n @example\n   mix(#f00, #00f) => #7f007f\n   mix(#f00, #00f, 25%) => #3f00bf\n   mix(rgba(255, 0, 0, 0.5), #00f) => rgba(63, 0, 191, 0.75)\n @overload mix($color1, $color2, $weight: 50%)\n   @param $color1 [Sass::Script::Value::Color]\n   @param $color2 [Sass::Script::Value::Color]\n   @param $weight [Sass::Script::Value::Number] The relative weight of each\n     color. Closer to `100%` gives more weight to `$color1`, closer to `0%`\n     gives more weight to `$color2`\n @return [Sass::Script::Value::Color]\n @raise [ArgumentError] if `$weight` is out of bounds or any parameter is\n   the wrong type", "Add quotes to a string if the string isn't quoted,\n or returns the same string if it is.\n\n @see #unquote\n @example\n   quote(\"foo\") => \"foo\"\n   quote(foo) => \"foo\"\n @overload quote($string)\n   @param $string [Sass::Script::Value::String]\n @return [Sass::Script::Value::String]\n @raise [ArgumentError] if `$string` isn't a string", "Converts a string to upper case.\n\n @example\n   to-upper-case(abcd) => ABCD\n\n @overload to_upper_case($string)\n   @param $string [Sass::Script::Value::String]\n @return [Sass::Script::Value::String]\n @raise [ArgumentError] if `$string` isn't a string", "Convert a string to lower case,\n\n @example\n   to-lower-case(ABCD) => abcd\n\n @overload to_lower_case($string)\n   @param $string [Sass::Script::Value::String]\n @return [Sass::Script::Value::String]\n @raise [ArgumentError] if `$string` isn't a string", "Returns the type of a value.\n\n @example\n   type-of(100px)  => number\n   type-of(asdf)   => string\n   type-of(\"asdf\") => string\n   type-of(true)   => bool\n   type-of(#fff)   => color\n   type-of(blue)   => color\n   type-of(null)   => null\n   type-of(a b c)  => list\n   type-of((a: 1, b: 2)) => map\n   type-of(get-function(\"foo\")) => function\n\n @overload type_of($value)\n   @param $value [Sass::Script::Value::Base] The value to inspect\n @return [Sass::Script::Value::String] The unquoted string name of the\n   value's type", "Returns whether two numbers can added, subtracted, or compared.\n\n @example\n   comparable(2px, 1px) => true\n   comparable(100px, 3em) => false\n   comparable(10cm, 3mm) => true\n @overload comparable($number1, $number2)\n   @param $number1 [Sass::Script::Value::Number]\n   @param $number2 [Sass::Script::Value::Number]\n @return [Sass::Script::Value::Bool]\n @raise [ArgumentError] if either parameter is the wrong type", "Converts a unitless number to a percentage.\n\n @example\n   percentage(0.2) => 20%\n   percentage(100px / 50px) => 200%\n @overload percentage($number)\n   @param $number [Sass::Script::Value::Number]\n @return [Sass::Script::Value::Number]\n @raise [ArgumentError] if `$number` isn't a unitless number", "Finds the minimum of several numbers. This function takes any number of\n arguments.\n\n @example\n   min(1px, 4px) => 1px\n   min(5em, 3em, 4em) => 3em\n @overload min($numbers...)\n   @param $numbers [[Sass::Script::Value::Number]]\n @return [Sass::Script::Value::Number]\n @raise [ArgumentError] if any argument isn't a number, or if not all of\n   the arguments have comparable units", "Finds the maximum of several numbers. This function takes any number of\n arguments.\n\n @example\n   max(1px, 4px) => 4px\n   max(5em, 3em, 4em) => 5em\n @overload max($numbers...)\n   @param $numbers [[Sass::Script::Value::Number]]\n @return [Sass::Script::Value::Number]\n @raise [ArgumentError] if any argument isn't a number, or if not all of\n   the arguments have comparable units", "Return a new list, based on the list provided, but with the nth\n element changed to the value given.\n\n Note that unlike some languages, the first item in a Sass list is number\n 1, the second number 2, and so forth.\n\n Negative index values address elements in reverse order, starting with the last element\n in the list.\n\n @example\n   set-nth($list: 10px 20px 30px, $n: 2, $value: -20px) => 10px -20px 30px\n @overload set-nth($list, $n, $value)\n   @param $list [Sass::Script::Value::Base] The list that will be copied, having the element\n     at index `$n` changed.\n   @param $n [Sass::Script::Value::Number] The index of the item to set.\n     Negative indices count from the end of the list.\n   @param $value [Sass::Script::Value::Base] The new value at index `$n`.\n @return [Sass::Script::Value::List]\n @raise [ArgumentError] if `$n` isn't an integer between 1 and the length\n   of `$list`", "Gets the nth item in a list.\n\n Note that unlike some languages, the first item in a Sass list is number\n 1, the second number 2, and so forth.\n\n This can return the nth pair in a map as well.\n\n Negative index values address elements in reverse order, starting with the last element in\n the list.\n\n @example\n   nth(10px 20px 30px, 1) => 10px\n   nth((Helvetica, Arial, sans-serif), 3) => sans-serif\n   nth((width: 10px, length: 20px), 2) => length, 20px\n @overload nth($list, $n)\n   @param $list [Sass::Script::Value::Base]\n   @param $n [Sass::Script::Value::Number] The index of the item to get.\n     Negative indices count from the end of the list.\n @return [Sass::Script::Value::Base]\n @raise [ArgumentError] if `$n` isn't an integer between 1 and the length\n   of `$list`", "Joins together two lists into one.\n\n Unless `$separator` is passed, if one list is comma-separated and one is\n space-separated, the first parameter's separator is used for the resulting\n list. If both lists have fewer than two items, spaces are used for the\n resulting list.\n\n Unless `$bracketed` is passed, the resulting list is bracketed if the\n first parameter is.\n\n Like all list functions, `join()` returns a new list rather than modifying\n its arguments in place.\n\n @example\n   join(10px 20px, 30px 40px) => 10px 20px 30px 40px\n   join((blue, red), (#abc, #def)) => blue, red, #abc, #def\n   join(10px, 20px) => 10px 20px\n   join(10px, 20px, comma) => 10px, 20px\n   join((blue, red), (#abc, #def), space) => blue red #abc #def\n   join([10px], 20px) => [10px 20px]\n @overload join($list1, $list2, $separator: auto, $bracketed: auto)\n   @param $list1 [Sass::Script::Value::Base]\n   @param $list2 [Sass::Script::Value::Base]\n   @param $separator [Sass::Script::Value::String] The list separator to use.\n     If this is `comma` or `space`, that separator will be used. If this is\n     `auto` (the default), the separator is determined as explained above.\n   @param $bracketed [Sass::Script::Value::Base] Whether the resulting list\n     will be bracketed. If this is `auto` (the default), the separator is\n     determined as explained above.\n @return [Sass::Script::Value::List]", "Appends a single value onto the end of a list.\n\n Unless the `$separator` argument is passed, if the list had only one item,\n the resulting list will be space-separated.\n\n Like all list functions, `append()` returns a new list rather than\n modifying its argument in place.\n\n @example\n   append(10px 20px, 30px) => 10px 20px 30px\n   append((blue, red), green) => blue, red, green\n   append(10px 20px, 30px 40px) => 10px 20px (30px 40px)\n   append(10px, 20px, comma) => 10px, 20px\n   append((blue, red), green, space) => blue red green\n @overload append($list, $val, $separator: auto)\n   @param $list [Sass::Script::Value::Base]\n   @param $val [Sass::Script::Value::Base]\n   @param $separator [Sass::Script::Value::String] The list separator to use.\n     If this is `comma` or `space`, that separator will be used. If this is\n     `auto` (the default), the separator is determined as explained above.\n @return [Sass::Script::Value::List]", "Combines several lists into a single multidimensional list. The nth value\n of the resulting list is a space separated list of the source lists' nth\n values.\n\n The length of the resulting list is the length of the\n shortest list.\n\n @example\n   zip(1px 1px 3px, solid dashed solid, red green blue)\n   => 1px solid red, 1px dashed green, 3px solid blue\n @overload zip($lists...)\n   @param $lists [[Sass::Script::Value::Base]]\n @return [Sass::Script::Value::List]", "Returns the position of a value within a list. If the value isn't found,\n returns `null` instead.\n\n Note that unlike some languages, the first item in a Sass list is number\n 1, the second number 2, and so forth.\n\n This can return the position of a pair in a map as well.\n\n @example\n   index(1px solid red, solid) => 2\n   index(1px solid red, dashed) => null\n   index((width: 10px, height: 20px), (height 20px)) => 2\n @overload index($list, $value)\n   @param $list [Sass::Script::Value::Base]\n   @param $value [Sass::Script::Value::Base]\n @return [Sass::Script::Value::Number, Sass::Script::Value::Null] The\n   1-based index of `$value` in `$list`, or `null`", "Returns a new map with keys removed.\n\n Like all map functions, `map-merge()` returns a new map rather than\n modifying its arguments in place.\n\n @example\n   map-remove((\"foo\": 1, \"bar\": 2), \"bar\") => (\"foo\": 1)\n   map-remove((\"foo\": 1, \"bar\": 2, \"baz\": 3), \"bar\", \"baz\") => (\"foo\": 1)\n   map-remove((\"foo\": 1, \"bar\": 2), \"baz\") => (\"foo\": 1, \"bar\": 2)\n @overload map_remove($map, $keys...)\n   @param $map  [Sass::Script::Value::Map]\n   @param $keys [[Sass::Script::Value::Base]]\n @return [Sass::Script::Value::Map]\n @raise [ArgumentError] if `$map` is not a map", "Returns whether a map has a value associated with a given key.\n\n @example\n   map-has-key((\"foo\": 1, \"bar\": 2), \"foo\") => true\n   map-has-key((\"foo\": 1, \"bar\": 2), \"baz\") => false\n @overload map_has_key($map, $key)\n   @param $map [Sass::Script::Value::Map]\n   @param $key [Sass::Script::Value::Base]\n @return [Sass::Script::Value::Bool]\n @raise [ArgumentError] if `$map` is not a map", "Returns a unique CSS identifier. The identifier is returned as an unquoted\n string. The identifier returned is only guaranteed to be unique within the\n scope of a single Sass run.\n\n @overload unique_id()\n @return [Sass::Script::Value::String]", "Check whether a variable with the given name exists in the current\n scope or in the global scope.\n\n @example\n   $a-false-value: false;\n   variable-exists(a-false-value) => true\n   variable-exists(a-null-value) => true\n\n   variable-exists(nonexistent) => false\n\n @overload variable_exists($name)\n   @param $name [Sass::Script::Value::String] The name of the variable to\n     check. The name should not include the `$`.\n @return [Sass::Script::Value::Bool] Whether the variable is defined in\n   the current scope.", "Check whether a function with the given name exists.\n\n @example\n   function-exists(lighten) => true\n\n   @function myfunc { @return \"something\"; }\n   function-exists(myfunc) => true\n\n @overload function_exists($name)\n   @param name [Sass::Script::Value::String] The name of the function to\n     check or a function reference.\n @return [Sass::Script::Value::Bool] Whether the function is defined.", "Check whether a mixin was passed a content block.\n\n Unless `content-exists()` is called directly from a mixin, an error will be raised.\n\n @example\n   @mixin needs-content {\n     @if not content-exists() {\n       @error \"You must pass a content block!\"\n     }\n     @content;\n   }\n\n @overload content_exists()\n @return [Sass::Script::Value::Bool] Whether a content block was passed to the mixin.", "Return a string containing the value as its Sass representation.\n\n @overload inspect($value)\n   @param $value [Sass::Script::Value::Base] The value to inspect.\n @return [Sass::Script::Value::String] A representation of the value as\n   it would be written in Sass.", "Unifies two selectors into a single selector that matches only\n elements matched by both input selectors. Returns `null` if\n there is no such selector.\n\n Like the selector unification done for `@extend`, this doesn't\n guarantee that the output selector will match *all* elements\n matched by both input selectors. For example, if `.a .b` is\n unified with `.x .y`, `.a .x .b.y, .x .a .b.y` will be returned,\n but `.a.x .b.y` will not. This avoids exponential output size\n while matching all elements that are likely to exist in\n practice.\n\n @example\n   selector-unify(\".a\", \".b\") => .a.b\n   selector-unify(\".a .b\", \".x .y\") => .a .x .b.y, .x .a .b.y\n   selector-unify(\".a.b\", \".b.c\") => .a.b.c\n   selector-unify(\"#a\", \"#b\") => null\n\n @overload selector_unify($selector1, $selector2)\n   @param $selector1 [Sass::Script::Value::String, Sass::Script::Value::List]\n     The first selector to be unified. This can be either a\n     string, a list of strings, or a list of lists of strings as\n     returned by `&`.\n   @param $selector2 [Sass::Script::Value::String, Sass::Script::Value::List]\n     The second selector to be unified. This can be either a\n     string, a list of strings, or a list of lists of strings as\n     returned by `&`.\n   @return [Sass::Script::Value::List, Sass::Script::Value::Null]\n     A list of lists of strings representing the result of the\n     unification, or null if no unification exists. This is in\n     the same format as a selector returned by `&`.", "This method implements the pattern of transforming a numeric value into\n another numeric value with the same units.\n It yields a number to a block to perform the operation and return a number", "Merges this query with another. The returned query queries for\n the intersection between the two inputs.\n\n Both queries should be resolved.\n\n @param other [Query]\n @return [Query?] The merged query, or nil if there is no intersection.", "Returns the CSS for the media query.\n\n @return [String]", "Returns a deep copy of this query and all its children.\n\n @return [Query]", "Returns whether an element in the list should be wrapped in parentheses\n when serialized to Sass.", "Returns whether a value is a number literal that shouldn't be divided.", "Parses the CSS template and applies various transformations\n\n @return [Tree::Node] The root node of the parsed tree", "Make rules use nesting so that\n\n     foo\n       color: green\n     foo bar\n       color: red\n     foo baz\n       color: blue\n\n becomes\n\n     foo\n       color: green\n       bar\n         color: red\n       baz\n         color: blue\n\n @param root [Tree::Node] The parent node", "Make rules use parent refs so that\n\n     foo\n       color: green\n     foo.bar\n       color: blue\n\n becomes\n\n     foo\n       color: green\n       &.bar\n         color: blue\n\n @param root [Tree::Node] The parent node", "Flatten rules so that\n\n     foo\n       bar\n         color: red\n\n becomes\n\n     foo bar\n       color: red\n\n and\n\n     foo\n       &.bar\n         color: blue\n\n becomes\n\n     foo.bar\n       color: blue\n\n @param root [Tree::Node] The parent node", "Flattens a single rule.\n\n @param rule [Tree::RuleNode] The candidate for flattening\n @see #flatten_rules", "Runs the visitor on the given node.\n This can be overridden by subclasses that need to do something for each node.\n\n @param node [Tree::Node] The node to visit.\n @return [Object] The return value of the `visit_*` method for this node.", "Processes the options set by the command-line arguments,\n and runs the CSS compiler appropriately.", "The SassScript `%` operation.\n\n @param other [Number] The right-hand side of the operator\n @return [Number] This number modulo the other\n @raise [NoMethodError] if `other` is an invalid type\n @raise [Sass::UnitConversionError] if `other` has incompatible units", "The SassScript `==` operation.\n\n @param other [Value] The right-hand side of the operator\n @return [Boolean] Whether this number is equal to the other object", "Hash-equality works differently than `==` equality for numbers.\n Hash-equality must be transitive, so it just compares the exact value,\n numerator units, and denominator units.\n The SassScript `>` operation.\n\n @param other [Number] The right-hand side of the operator\n @return [Boolean] Whether this number is greater than the other\n @raise [NoMethodError] if `other` is an invalid type", "The SassScript `>=` operation.\n\n @param other [Number] The right-hand side of the operator\n @return [Boolean] Whether this number is greater than or equal to the other\n @raise [NoMethodError] if `other` is an invalid type", "The SassScript `<` operation.\n\n @param other [Number] The right-hand side of the operator\n @return [Boolean] Whether this number is less than the other\n @raise [NoMethodError] if `other` is an invalid type", "The SassScript `<=` operation.\n\n @param other [Number] The right-hand side of the operator\n @return [Boolean] Whether this number is less than or equal to the other\n @raise [NoMethodError] if `other` is an invalid type", "Returns a readable representation of this number.\n\n This representation is valid CSS (and valid SassScript)\n as long as there is only one unit.\n\n @return [String] The representation", "Checks whether the number has the numerator unit specified.\n\n @example\n   number = Sass::Script::Value::Number.new(10, \"px\")\n   number.is_unit?(\"px\") => true\n   number.is_unit?(nil) => false\n\n @param unit [::String, nil] The unit the number should have or nil if the number\n   should be unitless.\n @see Number#unitless? The unitless? method may be more readable.", "The SassScript `+` operation.\n\n @param other [Value] The right-hand side of the operator\n @return [Script::Value::String] A string containing both values\n   without any separation", "Creates a new list containing `contents` but with the same brackets and\n separators as this object, when interpreted as a list.\n\n @param contents [Array<Value>] The contents of the new list.\n @param separator [Symbol] The separator of the new list. Defaults to \\{#separator}.\n @param bracketed [Boolean] Whether the new list is bracketed. Defaults to \\{#bracketed}.\n @return [Sass::Script::Value::List]", "Evaluates the variable.\n\n @param environment [Sass::Environment] The environment in which to evaluate the SassScript\n @return [Sass::Script::Value] The SassScript object that is the value of the variable\n @raise [Sass::SyntaxError] if the variable is undefined", "Finds the line of the source template\n on which an exception was raised.\n\n @param exception [Exception] The exception\n @return [String] The line number", "Set an option for specifying `Encoding.default_external`.\n\n @param opts [OptionParser]", "Wraps the given string in terminal escapes\n causing it to have the given color.\n If terminal escapes aren't supported on this platform,\n just returns the string instead.\n\n @param color [Symbol] The name of the color to use.\n   Can be `:red`, `:green`, or `:yellow`.\n @param str [String] The string to wrap in the given color.\n @return [String] The wrapped string.", "Construct a Sass Color from hsl values.\n\n @param hue [::Number] The hue of the color in degrees.\n   A non-negative number, usually less than 360.\n @param saturation [::Number] The saturation of the color.\n   Must be between 0 and 100 inclusive.\n @param lightness [::Number] The lightness of the color.\n   Must be between 0 and 100 inclusive.\n @param alpha [::Number] The alpha channel. A number between 0 and 1.\n\n @return [Sass::Script::Value::Color] the color object", "Construct a Sass Color from rgb values.\n\n @param red [::Number] The red component. Must be between 0 and 255 inclusive.\n @param green [::Number] The green component. Must be between 0 and 255 inclusive.\n @param blue [::Number] The blue component. Must be between 0 and 255 inclusive.\n @param alpha [::Number] The alpha channel. A number between 0 and 1.\n\n @return [Sass::Script::Value::Color] the color object", "Parses a user-provided selector.\n\n @param value [Sass::Script::Value::String, Sass::Script::Value::List]\n   The selector to parse. This can be either a string, a list of\n   strings, or a list of lists of strings as returned by `&`.\n @param name [Symbol, nil]\n   If provided, the name of the selector argument. This is used\n   for error reporting.\n @param allow_parent_ref [Boolean]\n   Whether the parsed selector should allow parent references.\n @return [Sass::Selector::CommaSequence] The parsed selector.\n @throw [ArgumentError] if the parse failed for any reason.", "Parses a user-provided complex selector.\n\n A complex selector can contain combinators but cannot contain commas.\n\n @param value [Sass::Script::Value::String, Sass::Script::Value::List]\n   The selector to parse. This can be either a string or a list of\n   strings.\n @param name [Symbol, nil]\n   If provided, the name of the selector argument. This is used\n   for error reporting.\n @param allow_parent_ref [Boolean]\n   Whether the parsed selector should allow parent references.\n @return [Sass::Selector::Sequence] The parsed selector.\n @throw [ArgumentError] if the parse failed for any reason.", "Parses a user-provided compound selector.\n\n A compound selector cannot contain combinators or commas.\n\n @param value [Sass::Script::Value::String] The selector to parse.\n @param name [Symbol, nil]\n   If provided, the name of the selector argument. This is used\n   for error reporting.\n @param allow_parent_ref [Boolean]\n   Whether the parsed selector should allow parent references.\n @return [Sass::Selector::SimpleSequence] The parsed selector.\n @throw [ArgumentError] if the parse failed for any reason.", "Converts a user-provided selector into string form or throws an\n ArgumentError if it's in an invalid format.", "Converts a user-provided selector into string form or returns\n `nil` if it's in an invalid format.", "Returns the standard exception backtrace,\n including the Sass backtrace.\n\n @return [Array<String>]", "Returns a string representation of the Sass backtrace.\n\n @param default_filename [String] The filename to use for unknown files\n @see #sass_backtrace\n @return [String]", "Fetch given a key and options and a fallback block attempts to find the key in the cache\n and stores the block result in there if no key is found.\n\n cache = Rabl::CacheEngine.new; cache.fetch(\"some_key\") { \"fallback data\" }", "Maps a cache key to an engine", "Returns the items that were found in the cache", "Maps the results from the cache back to the builders", "Returns the source given a relative template path", "Returns the object rootname based on if the root should be included\n Can be called with data as a collection or object\n determine_object_root(@user, :user, true) => \"user\"\n determine_object_root(@user, :person) => \"person\"\n determine_object_root([@user, @user]) => \"user\"", "Returns true if the obj is a collection of items\n is_collection?(@user) => false\n is_collection?([]) => true", "Returns an Engine based representation of any data object given ejs template block\n object_to_engine(@user) { attribute :full_name } => { ... }\n object_to_engine(@user, :source => \"...\") { attribute :full_name } => { ... }\n object_to_engine([@user], :source => \"...\") { attribute :full_name } => { ... }\n options must have :source (rabl file contents)\n options can have :source_location (source filename)", "Returns true if the cache has been enabled for the application", "Sets the object to be used as the data source for this template\n object(@user)\n object @user => :person\n object @users", "Sets the object as a collection casted to a simple array\n collection @users\n collection @users => :people\n collection @users, :root => :person\n collection @users, :object_root => :person", "Returns a guess at the default object for this template\n default_object => @user", "Returns a guess at the format in this context_scope\n request_format => \"xml\"", "Supports calling helpers defined for the template context_scope using method_missing hook", "Returns the rabl template path for padrino views using configured views", "Returns the rabl template path for Rails, including special lookups for Rails 2 and 3", "Returns the rabl template path for sinatra views using configured views", "Creates a child node that is included in json output\n child(@user) { attribute :full_name }\n child(@user => :person) { ... }\n child(@users => :people) { ... }", "Glues data from a child node to the json_output\n glue(@user) { attribute :full_name => :user_full_name }", "Calls permit! but doesn't raise authorization errors. If no exception is\n raised, permit? returns true and yields  to the optional block.", "Returns the role symbols of the given user.", "Returns the privilege hierarchy flattened for given privileges in context.", "resolves all the values in condition_hash", "may return an array of obligations to be OR'ed", "Consumes the given obligation, converting it into scope join and condition options.", "Parses the next step in the association path.  If it's an association, we advance down the\n path.  Otherwise, it's an attribute, and we need to evaluate it as a comparison operation.", "Adds the given expression to the current obligation's indicated path's conditions.\n\n Condition expressions must follow the format +[ <attribute>, <operator>, <value> ]+.", "Returns the model associated with the given path.", "Returns the reflection corresponding to the given path.", "Attempts to map a reflection for the given path.  Raises if already defined.", "Attempts to map a table alias for the given path.  Raises if already defined.", "If the user meets the given privilege, permitted_to? returns true\n and yields to the optional block.", "While permitted_to? is used for authorization, in some cases\n content should only be shown to some users without being concerned\n with authorization.  E.g. to only show the most relevant menu options\n to a certain group of users.  That is what has_role? should be used for.", "Intended to be used where you want to allow users with any single listed role to view\n the content in question", "As has_role? except checks all roles included in the role hierarchy", "As has_any_role? except checks all roles included in the role hierarchy", "Generates a +Fixnum+ hash value for this user object. Implemented to support equality.\n @return [Fixnum] The hash value.\n @see Object#hash\n Saves the room record to Redis, overwriting any previous data for the current ID.\n @return [void]", "Makes the robot join a room with the specified ID.\n @param room [Room, String] The room to join, as a {Room} object or a string identifier.\n @return [void]\n @since 3.0.0", "Makes the robot part from the room with the specified ID.\n @param room [Room, String] The room to leave, as a {Room} object or a string identifier.\n @return [void]\n @since 3.0.0", "Sends one or more messages to a user or room. If sending to a room,\n prefixes each message with the user's mention name.\n @param target [Source] The user or room to send to. If the Source\n   has a room, it will choose the room. Otherwise, it will send to the\n   user.\n @param strings [String, Array<String>] One or more strings to send.\n @return [void]\n @since 3.1.0", "Triggers an event, instructing all registered handlers to invoke any\n methods subscribed to the event, and passing them a payload hash of\n arbitrary data.\n @param event_name [String, Symbol] The name of the event to trigger.\n @param payload [Hash] An optional hash of arbitrary data.\n @return [void]", "Loads the selected adapter.", "Starts the web server.", "Adds a new HTTP route for the handler.", "Creates and configures a new HTTP route.", "Saves the user record to Redis, overwriting any previous data for the\n current ID and user name.\n @return [void]", "Replies by sending the given strings back to the user who sent the\n message directly, even if the message was sent in a room.\n @param strings [String, Array<String>] The strings to send back.\n @return [void]", "Validates an array of attributes, recursing if any nested attributes are encountered.", "Builds config.adapters", "Builds config.handlers", "Builds config.http", "Builds config.robot", "Sets a configuration attribute on the plugin.\n @return [void]\n @since 4.0.0\n @see ConfigurationBuilder#config", "Declares a configuration attribute.\n @param name [String, Symbol] The attribute's name.\n @param types [Object, Array<Object>] Optional: One or more types that the attribute's value\n   must be.\n @param type [Object, Array<Object>] Optional: One or more types that the attribute's value\n   must be.\n @param required [Boolean] Whether or not this attribute must be set. If required, and Lita\n   is run without it set, Lita will abort on start up with a message about it.\n @param default [Object] An optional default value for the attribute.\n @yield A block to be evaluated in the context of the new attribute. Used for\n   defining nested configuration attributes and validators.\n @return [void]", "Finalize a nested object.", "Finalize the root builder or any builder with children.", "Check's the value's type from inside the finalized object.", "Finds the first route that matches the request environment, if any. Does not trigger the\n route.\n @param env [Hash] A Rack environment.\n @return [Array] An array of the name of the first matching route.\n @since 4.0.0", "Registers routes in the router for each handler's defined routes.", "Checks if a user is in an authorization group.\n @param user [User] The user.\n @param group [Symbol, String] The name of the group.\n @return [Boolean] Whether or not the user is in the group.", "Checks if a user is an administrator.\n @param user [User] The user.\n @return [Boolean] Whether or not the user is an administrator.", "Returns a hash of authorization group names and the users in them.\n @return [Hash] A map of +Symbol+ group names to {User} objects.", "Allow custom route hooks to reject the route", "User must be in auth group if route is restricted.", "Create an empty object to use as the ERB context and set any provided variables in it.", "Starts Lita.\n @return [void]", "Outputs detailed stacktrace when there is a problem or exit 0 when OK.\n You can use this as a pre-check script for any automation\n @return [void]", "Merge schema data with provided schema\n\n @param [Hash, Prmd::Schema] schema\n @return [void]", "Convert Schema to JSON\n\n @return [String]", "Initializes new framer object.\n\n Generates common 9-byte frame header.\n - http://tools.ietf.org/html/draft-ietf-httpbis-http2-16#section-4.1\n\n @param frame [Hash]\n @return [String]", "Decodes common 9-byte header.\n\n @param buf [Buffer]", "Buffers outgoing DATA frames and applies flow control logic to split\n and emit DATA frames based on current flow control window. If the\n window is large enough, the data is sent immediately. Otherwise, the\n data is buffered until the flow control window is updated.\n\n Buffered DATA frames are emitted in FIFO order.\n\n @param frame [Hash]\n @param encode [Boolean] set to true by co", "Emit the connection preface if not yet", "Processes incoming HTTP 2.0 frames. The frames must be decoded upstream.\n\n @param frame [Hash]", "Processes outgoing HTTP 2.0 frames. Data frames may be automatically\n split and buffered based on maximum frame size and current stream flow\n control window size.\n\n @param frame [Hash]", "Sends a HEADERS frame containing HTTP response headers.\n All pseudo-header fields MUST appear in the header block before regular header fields.\n\n @param headers [Array or Hash] Array of key-value pairs or Hash\n @param end_headers [Boolean] indicates that no more headers will be sent\n @param end_stream [Boolean] indicates that no payload will be sent", "Sends DATA frame containing response payload.\n\n @param payload [String]\n @param end_stream [Boolean] indicates last response DATA frame", "Chunk data into max_size, yield each chunk, then return final chunk", "Handle locally initiated server-push event emitted by the stream.\n\n @param args [Array]\n @param callback [Proc]", "Subscribe to all future events for specified type.\n\n @param event [Symbol]\n @param block [Proc] callback function", "Emit event with provided arguments.\n\n @param event [Symbol]\n @param args [Array] arguments to be passed to the callbacks\n @param block [Proc] callback function", "Allocates new stream for current connection.\n\n @param priority [Integer]\n @param window [Integer]\n @param parent [Stream]", "Sends PING frame to the peer.\n\n @param payload [String] optional payload must be 8 bytes long\n @param blk [Proc] callback to execute when PONG is received", "Sends a GOAWAY frame indicating that the peer should stop creating\n new streams for current connection.\n\n Endpoints MAY append opaque data to the payload of any GOAWAY frame.\n Additional debug data is intended for diagnostic purposes only and\n carries no semantic value. Debug data MUST NOT be persistently stored,\n since it could contain sensitive information.\n\n @param error [Symbol]\n @param payload [String]", "Sends a connection SETTINGS frame to the peer.\n The values are reflected when the corresponding ACK is received.\n\n @param settings [Array or Hash]", "Applies HTTP 2.0 binary encoding to the frame.\n\n @param frame [Hash]\n @return [Array of Buffer] encoded frame", "Validate settings parameters.  See sepc Section 6.5.2.\n\n @param role [Symbol] The sender's role: :client or :server\n @return nil if no error.  Exception object in case of any error.", "Update connection settings based on parameters set by the peer.\n\n @param frame [Hash]", "Decode headers payload and update connection decompressor state.\n\n The receiver endpoint reassembles the header block by concatenating\n the individual fragments, then decompresses the block to reconstruct\n the header set - aka, header payloads are buffered until END_HEADERS,\n or an END_PROMISE flag is seen.\n\n @param frame [Hash]", "Encode headers payload and update connection compressor state.\n\n @param frame [Hash]\n @return [Array of Frame]", "Activates new incoming or outgoing stream and registers appropriate\n connection managemet callbacks.\n\n @param id [Integer]\n @param priority [Integer]\n @param window [Integer]\n @param parent [Stream]", "Emit GOAWAY error indicating to peer that the connection is being\n aborted, and once sent, raise a local exception.\n\n @param error [Symbol]\n @option error [Symbol] :no_error\n @option error [Symbol] :internal_error\n @option error [Symbol] :flow_control_error\n @option error [Symbol] :stream_closed\n @option error [Symbol] :frame_too_large\n @option error [Symbol] :compression_error\n @param msg [String]", "Create a build for the given commit.\n\n commit  - the Janky::Commit instance to build.\n user    - The login of the GitHub user who pushed.\n compare - optional String GitHub Compare View URL. Defaults to the\n           commit last build, if any.\n room_id - optional String room ID. Defaults to the room set on\n           the repository.\n\n Returns the newly created Janky::Build.", "Fetch the HEAD commit of this branch using the GitHub API and create a\n build and commit record.\n\n room_id - See build_for documentation. This is passed as is to the\n           build_for method.\n user    - Ditto.\n\n Returns the newly created Janky::Build.", "Human readable status of this branch\n\n Returns a String.", "Hash representation of this branch status.\n\n Returns a Hash with the name, status, sha1 and compare url.", "Calculate the name of the Jenkins job.\n\n Returns a String hash of this Repository name and uri.", "Run a copy of itself. Typically used to force a build in case of\n temporary test failure or when auto-build is disabled.\n\n new_room_id - optional Campfire room String ID. Defaults to the room of the\n               build being re-run.\n\n Returns the build copy.", "Mark the build as started.\n\n url - the full String URL of the build on the Jenkins server.\n now - the Time at which the build started.\n\n Returns nothing or raise an Error for weird transitions.", "Mark the build as complete, store the build output and notify Campfire.\n\n green - Boolean indicating build success.\n now   - the Time at which the build completed.\n\n Returns nothing or raise an Error for weird transitions.", "todo - memoize?", "Renders HTML table rows using given grid definition using columns defined in it.\n Allows to provide a custom layout for each for in place with a block\n\n Supported options:\n\n * <tt>:columns</tt> - Array of column names to display.\n   Used in case when same grid class is used in different places\n   and needs different columns. Default: all defined columns.\n * <tt>:partials</tt> - Path for partials lookup.\n   Default: 'datagrid'.\n\n   = datagrid_rows(grid) # Generic table rows Layout\n\n   = datagrid_rows(grid) do |row| # Custom Layout\n     %tr\n       %td= row.project_name\n       %td.project-status{class: row.status}= row.status", "Provides access to datagrid columns data.\n\n   # Suppose that <tt>grid</tt> has first_name and last_name columns\n   <%= datagrid_row(grid, user) do |row| %>\n     <tr>\n       <td><%= row.first_name %></td>\n       <td><%= row.last_name %></td>\n     </tr>\n   <% end %>\n\n Used in case you want to build html table completelly manually", "Generates an ascending or descending order url for the given column", "Returns a form input html for the corresponding filter name", "Returns a form label html for the corresponding filter name", "Create a Grouping node. This allows you to set balanced\n pairs of parentheses around your SQL.\n\n ==== Arguments\n\n * +expr+ - The expression to group.\n\n ==== Example\n     Post.where.has{_([summary, description]).in(...)}\n     #=> SELECT \"posts\".* FROM \"posts\" WHERE (\"posts\".\"summary\", \"posts\".\"description\") IN (...)\"\n     Post.select{[id, _(Comment.where.has{post_id == posts.id}.selecting{COUNT(id)})]}.as('comment_count')}\n     #=> SELECT \"posts\".\"id\", (SELECT COUNT(\"comments\".\"id\") FROM \"comments\" WHERE \"comments.post_id\" = \"posts\".\"id\") AS \"comment_count\" FROM \"posts\"", "this method allows setting the current_tenant by reading the subdomain and looking\n it up in the tenant-model passed to the method. The method will look for the subdomain\n in a column referenced by the second argument.", "This method sets up a method that allows manual setting of the current_tenant. This method should\n be used in a before_action. In addition, a helper is setup that returns the current_tenant", "Initialize a new Metric.\n\n watch       - The Watch.\n destination - The optional destination Hash in canonical hash form.\n Public: Instantiate the given Condition and pass it into the optional\n block. Attributes of the condition must be set in the config file.\n\n kind - The Symbol name of the condition.\n\n Returns nothing.", "Start the DRb server. Abort if there is already a running god instance\n on the socket.\n\n Returns nothing", "Verify that the minimum set of configuration requirements has been met.\n\n Returns true if valid, false if not.", "Move to the given state.\n\n to_state - The Symbol representing the state to move to.\n\n Returns this Task.", "Perform the given action.\n\n a - The Symbol action.\n c - The Condition.\n\n Returns this Task.", "Asynchronously evaluate and handle the given event condition. Handles\n logging notifications, and moving to the new state if necessary.\n\n condition - The Condition to handle.\n\n Returns nothing.", "Log info about the condition and return the list of messages logged.\n\n watch     - The Watch.\n metric    - The Metric.\n condition - The Condition.\n result    - The Boolean result of the condition test evaluation.\n\n Returns the Array of String messages.", "Format the destination specification for use in debug logging.\n\n metric    - The Metric.\n condition - The Condition.\n\n Returns the formatted String.", "Notify all recipients of the given condition with the specified message.\n\n condition - The Condition.\n message   - The String message to send.\n\n Returns nothing.", "Instantiate a new Logger object", "Get all log output for a given Watch since a certain Time.\n   +watch_name+ is the String name of the Watch\n   +since+ is the Time since which to fetch log lines\n\n Returns String", "Fetch the PID from pid_file. If the pid_file does not\n exist, then use the PID from the last time it was read.\n If it has never been read, then return nil.\n\n Returns Integer(pid) or nil", "Send the given signal to this process.\n\n Returns nothing", "Ensure that a stop command actually stops the process. Force kill\n if necessary.\n\n Returns nothing", "Wait until the queue has something due, pop it off the queue, and return\n it.\n\n Returns the popped event.", "Create and schedule a new DriverEvent.\n\n condition - The Condition.\n delay     - The Numeric number of seconds to delay (default: interval\n             defined in condition).\n\n Returns nothing.", "Perform the specifics of the action.\n\n condition - The Condition.\n action    - The Symbol action.\n\n Returns nothing.", "This is how the collection is loaded.\n\n You might want to overwrite this method if you want to add pagination\n for example. When you do that, don't forget to cache the result in an\n instance_variable:\n\n   def collection\n     @projects ||= end_of_association_chain.paginate(params[:page]).all\n   end", "This methods gets your begin_of_association_chain, join it with your\n parents chain and returns the scoped association.", "URL to redirect to when redirect implies collection url.", "extract attributes from params", "Defines wich actions will be inherited from the inherited controller.\n Syntax is borrowed from resource_controller.\n\n   actions :index, :show, :edit\n   actions :all, :except => :index", "A quick method to declare polymorphic belongs to.", "A quick method to declare singleton belongs to.", "A quick method to declare optional belongs to.", "Defines custom restful actions by resource or collection basis.\n\n   custom_actions :resource => [:delete, :transit], :collection => :search\n\n == Options\n\n * <tt>:resource</tt> -  Allows you to specify resource actions.\n     custom_actions :resource => :delete\n                         This macro creates 'delete' method in controller and defines\n                         delete_resource_{path,url} helpers. The body of generated 'delete'\n                         method is same as 'show' method. So you can override it if need\n\n * <tt>:collection</tt> - Allows you to specify collection actions.\n     custom_actions :collection => :search\n                         This macro creates 'search' method in controller and defines\n                         search_resources_{path,url} helpers. The body of generated 'search'\n                         method is same as 'index' method. So you can override it if need", "Initialize resources class accessors and set their default values.", "Maps parents_symbols to build association chain.\n\n If the parents_symbols find :polymorphic, it goes through the\n params keys to see which polymorphic parent matches the given params.\n\n When optional is given, it does not raise errors if the polymorphic\n params are missing.", "Create a Connection object.\n @param version [String] The Unsplash API version to use.\n @param api_base_uri [String] Base URI at which to make API calls.\n @param oauth_base_uri [String] Base URI for OAuth requests.\n Get OAuth URL for user authentication and authorization.\n @param requested_scopes [Array] An array of permission scopes being requested.\n @return [String] The authorization URL.", "Build an Unsplash object with the given attributes.\n @param attrs [Hash]\n (Re)load full object details from Unsplash.\n @return [Unspash::Client] Itself, with full details reloaded.", "Get a list of photos uploaded by the user.\n @param page  [Integer] Which page of results to return.\n @param per_page [Integer] The number of results per page.\n @return [Array] a list of +Unsplash::Photo+ objects.", "Get a list of collections created by the user.\n @param page  [Integer] Which page of results to return.\n @param per_page [Integer] The number of results per page. (default: 10, maximum: 30)\n @return [Array] a list of +Unsplash::Collection+ objects.", "Update the collection's attributes.\n @param title [String] The title of the collection.\n @param description [String] The collection's description. (optional)\n @param private [Boolean] Whether to make the collection private. (optional)", "Add a photo to the collection. If the photo is already in the collection,\n this action has no effect.\n @param [Unsplash::Photo] The photo to add.\n @return [Hash] Collected photo metadata.", "Remove a photo from the collection. If the photo is not in the collection,\n this action has no effect.\n @param [Unsplash::Photo] The photo to remove.\n @return [Boolean] +true+ on success.", "Returns a copy of this duration, omitting its seconds.", "session key of rucaptcha", "Generate a new Captcha", "Verify captcha code\n\n params:\n resource - [optional] a ActiveModel object, if given will add validation error message to object.\n :keep_session - if true, RuCaptcha will not delete the captcha code session.\n :captcha - if given, the value of it will be used to verify the captcha,\n            if do not give or blank, the value of params[:_rucaptcha] will be used to verify the captcha\n\n exmaples:\n\n   verify_rucaptcha?\n   verify_rucaptcha?(user, keep_session: true)\n   verify_rucaptcha?(nil, keep_session: true)\n   verify_rucaptcha?(nil, captcha: params[:user][:captcha])", "Generate a fresh new certificate for the configured domain.", "Just pass all certificates into the new instance. We use the variadic\n argument feature here to ease the usage and improve the readability.\n\n Example:\n\n   certs_chain_file = Billy::CertificateChain.new('localhost',\n                                                  cert1,\n                                                  cert2, ..).file\n Write out the certificates chain file and pass the path back. This will\n produce a temporary file which will be remove after the current process\n terminates.", "Name of the connection pool. Used by ConnectionHandler to retrieve the current connection pool.", "Insert an XML declaration into the XML markup.\n\n For example:\n\n   xml.declare! :ELEMENT, :blah, \"yada\"\n       # => <!ELEMENT blah \"yada\">", "Insert a processing instruction into the XML markup.  E.g.\n\n For example:\n\n    xml.instruct!\n        #=> <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n    xml.instruct! :aaa, :bbb=>\"ccc\"\n        #=> <?aaa bbb=\"ccc\"?>\n\n Note: If the encoding is setup to \"UTF-8\" and the value of\n $KCODE is \"UTF8\", then builder will emit UTF-8 encoded strings\n rather than the entity encoding normally used.", "Insert special instruction.", "Create XML markup based on the name of the method.  This method\n is never invoked directly, but is called for each markup method\n in the markup block that isn't cached.", "If XmlBase.cache_method_calls = true, we dynamicly create the method\n missed as an instance method on the XMLBase object. Because XML\n documents are usually very repetative in nature, the next node will\n be handled by the new method instead of method_missing. As\n method_missing is very slow, this speeds up document generation\n significantly.", "Same as +render_to_string+ but writes the processed template to +output_path+.", "Adds a new tag to the permitted tags hash or replaces an existing one", "Same as pool, but links to the pool manager", "Create a new actor and link to the current one", "Wait for the given signal and return the associated value", "Send a signal to the first task waiting on this condition", "Broadcast a value to all waiting tasks and threads", "Execute the given method in future context", "Obtain the value for this Future", "Signal this future with the given result value", "Run the actor loop", "Perform a linking request with another actor", "Receive an asynchronous message", "Handle standard low-priority messages", "Handle any exceptions that occur within a running actor", "Handle cleaning up this actor after it exits", "Clean up after this actor", "Suspend the current task, changing the status to the given argument", "Resume a suspended task, giving it a value to return if needed", "Terminate this task", "Run the user-defined finalizer, if one is set", "Add a message to the Mailbox", "Receive a message from the Mailbox. May return nil and may return before\n the specified timeout.", "Receive a letter from the mailbox. Guaranteed to return a message. If\n timeout is exceeded, raise a TaskTimeout.", "Shut down this mailbox and clean up its contents", "Retrieve the next message in the mailbox", "Merge two incidents together. This may be useful if two incidents occur at the same time.", "Handle high-priority system event messages", "Create a new IncidentLogger.\n add an event.", "returns decrypted_message, status, desc, lines", "actually distribute the message", "apparently it's a million times faster to call this directly if\n we're just moving messages around on disk, than reading things\n into memory with raw_message.", "must be called first with the default account. fills in missing\n values from the default account.", "open up a thread view window", "both spam and deleted have the curious characteristic that you\n always want to hide the thread after either applying or removing\n that label. in all thread-index-views except for\n label-search-results-mode, when you mark a message as spam or\n deleted, you want it to disappear immediately; in LSRM, you only\n see deleted or spam emails, and when you undelete or unspam them\n you also want them to disappear immediately.", "see comment for multi_toggle_spam", "m-m-m-m-MULTI-KILL", "used to tag threads by query. this can be made a lot more sophisticated,\n but for right now we'll do the obvious this.", "preserve author order from the thread", "s nil means a blank line!", "we reset force_to_top when rolling buffers. this is so that the\n human can actually still move buffers around, while still\n programmatically being able to pop stuff up in the middle of\n drawing a window without worrying about covering it up.\n\n if we ever start calling roll_buffers programmatically, we will\n have to change this. but it's not clear that we will ever actually\n do that.", "returns an array of labels", "for simplicitly, we always place the question at the very bottom of the\n screen", "this may not actually be called anywhere, since we still keep contacts\n around without aliases to override any fullname changes.", "here we generate the actual content lines. we accumulate\n everything into @text, and we set @chunk_lines and\n @message_lines, and we update @layout.", "Return the number of matches for query in the index", "Load message with the given message-id from the index", "Given an array of email addresses, return an array of Person objects that\n have sent mail to or received mail from any of the given addresses.", "Index content that can't be changed by the user", "Construct a Xapian term", "link two containers", "loads in all messages needed to thread m\n may do nothing if m's thread is killed", "merges in a pre-loaded thread", "merges two threads together. both must be members of this threadset.\n does its best, heuristically, to determine which is the parent.", "the heart of the threading code", "this is called when the message body needs to actually be loaded.", "returns all the content from a message that will be indexed", "here's where we handle decoding mime attachments. unfortunately\n but unsurprisingly, the world of mime attachments is a bit of a\n mess. as an empiricist, i'm basing the following behavior on\n observed mail rather than on interpretations of rfcs, so probably\n this will have to be tweaked.\n\n the general behavior i want is: ignore content-disposition, at\n least in so far as it suggests something being inline vs being an\n attachment. (because really, that should be the recipient's\n decision to make.) if a mime part is text/plain, OR if the user\n decoding hook converts it, then decode it and display it\n inline. for these decoded attachments, if it has associated\n filename, then make it collapsable and individually saveable;\n otherwise, treat it as regular body text.\n\n everything else is just an attachment and is not displayed\n inline.\n\n so, in contrast to mutt, the user is not exposed to the workings\n of the gruesome slaughterhouse and sausage factory that is a\n mime-encoded message, but need only see the delicious end\n product.", "reverse the label->string mapping, for convenience!", "subclasses can override these three!", "set top line to l", "more complicated than one might think. three behaviors.", "ncurses inanity wrapper\n\n DO NOT READ THIS CODE. YOU WILL GO MAD.", "Trigger the success callback function attached to the client event that triggered\n this action. The object passed to this method will be passed as an argument to\n the callback function on the client.", "Trigger the failure callback function attached to the client event that triggered\n this action. The object passed to this method will be passed as an argument to\n the callback function on the client.", "Sends a message to the client that initiated the current event being executed. Messages\n are serialized as JSON into a two element Array where the first element is the event\n and the second element is the message that was passed, typically a Hash.\n\n To send an event under a namespace, add the `:namespace => :target_namespace` option.\n\n   send_message :new_message, message_hash, :namespace => :product\n\n Nested namespaces can be passed as an array like the following:\n\n   send_message :new, message_hash, :namespace => [:products,:glasses]\n\n See the {EventMap} documentation for more on mapping namespaced actions.", "Reloads the controller class to pick up code changes\n while in the development environment.", "Primary entry point for the Rack application", "Use the bare minimum to redirect to legacy page\n\n Don't use query string of legacy urlname.\n This drops the given query string.", "Updates all related contents by calling +update_essence+ on each of them.\n\n @param contents_attributes [Hash]\n   Hash of contents attributes.\n   The keys has to be the #id of the content to update.\n   The values a Hash of attribute names and values\n\n @return [Boolean]\n   True if +errors+ are blank or +contents_attributes+ hash is nil\n\n == Example\n\n   @element.update_contents(\n     \"1\" => {ingredient: \"Title\"},\n     \"2\" => {link: \"https://google.com\"}\n   )", "Copy current content's contents to given target element", "Returns the definition for given content_name", "Returns an array of all EssenceRichtext contents ids from elements\n\n This is used to re-initialize the TinyMCE editor in the element editor.", "creates the contents for this element as described in the elements.yml", "All available element definitions that can actually be placed on current page.\n\n It extracts all definitions that are unique or limited and already on page.\n\n == Example of unique element:\n\n   - name: headline\n     unique: true\n     contents:\n     - name: headline\n       type: EssenceText\n\n == Example of limited element:\n\n   - name: article\n     amount: 2\n     contents:\n     - name: text\n       type: EssenceRichtext", "Available element definitions excluding nested unique elements.", "All element definitions defined for page's page layout including nestable element definitions", "Looks in the page_layout descripion, if there are elements to autogenerate.\n\n And if so, it generates them.", "Deletes limited and outnumbered definitions from @_element_definitions.", "Define a page layout callback\n\n Pass a block or method name in which you have the +@page+ object available and can do\n everything as if you were in a normal controller action.\n\n Pass a +Alchemy::PageLayout+ name, an array of names, or +:all+ to\n evaluate the callback on either some specific or all the pages.", "Serialized object representation for json api", "Updates the essence.\n\n Called from +Alchemy::Element#update_contents+\n\n Adds errors to self.base if essence validation fails.", "Block-level helper for element views. Constructs a DOM element wrapping\n your content element and provides a block helper object you can use for\n concise access to Alchemy's various helpers.\n\n === Example:\n\n   <%= element_view_for(element) do |el| %>\n     <%= el.render :title %>\n     <%= el.render :body %>\n     <%= link_to \"Go!\", el.ingredient(:target_url) %>\n   <% end %>\n\n You can override the tag, ID and class used for the generated DOM\n element:\n\n   <%= element_view_for(element, tag: 'span', id: 'my_id', class: 'thing') do |el| %>\n      <%- ... %>\n   <% end %>\n\n If you don't want your view to be wrapped into an extra element, simply set\n `tag` to `false`:\n\n   <%= element_view_for(element, tag: false) do |el| %>\n      <%- ... %>\n   <% end %>\n\n @param [Alchemy::Element] element\n   The element to display.\n @param [Hash] options\n   Additional options.\n\n @option options :tag (:div)\n   The HTML tag to be used for the wrapping element.\n @option options :id (the element's dom_id)\n   The wrapper tag's DOM ID.\n @option options :class (the element's essence name)\n   The wrapper tag's DOM class.\n @option options :tags_formatter\n   A lambda used for formatting the element's tags (see Alchemy::ElementsHelper::element_tags_attributes). Set to +false+ to not include tags in the wrapper element.", "Returns a path to picture for use inside a image_tag helper.\n\n Any additional options are passed to the url_helper, so you can add arguments to your url.\n\n Example:\n\n   <%= image_tag picture.url(size: '320x200', format: 'png') %>", "Returns the processed image dependent of size and cropping parameters", "Returns the encoded image\n\n Flatten animated gifs, only if converting to a different format.\n Can be overwritten via +options[:flatten]+.", "Returns the value from resource attribute\n\n If the attribute has a relation, the related object's attribute value will be returned.\n\n The output will be truncated after 50 chars.\n Pass another number to truncate then and pass false to disable this completely.\n\n @param [Alchemy::Resource] resource\n @param [Hash] attribute\n @option options [Hash] :truncate (50) The length of the value returned.\n @option options [Hash] :datetime_format (alchemy.default) The format of timestamps.\n @option options [Hash] :time_format (alchemy.time) The format of time values.\n\n @return [String]", "Returns a options hash for simple_form input fields.", "Renders the row for a resource record in the resources table.\n\n This helper has a nice fallback. If you create a partial for your record then this partial will be rendered.\n\n Otherwise the default +app/views/alchemy/admin/resources/_resource.html.erb+ partial gets rendered.\n\n == Example\n\n For a resource named +Comment+ you can create a partial named +_comment.html.erb+\n\n   # app/views/admin/comments/_comment.html.erb\n   <tr>\n     <td><%= comment.title %></td>\n     <td><%= comment.body %></td>\n   </tr>\n\n NOTE: Alchemy gives you a local variable named like your resource", "Returns all attribute names that are searchable in the admin interface", "Returns a help text for resource's form\n\n === Example:\n\n   de:\n     alchemy:\n       resource_help_texts:\n         my_resource_name:\n           attribute_name: This is the fancy help text", "Expands the resource_relations hash with matching activerecord associations data.", "Stores all activerecord associations in model_associations attribute", "Prints out all the todos", "Prints out the given log message with the color due to its type\n\n @param [String] message\n @param [Symbol] type", "Gives the color string using Thor\n Used for colorizing the message on the shell\n\n @param [String] name\n @return [String]", "Picture rendering options\n\n Returns the +default_render_format+ of the associated +Alchemy::Picture+\n together with the +crop_from+ and +crop_size+ values\n\n @return [HashWithIndifferentAccess]", "Returns an url for the thumbnail representation of the assigned picture\n\n It takes cropping values into account, so it always represents the current\n image displayed in the frontend.\n\n @return [String]", "A Hash of coordinates suitable for the graphical image cropper.\n\n @return [Hash]", "Show image cropping link for content and options?", "Returns a hint\n\n To add a hint to a content pass +hint: true+ to the element definition in its element.yml\n\n Then the hint itself is placed in the locale yml files.\n\n Alternativly you can pass the hint itself to the hint key.\n\n == Locale Example:\n\n   # elements.yml\n   - name: headline\n     contents:\n     - name: headline\n       type: EssenceText\n       hint: true\n\n   # config/locales/de.yml\n     de:\n       content_hints:\n         headline: Lorem ipsum\n\n == Hint Key Example:\n\n   - name: headline\n     contents:\n     - name: headline\n       type: EssenceText\n       hint: Lorem ipsum\n\n @return String", "Returns the default centered image mask for a given size.\n If the mask is bigger than the image, the mask is scaled down\n so the largest possible part of the image is visible.", "Returns a size value String for the thumbnail used in essence picture editors.", "Returns the rendered cropped image. Tries to use the crop_from and crop_size\n parameters. When they can't be parsed, it just crops from the center.", "This function takes a target and a base dimensions hash and returns\n the dimensions of the image when the base dimensions hash fills\n the target.\n\n Aspect ratio will be preserved.", "Uses imagemagick to make a centercropped thumbnail. Does not scale the image up.", "Use imagemagick to custom crop an image. Uses -thumbnail for better performance when resizing.", "Used when centercropping.", "Returns the previous page on the same level or nil.\n\n @option options [Boolean] :restricted (false)\n   only restricted pages (true), skip restricted pages (false)\n @option options [Boolean] :public (true)\n   only public pages (true), skip public pages (false)", "Publishes the page.\n\n Sets +public_on+ and the +published_at+ value to current time\n and resets +public_until+ to nil\n\n The +published_at+ attribute is used as +cache_key+.", "Stores the old urlname in a LegacyPageUrl", "Returns true if the page cache control headers should be set.\n\n == Disable Alchemy's page caching globally\n\n     # config/alchemy/config.yml\n     ...\n     cache_pages: false\n\n == Disable caching on page layout level\n\n     # config/alchemy/page_layouts.yml\n     - name: contact\n       cache: false\n\n == Note:\n\n This only sets the cache control headers and skips rendering of the page body,\n if the cache is fresh.\n This does not disable the fragment caching in the views.\n So if you don't want a page and it's elements to be cached,\n then be sure to not use <% cache element %> in the views.\n\n @returns Boolean", "Set a list of tags\n Pass a String with comma separated tag names or\n an Array of tag names", "sends file as attachment. aka download", "Returns a security token for signed picture rendering requests.\n\n Pass a params hash containing:\n\n   size       [String]  (Optional)\n   crop       [Boolean] (Optional)\n   crop_from  [String]  (Optional)\n   crop_size  [String]  (Optional)\n   quality    [Integer] (Optional)\n\n to sign them.", "Makes a slug of all ancestors urlnames including mine and delimit them be slash.\n So the whole path is stored as urlname in the database.", "Converts the given name into an url friendly string.\n\n Names shorter than 3 will be filled up with dashes,\n so it does not collidate with the language code.", "== Renders the element view partial\n\n === Accepted Formats\n\n * html\n * js (Tries to replace a given +container_id+ with the elements view partial content via jQuery.)", "Render a Fontawesome icon\n\n @param icon_class [String] Fontawesome icon name\n @param size: nil [String] Fontawesome icon size\n @param transform: nil [String] Fontawesome transform style\n\n @return [String]", "Checks if the given argument is a String or a Page object.\n If a String is given, it tries to find the page via page_layout\n Logs a warning if no page is given.", "== Loads page by urlname\n\n If a locale is specified in the request parameters,\n scope pages to it to make sure we can raise a 404 if the urlname\n is not available in that language.\n\n @return Alchemy::Page\n @return NilClass", "We only render the page if either the cache is disabled for this page\n or the cache is stale, because it's been republished by the user.", "Renders the +Essence+ view partial from +Element+ by name.\n\n Pass the name of the +Content+ from +Element+ as second argument.\n\n == Example:\n\n This renders the +Content+ named \"intro\" from element.\n\n   <%= render_essence_view_by_name(element, \"intro\") %>", "Renders the +Esssence+ partial for given +Content+.\n\n The helper renders the view partial as default.\n\n Pass +:editor+ as second argument to render the editor partial\n\n == Options:\n\n You can pass a options Hash to each type of essence partial as third argument.\n\n This Hash is available as +options+ local variable.\n\n   for_view: {}\n   for_editor: {}", "The current authorized user.\n\n In order to have Alchemy's authorization work, you have to\n provide a +current_user+ method in your app's ApplicationController,\n that returns the current user. To change the method +current_alchemy_user+\n will call, set +Alchemy.current_user_method+ to a different method name.\n\n If you don't have an App that can provide a +current_user+ object,\n you can install the `alchemy-devise` gem that provides everything you need.", "Try to find and stores current language for Alchemy.", "Stores language's id in the session.\n\n Also stores language in +Language.current+", "Renders elements from given page\n\n == Examples:\n\n === Render only certain elements:\n\n   <header>\n     <%= render_elements only: ['header', 'claim'] %>\n   </header>\n   <section id=\"content\">\n     <%= render_elements except: ['header', 'claim'] %>\n   </section>\n\n === Render elements from global page:\n\n   <footer>\n     <%= render_elements from_page: 'footer' %>\n   </footer>\n\n === Fallback to elements from global page:\n\n You can use the fallback option as an override for elements that are stored on another page.\n So you can take elements from a global page and only if the user adds an element on current page the\n local one gets rendered.\n\n 1. You have to pass the the name of the element the fallback is for as <tt>for</tt> key.\n 2. You have to pass a <tt>page_layout</tt> name or {Alchemy::Page} from where the fallback elements is taken from as <tt>from</tt> key.\n 3. You can pass the name of element to fallback with as <tt>with</tt> key. This is optional (the element name from the <tt>for</tt> key is taken as default).\n\n   <%= render_elements(fallback: {\n     for: 'contact_teaser',\n     from: 'sidebar',\n     with: 'contact_teaser'\n   }) %>\n\n === Custom elements finder:\n\n Having a custom element finder class:\n\n   class MyCustomNewsArchive\n     def elements(page:)\n       news_page.elements.available.named('news').order(created_at: :desc)\n     end\n\n     private\n\n     def news_page\n       Alchemy::Page.where(page_layout: 'news-archive')\n     end\n   end\n\n In your view:\n\n   <div class=\"news-archive\">\n     <%= render_elements finder: MyCustomNewsArchive.new %>\n   </div>\n\n @option options [Alchemy::Page|String] :from_page (@page)\n   The page the elements are rendered from. You can pass a page_layout String or a {Alchemy::Page} object.\n @option options [Array<String>|String] :only\n   A list of element names only to be rendered.\n @option options [Array<String>|String] :except\n   A list of element names not to be rendered.\n @option options [Number] :count\n   The amount of elements to be rendered (begins with first element found)\n @option options [Number] :offset\n   The offset to begin loading elements from\n @option options [Hash] :fallback\n   Define elements that are rendered from another page.\n @option options [Boolean] :random (false)\n   Randomize the output of elements\n @option options [Boolean] :reverse (false)\n   Reverse the rendering order\n @option options [String] :separator\n   A string that will be used to join the element partials.\n @option options [Class] :finder (Alchemy::ElementsFinder)\n   A class instance that will return elements that get rendered.\n   Use this for your custom element loading logic in views.", "Renders the HTML tag attributes required for preview mode.", "Returns the element's tags information as an attribute hash.\n\n @param [Alchemy::Element] element The {Alchemy::Element} you want to render the tags from.\n\n @option options [Proc] :formatter\n   ('lambda { |tags| tags.join(' ') }')\n   Lambda converting array of tags to a string.\n\n @return [Hash]\n   HTML tag attributes containing the element's tag information.", "Returns next public element from same page.\n\n Pass an element name to get next of this kind.", "Copy all nested elements from current element to given target element.", "Essence validation errors\n\n == Error messages are translated via I18n\n\n Inside your translation file add translations like:\n\n   alchemy:\n     content_validations:\n       name_of_the_element:\n         name_of_the_content:\n           validation_error_type: Error Message\n\n NOTE: +validation_error_type+ has to be one of:\n\n   * blank\n   * taken\n   * invalid\n\n === Example:\n\n   de:\n     alchemy:\n       content_validations:\n         contactform:\n           email:\n             invalid: 'Die Email hat nicht das richtige Format'\n\n\n == Error message translation fallbacks\n\n In order to not translate every single content for every element\n you can provide default error messages per content name:\n\n === Example\n\n   en:\n     alchemy:\n       content_validations:\n         fields:\n           email:\n             invalid: E-Mail has wrong format\n             blank: E-Mail can't be blank\n\n And even further you can provide general field agnostic error messages:\n\n === Example\n\n   en:\n     alchemy:\n       content_validations:\n         errors:\n           invalid: %{field} has wrong format\n           blank: %{field} can't be blank", "Renders links to language root pages of all published languages.\n\n @option options linkname [String] ('name')\n   Renders name/code of language, or I18n translation for code.\n\n @option options show_title [Boolean] (true)\n   Renders title attributes for the links.\n\n @option options spacer [String] ('')\n   Renders the passed spacer string. You can also overwrite the spacer partial: \"alchemy/language_links/_spacer\".\n\n @option options reverse [Boolean] (false)\n   Reverses the ordering of the links.", "Renders the navigation.\n\n It produces a html <ul><li></li></ul> structure with all necessary classes so you can produce every navigation the web uses today.\n I.E. dropdown-navigations, simple mainnavigations or even complex nested ones.\n\n === HTML output:\n\n   <ul class=\"navigation level_1\">\n     <li class=\"first home\"><a href=\"/home\" class=\"active\" title=\"Homepage\" lang=\"en\" data-page-id=\"1\">Homepage</a></li>\n     <li class=\"contact\"><a href=\"/contact\" title=\"Contact\" lang=\"en\" data-page-id=\"2\">Contact</a></li>\n     <li class=\"last imprint\"><a href=\"/imprint\" title=\"Imprint\" lang=\"en\" data-page-id=\"3\">Imprint</a></li>\n   </ul>\n\n As you can see: Everything you need.\n\n Not pleased with the way Alchemy produces the navigation structure?\n\n Then feel free to overwrite the partials (_renderer.html.erb and _link.html.erb) found in +views/navigation/+ or pass different partials via the options +:navigation_partial+ and +:navigation_link_partial+.\n\n === Passing HTML classes and ids to the renderer\n\n A second hash can be passed as html_options to the navigation renderer partial.\n\n ==== Example:\n\n   <%= render_navigation({from_page: 'subnavi'}, {class: 'navigation', id: 'subnavigation'}) %>\n\n\n @option options submenu [Boolean] (false)\n   Do you want a nested <ul> <li> structure for the deeper levels of your navigation, or not?\n   Used to display the subnavigation within the mainnaviagtion. I.e. for dropdown menues.\n\n @option options all_sub_menues [Boolean] (false)\n   Renders the whole page tree.\n\n @option options from_page [Alchemy::Page] (@root_page)\n   Do you want to render a navigation from a different page then the current page?\n   Then pass an Page instance or a Alchemy::PageLayout name as string.\n\n @option options spacer [String] (nil)\n   A spacer for the entries can be passed.\n   Simple string, or even a complex html structure.\n   I.e: \"<span class='spacer'>|</spacer>\".\n\n @option options navigation_partial [String] (\"navigation/renderer\")\n   Pass a different partial to be taken for the navigation rendering.\n   Alternatively you could override the +app/views/alchemy/navigation/renderer+ partial in your app.\n\n @option options navigation_link_partial [String] (\"navigation/link\")\n   Alchemy places an <a> html link in <li> tags.\n   The tag automatically has an active css class if necessary.\n   So styling is everything. But maybe you don't want this.\n   So feel free to make you own partial and pass the filename here.\n   Alternatively you could override the +app/views/alchemy/navigation/link+ partial in your app.\n\n @option options show_nonactive [Boolean] (false)\n   Commonly Alchemy only displays the submenu of the active page (if submenu: true).\n   If you want to display all child pages then pass true (together with submenu: true of course).\n   I.e. for css-driven drop down menues.\n\n @option options show_title [Boolean] (true)\n   For our beloved SEOs :)\n   Appends a title attribute to all links and places the +page.title+ content into it.\n\n @option options restricted_only [Boolean] (false)\n   Render only restricted pages. I.E for members only navigations.\n\n @option options reverse [Boolean] (false)\n   Reverse the output of the pages\n\n @option options reverse_children [Boolean] (false)\n   Like reverse option, but only reverse the children of the first level\n\n @option options deepness [Fixnum] (nil)\n   Show only pages up to this depth.", "Returns +'active'+ if the given external page is in the current url path or +nil+.", "Returns page links in a breadcrumb beginning from root to current page.\n\n === Options:\n\n   separator: %(<span class=\"separator\">></span>)      # Maybe you don't want this separator. Pass another one.\n   page: @page                                         # Pass a different Page instead of the default (@page).\n   without: nil                                        # Pass Page object or array of Pages that must not be displayed.\n   restricted_only: false                              # Pass boolean for displaying restricted pages only.\n   reverse: false                                      # Pass boolean for displaying breadcrumb in reversed reversed.", "Returns current page title\n\n === Options:\n\n   prefix: \"\"                 # Prefix\n   separator: \"\"              # Separating prefix and title", "Returns all pages as json object", "Returns all pages as nested json object for tree views\n\n Pass a page_id param to only load tree for this page\n\n Pass elements=true param to include elements for pages", "Returns all elements as json object\n\n You can either load all or only these for :page_id param\n\n If you want to only load a specific type of element pass ?named=an_element_name", "Decides if the locale should be prefixed to urls\n\n If the current language's locale (or the optionally passed in locale)\n matches the current I18n.locale then the prefix os omitted.\n Also, if only one published language exists.", "Get the module definition for given module name\n\n You can also pass a hash of an module definition.\n It then tries to find the module defintion from controller name and action name", "Returns all contents as json object\n\n You can either load all or only these for :element_id param", "Returns a json object for content\n\n You can either load it from :id param\n or even more useful via passing the element id and the name of the content\n\n   $ bin/rake routes\n\n for more infos on how the url looks like.", "If no languages are present, create a default language based\n on the host app's Alchemy configuration.", "Returns the correct params-hash for passing to show_page_path", "Page url with or without locale while keeping all additional params", "Make a model bookable", "Validation method. Check if the bookable resource is actually bookable", "Validation method. Check if the booker model is actually a booker", "Buids selenium driver for a cloud service\n @param app [<Rack>] a rack application that this server will contain\n @param caps [Hash] remote capabilities\n @param url [String] a remote hub url\n @return [Capybara::Selenium::Driver]", "Use per-instance logger instead of the default per-class logger\n\n Sets the instance variable returned by #logger\n\n @return [Logger]", "Delete all stack resources that were not applied\n @param client [K8s::Client]\n @param keep_resources [NilClass, Boolean]\n @param skip_forbidden [Boolean]", "Returns nils for any resources that do not exist.\n This includes custom resources that were not yet defined.\n\n @param resources [Array<K8s::Resource>]\n @return [Array<K8s::Resource, nil>] matching resources array 1:1", "Get Shipping labels", "Calculates a timestamp that corresponds a given number of business days in the future\n\n @param days [Integer] The number of business days from now.\n @return [DateTime] A timestamp, the provided number of business days in the future.", "Adds a package to this rate estimate\n @param package [ActiveShipping::Package] The package to add.\n @param rate [#cents, Float, String, nil] The rate for this package. This is only required if\n   there is no total price for this shipment\n @return [self]", "line_items should be a list of PackageItem's", "Use it when CSV file contain redundant columns\n\n Example:\n\n ActiveAdmin.register Post\n   active_admin_import before_batch_import: lambda { |importer|\n                         importer.batch_slice_columns(['name', 'birthday'])\n                       }\n end", "Does this PageStore contain the specified URL?\n HTTP and HTTPS versions of a URL are considered to be the same page.", "Perform the crawl", "Freeze the opts Hash so that no options can be modified\n once the crawl begins", "Allowed to connect to the requested url?", "Create a new Tentacle\n\n\n Gets links from @link_queue, and returns the fetched\n Page objects into @page_queue", "Check whether default filters should be applied.\n\n @param records [ActiveRecord::Relation, Array] collection of records\n   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]\n\n @param options [Hash] JU's options\n   e.g.: { filter: false, paginate: false }\n\n @return [Boolean]\n\n @api public", "Build a Hash with the default filters.\n\n @return [Hash, NilClass]\n\n @api public", "Build a Hash with the sort criteria.\n\n @return [Hash, NilClass]\n\n @api public", "Instantiate the request object.\n\n @return [JSONAPI::RequestParser]\n\n @api public", "Extract params from request and build a Hash with params\n for either the main resource or relationships.\n\n @return [Hash]\n\n @api private", "after delayed interpolation", "Typecasts a value using a Class\n\n @param [#call] typecaster The typecaster to use for typecasting\n @param [Object] value The value to be typecasted\n\n @return [Object, nil] The typecasted value or nil if it cannot be\n   typecasted\n\n @since 0.5.0", "Returns the class name plus its attributes\n\n @example Inspect the model.\n   person.inspect\n\n @return [String] Human-readable presentation of the attribute\n   definitions\n\n @since 0.2.0", "Creates a new AttributeDefinition\n\n @example Create an attribute defintion\n   AttributeDefinition.new(:amount)\n\n @param [Symbol, String, #to_sym] name attribute name\n @param [Hash{Symbol => Object}] options attribute options\n\n @return [ActiveAttr::AttributeDefinition]\n\n @since 0.2.0\n Returns the code that would generate the attribute definition\n\n @example Inspect the attribute definition\n   attribute.inspect\n\n @return [String] Human-readable presentation of the attribute\n   definition\n\n @since 0.6.0", "Applies the attribute defaults\n\n Applies all the default values to any attributes not yet set, avoiding\n any attribute setter logic, such as dirty tracking.\n\n @example Usage\n   class Person\n     include ActiveAttr::AttributeDefaults\n\n     attribute :first_name, :default => \"John\"\n\n     def reset!\n       @attributes = {}\n       apply_defaults\n     end\n   end\n\n   person = Person.new(:first_name => \"Chris\")\n   person.reset!\n   person.first_name #=> \"John\"\n\n @param [Hash{String => Object}, #each] defaults The defaults to apply\n\n @since 0.5.0", "Calculates an attribute default\n\n @private\n @since 0.5.0", "Rails 3.0 and 4.0 do not take a role argument for the sanitizer\n @since 0.7.0", "Returns the user who is responsible for any changes that occur.\n By default this calls `current_user` and returns the result.\n\n Override this method in your controller to call a different\n method, e.g. `current_person`, or anything you like.", "Set exception information for this DirmonEntry and fail it", "Archives the file and kicks off a proxy job to upload the file.", "strip whitespaces from all variables that reference paths or patterns", "Move the file to the archive directory\n\n The archived file name is prefixed with the job id\n\n Returns [String] the fully qualified archived file name\n\n Note:\n - Works across partitions when the file and the archive are on different partitions", "Validates job_class is a Rocket Job", "Does the job have all the supplied properties", "In a standalone environment, explicitly load config files", "Create a PID file if requested", "Parse command line options placing results in the corresponding instance variables", "Process jobs until it shuts down\n\n Params\n   worker_id [Integer]\n     The number of this worker for logging purposes", "Resets the current job filter if the relevant time interval has passed", "Returns the previous time the cronline matched. It's like next_time, but\n for the past.", "Add new workers to get back to the `max_workers` if not already at `max_workers`\n   Parameters\n     stagger_start\n       Whether to stagger when the workers poll for work the first time.\n       It spreads out the queue polling over the max_poll_seconds so\n       that not all workers poll at the same time.\n       The worker also responds faster than max_poll_seconds when a new job is created.", "Export the Results hash to a CSV file", "create a new event identical to the old event except for the provided changes\n\n @param attributes [Hash]\n @return Event\n @example\n     old_event = EventSourcery::Event.new(type: \"item_added\", causation_id: nil)\n     new_event = old_event.with(causation_id: \"05781bd6-796a-4a58-8573-b109f683fd99\")\n\n     new_event.type # => \"item_added\"\n     new_event.causation_id # => \"05781bd6-796a-4a58-8573-b109f683fd99\"\n\n     old_event.type # => \"item_added\"\n     old_event.causation_id # => nil\n\n     # Of course, with can accept any number of event attributes:\n\n     new_event = old_event.with(id: 42, version: 77, body: { 'attr' => 'value' })\n\n     # When using typed events you can also override the event class:\n\n     new_event = old_event.with(event_class: ItemRemoved)\n     new_event.type # => \"item_removed\"\n     new_event.class # => ItemRemoved", "returns a hash of the event attributes\n\n @return Hash", "Parses file into final docset that can be fed into Aggregator", "Parses the file depending on filename as JS or SCSS", "Parses the docs, detects tagname and expands class docset", "Merges comment and code parts of docset", "Given the name and contents of a source file, reads the already\n parsed data structure from cache.  Returns nil when not found.", "Writes parse data into cache under a name generated from the\n name and contents of a source file.", "Parses guides config file\n Writes all guides to given dir in JsonP format", "Ensures the guide dir contains icon.png.\n When there isn't looks for icon-lg.png and renames it to icon.png.\n When neither exists, copies over default icon.", "When class exists, merge it with class node.\n Otherwise add as new class.", "Merges new class-doc into old one.", "Tries to place members into classes where they belong.\n\n @member explicitly defines the containing class, but we can meet\n item with @member=Foo before we actually meet class Foo - in\n that case we register them as orphans.  (Later when we finally\n meet class Foo, orphans are inserted into it.)\n\n Items without @member belong by default to the preceding class.\n When no class precedes them - they too are orphaned.", "Inserts available orphans to class", "Applies default merge algorithm to the rest of the data.", "merges second members hash into first one", "Invoked when merge! finds two members with the same name.\n New member always overrides the old, but inside new we keep\n a list of members it overrides.  Normally one member will\n override one other member, but a member from mixin can override\n multiple members - although there's not a single such case in\n ExtJS, we have to handle it.\n\n Every overridden member is listed just once.", "Returns all members of a class that have been marked as new, or\n have parameters marked as new.", "Inserts table of contents at the top of guide HTML by looking\n for headings at or below the specified maximum level.", "Sets the internal doc object.\n\n The doc object is processed in parallel and then assigned back\n through this method.  But because of parallel processing the\n assigned doc object will not be just a modified old @doc but a\n completely new.  If we were to just assign to @doc the\n #find_members caches would still point to old @doc members\n resulting in mysterious errors further along...", "Looks up class object by name\n When not found, prints warning message.", "Returns list of members filtered by a query.\n Searches both local and inherited members.\n\n The query hash can contain the following fields:\n\n - :name : String    - the name of the member to find.\n\n - :tagname : Symbol - the member type to look for.\n\n - :static : Boolean - true to only return static members,\n                       false to only return instance members.\n                       When nil or unspecified, both static\n                       and instance members are returned.\n\n - :local : Boolean -  true to only return non-inherited members.\n\n When called without arguments all members are returned.\n\n When nothing found, an empty array is returned.", "Extracts the fields auto-detected from code that are relevant to\n the member type and returns a hash with them.\n\n The implementation here extracts fields applicable to all member\n types.  When additional member-specific fields are to be\n extracted, override this method, but be sure to call the\n superclass method too.\n\n For example inside Method tag we might additionally want to\n extract :type and :default:\n\n     def process_code(code)\n       h = super(code)\n       h[:type] = code[:type]\n       h[:default] = code[:default]\n       h\n     end", "Iterates over all items in all groups", "Aggregates parsing results sequencially", "Do all kinds of processing on the classes hash before turning it\n into Relations object.", "Turns all aggregated data into Class objects and places the\n classes inside Relations container.", "Do all kinds of post-processing on Relations object.", "Initialized with the name of subitems field.\n Splits the array of items into n chunks so that the sum of\n largest chunk is as small as possible.\n\n This is a brute-force implementation - we just try all the\n combinations and choose the best one.", "Adds entry at the corresponding heading level.", "Adds a classname or pattern to list of external classes.", "Configures warnings to default settings.\n\n NB! Needs to be called before retrieving the documentation with\n #doc_warnings (otherwise the +/- signs will be wrong).", "Configures the logger with command line options.", "Prints warning message.\n\n The type must be one of predefined warning types which can be\n toggled on/off with command-line options, or it can be nil, in\n which case the warning is always shown.\n\n Ignores duplicate warnings - only prints the first one.\n Works best when --processes=0, but it reduces the amount of\n warnings greatly also when run multiple processes.\n\n The `file` parameter must be a hash like:\n\n     {:filename => \"foo.js\", :linenr => 17}\n\n When supplied, it the filename and line number will be appended\n to the message, to convey where the warning was triggered.\n\n The optional `args` parameter must be an array of arguments and\n only applies to some warning types like :nodoc.", "Formats filename and line number for output", "Helper for doing colored output in UNIX terminal\n\n Only does color output when STDERR is attached to TTY\n i.e. is not piped/redirected.", "Extracts inline examples from classes", "Extracts inline examples from guides", "Extracts inline examples from HTML", "Handles old syntax where configs and constructor are part of class\n doc-comment.\n\n Gathers all tags until first @cfg or @constructor into the first\n bare :class group.  We have a special case for @xtype which in\n ExtJS comments often appears after @constructor - so we\n explicitly place it into :class group.\n\n Then gathers each @cfg and tags following it into :cfg group, so\n that it becomes array of arrays of tags.  This is to allow some\n configs to be marked with @private or whatever else.\n\n Finally gathers tags after @constructor into its group.", "Turns groups hash into list of docsets", "Turns auto-detected class members into docsets in their own\n right.", "Loads tag classes from given dir or single file.", "Options used by VIM.connect\n\n  !!!plain\n  host: -o --host RBVMOMI_HOST\n  port: --port RBVMOMI_PORT (443)\n  no-ssl: --no-ssl RBVMOMI_SSL (false)\n  insecure: -k --insecure RBVMOMI_INSECURE (false)\n  user: -u --user RBVMOMI_USER (root)\n  password: -p --password RBVMOMI_PASSWORD ()\n  path: --path RBVMOMI_PATH (/sdk)\n  debug: -d --debug RBVMOMI_DEBUG (false)", "Reload all extensions for loaded VMODL types from the given directory", "XXX does the value need to be deserialized?", "Draw graph paper for samples", "Define a set of samples on some graph paper", "Not a DSL method, but initialized from Deck.new", "Checks if we have any absentee parents\n @api private", "Compute the width of the carve that we need", "Draw cards in a fan.\n @api private", "Parse crop line definitions from template.", "Parse card definitions from template.", "When a record is created, updated, or destroyed, we determine what the\n HABTM associations looked like before any changes were made, by using\n the `paper_trail_habtm` data structure. Then, we create\n `VersionAssociation` records for each of the associated records.\n @api private", "Given a HABTM association, returns an array of ids.\n\n @api private", "Save a single `belongs_to` association.\n @api private", "Returns true if the given HABTM association should be saved.\n @api private", "Raises an error if the provided class is an `abstract_class`.\n @api private", "Wait until aws_object obtains one of expected_responses\n\n @param aws_object Aws SDK Object to check state on\n @param query_method Method to call on aws_object to get current state\n @param expected_responses [Symbol,Array<Symbol>] Final state(s) to look for\n @param acceptable_errors [Exception,Array<Exception>] Acceptable errors that are caught and squelched\n @param tries [Integer] Number of times to check state, defaults to 60\n @param sleep [Integer] Time to wait between checking states, defaults to 5", "Generates a random seed value", "Un-Base64's the IV and CipherText\n Returns an array containing the IV, and CipherText", "Create a new cipher using the cipher type specified", "Provide the load paths for the Radiant installation", "Determine if another extension is installed and up to date.\n\n if MyExtension.extension_enabled?(:third_party)\n   ThirdPartyExtension.extend(MyExtension::IntegrationPoints)\n end", "If the supplied path within the extension root exists and is a directory, its absolute path is returned. Otherwise, nil.", "Loads the specified extension.", "returns the usual set of pagination links.\n options are passed through to will_paginate\n and a 'show all' depagination link is added if relevant.", "Return renderable attributes", "Creates a new empty thread and assigns it to the commontable\n The old thread is kept in the database for archival purposes", "Thread moderator capabilities", "Perform actual shortening of the text\n\n @return [String]\n\n @api private", "Apply padding to multiline text with ANSI codes\n\n @param [String] text\n   the text to pad out\n @param [Integer, Array[Integer]] padding\n   the padding to apply to text\n\n @example\n  text = \"Ignorance is the parent of fear.\"\n\n  Strings::Pad.pad(text, [1, 2], fill: \"*\")\n  # =>\n  # \"************************************\\n\"\n  # \"**Ignorance is the parent of fear.**\\n\"\n  # \"************************************\\n\"\n\n @return [String]\n\n @api private", "Apply padding to left and right side of string\n\n @param [String] text\n\n @return [String]\n\n @api private", "Aligns text to the left at given length\n\n @return [String]\n\n @api public", "Centers text within the width\n\n @return [String]\n\n @api public", "Enumerate text line by line\n\n @param [String] text\n\n @return [String]\n\n @api private", "Sends a request to the Nylas API and rai\n @param method [Symbol] HTTP method for the API call. Either :get, :post, :delete, or :patch\n @param path [String] (Optional, defaults to nil) - Relative path from the API Base. Preferred way to\n                      execute arbitrary or-not-yet-SDK-ified API commands.\n @param headers [Hash] (Optional, defaults to {}) - Additional HTTP headers to include in the payload.\n @param query [Hash] (Optional, defaults to {}) - Hash of names and values to include in the query\n                      section of the URI fragment\n @param payload [String,Hash] (Optional, defaults to nil) - Body to send with the request.\n @return [Array Hash Stringn]\n rubocop:disable Metrics/MethodLength", "Syntactical sugar for making GET requests via the API.\n @see #execute", "Syntactical sugar for making POST requests via the API.\n @see #execute", "Syntactical sugar for making PUT requests via the API.\n @see #execute", "Syntactical sugar for making DELETE requests via the API.\n @see #execute", "Merges in additional filters when querying the collection\n @return [Collection<Model>]", "The collection now returns a string representation of the model in a particular mime type instead of\n Model objects\n @return [Collection<String>]", "Iterates over a single page of results based upon current pagination settings", "Iterates over every result that meets the filters, retrieving a page at a time", "Redownloads a file even if it's been cached. Closes and unlinks the tempfile to help memory usage.", "Revokes access to the Nylas API for the given access token\n @return [Boolean]", "If the paths provided are valid\n\n @return [Boolean] True if the paths exist.", "Is the search grammar specified valid?\n\n @return [Boolean] True if the grammar has not been provided or can be\n   loaded.", "List the rules that are currently in effect.\n\n The `options` are a hash where the valid keys are:\n\n * `:include_rules` - Paths to additional rules to apply\n * `:search_gems - If true then search for custom rules in installed gems.\n * `:tags` - The tags to filter rules based on", "Review the cookbooks at the provided path, identifying potential\n improvements.\n\n The `options` are a hash where the valid keys are:\n\n * `:cookbook_paths` - Cookbook paths to lint\n * `:role_paths` - Role paths to lint\n * `:include_rules` - Paths to additional rules to apply\n * `:search_gems - If true then search for custom rules in installed gems.\n * `:tags` - The tags to filter rules based on\n * `:fail_tags` - The tags to fail the build on\n * `:exclude_paths` - Paths to exclude from linting", "Some rules are version specific.", "given a file in the cookbook lookup all the applicable tag rules defined in rule\n files. The rule file is either that specified via CLI or the .foodcritic file\n in the cookbook. We cache this information at the cookbook level to prevent looking\n  up the same thing dozens of times\n\n @param [String] file in the cookbook\n @return [Array] array of tag rules", "given a filename parse any tag rules in that file\n\n @param [String] rule file path\n @return [Array] array of tag rules from the file", "provides the path to the cookbook from a file within the cookbook\n we cache this data in a hash because this method gets called often\n for the same files.\n\n @param [String] file - a file path in the cookbook\n @return [String] the path to the cookbook", "Return the files within a cookbook tree that we are interested in trying to match rules against.\n\n @param [Hash] paths - paths of interest: {:exclude=>[], :cookbook=>[], :role=>[], :environment=>[]}\n @return [Array] array of hashes for each file {:filename=>\"./metadata.rb\", :path_type=>:cookbook}", "Invoke the DSL method with the provided parameters.", "Is this a valid Lucene query?", "To avoid the runtime hit of loading the Chef gem and its dependencies\n we load the DSL metadata from a JSON file shipped with our gem.\n\n The DSL metadata doesn't necessarily reflect the version of Chef in the\n local user gemset.", "Output the review showing matching lines with context.\n\n @param [Review] review The review to output.", "Build a hash lookup by filename and line number for warnings found in the\n specified review.\n\n @param [Review] review The review to convert.\n @return [Hash] Nested hashes keyed by filename and line number.", "Match unless a file exists using the basepath of the cookbook and the filepath\n\n @author Joseph Holsten - joseph@josephholsten.com\n @since 10.3\n @param basepath [String] base path of the cookbook\n @param filepath [String] path to the file within the cookbook\n @return [String] the absolute path to the base of the cookbook", "Find attribute access by type.", "The absolute path of a cookbook from the specified file.\n\n @author Tim Smith - tsmith@chef.io\n @since 10.1\n @param file [String, Pathname] relative or absolute path to a file in the cookbook\n @return [String] the absolute path to the base of the cookbook", "Retrieves a value of a metadata field.\n\n @author Miguel Fonseca\n @since 7.0.0\n @return [String] the value of the metadata field", "The name of the cookbook containing the specified file.\n\n @param file [String] file within a cookbook\n @return [String] name of the cookbook", "The dependencies declared in cookbook metadata.", "Look for a method call with a given name.\n\n @param ast [Nokogiri::XML::Node] Document to search under\n @param field_name [String] Method name to search for\n @return [Nokogiri::XML::NodeSet]", "The value for a specific key in an environment or role ruby file", "Create a match for a specified file. Use this if the presence of the file\n triggers the warning rather than content.", "Retrieve the recipes that are included within the given recipe AST.\n\n These two usages are equivalent:\n\n     included_recipes(ast)\n     included_recipes(ast, :with_partial_names => true)", "Create a match from the specified node.", "Read the AST for the given Ruby source file", "Retrieve a single-valued attribute from the specified resource.", "Retrieve all attributes from the specified resource.", "Resources keyed by type, with an array of matching nodes for each.", "Retrieve the name attribute associated with the specified resource.", "Resources in an AST, keyed by type.", "Does the provided string look like ruby code?", "Platforms declared as supported in cookbook metadata. Returns an array\n of hashes containing the name and version constraints for each platform.\n\n @param ast [Nokogiri::XML::Node] Document to search from.\n @return [Array<Hash>]", "Templates in the current cookbook", "Give a filename path it returns the hash of the JSON contents\n\n @author Tim Smith - tsmith@chef.io\n @since 11.0\n @param filename [String] path to a file in JSON format\n @return [Hash] hash of JSON content", "Recurse the nested arrays provided by Ripper to create a tree we can more\n easily apply expressions to.", "check to see if the passed method is a node method\n we generally look this up from the chef DSL data we have\n but we specifically check for 'set' and 'set_unless' since\n those exist in cookbooks, but are not longer part of chef 14+\n this prevents false positives in FC019 anytime node.set is found", "Expect a warning to be included in the command output.\n\n @param [String] code The warning code to check for.\n @param [Hash] options The warning options.\n @option options [Integer] :line The line number the warning should appear on - nil for any line.\n @option options [Boolean] :expect_warning If false then assert that a warning is NOT present\n @option options [String] :file The path to the file the warning should be raised against\n @option options [Symbol] :file_type Alternative to specifying file name. One of: :attributes, :definition,\n   :metadata, :provider, :resource", "Assert that the usage message is displayed.\n\n @param [Boolean] is_exit_zero The exit code to check for.", "Run a lint check with the provided command line arguments.\n\n @param [Array] cmd_args The command line arguments.", "Assert the build outcome\n\n @param [Boolean] success True if the build should succeed\n @param [Array] warnings The warnings expected", "The available tasks for this build\n\n @return [Array] Task name and description", "Assert that the output contains the specified warning.\n\n @param [String] output The output to check for.", "Extracts notification details from the provided AST, returning an\n array of notification hashes.\n\n     template \"/etc/www/configures-apache.conf\" do\n       notifies :restart, \"service[apache]\"\n     end\n\n     => [{:resource_name=>\"apache\",\n       :resource_type=>:service,\n       :type=>:notifies,\n       :style=>:new,\n       :action=>:restart,\n       :timing=>:delayed}]", "return the notification action as either a symbol or string or nil if it's a variable.\n Yes you can notify an action as a string but it's wrong and we want to return it as\n a string so we can tell people not to do that.", "Create a cookbook that will match the specified rules.\n\n @param [Array] codes The codes to match. Only FC002, FC004 and FC005 and FC006 are supported.", "Create a cookbook with a LRWP\n\n @param [Hash] lwrp The options to use for the created LWRP\n @option lwrp [Symbol] :default_action One of :no_default_action, :ruby_default_action, :dsl_default_action\n @option lwrp [Symbol] :notifies One of :does_not_notify, :does_notify, :does_notify_without_parens, :deprecated_syntax, :class_variable\n @option lwrp [Symbol] :use_inline_resources Defaults to false", "Create an cookbook with the maintainer specified in the metadata\n\n @param [String] name The maintainer name\n @param [String] email The maintainer email address", "Create a Rakefile that uses the linter rake task\n\n @param [Symbol] task Type of task\n @param [Hash] options Task options\n @option options [String] :name Task name\n @option options [String] :files Files to process\n @option options [String] :options The options to set on the rake task", "Install a gem using the specified approach.\n\n @param [Symbol] type The type of approach, one of :simple, :compile_time,\n   :compile_time_from_array, :compile_time_from_word_list\n @param [Symbol] action Either :install or :upgrade", "Create a recipe with an external dependency on another cookbook.\n\n @param [Hash] dep The options to use for dependency\n @option dep [Boolean] :is_declared True if this dependency has been declared in the cookbook metadata\n @option dep [Boolean] :is_scoped True if the include_recipe references a specific recipe or the cookbook\n @option dep [Boolean] :parentheses True if the include_recipe is called with parentheses", "Create a recipe with a ruby_block resource.\n\n @param [Symbol] length A :short or :long block, or :both", "Create a role file\n\n @param [Hash] options The options to use for the role\n @option options [String] :role_name The name of the role declared in the role file\n @option options [String] :file_name The containing file relative to the roles directory\n @option options [Symbol] :format Either :ruby or :json. Default is :ruby", "Returns a string representation of this review. This representation is\n liable to change.", "Connects to the server and downloads artifacts to a specified location\n\n @param [String] job_name\n @param [String] filename location to save artifact", "Connects to the server and download all artifacts of a build to a specified location\n\n @param [String] job_name\n @param [String] dldir location to save artifacts\n @param [Integer] build_number optional, defaults to current build\n @returns [String, Array] list of retrieved artifacts", "Connects to the Jenkins server, sends the specified request and returns\n the response.\n\n @param [Net::HTTPRequest] request The request object to send\n @param [Boolean] follow_redirect whether to follow redirects or not\n\n @return [Net::HTTPResponse] Response from Jenkins", "Sends a GET request to the Jenkins CI server with the specified URL\n\n @param [String] url_prefix The prefix to use in the URL\n @param [String] tree A specific JSON tree to optimize the API call\n @param [String] url_suffix The suffix to be used in the URL\n @param [Boolean] raw_response Return complete Response object instead of\n   JSON body of response\n\n @return [String, Hash] JSON response from Jenkins", "Sends a POST message to the Jenkins CI server with the specified URL\n\n @param [String] url_prefix The prefix to be used in the URL\n @param [Hash] form_data Form data to send with POST request\n @param [Boolean] raw_response Return complete Response object instead of\n   JSON body of response\n\n @return [String] Response code form Jenkins Response", "Obtains the configuration of a component from the Jenkins CI server\n\n @param [String] url_prefix The prefix to be used in the URL\n\n @return [String] XML configuration obtained from Jenkins", "Execute the Jenkins CLI\n\n @param command [String] command name\n @param args [Array] the arguments for the command\n\n @return [String] command output from the CLI\n\n @raise [Exceptions::CLIException] if there are issues in running the\n   commands using CLI", "Private method.  Converts keys passed in as strings into symbols.\n\n @param hash [Hash] Hash containing arguments to login to jenkins.", "Private method that handles the exception and raises with proper error\n message with the type of exception and returns the required values if no\n exceptions are raised.\n\n @param [Net::HTTP::Response] response Response from Jenkins\n @param [String] to_send What should be returned as a response. Allowed\n   values: \"code\", \"body\", and \"raw\".\n @param [Boolean] send_json Boolean value used to determine whether to\n   load the JSON or send the response as is.\n\n @return [String, Hash] Response returned whether loaded JSON or raw\n   string\n\n @raise [Exceptions::Unauthorized] When invalid credentials are\n   provided to connect to Jenkins\n @raise [Exceptions::NotFound] When the requested page on Jenkins is not\n   found\n @raise [Exceptions::InternalServerError] When Jenkins returns a 500\n   Internal Server Error\n @raise [Exceptions::ApiException] Any other exception returned from\n   Jenkins that are not categorized in the API Client.", "Initializes a new report from an exception.\n\n Add a new metadata tab to this notification.", "Builds and returns the exception payload for this notification.", "Generates a summary to be attached as a breadcrumb\n\n @return [Hash] a Hash containing the report's error class, error message, and severity", "Tests whether the meta_data types are non-complex objects.\n\n Acceptable types are String, Numeric, TrueClass, FalseClass, and nil.\n\n @param value [Object] the object to be type checked", "Wraps a call to the application with error capturing", "Initializes the session tracker.\n\n Starts a new session, storing it on the current thread.\n\n This allows Bugsnag to track error rates for a release.", "Delivers the current session_counts lists to the session endpoint.", "Subscribes to an ActiveSupport event, leaving a breadcrumb when it triggers\n\n @api private\n @param event [Hash] details of the event to subscribe to", "Notifies Bugsnag of a raised exception.", "Inserts a new middleware to use after a given middleware already added.\n\n Will return early if given middleware is disabled or already added.\n New middleware will be inserted last if the existing middleware is not already included.", "Inserts a new middleware to use before a given middleware already added.\n\n Will return early if given middleware is disabled or already added.\n New middleware will be inserted last if the existing middleware is not already included.", "Runs the middleware stack.", "Generates breadcrumb data from an event\n\n @param event_name [String] the type of event\n @param event [Mongo::Event::Base] the mongo_ruby_driver generated event", "Removes values from filter hashes, replacing them with '?'\n\n @param filter_hash [Hash] the filter hash for the mongo transaction\n @param depth [Integer] the current filter depth\n\n @return [Hash] the filtered hash", "Transforms a value element into a useful, redacted, version\n\n @param value [Object] the filter value\n @param depth [Integer] the current filter depth\n\n @return [Array, Hash, String] the sanitized value", "Parses and sets proxy from a uri", "Calls the mailman middleware.", "Renders the navigation according to the specified options-hash.\n\n The following options are supported:\n * <tt>:level</tt> - defaults to :all which renders the the sub_navigation\n   for an active primary_navigation inside that active\n   primary_navigation item.\n   Specify a specific level to only render that level of navigation\n   (e.g. level: 1 for primary_navigation, etc).\n   Specifiy a Range of levels to render only those specific levels\n   (e.g. level: 1..2 to render both your first and second levels, maybe\n   you want to render your third level somewhere else on the page)\n * <tt>:expand_all</tt> - defaults to false. If set to true the all\n   specified levels will be rendered as a fully expanded\n   tree (always open). This is useful for javascript menus like Superfish.\n * <tt>:context</tt> - specifies the context for which you would render\n   the navigation. Defaults to :default which loads the default\n   navigation.rb (i.e. config/navigation.rb).\n   If you specify a context then the plugin tries to load the configuration\n   file for that context, e.g. if you call\n   <tt>render_navigation(context: :admin)</tt> the file\n   config/admin_navigation.rb will be loaded and used for rendering\n   the navigation.\n * <tt>:items</tt> - you can specify the items directly (e.g. if items are\n   dynamically generated from database).\n   See SimpleNavigation::ItemsProvider for documentation on what to\n   provide as items.\n * <tt>:renderer</tt> - specify the renderer to be used for rendering the\n   navigation. Either provide the Class or a symbol matching a registered\n   renderer. Defaults to :list (html list renderer).\n\n Instead of using the <tt>:items</tt> option, a block can be passed to\n specify the items dynamically\n\n ==== Examples\n   render_navigation do |menu|\n     menu.item :posts, \"Posts\", posts_path\n   end", "Returns the currently active navigation item belonging to the specified\n level.\n\n The following options are supported:\n * <tt>:level</tt> - defaults to :all which returns the\n   most specific/deepest selected item (the leaf).\n   Specify a specific level to only look for the selected item in the\n   specified level of navigation\n   (e.g. level: 1 for primary_navigation, etc).\n * <tt>:context</tt> - specifies the context for which you would like to\n   find the active navigation item. Defaults to :default which loads the\n   default navigation.rb (i.e. config/navigation.rb).\n   If you specify a context then the plugin tries to load the configuration\n   file for that context, e.g. if you call\n   <tt>active_navigation_item_name(context: :admin)</tt> the file\n   config/admin_navigation.rb will be loaded and used for searching the\n   active item.\n * <tt>:items</tt> - you can specify the items directly (e.g. if items are\n   dynamically generated from database).\n   See SimpleNavigation::ItemsProvider for documentation on what to provide\n   as items.\n\n Returns the supplied <tt>value_for_nil</tt> object (<tt>nil</tt>\n by default) if no active item can be found for the specified\n options", "Returns the currently active item container belonging to the specified\n level.\n\n The following options are supported:\n * <tt>:level</tt> - defaults to :all which returns the\n   least specific/shallowest selected item.\n   Specify a specific level to only look for the selected item in the\n   specified level of navigation\n   (e.g. level: 1 for primary_navigation, etc).\n * <tt>:context</tt> - specifies the context for which you would like to\n   find the active navigation item. Defaults to :default which loads the\n   default navigation.rb (i.e. config/navigation.rb).\n   If you specify a context then the plugin tries to load the configuration\n   file for that context, e.g. if you call\n   <tt>active_navigation_item_name(context: :admin)</tt> the file\n   config/admin_navigation.rb will be loaded and used for searching the\n   active item.\n * <tt>:items</tt> - you can specify the items directly (e.g. if items are\n   dynamically generated from database).\n   See SimpleNavigation::ItemsProvider for documentation on what to provide\n   as items.\n\n Returns <tt>nil</tt> if no active item container can be found", "Returns the html-options hash for the item, i.e. the options specified\n for this item in the config-file.\n It also adds the 'selected' class to the list of classes if necessary.", "Creates a new navigation item.\n\n The <tt>key</tt> is a symbol which uniquely defines your navigation item\n in the scope of the primary_navigation or the sub_navigation.\n\n The <tt>name</tt> will be displayed in the rendered navigation.\n This can also be a call to your I18n-framework.\n\n The <tt>url</tt> is the address that the generated item points to.\n You can also use url_helpers (named routes, restful routes helper,\n url_for, etc). <tt>url</tt> is optional - items without URLs should not\n be rendered as links.\n\n The <tt>options</tt> can be used to specify the following things:\n * <tt>any html_attributes</tt> - will be included in the rendered\n   navigation item (e.g. id, class etc.)\n * <tt>:if</tt> - Specifies a proc to call to determine if the item should\n   be rendered (e.g. <tt>if: Proc.new { current_user.admin? }</tt>). The\n   proc should evaluate to a true or false value and is evaluated\n   in the context of the view.\n * <tt>:unless</tt> - Specifies a proc to call to determine if the item\n   should not be rendered\n   (e.g. <tt>unless: Proc.new { current_user.admin? }</tt>).\n   The proc should evaluate to a true or false value and is evaluated in\n   the context of the view.\n * <tt>:method</tt> - Specifies the http-method for the generated link -\n   default is :get.\n * <tt>:highlights_on</tt> - if autohighlighting is turned off and/or you\n   want to explicitly specify when the item should be highlighted, you can\n   set a regexp which is matched againstthe current URI.\n\n The <tt>block</tt> - if specified - will hold the item's sub_navigation.", "Returns the level of the item specified by navi_key.\n Recursively works its way down the item's sub_navigations if the desired\n item is not found directly in this container's items.\n Returns nil if item cannot be found.", "Checks if the key is capable of all of these actions. If empty array\n is passed then will return true.\n\n Returns false if the keys trust has been invalidated.", "class << self\n Read at most +length+ bytes from the data object, or to the end\n of file if +length+ is omitted or is +nil+.\n\n @example\n   data = GPGME::Data.new(\"From a string\")\n   data.read # => \"From a string\"\n\n @example\n   data = GPGME::Data.new(\"From a string\")\n   data.read(4) # => \"From\"", "Seek to a given +offset+ in the data object according to the\n value of +whence+.\n\n @example going to the beginning of the buffer after writing something\n  data = GPGME::Data.new(\"Some data\")\n  data.read # => \"Some data\"\n  data.read # => \"\"\n  data.seek 0\n  data.read # => \"Some data\"", "Sets the file name for this buffer.\n\n @raise [GPGME::Error::InvalidValue] if the value isn't accepted.", "Delete this key. If it's public, and has a secret one it will fail unless\n +allow_secret+ is specified as true.", "Getters and setters\n\n Set the +protocol+ used within this context. See {GPGME::Ctx.new} for\n possible values.", "Advance to the next key in the key listing operation.\n\n Used by {GPGME::Ctx#each_key}", "End a pending key list operation.\n\n Used by {GPGME::Ctx#each_key}", "Convenient method to iterate over keys.\n\n If +pattern+ is +nil+, all available keys are returned. If +secret_only+\n is +true+, only secret keys are returned.\n\n See {GPGME::Key.find} for an example of how to use, or for an easier way\n to use.", "Returns the keys that match the +pattern+, or all if +pattern+ is nil.\n Returns only secret keys if +secret_only+ is true.", "Get the key with the +fingerprint+.\n If +secret+ is +true+, secret key is returned.", "Add the keys in the data buffer to the key ring.", "Delete the key from the key ring.\n If allow_secret is false, only public keys are deleted,\n otherwise secret keys are deleted as well.", "Edit attributes of the key in the local key ring.", "Edit attributes of the key on the card.", "Verify that the signature in the data object is a valid signature.", "Add _keys_ to the list of signers.", "Create a signature for the text.\n +plain+ is a data object which contains the text.\n +sig+ is a data object where the generated signature is stored.", "Encrypt the plaintext in the data object for the recipients and\n return the ciphertext.", "Encrypts an element\n\n  crypto.encrypt something, options\n\n Will return a {GPGME::Data} element which can then be read.\n\n Must have some key imported, look for {GPGME::Key.import} to know how\n to import one, or the gpg documentation to know how to create one\n\n @param plain\n  Must be something that can be converted into a {GPGME::Data} object, or\n  a {GPGME::Data} object itself.\n\n @param [Hash] options\n  The optional parameters are as follows:\n   * +:recipients+ for which recipient do you want to encrypt this file. It\n     will pick the first one available if none specified. Can be an array of\n     identifiers or just one (a string).\n   * +:symmetric+ if set to true, will ignore +:recipients+, and will perform\n     a symmetric encryption. Must provide a password via the +:password+\n     option.\n   * +:always_trust+ if set to true specifies all the recipients to be\n     trusted, thus not requiring confirmation.\n   * +:sign+ if set to true, performs a combined sign and encrypt operation.\n   * +:signers+ if +:sign+ specified to true, a list of additional possible\n     signers. Must be an array of sign identifiers.\n   * +:output+ if specified, it will write the output into it. It will be\n     converted to a {GPGME::Data} object, so it could be a file for example.\n   * Any other option accepted by {GPGME::Ctx.new}\n\n @return [GPGME::Data] a {GPGME::Data} object that can be read.\n\n @example returns a {GPGME::Data} that can be later encrypted\n  encrypted = crypto.encrypt \"Hello world!\"\n  encrypted.read # => Encrypted stuff\n\n @example to be decrypted by someone@example.com.\n  crypto.encrypt \"Hello\", :recipients => \"someone@example.com\"\n\n @example If I didn't trust any of my keys by default\n  crypto.encrypt \"Hello\" # => GPGME::Error::General\n  crypto.encrypt \"Hello\", :always_trust => true # => Will work fine\n\n @example encrypted string that can be decrypted and/or *verified*\n  crypto.encrypt \"Hello\", :sign => true\n\n @example multiple signers\n  crypto.encrypt \"Hello\", :sign => true, :signers => \"extra@example.com\"\n\n @example writing to a file instead\n  file = File.open(\"signed.sec\",\"w+\")\n  crypto.encrypt \"Hello\", :output => file # output written to signed.sec\n\n @raise [GPGME::Error::General] when trying to encrypt with a key that is\n   not trusted, and +:always_trust+ wasn't specified", "Decrypts a previously encrypted element\n\n   crypto.decrypt cipher, options, &block\n\n Must have the appropiate key to be able to decrypt, of course. Returns\n a {GPGME::Data} object which can then be read.\n\n @param cipher\n   Must be something that can be converted into a {GPGME::Data} object,\n   or a {GPGME::Data} object itself. It is the element that will be\n   decrypted.\n\n @param [Hash] options\n   The optional parameters:\n   * +:output+ if specified, it will write the output into it. It will\n     me converted to a {GPGME::Data} object, so it can also be a file,\n     for example.\n   * If the file was encrypted with symmentric encryption, must provide\n     a :password option.\n   * Any other option accepted by {GPGME::Ctx.new}\n\n @param &block\n   In the block all the signatures are yielded, so one could verify them.\n   See examples.\n\n @return [GPGME::Data] a {GPGME::Data} that can be read.\n\n @example Simple decrypt\n   crypto.decrypt encrypted_data\n\n @example symmetric encryption, or passwored key\n   crypto.decrypt encrypted_data, :password => \"gpgme\"\n\n @example Output to file\n   file = File.open(\"decrypted.txt\", \"w+\")\n   crypto.decrypt encrypted_data, :output => file\n\n @example Verifying signatures\n   crypto.decrypt encrypted_data do |signature|\n     raise \"Signature could not be verified\" unless signature.valid?\n   end\n\n @raise [GPGME::Error::UnsupportedAlgorithm] when the cipher was encrypted\n   using an algorithm that's not supported currently.\n\n @raise [GPGME::Error::WrongKeyUsage] TODO Don't know when\n\n @raise [GPGME::Error::DecryptFailed] when the cipher was encrypted\n   for a key that's not available currently.", "Creates a signature of a text\n\n   crypto.sign text, options\n\n Must have the appropiate key to be able to decrypt, of course. Returns\n a {GPGME::Data} object which can then be read.\n\n @param text\n   The object that will be signed. Must be something that can be converted\n   to {GPGME::Data}.\n\n @param [Hash] options\n  Optional parameters.\n   * +:signer+ sign identifier to sign the text with. Will use the first\n    key it finds if none specified.\n   * +:output+ if specified, it will write the output into it. It will be\n     converted to a {GPGME::Data} object, so it could be a file for example.\n   * +:mode+ Desired type of signature. Options are:\n    - +GPGME::SIG_MODE_NORMAL+ for a normal signature. The default one if\n      not specified.\n    - +GPGME::SIG_MODE_DETACH+ for a detached signature\n    - +GPGME::SIG_MODE_CLEAR+ for a cleartext signature\n   * Any other option accepted by {GPGME::Ctx.new}\n\n @return [GPGME::Data] a {GPGME::Data} that can be read.\n\n @example normal sign\n   crypto.sign \"Hi there\"\n\n @example outputing to a file\n   file = File.open(\"text.sign\", \"w+\")\n   crypto.sign \"Hi there\", :options => file\n\n @example doing a detached signature\n   crypto.sign \"Hi there\", :mode => GPGME::SIG_MODE_DETACH\n\n @example specifying the signer\n   crypto.sign \"Hi there\", :signer => \"mrsimo@example.com\"\n\n @raise [GPGME::Error::UnusableSecretKey] TODO don't know when", "Verifies a previously signed element\n\n   crypto.verify sig, options, &block\n\n Must have the proper keys available.\n\n @param sig\n   The signature itself. Must be possible to convert into a {GPGME::Data}\n   object, so can be a file.\n\n @param [Hash] options\n   * +:signed_text+ if the sign is detached, then must be the plain text\n     for which the signature was created.\n   * +:output+ where to store the result of the signature. Will be\n     converted to a {GPGME::Data} object.\n   * Any other option accepted by {GPGME::Ctx.new}\n\n @param &block\n   In the block all the signatures are yielded, so one could verify them.\n   See examples.\n\n @return [GPGME::Data] unless the sign is detached, the {GPGME::Data}\n   object with the plain text. If the sign is detached, will return nil.\n\n @example simple verification\n   sign = crypto.sign(\"Hi there\")\n   data = crypto.verify(sign) { |signature| signature.valid? }\n   data.read # => \"Hi there\"\n\n @example saving output to file\n   sign = crypto.sign(\"Hi there\")\n   out  = File.open(\"test.asc\", \"w+\")\n   crypto.verify(sign, :output => out) {|signature| signature.valid?}\n   out.read # => \"Hi there\"\n\n @example verifying a detached signature\n   sign = crypto.detach_sign(\"Hi there\")\n   # Will fail\n   crypto.verify(sign) { |signature| signature.valid? }\n   # Will succeed\n   crypto.verify(sign, :signed_text => \"hi there\") do |signature|\n     signature.valid?\n   end", "Initialize a new Index object.\n\n repo - The Grit::Repo to which the index belongs.\n\n Returns the newly initialized Grit::Index.\n Public: Add a file to the index.\n\n path - The String file path including filename (no slash prefix).\n data - The String binary contents of the file.\n\n Returns nothing.", "Recursively write a tree to the index.\n\n tree -     The Hash tree map:\n            key - The String directory or filename.\n            val - The Hash submap or the String contents of the file.\n now_tree - The Grit::Tree representing the a previous tree upon which\n            this tree will be based (default: nil).\n\n Returns the String SHA1 String of the tree.", "Parse a content item and create the appropriate object\n   +repo+ is the Repo\n   +text+ is the single line containing the items data in `git ls-tree` format\n\n Returns Grit::Blob or Grit::Tree", "Find the named object in this tree's contents\n\n Examples\n   Repo.new('/path/to/grit').tree/'lib'\n   # => #<Grit::Tree \"6cc23ee138be09ff8c28b07162720018b244e95e\">\n   Repo.new('/path/to/grit').tree/'README.txt'\n   # => #<Grit::Blob \"8b1e02c0fb554eed2ce2ef737a68bb369d7527df\">\n\n Returns Grit::Blob or Grit::Tree or nil if not found", "Initializer for Submodule.create\n   +repo+ is the Repo\n   +atts+ is a Hash of instance variable data\n\n Returns Grit::Submodule", "The url of this submodule\n   +ref+ is the committish that should be used to look up the url\n\n Returns String", "compares the index and the working directory", "Outputs an actor string for Git commits.\n\n   actor = Actor.new('bob', 'bob@email.com')\n   actor.output(time) # => \"bob <bob@email.com> UNIX_TIME +0700\"\n\n time - The Time the commit was authored or committed.\n\n Returns a String.", "Finds the most recent annotated tag name that is reachable from a commit.\n\n   @repo.recent_tag_name('master')\n   # => \"v1.0-0-abcdef\"\n\n committish - optional commit SHA, branch, or tag name.\n options    - optional hash of options to pass to git.\n              Default: {:always => true}\n              :tags => true      # use lightweight tags too.\n              :abbrev => Integer # number of hex digits to form the unique\n                name.  Defaults to 7.\n              :long => true      # always output tag + commit sha\n              # see `git describe` docs for more options.\n\n Returns the String tag name, or just the commit if no tag is\n found.  If there have been updates since the tag was made, a\n suffix is added with the number of commits since the tag, and\n the abbreviated object name of the most recent commit.\n Returns nil if the committish value is not found.", "returns an array of hashes representing all references", "Returns a list of commits that is in +other_repo+ but not in self\n\n Returns Grit::Commit[]", "The commit log for a treeish\n\n Returns Grit::Commit[]", "Sets the alternates\n   +alts+ is the Array of String paths representing the alternates\n\n Returns nothing", "Shows diffs between the commit's parent and the commit.\n\n options - An optional Hash of options, passed to Grit::Commit.diff.\n\n Returns Grit::Diff[] (baked)", "Write a normal file to the filesystem.\n   +file+ is the relative path from the Git dir\n   +contents+ is the String content to be written\n\n Returns nothing", "Move a normal file\n   +from+ is the relative path to the current file\n   +to+ is the relative path to the destination file\n\n Returns nothing", "Chmod the the file or dir and everything beneath\n   +file+ is the relative path from the Git dir\n\n Returns nothing", "Checks if the patch of a commit can be applied to the given head.\n\n options     - grit command options hash\n head_sha    - String SHA or ref to check the patch against.\n applies_sha - String SHA of the patch.  The patch itself is retrieved\n               with #get_patch.\n\n Returns 0 if the patch applies cleanly (according to `git apply`), or\n an Integer that is the sum of the failed exit statuses.", "Gets a patch for a given SHA using `git diff`.\n\n options     - grit command options hash\n applies_sha - String SHA to get the patch from, using this command:\n               `git diff #{applies_sha}^ #{applies_sha}`\n\n Returns the String patch from `git diff`.", "Applies the given patch against the given SHA of the current repo.\n\n options  - grit command hash\n head_sha - String SHA or ref to apply the patch to.\n patch    - The String patch to apply.  Get this from #get_patch.\n\n Returns the String Tree SHA on a successful patch application, or false.", "Execute a git command, bypassing any library implementation.\n\n cmd - The name of the git command as a Symbol. Underscores are\n   converted to dashes as in :rev_parse => 'rev-parse'.\n options - Command line option arguments passed to the git command.\n   Single char keys are converted to short options (:a => -a).\n   Multi-char keys are converted to long options (:arg => '--arg').\n   Underscores in keys are converted to dashes. These special options\n   are used to control command execution and are not passed in command\n   invocation:\n     :timeout - Maximum amount of time the command can run for before\n       being aborted. When true, use Grit::Git.git_timeout; when numeric,\n       use that number of seconds; when false or 0, disable timeout.\n     :base - Set false to avoid passing the --git-dir argument when\n       invoking the git command.\n     :env - Hash of environment variable key/values that are set on the\n       child process.\n     :raise - When set true, commands that exit with a non-zero status\n       raise a CommandFailed exception. This option is available only on\n       platforms that support fork(2).\n     :process_info - By default, a single string with output written to\n       the process's stdout is returned. Setting this option to true\n       results in a [exitstatus, out, err] tuple being returned instead.\n args - Non-option arguments passed on the command line.\n\n Optionally yields to the block an IO object attached to the child\n process's STDIN.\n\n Examples\n   git.native(:rev_list, {:max_count => 10, :header => true}, \"master\")\n\n Returns a String with all output written to the child process's stdout\n   when the :process_info option is not set.\n Returns a [exitstatus, out, err] tuple when the :process_info option is\n   set. The exitstatus is an small integer that was the process's exit\n   status. The out and err elements are the data written to stdout and\n   stderr as Strings.\n Raises Grit::Git::GitTimeout when the timeout is exceeded or when more\n   than Grit::Git.git_max_size bytes are output.\n Raises Grit::Git::CommandFailed when the :raise option is set true and the\n   git command exits with a non-zero exit status. The CommandFailed's #command,\n   #exitstatus, and #err attributes can be used to retrieve additional\n   detail about the error.", "DEPRECATED OPEN3-BASED COMMAND EXECUTION", "Transform Ruby style options into git command line options\n   +options+ is a hash of Ruby style options\n\n Returns String[]\n   e.g. [\"--max-count=10\", \"--header\"]", "This feels wrong to be checking the class type of the body\n Do this better somehow.", "This probably belongs somewhere else.", "Get the least loaded proxy from the given list of proxies", "returns a scope of the locks colliding with this one", "Triggers a task on the proxy \"the old way\"", "The proxy action is able to contribute to continuous output", "Hook to be called when a repetition needs to be triggered. This either happens when the plan goes into planned state\n   or when it fails.", "List repo followers\n\n = Examples\n  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'\n  bitbucket.repos.following.followers\n  bitbucket.repos.following.followers { |watcher| ... }", "List repos being followed by the authenticated user\n\n = Examples\n  bitbucket = BitBucket.new :oauth_token => '...', :oauth_secret => '...'\n  bitbucket.repos.following.followed", "Get a component by it's ID\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.repos.components.get 'user-name', 'repo-name', 1", "Create a service\n\n = Inputs\n * <tt>:type</tt> - One of the supported services. The type is a case-insensitive value.\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.repos.services.create 'user-name', 'repo-name',\n    \"type\"           => \"Basecamp\",\n    \"Password\"       => \"...\",\n    \"Username\"       => \"...\",\n    \"Discussion URL\" => \"...\"", "Edit a service\n\n = Inputs\n * <tt>:type</tt> - One of the supported services. The type is a case-insensitive value.\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.repos.services.edit 'user-name', 'repo-name', 109172378,\n    \"type\"           => \"Basecamp\",\n    \"Password\"       => \"...\",\n    \"Username\"       => \"...\",\n    \"Discussion URL\" => \"...\"", "Get a default reviewer's info\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.repos.default_reviewers.get 'user-name', 'repo-name', 'reviewer-username'", "Add a user to the default-reviewers list for the repo\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.repos.default_reviewers.add 'user-name', 'repo-name', 'reviewer-username'", "Remove a user from the default-reviewers list for the repo\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.repos.default_reviewers.remove 'user-name', 'repo-name', 'reviewer-username'", "Get a single component\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.issues.components.find 'user-name', 'repo-name', 'component-id'", "Update a component\n\n = Inputs\n  <tt>:name</tt> - Required string\n\n = Examples\n  @bitbucket = BitBucket.new\n  @bitbucket.issues.components.update 'user-name', 'repo-name', 'component-id',\n    :name => 'API'", "Delete a component\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.issues.components.delete 'user-name', 'repo-name', 'component-id'", "Create a key\n\n = Inputs\n * <tt>:title</tt> - Required string.\n * <tt>:key</tt> - Required string.\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.repos.keys.create 'user-name', 'repo-name',\n    \"label\" => \"octocat@octomac\",\n    \"key\" =>  \"ssh-rsa AAA...\"", "Edit a key\n\n = Inputs\n * <tt>:title</tt> - Required string.\n * <tt>:key</tt> - Required string.\n\n = Examples\n  bitbucket = BitBucket.new\n  bitbucket.repos.keys.edit 'user-name', 'repo-name',\n    \"label\" => \"octocat@octomac\",\n    \"key\" =>  \"ssh-rsa AAA...\"", "List members of the provided team\n\n = Examples\n   bitbucket = BitBucket.new :oauth_token => '...', :oauth_secret => '...'\n   bitbucket.teams.members(:team_name_here)\n   bitbucket.teams.members(:team_name_here) { |member| ... }", "List followers of the provided team\n\n = Examples\n   bitbucket = BitBucket.new :oauth_token => '...', :oauth_secret => '...'\n   bitbucket.teams.followers(:team_name_here)\n   bitbucket.teams.followers(:team_name_here) { |follower| ... }", "List accounts following the provided team\n\n = Examples\n   bitbucket = BitBucket.new :oauth_token => '...', :oauth_secret => '...'\n   bitbucket.teams.following(:team_name_here)\n   bitbucket.teams.following(:team_name_here) { |followee| ... }", "List repos for provided team\n Private repos will only be returned if the user is authorized to view them\n\n = Examples\n   bitbucket = BitBucket.new :oauth_token => '...', :oauth_secret => '...'\n   bitbucket.teams.repos(:team_name_here)\n   bitbucket.teams.repos(:team_name_here) { |repo| ... }", "List issues for a repository\n\n = Inputs\n  <tt>:limit</tt> - Optional - Number of issues to retrieve, default 15\n  <tt>:start</tt> - Optional - Issue offset, default 0\n  <tt>:search</tt> - Optional - A string to search for\n  <tt>:sort</tt> - Optional - Sorts the output by any of the metadata fields\n  <tt>:title</tt> - Optional - Contains a filter operation to restrict the list of issues by the issue title\n  <tt>:content</tt> - Optional - Contains a filter operation to restrict the list of issues by the issue content\n  <tt>:version</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the version\n  <tt>:milestone</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the milestone\n  <tt>:component</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the component\n  <tt>:kind</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the issue kind\n  <tt>:status</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the issue status\n  <tt>:responsible</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the user responsible\n  <tt>:reported_by</tt> - Optional - Contains a filter operation to restrict the list of issues by the user that reported the issue\n\n = Examples\n  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'\n  bitbucket.issues.list_repo :filter => 'kind=bug&kind=enhancement'", "Create an issue\n\n = Inputs\n  <tt>:title</tt> - Required string\n  <tt>:content</tt> - Optional string\n  <tt>:responsible</tt> - Optional string - Login for the user that this issue should be assigned to.\n  <tt>:milestone</tt> - Optional number - Milestone to associate this issue with\n  <tt>:version</tt> - Optional number - Version to associate this issue with\n  <tt>:component</tt> - Optional number - Component to associate this issue with\n  <tt>:priority</tt> - Optional string - The priority of this issue\n  * <tt>trivial</tt>\n  * <tt>minor</tt>\n  * <tt>major</tt>\n  * <tt>critical</tt>\n  * <tt>blocker</tt>\n  <tt>:status</tt> - Optional string - The status of this issue\n  * <tt>new</tt>\n  * <tt>open</tt>\n  * <tt>resolved</tt>\n  * <tt>on hold</tt>\n  * <tt>invalid</tt>\n  * <tt>duplicate</tt>\n  * <tt>wontfix</tt>\n  <tt>:kind</tt> - Optional string - The kind of issue\n  * <tt>bug</tt>\n  * <tt>enhancement</tt>\n  * <tt>proposal</tt>\n  * <tt>task</tt>\n\n = Examples\n  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'\n  bitbucket.issues.create\n    \"title\" => \"Found a bug\",\n    \"content\" => \"I'm having a problem with this.\",\n    \"responsible\" => \"octocat\",\n    \"milestone\" => 1,\n    \"priority\" => \"blocker\"", "Responds to attribute query or attribute clear", "Retrieves potential filename from the \"Content-Disposition\" header.", "Initializes the backend with common defaults.\n Downlods the remote file to disk. Accepts wget command-line options and\n some additional options as well.", "Starts retrieving the remote file and returns an IO-like object which\n downloads the response body on-demand. Accepts wget command-line options.", "Generates the wget command.", "Initializes the backend with common defaults.\n Downlods the remote file to disk. Accepts HTTP.rb options via a hash or a\n block, and some additional options as well.", "Starts retrieving the remote file and returns an IO-like object which\n downloads the response body on-demand. Accepts HTTP.rb options via a hash\n or a block.", "Yields chunks of the response body to the block.", "Initializes the backend with common defaults.\n Downloads a remote file to disk using open-uri. Accepts any open-uri\n options, and a few more.", "Checks that the url is a valid URI and that its scheme is http or https.", "Makes sure that the URL is properly encoded.", "If destination path is defined, move tempfile to the destination,\n otherwise return the tempfile unchanged.", "Calculates XIRR using Newton method\n @return [BigDecimal]\n @param guess [Float]", "Calculates yearly Internal Rate of Return\n @return [BigDecimal]\n @param midpoint [Float]\n An initial guess rate will override the {Cashflow#irr_guess}", "Net Present Value function that will be used to reduce the cashflow\n @param rate [BigDecimal]\n @return [BigDecimal]", "copy other gem files to staging directory", "Discover Java Extension Directories and build an extdirs argument", "Creates a new shell on the remote Windows server associated with\n this connection.\n @param shell_type [Symbol] The shell type :cmd or :powershell\n @param shell_opts [Hash] Options targeted for the created shell\n @return [Shell] PowerShell or Cmd shell instance.", "Executes a WQL query against the WinRM connection\n @param wql [String] The wql query\n @param namespace [String] namespace for query - default is root/cimv2/*\n @return [Hash] Hash representation of wql query response (Hash is empty if a block is given)\n @yeild [type, item] Yields the time name and item for every item", "Takes an Array and a value and returns true if the value exists in the\n array in String or Symbol form, otherwise false.", "Determines if error class should be ignored.\n\n ignored_class_name - The name of the ignored class. May be a\n string or regexp (optional).\n\n Returns true or false.", "Construct the request data.\n\n Returns Hash request data.", "Get optional context from exception.\n\n Returns the Hash context.", "Parse Backtrace from exception backtrace.\n\n backtrace - The Array backtrace from exception.\n\n Returns the Backtrace.", "Fetch cause from exception.\n\n exception - Exception to fetch cause from.\n\n Returns the Exception cause.", "Create a list of causes.\n\n cause - The first cause to unwrap.\n\n Returns Array causes (in Hash payload format).", "Blocks until queue is processed up to this point in time.", "Sends an exception to Honeybadger. Does not report ignored exceptions by\n default.\n\n @example\n   # With an exception:\n   begin\n     fail 'oops'\n   rescue => exception\n     Honeybadger.notify(exception, context: {\n       my_data: 'value'\n     }) # => '-1dfb92ae-9b01-42e9-9c13-31205b70744a'\n   end\n\n   # Custom notification:\n   Honeybadger.notify('Something went wrong.', {\n     error_class: 'MyClass',\n     context: {my_data: 'value'}\n   }) # => '06220c5a-b471-41e5-baeb-de247da45a56'\n\n @param [Exception, Hash, Object] exception_or_opts An Exception object,\n   or a Hash of options which is used to build the notice. All other types\n   of objects will be converted to a String and used as the :error_message.\n @param [Hash] opts The options Hash when the first argument is an Exception.\n\n @option opts [String]    :error_message The error message.\n @option opts [String]    :error_class ('Notice') The class name of the error.\n @option opts [Array]     :backtrace The backtrace of the error (optional).\n @option opts [String]    :fingerprint The grouping fingerprint of the exception (optional).\n @option opts [Boolean]   :force (false) Always report the exception when true, even when ignored (optional).\n @option opts [String]    :tags The comma-separated list of tags (optional).\n @option opts [Hash]      :context The context to associate with the exception (optional).\n @option opts [String]    :controller The controller name (such as a Rails controller) (optional).\n @option opts [String]    :action The action name (such as a Rails controller action) (optional).\n @option opts [Hash]      :parameters The HTTP request paramaters (optional).\n @option opts [Hash]      :session The HTTP request session (optional).\n @option opts [String]    :url The HTTP request URL (optional).\n @option opts [Exception] :cause The cause for this error (optional).\n\n @return [String] UUID reference to the notice within Honeybadger.\n @return [false] when ignored.", "Perform a synchronous check_in.\n\n @example\n   Honeybadger.check_in('1MqIo1')\n\n @param [String] id The unique check in id (e.g. '1MqIo1') or the check in url.\n\n @return [Boolean] true if the check in was successful and false\n   otherwise.", "Convert Backtrace to arry.\n\n Returns array containing backtrace lines.", "This method accepts the name of an sdk operation, then finds the parameter for that\n operation in the data structures from the swagger.json file. The parameter is a\n json object. Some of the attributes of the json object are read-only, and some\n are read-write. A few are write-only. The list of read-write and write-only attribute\n names are returned as an array. That array can be used to take the json document that\n describes an object and strip out the read-only values, creating a document that can\n be used to create or update an object.\n\n The pattern typically looks like this...\n\n   new_obj_hash = existing_obj_hash.select do |k,v|\n     keys_to_keep('create_new_obj').include? k\n   end", "The tty-table gem is normally used to output tabular data. This method accepts a Table\n object as used by the tty-table gem, and generates CSV output. It returns a string\n with crlf encoding", "This method accepts a string containing a list of fields. The fields can be nested\n in a format like...\n\n 'a,b,c(d,e(f,g)),h'\n\n representing a structure like\n\n {\n   a: \"val\",\n   b: \"val\",\n   c: {\n     d: \"val\",\n     e: {\n       f: \"val\",\n       g: \"val\"\n     }\n   },\n   h: \"val\"\n }\n\n That string will get parsed and yield an array like\n [ a, b, c.d, c.e.f, c.e.g, h ]", "Extract OCLC numbers from, by default 035a's by known prefixes, then stripped\n just the num, and de-dup.", "245 a and b, with non-filing characters stripped off", "An opinionated algorithm for getting a SINGLE publication date out of marc\n\n * Prefers using 008, but will resort to 260c\n * If 008 represents a date range, will take the midpoint of the range,\n     only if range is smaller than estimate_tolerance, default 15 years.\n * Ignores dates below min_year (default 500) or above max_year (this year plus 6 years),\n     because experience shows too many of these were in error.\n\n Yeah, this code ends up ridiculous.", "An opinionated method of making a geographic facet out of BOTH 048 marc\n codes, AND geo subdivisions in 6xx LCSH subjects.\n\n The LCSH geo subdivisions are further normalized:\n * geo qualifiers in $z fields into parens, so \"Germany -- Berlin\" becomes \"Berlin (Germany)\"\n   (to be consistent with how same areas are written in $a fields -- doesn't\n    get everything, but gets lots of em)\n * qualified regions like that are additionally 'posted up', so \"Germany -- Berlin\" gets\n   recorded additionally as \"Germany\"", "Extracts LCSH-carrying fields, and formatting them\n as a pre-coordinated LCSH string, for instance suitable for including\n in a facet.\n\n You can supply your own list of fields as a spec, but for significant\n customization you probably just want to write your own method in\n terms of the Marc21Semantics.assemble_lcsh method.", "Run every element of an array through this translation map,\n return the resulting array. If translation map returns nil,\n original element will be missing from output.\n\n If an input maps to an array, each element of the array will be flattened\n into the output.\n\n If an input maps to nil, it will cause the input element to be removed\n entirely.", "Return a new TranslationMap that results from merging argument on top of self.\n Can be useful for taking an existing translation map, but merging a few\n overrides on top.\n\n     merged_map = TranslationMap.new(something).merge TranslationMap.new(else)\n     #...\n     merged_map.translate_array(something) # etc\n\n If a default is set in the second map, it will merge over the first too.\n\n You can also pass in a plain hash as an arg, instead of an existing TranslationMap:\n\n     TranslationMap.new(something).merge(\"overridden_key\" => \"value\", \"a\" => \"\")", "Takes the whole record, by default from tags 100 to 899 inclusive,\n all subfields, and adds them to output. Subfields in a record are all\n joined by space by default.\n\n options\n [:from] default '100', only tags >= lexicographically\n [:to]   default '899', only tags <= lexicographically\n [:separator] how to join subfields, default space, nil means don't join\n\n All fields in from-to must be marc DATA (not control fields), or weirdness\n\n Can always run this thing multiple times on the same field if you need\n non-contiguous ranges of fields.", "re-use an http-client for subsequent requests, to get http.rb's persistent connection re-use\n Note this means this is NOT thread safe, which is fine for now, but we'd have to do something\n different if we tried to multi-thread reading multiple files or something.\n\n @returns [HTTP::Client] from http.rb gem", "in inky.js this is factored out into makeClumn.  TBD if we need that here.", "Initializes the Committer.\n\n wiki    - The Gollum::Wiki instance that is being updated.\n options - The commit Hash details:\n           :message   - The String commit message.\n           :name      - The String author full name.\n           :email     - The String email address.\n           :parent    - Optional Gollum::Git::Commit parent to this update.\n           :tree      - Optional String SHA of the tree to create the\n                        index from.\n           :committer - Optional Gollum::Committer instance.  If provided,\n                        assume that this operation is part of batch of\n                        updates and the commit happens later.\n\n Returns the Committer instance.\n Public: References the Git index for this commit.\n\n Returns a Gollum::Git::Index.", "Adds a page to the given Index.\n\n dir    - The String subdirectory of the Gollum::Page without any\n          prefix or suffix slashes (e.g. \"foo/bar\").\n name   - The String Gollum::Page filename_stripped.\n format - The Symbol Gollum::Page format.\n data   - The String wiki data to store in the tree map.\n allow_same_ext - A Boolean determining if the tree map allows the same\n                  filename with the same extension.\n\n Raises Gollum::DuplicatePageError if a matching filename already exists.\n This way, pages are not inadvertently overwritten.\n\n Returns nothing (modifies the Index in place).", "Writes the commit to Git and runs the after_commit callbacks.\n\n Returns the String SHA1 of the new commit.", "Determine if a given file is scheduled to be deleted in the next commit\n for the given Index.\n\n map   - The Hash map:\n         key - The String directory or filename.\n         val - The Hash submap or the String contents of the file.\n path - The String path of the file including extension.\n\n Returns the Boolean response.", "Proxies methods t", "Find a file in the given Gollum repo.\n\n name    - The full String path.\n version - The String version ID to find.\n try_on_disk - If true, try to return just a reference to a file\n               that exists on the disk.\n\n Returns a Gollum::File or nil if the file could not be found. Note\n that if you specify try_on_disk=true, you may or may not get a file\n for which on_disk? is actually true.", "Gets a Page instance for this blob.\n\n wiki - Gollum::Wiki instance for the Gollum::Page\n\n Returns a Gollum::Page instance.", "Gets a File instance for this blob.\n\n wiki - Gollum::Wiki instance for the Gollum::File\n\n Returns a Gollum::File instance.", "Render data using default chain in the target format.\n\n data - the data to render\n format - format to use as a symbol\n name - name using the extension of the format\n\n Returns the processed data", "Process the filter chain\n\n data - the data to send through the chain\n filter_chain - the chain to process\n\n Returns the formatted data", "Render the content with Gollum wiki syntax on top of the file's own\n markup language.\n\n no_follow - Boolean that determines if rel=\"nofollow\" is added to all\n             <a> tags.\n encoding  - Encoding Constant or String.\n\n Returns the formatted String content.", "Find the given file in the repo.\n\n name - The String absolute or relative path of the file.\n\n Returns the Gollum::File or nil if none was found.", "Remove the named filter from the filter chain.\n\n Returns nothing.  Raises `ArgumentError` if the named filter doesn't\n exist in the chain.", "Fill an array with a list of pages.\n\n ref - A String ref that is either a commit SHA or references one.\n\n Returns a flat Array of Gollum::Page instances.", "Fill an array with a list of files.\n\n ref - A String ref that is either a commit SHA or references one.\n\n Returns a flat Array of Gollum::File instances.", "Finds a full listing of files and their blob SHA for a given ref.  Each\n listing is cached based on its actual commit SHA.\n\n ref - A String ref that is either a commit SHA or references one.\n ignore_page_file_dir - Boolean, if true, searches all files within the git repo, regardless of dir/subdir\n\n Returns an Array of BlobEntry instances.", "Attempts to get the given data from a cache.  If it doesn't exist, it'll\n pass the results of the yielded block to the cache for future accesses.\n\n name - The cache prefix used in building the full cache key.\n key  - The unique cache key suffix, usually a String Git SHA.\n\n Yields a block to pass to the cache.\n Returns the cached result.", "Parses a line of output from the `ls-tree` command.\n\n line - A String line of output:\n          \"100644 blob 839c2291b30495b9a882c17d08254d3c90d8fb53  Home.md\"\n\n Returns an Array of BlobEntry instances.", "Find a page in the given Gollum repo.\n\n name    - The human or canonical String page name to find.\n version - The String version ID to find.\n\n Returns a Gollum::Page or nil if the page could not be found.", "Find a page in a given tree.\n\n map         - The Array tree map from Wiki#tree_map.\n name        - The canonical String page name.\n checked_dir - Optional String of the directory a matching page needs\n               to be in.  The string should\n\n Returns a Gollum::Page or nil if the page could not be found.", "The full directory path for the given tree.\n\n treemap - The Hash treemap containing parentage information.\n tree    - The Gollum::Git::Tree for which to compute the path.\n\n Returns the String path.", "Compare the canonicalized versions of the two names.\n\n name     - The human or canonical String page name.\n path     - the String path on disk (including file extension).\n\n Returns a Boolean.", "`find_value` is a recursive method that takes a \"user\" and a\n \"user schema\" and replaces any symbols in the schema with the\n corresponding value from the user. Given a schema with symbols,\n `find_value` will search through the object for the symbols,\n send those symbols to the model, and replace the symbol with\n the return value.", "`path_for` is a recursive method used to find the \"path\" for\n `.dig` to take when looking for a given attribute in the\n params.\n\n Example: `path_for(:name)` should return an array that looks\n like [:names, 0, :givenName]. `.dig` can then use that path\n against the params to translate the :name attribute to \"John\".", "Public marks an envelope as sent\n\n envelope_id           - ID of the envelope which you want to send\n\n Returns the response (success or failure).", "Public returns the URL for embedded signing\n\n envelope_id - the ID of the envelope you wish to use for embedded signing\n name        - the name of the signer\n email       - the email of the recipient\n return_url  - the URL you want the user to be directed to after he or she\n               completes the document signing\n headers     - optional hash of headers to merge into the existing\n               required headers for a multipart request.\n\n Returns the URL string for embedded signing (can be put in an iFrame)", "Public returns the envelope recipients for a given envelope\n\n include_tabs - boolean, determines if the tabs for each signer will be\n                returned in the response, defaults to false.\n envelope_id  - ID of the envelope for which you want to retrieve the\n                signer info\n headers      - optional hash of headers to merge into the existing\n                required headers for a multipart request.\n\n Returns a hash of detailed info about the envelope including the signer\n hash and status of each signer", "Public retrieves a png of a page of a document in an envelope\n\n envelope_id      - ID of the envelope from which the doc will be retrieved\n document_id      - ID of the document to retrieve\n page_number      - page number to retrieve\n\n Returns the png as a bytestream", "Public retrieves the attached file from a given envelope\n\n envelope_id      - ID of the envelope from which the doc will be retrieved\n document_id      - ID of the document to retrieve\n local_save_path  - Local absolute path to save the doc to including the\n                    filename itself\n headers          - Optional hash of headers to merge into the existing\n                    required headers for a multipart request.\n\n Example\n\n   client.get_document_from_envelope(\n     envelope_id: @envelope_response['envelopeId'],\n     document_id: 1,\n     local_save_path: 'docusign_docs/file_name.pdf',\n     return_stream: true/false # will return the bytestream instead of saving doc to file system.\n   )\n\n Returns the PDF document as a byte stream.", "Public deletes a recipient for a given envelope\n\n envelope_id  - ID of the envelope for which you want to retrieve the\n                signer info\n recipient_id - ID of the recipient to delete\n\n Returns a hash of recipients with an error code for any recipients that\n were not successfully deleted.", "Public voids an in-process envelope\n\n envelope_id      - ID of the envelope to be voided\n voided_reason    - Optional reason for the envelope being voided\n\n Returns the response (success or failure).", "Validate the uncles of this block.", "Add a transaction to the transaction trie.\n\n Note that this does not execute anything, i.e. the state is not updated.", "Get the `num`th transaction in this block.\n\n @raise [IndexError] if the transaction does not exist", "Apply rewards and commit.", "Serialize the block to a readable hash.\n\n @param with_state [Bool] include state for all accounts\n @param full_transactions [Bool] include serialized transactions (hashes\n   otherwise)\n @param with_storage_roots [Bool] if account states are included also\n   include their storage roots\n @param with_uncles [Bool] include uncle hashes\n\n @return [Hash] a hash represents the block", "Get the parent of this block.", "Get the summarized difficulty.\n\n If the summarized difficulty is not stored in the database, it will be\n calculated recursively and put int the database.", "Returns true when the account is either empty or non-exist.", "Make a snapshot of the current state to enable later reverting.", "Revert to a previously made snapshot.\n\n Reverting is for example neccessary when a contract runs out of gas\n during execution.", "Get the receipt of the `num`th transaction.\n\n @raise [IndexError] if receipt at index is not found\n\n @return [Receipt]", "Build a list of all receipts in this block.", "Transfer a value between two account balance.\n\n @param from [String] the address of the sending account (binary or hex\n   string)\n @param to [String] the address of the receiving account (binary or hex\n   string)\n @param value [Integer] the (positive) value to send\n\n @return [Bool] `true` if successful, otherwise `false`", "Get the trie holding an account's storage.\n\n @param address [String] the address of the account (binary or hex string)\n\n @return [Trie] the storage trie of account", "Get a specific item in the storage of an account.\n\n @param address [String] the address of the account (binary or hex string)\n @param index [Integer] the index of the requested item in the storage\n\n @return [Integer] the value at storage index", "Set a specific item in the storage of an account.\n\n @param address [String] the address of the account (binary or hex string)\n @param index [Integer] the index of the requested item in the storage\n @param value [Integer] the new value of the item", "Serialize an account to a hash with human readable entries.\n\n @param address [String] the account address\n @param with_storage_root [Bool] include the account's storage root\n @param with_storage [Bool] include the whole account's storage\n\n @return [Hash] hash represent the account", "Return `n` ancestors of this block.\n\n @return [Array] array of ancestors in format of `[parent, parent.parent, ...]", "Check that the values of all fields are well formed.\n\n Serialize and deserialize and check that the values didn't change.", "Add a value to an account item.\n\n If the resulting value would be negative, it is left unchanged and\n `false` is returned.\n\n @param address [String] the address of the account (binary or hex string)\n @param param [Symbol] the parameter to increase or decrease (`:nonce`,\n   `:balance`, `:storage`, or `:code`)\n @param value [Integer] can be positive or negative\n\n @return [Bool] `true` if the operation was successful, `false` if not", "Get a specific parameter of a specific account.\n\n @param address [String] the address of the account (binary or hex string)\n @param param [Symbol] the requested parameter (`:nonce`, `:balance`,\n   `:storage` or `:code`)\n\n @return [Object] the value", "Set a specific parameter of a specific account.\n\n @param address [String] the address of the account (binary or hex string)\n @param param [Symbol] the requested parameter (`:nonce`, `:balance`,\n   `:storage` or `:code`)\n @param value [Object] the new value", "Get the account with the given address.\n\n Note that this method ignores cached account items.", "Sign this transaction with a private key.\n\n A potentially already existing signature would be override.", "returns the address of a contract created by this tx", "Mines on the current head. Stores received transactions.\n\n The process of finalising a block involves four stages:\n\n 1. validate (or, if mining, determine) uncles;\n 2. validate (or, if mining, determine) transactions;\n 3. apply rewards;\n 4. verify (or, if mining, compute a valid) state and nonce.", "It presents a hash like interface.\n\n @param db [Object] key value database\n @param root_hash [String] blank or trie node in form of [key, value] or\n   [v0, v1, .. v15, v]\n\n\n @return empty or 32 bytes string", "Set value of key.\n\n @param key [String]\n @param value [String]", "Delete value at key.\n\n @param key [String] a string with length of [0,32]", "Convert to hash.", "Get value inside a node.\n\n @param node [Array, BLANK_NODE] node in form of array, or BLANK_NODE\n @param nbk [Array] nibble array without terminator\n\n @return [String] BLANK_NODE if does not exist, otherwise node value", "Update item inside a node.\n\n If this node is changed to a new node, it's parent will take the\n responsibility to **store** the new node storage, and delete the old node\n storage.\n\n @param node [Array, BLANK_NODE] node in form of array, or BLANK_NODE\n @param key [Array] nibble key without terminator\n @param value [String] value string\n\n @return [Array, BLANK_NODE] new node", "Delete item inside node.\n\n If this node is changed to a new node, it's parent will take the\n responsibility to **store** the new node storage, and delete the old node\n storage.\n\n @param node [Array, BLANK_NODE] node in form of array, or BLANK_NODE\n @param key [Array] nibble key without terminator. key maybe empty\n\n @return new node", "Delete node storage.\n\n @param node [Array, BLANK_NODE] node in form of array, or BLANK_NODE", "get node type and content\n\n @param node [Array, BLANK_NODE] node in form of array, or BLANK_NODE\n\n @return [Symbol] node type", "Preprocesses code, and determines which locations are in the middle of\n pushdata and thus invalid", "Check if the proof-of-work of the block is valid.\n\n @param nonce [String] if given the proof of work function will be\n   evaluated with this nonce instead of the one already present in the\n   header\n\n @return [Bool]", "Serialize the header to a readable hash.", "Return the uncles of the hypothetical child of `block`.", "Returns `true` if block was added successfully.", "Add a transaction to the `head_candidate` block.\n\n If the transaction is invalid, the block will not be changed.\n\n @return [Bool,NilClass] `true` is the transaction was successfully added or\n   `false` if the transaction was invalid, `nil` if it's already included", "Return `count` of blocks starting from head or `start`.", "after new head is set", "start from head and update until the existing indices match the block", "Change the if_in_swupdate field in the JSS\n\n @param new_val[Boolean]\n\n @return [void]", "Change the priority field in the JSS\n\n @param new_val[Integer] one of PRIORITIES\n\n @return [void]", "Change the required processor field in the JSS\n\n @param new_val[String] one of {CPU_TYPES}\n\n @return [void]", "Caclulate and return the checksum hash for a given local file, or the file\n on the master dist point if no local file is given.\n\n @param type [String] The checksum hash type, one of the keys of\n   CHECKSUM_HASH_TYPES\n\n @param local_file [String, Pathname] A local copy of the pkg file. BE SURE\n   it's identical to the one on the server. If omitted, the master dist.\n   point will be mounted and the file read from there.\n\n @param rw_pw [String] The read-write password for mounting the master dist\n   point. Either this or the ro_pw must be provided if no local_file\n\n @param ro_pw [String] The read-onlypassword for mounting the master dist\n   point. Either this or the rw_pw must be provided if no local_file\n\n @param unmount [Boolean] Unmount the master dist point after using it.\n   Only used if the dist point is mounted. default: true\n\n @return [String] The calculated checksum", "Is the checksum for this pkg is valid?\n\n @param local_file [String, Pathname] A local copy of the pkg file. BE SURE\n   it's identical to the one on the server. If omitted, the master dist.\n   point will be mounted and the file read from there.\n\n @param rw_pw [String] The read-write password for mounting the master dist\n   point. Either this or the ro_pw must be provided if no local_file\n\n @param ro_pw [String] The read-onlypassword for mounting the master dist\n   point. Either this or the rw_pw must be provided if no local_file\n\n @param unmount [Boolean] Unmount the master dist point after using it.\n   Only used if the dist point is mounted. default: true\n\n @return [Boolean] false if there is no checksum for this pkg, otherwise,\n   does the calculated checksum match the one stored for the pkg?", "Change the name of a package file on the master distribution point.\n\n @param new_file_name[String]\n\n @param old_file_name[default: @filename, String]\n\n @param unmount[Boolean] whether or not ot unount the distribution point when finished.\n\n @param rw_pw[String,Symbol] the password for the read/write account on the master Distribution Point,\n   or :prompt, or :stdin# where # is the line of stdin containing the password See {JSS::DistributionPoint#mount}\n\n @return [nil]", "delete master file\n Delete this package from the JSS, optionally\n deleting the master dist point file also.\n\n @param delete_file[Boolean] should the master dist point file be deleted?\n\n @param rw_pw[String] the password for the read/write account on the master Distribution Point\n   or :prompt, or :stdin# where # is the line of stdin containing the password. See {JSS::DistributionPoint#mount}\n\n @param unmount[Boolean] whether or not ot unount the distribution point when finished.", "Uninstall this pkg via the jamf command.\n\n @param args[Hash] the arguments for installation\n\n @option args :target[String,Pathname] The drive from which to uninstall the package, defaults to '/'\n\n @option args :verbose[Boolean] be verbose to stdout, defaults to false\n\n @option args :feu[Boolean] fill existing users, defaults to false\n\n @option args :fut[Boolean] fill user template, defaults to false\n\n @return [Process::Status] the result of the 'jamf uninstall' command\n\n @note This code must be run as root to uninstall packages", "Unused - until I get around to making DP's updatable\n\n the XML representation of the current state of this object,\n for POSTing or PUTting back to the JSS via the API\n Will be supported for Dist Points some day, I'm sure.", "Set the event handled by this webhook\n Must be a member of the EVENTS Array\n\n @param new_val[String] The event name\n\n @return [void]", "Return the REST XML for this webhook, with the current values,\n for saving or updating", "Public Instance Methods\n\n @see APIObject#initialize\n\n Public Class Methods\n\n Needed to support creation of new Computer Invitations to set their name.\n\n @return [JSS::ComputerInvitation]", "Sets invitation expiration 4 hours after request.", "Save the icon to a file.\n\n @param path[Pathname, String] The path to which the file should be saved.\n If the path given is an existing directory, the icon's current filename will\n be used, if known.\n\n @param overwrite[Boolean] Overwrite the file if it exists? Defaults to false\n\n @return [void]", "Change the category of this object.\n Any of the NON_CATEGORIES values will\n unset the category\n\n @param new_cat[Integer, String] The new category\n\n @return [void]", "Parse the category data from any incoming API data\n\n @return [void] description_of_returned_object", "Add the category to the XML for POSTing or PUTting to the API.\n\n @param xmldoc[REXML::Document] The in-construction XML document\n\n @return [void]", "Change the scope\n\n @param new_scope[JSS::Scopable::Scope] the new scope\n\n @return [void]", "Send an erase device command to this object\n\n @param passcode[String] a six-char passcode, required for computers & computergroups\n\n @return (see .send_mdm_command)", "Send a wallpaper command to this object\n\n @param wallpaper_setting[Symbol] :lock_screen, :home_screen, or :lock_and_home_screen\n\n @param wallpaper_content[String,Pathname] The local path to a .png or .jpg to use\n   as the walpaper image, required if no wallpaper_id\n\n @param wallpaper_id[Symbol] The id of an Icon in Jamf Pro to use as the wallpaper image,\n   required if no wallpaper_content\n\n @return (see .send_mdm_command)", "Send a enable_lost_mode command to one or more targets\n\n Either or both of message and phone number must be provided\n\n @param message[String] The message to display on the lock screen\n\n @param phone_number[String] The phone number to display on the lock screen\n\n @param footnote[String] Optional footnote to display on the lock screen\n\n @param play_sound[Boolean] Play a sound when entering lost mode\n\n @param enforce_lost_mode[Boolean] Re-enabled lost mode when re-enrolled after wipe.\n\n @return (see .send_mdm_command)", "Set a new frequency for this policy.\n\n @param freq[Symbol] the desired frequency, must be one of the keys of {FREQUENCIES}\n\n @return [void]", "Set a new target drive for this policy.\n\n @param path_to_drive[String,Pathname] the full path to the target drive, must start with a '/'\n\n @return [void]", "Set whether this policy is available offline.\n\n @param new_val[Boolean]\n\n @return [void]", "Change a trigger event\n\n @param type[Symbol] the type of trigger, one of the keys of {TRIGGER_EVENTS}\n\n @param new_val[Boolean] whether the type of trigger is active or not.\n\n @return [void]", "Set Server Side Activation\n\n @param activation[Time] Activation date and time\n\n @return [void]", "Set Server Side Expiration\n\n @param expiration[Time] Expiration date and time\n\n @return [void]", "What to do at reboot when there is a User Logged In\n\n @param logged_in_option[String] Any one of the Strings from USER_LOGGED_IN\n\n @return [void]", "Set Reboot Message\n\n @param reboot_message[String] Text of Reboot Message\n\n @return [void] description of returned object", "Set Startup Disk\n Only Supports 'Specify Local Startup Disk' at the moment\n\n @param startup_disk_option[String]\n\n @return [void]", "Specify Startup Volume\n Only Supports \"Specify Local Startup Disk\"\n\n @param startup_volume[String] a Volume to reboot to\n\n @return [void]", "Reboot Options\n Minutes Until Reboot\n\n @param minutes[String] The number of minutes to delay prior to reboot\n\n @return [void]", "Set the unix shell command to be run on the client\n\n @param command[String] the unix shell command to be run on the client\n\n @return [void]", "Set the process name to search for, and if it should be killed if found.\n\n Setter methods (which end with =) can't easily take\n multiple arguments, so we instead name them \"set_blah_blah\"\n rather than \"blah_blah=\"\n\n @param process[String] the process name to search for\n\n @param kill[Boolean] should be process be killed if found\n\n @return [void]", "Set the path to search for, a String or Pathname, and whether or not to delete it if found.\n\n Setter methods (which end with =) can't easily take\n multiple arguments, so we instead name them \"set_blah_blah\"\n rather than \"blah_blah=\"\n\n @param path[String,Pathname] the path to search for\n\n @param delete[Boolean] should the path be deleted if found\n\n @return [void]", "Set the term to seach for using spotlight\n\n @param term[String] the term to seach for using spotlight\n\n @return [void]", "Set the term to seach for using the locate command\n\n @param term[String] the term to seach for using the locate command\n\n @return [void]", "Add a package to the list of pkgs handled by this policy.\n If the pkg already exists in the policy, nil is returned and\n no changes are made.\n\n @param [String,Integer] identifier the name or id of the package to add to this policy\n\n @param position [Symbol, Integer] where to add this pkg among the list of\n   pkgs. Zero-based, :start and 0 are the same, as are :end and -1.\n   Defaults to :end\n\n @param action [String] One of the values of PACKAGE_ACTIONS\n\n @param feu [Boolean]  Overrides the setting for the pkg itself Defaults to false\n\n @param fut [Boolean] Overrides the setting for the pkg itself Defaults to false\n\n @param update_autorun [Boolean] Defaults to false\n\n @return [Array, nil]  the new @packages array, nil if pkg was already in the policy", "Remove a package from this policy by name or id\n\n @param identfier [String,Integer] the name or id of the package to remove\n\n @return [Array, nil] the new packages array or nil if no change", "Add a script to the list of SCRIPT_PRIORITIESipts run by this policy.\n If the script already exists in the policy, nil is returned and\n no changes are made.\n\n @param [String,Integer] identifier the name or id of the script to add to this policy\n\n @param [Hash] opts the options for this script\n\n @option [Symbol, Integer] position: where to add this script among the list of\n   scripts. Zero-based, :start and 0 are the same, as are :end and -1. Defaults to :end\n\n @option [Symbol] priority: either :before or :after\n\n @option [String] parameter4: the value of the 4th parameter passed to the script. this\n   overrides the same parameter in the script object itself.\n\n @option [String] parameter5: the value of the 5th parameter passed to the script. this\n   overrides the same parameter in the script object itself.\n\n @option [String] parameter6: the value of the 6th parameter passed to the script. this\n   overrides the same parameter in the script object itself.\n\n @option [String] parameter7: the value of the 7th parameter passed to the script. this\n   overrides the same parameter in the script object itself.\n\n @option [String] parameter8: the value of the 8th parameter passed to the script. this\n   overrides the same parameter in the script object itself.\n\n @option [String] parameter9: the value of the 9th parameter passed to the script. this\n   overrides the same parameter in the script object itself.\n\n @option [String] parameter10: the value of the 10th parameter passed to the script. this\n   overrides the same parameter in the script object itself.\n\n @option [String] parameter11: the value of the 11th parameter passed to the script. this\n   overrides the same parameter in the script object itself.\n\n @return [Array, nil]  the new @scripts array, nil if script was already in the policy", "Remove a script from this policy by name or id\n\n @param identfier [String,Integer] the name or id of the script to remove\n\n @return [Array, nil] the new scripts array or nil if no change", "Actions\n Try to execute this policy on this machine.\n\n @param show_output[Boolean] should the stdout and stderr of the\n  'jamf policy' command be sent to stdout in realtime?\n\n @return [Boolean, nil] The success of the 'jamf policy' command, or nil\n   if the policy couldn't be executed (out of scope, policy disabled, etc)", "Flush all policy logs for this policy older than\n some number of days, weeks, months or years.\n\n With no parameters, flushes all logs\n\n NOTE: Currently the API doesn't have a way to\n flush only failed policies.\n\n @param older_than[Integer] 0, 1, 2, 3, or 6\n\n @param period[Symbol] :days, :weeks, :months, or :years\n\n @return [void]", "raise an error if a package being added isn't valid\n\n @see #add_package\n\n @return [Integer, nil] the valid id for the package", "raise an error if a script being added isn't valid\n\n @see #add_script\n\n @return [Integer, nil] the valid id for the package", "Change the inventory_display of this EA\n\n @param new_val[String] the new value, which must be a member of INVENTORY_DISPLAY_CHOICES\n\n @return [void]", "Change the input type of this EA\n\n @param new_val[String] the new value, which must be a member of INPUT_TYPES\n\n @return [void]", "Change the Popup Choices of this EA\n New value must be an Array, the items will be converted to Strings.\n\n This automatically sets input_type to \"Pop-up Menu\"\n\n Values are checked to ensure they match the @data_type\n Note, Dates must be in the format \"YYYY-MM-DD hh:mm:ss\"\n\n @param new_val[Array<#to_s>] the new values\n\n @return [void]", "Get an Array of Hashes for all inventory objects\n with a desired result in their latest report for this EA.\n\n Each Hash is one inventory object (computer, mobile device, user), with these keys:\n   :id - the computer id\n   :name - the computer name\n   :value - the matching ext attr value for the objects latest report.\n\n This is done by creating a temprary {AdvancedSearch} for objects with matching\n values in the EA field, then getting the #search_results hash from it.\n\n The AdvancedSearch is then deleted.\n\n @param search_type[String] how are we comparing the stored value with the desired value.\n must be a member of JSS::Criterion::SEARCH_TYPES\n\n @param desired_value[String] the value to compare with the stored value to determine a match.\n\n @return [Array<Hash{:id=>Integer,:name=>String,:value=>String,Integer,Time}>] the items that match the result.", "Return a REXML object for this ext attr, with the current values.\n Subclasses should augment this in their rest_xml methods\n then return it .to_s, for saving or updating", "Change the recon_display of this EA", "raise an exeption if needed when trying to do something that needs\n a host and port set\n\n @param action[String] The action that needs a host and port\n\n @return [void]", "disconnect\n Test that a given hostname is a MySQL server\n\n @param server[String] The hostname to test\n\n @return [Boolean] does the server host a MySQL server?", "Add or change one of the categories for this item in self service\n\n @param new_cat[String, Integer] the name or id of a category where this\n   object should appear in SelfSvc\n\n @param display_in[Boolean] should this item appear in the SelfSvc page for\n  the category? Only meaningful in applicable classes\n\n @param feature_in[Boolean] should this item be featured in the SelfSvc page\n   for the category? Only meaningful in applicable classes.\n   NOTE: this will always be false if display_in is false.\n\n @return [void]", "Set the value for user-removability of profiles, optionally\n providing a password for removal, on iOS targets.\n\n @param new_val[Symbol] One of the keys of PROFILE_REMOVAL_BY_USER,\n   :always, :never, or :with_auth\n\n @param pw[String] A new password to use if removable :with_auth\n\n @return [void]", "How should self service notifications be displayed\n\n @param type[Symbol] A key from SelfServable::NOTIFICATION_TYPES\n\n @return [void]", "set reminder notification frequency\n\n @param new_val[Integer] How many days between reminder notifications?\n\n @return [void]", "Set a new Self Service icon for this object.\n\n Since JSS::Icon objects are read-only,\n the icon can only be changed by supplying the id number\n of an icon already existing in the JSS, or a path to\n a local file, which will be uploaded to the JSS and added\n to this instance.  Uploads\n take effect immediately, but if an integer is supplied, the change\n must be sent to the JSS via {#update} or {#create}\n\n @param new_icon[Integer, String, Pathname] The id or path to the new icon.\n\n @return [false, Integer, Pathname] false means no change was made.", "parse incoming ssvc notification settings", "refresh icon\n Add approriate XML for self service data to the XML document for this\n item.\n\n @param xdoc[REXML::Document] The XML Document to which we're adding Self\n   Service data\n\n @return [void]", "add_self_service_xml\n add the correct XML indicating whether or not we're even in SSvc", "add the xml specific to profiles", "add the xml for self-service categories", "set macOS settings in ssvc xml", "set ssvc notification settings in xml", "Raise an error if user_removable settings are wrong", "Raise an error if an icon id is not valid", "Save any changes\n\n If get_results is true, they'll be available in {#search_results}. This might be slow.\n\n @param get_results[Boolean] should the results of the search be queried immediately?\n\n @return [Integer] the id of the updated search", "Requery the API for the search results.\n\n This can be very slow, so temporarily reset the API timeout to 30 minutes\n\n @return [Array<Hash>] the new search results", "Set the list of fields to be retrieved with the\n search results.\n\n @param new_val[Array<String>] the new field names", "Export the display fields of the search results to a file.\n\n @param output_file[String,Pathname] The file in which to store the exported results\n\n @param format[Symbol] one of :csv, :tab, or :xml, defaults to :csv\n\n @param overwrite[Boolean] should the output_file be overwrite if it exists? Defaults to false\n\n @return [Pathname] the path to the output file\n\n @note This method only exports the display fields defined in this advanced search for\n the search_result members (computers, mobile_devices, or users)\n It doesn't currently provide the ability to export subsets of info about those objects, as the\n Web UI does (e.g. group memberships, applications, receipts, etc)", "Clean up the inconsistent \"Display Field\" keys in the search results.\n\n Sometimes spaces have been converted to underscores, sometimes not, sometimes both.\n Same for dashes.\n E.g  :\"Last Check-in\"/:Last_Check_in/:\"Last_Check-in\", :Computer_Name, and :\"Display Name\"/:Display_Name\n\n This ensures there's always the fully underscored version.\n\n Update an internally used array of the display field names, symbolized, with\n spaces and dashes converted to underscores. We use these\n to overcome inconsistencies in how the names come from the API\n\n @return [void]\n\n def standardize_display_field_keys\n   spdash =\n     us =\n       @display_field_std_keys = @display_fields.map { |f| f.gsub(/ |-/, '_').to_sym }\n end", "Set whether or not this app should be deployed as managed\n\n @param new_val[Boolean] The new value\n\n @return [void]", "Set whether or not this app should be removed when\n the device is unmanaged\n\n @param new_val[Boolean] The new value\n\n @return [void]", "Set whether or not the device should back up this app's data\n\n @param new_val[Boolean] The new value\n\n @return [void]", "Set whether or not the jss should update info about this app from the app store\n\n @param new_val[Boolean] The new value\n\n @return [void]", "Set whether or not this is a free app\n\n @param new_val[Boolean] The new value\n\n @return [void]", "Set whether or not Jamf should manage this app even if the user installed\n it on their own.\n\n @param new_val[Boolean] The new value\n\n @return [void]", "Set whether or not this app's .ipa is hosted outside the Jamf server\n\n @param new_val[Boolean] The new value\n\n @return [void]", "Save the application to a file.\n\n @param path[Pathname, String] The path to which the file should be saved.\n If the path given is an existing directory, the ipa's current filename will\n be used, if known.\n\n @param overwrite[Boolean] Overwrite the file if it exists? Defaults to false\n\n @return [void]", "app usage\n The 'computer management' data for this computer\n\n NOTE: the data isn't cached locally, and the API is queried every time\n\n @see {JSS::Computer.management_data} for details", "Set or unset management acct and password for this computer\n\n @param name[String] the name of the management acct.\n\n @param password[String] the password of the management acct\n\n @return [void]\n\n The changes will need to be pushed to the server with {#update}\n before they take effect.\n\n CAUTION: this does nothing to confirm the name and password\n will work on the machine!", "Return a String with the XML Resource\n for submitting  changes to the JSS via\n the API\n\n For Computers, only some items can be changed via the API\n In particular, any data gatherd by a Recon cannot be changed", "disconnect\n Get an arbitrary JSS resource\n\n The first argument is the resource to get (the part of the API url\n after the 'JSSResource/' )\n\n By default we get the data in JSON, and parse it\n into a ruby data structure (arrays, hashes, strings, etc)\n with symbolized Hash keys.\n\n @param rsrc[String] the resource to get\n   (the part of the API url after the 'JSSResource/' )\n\n @param format[Symbol] either ;json or :xml\n  If the second argument is :xml, the XML data is returned as a String.\n\n @return [Hash,String] the result of the get", "Change an existing JSS resource\n\n @param rsrc[String] the API resource being changed, the URL part after 'JSSResource/'\n\n @param xml[String] the xml specifying the changes.\n\n @return [String] the xml response from the server.", "Create a new JSS resource\n\n @param rsrc[String] the API resource being created, the URL part after 'JSSResource/'\n\n @param xml[String] the xml specifying the new object.\n\n @return [String] the xml response from the server.", "post_rsrc\n Delete a resource from the JSS\n\n @param rsrc[String] the resource to create, the URL part after 'JSSResource/'\n\n @return [String] the xml response from the server.", "Get the DistributionPoint instance for the master\n distribution point in the JSS. If there's only one\n in the JSS, return it even if not marked as master.\n\n @param refresh[Boolean] re-read from the API?\n\n @return [JSS::DistributionPoint]", "Get the DistributionPoint instance for the machine running\n this code, based on its IP address. If none is defined for this IP address,\n use the result of master_distribution_point\n\n @param refresh[Boolean] should the distribution point be re-queried?\n\n @return [JSS::DistributionPoint]", "def network_segments\n Find the ids of the network segments that contain a given IP address.\n\n Even tho IPAddr.include? will take a String or an IPAddr\n I convert the ip to an IPAddr so that an exception will be raised if\n the ip isn't a valid ip.\n\n @param ip[String, IPAddr] the IP address to locate\n\n @param refresh[Boolean] should the data be re-queried?\n\n @return [Array<Integer>] the ids of the NetworkSegments containing the given ip", "Send an MDM command to one or more mobile devices managed by\n this JSS\n\n see {JSS::MobileDevice.send_mdm_command}\n\n @deprecated Please use JSS::MobileDevice.send_mdm_command or its\n   convenience methods. @see JSS::MDM", "Raise execeptions if we don't have essential data for the connection\n\n @param args[Hash] The args for #connect\n\n @return [void]", "Verify that we can connect with the args provided, and that\n the server version is high enough for this version of ruby-jss.\n\n This makes the first API GET call and will raise an exception if things\n are wrong, like failed authentication. Will also raise an exception\n if the JSS version is too low\n (see also JSS::Server)\n\n @return [void]", "Build the base URL for the API connection\n\n @param args[Hash] The args for #connect\n\n @return [String] The URI encoded URL", "cat assigned?\n Change the site of this object.\n Any of the NON_SITES values will\n unset the site\n\n @param new_site[Integer, String] The new site\n\n @return [void]", "Parse the site data from any incoming API data\n\n @return [void]", "parse site\n Add the site to the XML for POSTing or PUTting to the API.\n\n @param xmldoc[REXML::Document] The in-construction XML document\n\n @return [void]", "Associate this peripheral with a computer.\n\n @param computer[String,Integer] the name or id of a computer in the JSS\n\n @return [void]", "check a field, the field name must match those defined in\n the appropriate peripheral type.\n If a field is a menu field, the value must also be one of those defined\n in the periph type.\n Raise an exception if wrong.", "raise an error if the patch title we're trying to use isn't available in\n the jss. If handed a PatchTitle instance, we assume it came from the JSS\n\n @param new_title[String,Integer,JSS::PatchTitle] the title to validate\n\n @return [Integer] the id of the valid title", "raise an exception if a given target version is not valid for this policy\n Otherwise return it", "Update our local version data after the target_version is changed", "Add this user to a site\n\n @param site[String] the name of the site\n\n @return [void]", "Remove this user from a site\n\n @param site[String] the name of the site\n\n @return [void]", "Does this network segment overlap with another?\n\n @param other_segment[JSS::NetworkSegment] the other segment to check\n\n @return [Boolean] Does the other segment overlap this one?", "Does this network segment include an address or another segment?\n Inclusion means the other is completely inside this one.\n\n @param thing[JSS::NetworkSegment, String, IPAddr] the other thing to check\n\n @return [Boolean] Does this segment include the other?", "Does this network segment equal another?\n equality means the ranges are equal\n\n @param other_segment[JSS::NetworkSegment] the other segment to check\n\n @return [Boolean] Does this segment include the other?\n\n Set the building\n\n @param newval[String, Integer] the new building by name or id, must be in the JSS\n\n @return [void]", "set the override buildings option\n\n @param newval[Boolean] the new override buildings option\n\n @return [void]", "set the department\n\n @param newval[String, Integer] the new dept by name or id, must be in the JSS\n\n @return [void]", "set the override depts option\n\n @param newval[Boolean] the new setting\n\n @return [void]", "set the distribution_point\n\n @param newval[String, Integer] the new dist. point by name or id, must be in the JSS\n\n @return [void]", "set the netboot_server\n\n @param newval[String, Integer] the new netboot server by name or id, must be in the JSS\n\n @return [void]", "set the sw update server\n\n @param newval[String, Integer] the new server by name or id, must be in the JSS\n\n @return [void]", "set a new starting and ending addr at the same time.\n\n @see_also NetworkSegment.ip_range for how to specify the starting\n and ending addresses.\n\n @param starting_address[String] The starting address, possibly masked\n\n @param ending_address[String] The ending address\n\n @param mask[String] The subnet mask to apply to the starting address to get\n   the ending address\n\n @param cidr[String, Integer] he cidr value to apply to the starting address to get\n   the ending address\n\n @return [void]", "filename=\n Change the script's display name\n\n If the filename is the same as the name, the filename  will be changed also\n\n @param new_val[String] the new display name\n\n @return [void]", "name=\n Change the os_requirements\n\n Minumum OS's can be specified as a string using the notation \">=10.6.7\"\n See the {JSS.expand_min_os} method for details.\n\n @param new_val[String, Array<String>] the new os requirements as a comma-separted String or an Array of Strings\n\n @return [void]\n\n @example String value\n   myscript.os_requirements \"10.5, 10.5.3, 10.6.x\"\n\n @example Array value\n   ok_oses = ['10.5', '10.5.3', '10.6.x']\n   myscript.os_requirements ok_oses\n\n @example Minimum OS\n   myscript.os_requirements \">=10.7.5\"", "os_requirements=\n Change the priority of this script\n\n @param new_val[Integer] the new priority, which must be one of {PRIORITIES}\n\n @return [void]", "notes=\n Replace all the script parameters at once.\n\n This will replace the entire set with the hash provided.\n\n @param new_val[Hash]  the Hash keys must exist in {PARAMETER_KEYS}\n\n @return [void]", "parameters=\n Change one of the stored parameters\n\n @param param_num[Integer] which param are we setting? must be 4..11\n\n @param new_val[String] the new value for the parameter\n\n @return [void]", "Change the executable code of this script.\n\n If the arg is a Pathname instance, or a String starting with \"/\"\n Then the arg is assumed to be a file from which to read the code.\n\n Otherwise it should be a String with the code itself, and it must start with '#!\"\n\n After doing this, use {#create} or {#update} to write it to the database or\n use {#upload_master_file} to save it to the master dist. point.\n\n @param new_val[String,Pathname] the new script contents or a path to a file containing it.\n\n @return [void]", "upload\n Delete the filename from the master distribution point, if it exists.\n\n If you'll be uploading several files you can specify unmount as false, and do it manually when all\n are finished.\n\n @param rw_pw[String] the password for the read/write account on the master Distribution Point\n\n @param unmount[Boolean] whether or not ot unount the distribution point when finished.\n\n @return [Boolean] was the file deleted?", "Run this script on the current machine using the \"jamf runScript\" command.\n\n If the script code is available in the {#script_contents} attribute, then that\n code is saved to a tmp file, and executed. Otherwise, the script is assumed\n to be stored on the distribution point.\n\n If the dist. point has http downloads enabled, then the URL is used as the path with the\n 'jamf runScript' command.\n\n If http is not an option, the dist.point is mounted, and the script copied locally before running.\n In this case the options must include :ro_pw => 'somepass'\n to provide the read-only password for mounting the distribution point. If :unmount => true\n is provided, the dist. point will be unmounted immediately after copying\n the script locally.  Otherwise it will remain mounted, in case there's further need of it.\n\n Any local on-disk copies of the script are removed after running.\n\n After the script runs, this method returns a two-item Array.\n - the first item is an Integer, the exit status of the script itself (0 means success)\n - the second item is a String, the output (stdout + stderr) of the jamf binary, which will include\n   the script output.\n The exit status of the jamf binary process will be available as a Process::Status object\n in $? immediately after running.\n\n @param opts[Hash] the options for running the script\n\n @option opts :target[String,Pathname] the 'target drive', passed to the script as the first commandline option.\n   Defaults to '/'\n\n @option opts :computer_name[String] the name of the computer, passed to the script as the second commandline\n   option. Defaults to the name of the current machine\n\n @option opts :username[String] the username to be passed to the script as the third commandline option.\n\n @option opts :p1..:p8[String] the values to be passed as the 4th - 11th commandline options, overriding\n   those defined with the script in the JSS\n\n @option opts :ro_pw[String] the read-only password for mounting the distribution point, if needed\n\n @option opts :unmount[Boolean} should the dist. point be unmounted when finished, if we mounted it?\n\n @option opts :verbose[Boolean] should the 'jamf runScript' command be verbose?\n\n @option opts :show_output[Boolean] should the output (stdout + stderr) of 'jamf runScript' be copied to\n  stdout in realtime, as well as returned?\n\n @return [Array<(Integer,String)>] the exit status of the *script* and stdout+stderr of 'jamf runScript'.\n   The exit status of the jamf binary will be available in $? immediately after running.\n\n *NOTE* In the WEB UI and API, the definable parameters are numbered 4-11, since 1, 2, & 3 are the\n target drive, computer name, and user name respectively.  However, the jamf binary refers to them as\n p1-p8, and that's how they are expected as options to #run. So if :p1=> \"new param\" is given as an\n aption to #run, it will override any value that the API provided in @parameters[:parameter4]", "Return the xml for creating or updating this script in the JSS", "Replace the details of one specific field.\n\n The order must already exist. Otherwise use\n {#append_field}, {#prepend_field}, or {#insert_field}\n\n @param order[Integer] which field are we replacing?\n\n @param field[Hash] the new field data\n\n @return [void]", "Add a new field to the middle of the fields Array.\n\n @param order[Integer] where does the new field go?\n\n @param field[Hash] the new field data\n\n @return [void]", "Remove a field from the array of fields.\n\n @param order[Integer] which field to remove?\n\n @return [void]", "is a Hash of field data OK for use in the JSS?\n Return true or raise an exception", "Remove a member by id, or name\n\n @param m[Integer,String] the id or name of the member to remove\n\n @return [void]", "Check that a potential group member is valid in the JSS.\n Arg must be an id or name.\n An exception is raised if the device doesn't exist.\n\n @return [Hash{:id=>Integer,:name=>String}] the valid id and name", "Set email notifications on or off\n\n @param new_setting[Boolean] Should email notifications be on or off?\n\n @return [void]", "Set web notifications on or off\n\n @param new_setting[Boolean] Should email notifications be on or off?\n\n @return [void]", "Return the REST XML for this title, with the current values,\n for saving or updating.", "rest_xml\n add xml for any package changes to patch versions", "Raise an exception if object history is not\n available for this object\n\n @return [void]", "If we were passed pre-lookedup API data, validate it,\n raising exceptions if not valid.\n\n DEPRECATED: pre-lookedup data is never used\n and support for it will be going away.\n\n TODO: delete this and all defined VALID_DATA_KEYS\n\n @return [void]", "validate_init_data\n If we're making a new object in the JSS, make sure we were given\n valid data to do so, raise exceptions otherwise.\n\n NOTE: some subclasses may do further validation.\n\n TODO: support for objects that can have duplicate names.\n\n @param args[Hash] The args passed to #initialize\n\n @return [void]", "Given initialization args, perform an API lookup for an object.\n\n @param args[Hash] The args passed to #initialize\n\n @return [Hash] The parsed JSON data for the object from the API", "Return a String with the XML Resource\n for submitting creation or changes to the JSS via\n the API via the Creatable or Updatable modules\n\n Most classes will redefine this method.", "Clear the settings and reload the prefs files, or another file if provided\n\n @param file[String,Pathname] a non-standard prefs file to load\n\n @return [void]", "Read in any prefs file\n\n @param file[String,Pathname] the file to read\n\n @return [void]", "Set whether or not the VPP licenses should be assigned\n by device rather than by user\n\n @param new_val[Boolean] The new value\n\n @return [void]", "Insert an appropriate vpp element into the XML for sending changes\n to the JSS\n\n @param xdoc[REXML::Document] The XML document to work with\n\n @return [void]", "Returns true if verify domain is succeed.", "Returns a Hash containing all supported properties for this record\n along with corresponding values.\n\n @return [{ Symbol => Object }]", "Sorts the data by the currently set criteria and returns an array of profiling results.\n\n @return [Array] An array of profiling results.", "Sorts the data by the currently set criteria and returns a pretty printed table as a string.\n\n @return [String] A table of profiling results.", "Assembler of seccomp bpf.\n @param [String] str\n @return [String]\n   Raw bpf bytes.\n @example\n   asm(<<EOS)\n     # lines start with '#' are comments\n     A = sys_number                # here's a comment, too\n     A >= 0x40000000 ? dead : next # 'next' is a keyword, denote the next instruction\n     A == read ? ok : next         # custom defined label 'dead' and 'ok'\n     A == 1 ? ok : next            # SYS_write = 1 in amd64\n     return ERRNO(1)\n     dead:\n     return KILL\n     ok:\n     return ALLOW\n   EOS\n   #=> <raw binary bytes>", "Main working method of CLI.\n @param [Array<String>] argv\n   Command line arguments.\n @return [void]\n @example\n   work(%w[--help])\n   #=> # usage message\n   work(%w[--version])\n   #=> # version message", "Disassemble bpf codes.\n @param [String] raw\n   The raw bpf bytes.\n @param [Symbol] arch\n   Architecture.", "Corresponding instruction object.\n @return [SeccompTools::Instruction::Base]", "Get currently supported architectures.\n @return [Array<Symbol>]\n   Architectures.", "Wrapper color codes.\n @param [String] s\n   Contents to wrapper.\n @param [Symbol?] t\n   Specific which kind of color to use, valid symbols are defined in {Util.COLOR_CODE}.\n @return [String]\n   Wrapper with color codes.", "Set commands implemented in this core library.\n\n - implemented_mjsonwp_commands:  All commands include ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS\n - implemented_w3c_commands:  All commands include ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS\n - implemented_core_commands:  All commands except for selenium-webdriver's commands\n - webdriver_oss_commands: ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS\n - webdriver_w3c_commands: ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS\n\n Get the bellow url's file.\n https://raw.githubusercontent.com/appium/appium-base-driver/master/lib/mjsonwp/routes.js?raw=1\n\n @param [String] to_path: A file path to routes.js\n @return [String] The file path in which has saved `routes.js`.", "Commands, only this core library, which haven't been implemented in ruby core library yet.\n @return [Hash]", "Assigns first_name and last_name attributes as extracted from a supplied full name.", "Set unique identifer for the message", "Returns the id of the batch to which the given transaction belongs\n Identified based upon the reference of the transaction", "Returns public statuses from or in reply to a set of users. Mentions\n (\"Hello @user!\") and implicit replies (\"@user Hello!\" created without\n pressing the reply \"swoosh\") are not matched. Requires integer user\n IDs, not screen names. Query parameters may be passed as the last argument.", "Make a call to the userstream api for currently authenticated user", "connect to twitter while starting a new EventMachine run loop", "connect to twitter without starting a new EventMachine run loop", "Recurse through complex data structures.  Return on first error.", "Parses multiple XML files, which fills all the attributes,\n will `raise` for errors\n @return   [void]", "Causes a build fail if there are test failures,\n and outputs a markdown table of the results.\n\n @return   [void]", "Generate csv output", "Uses the more printable names in @visible_fields", "Command to be executed at @repository\n @silent = true wont raise an error on exit code =! 0", "List all files in current git directory, excluding\n extensions in @extensions defined by the user", "Convert the configuration to a hash sutiable for Pusher JS options.\n\n @param [Hash] options Custom options for Pusher client.", "Emit an event to the connection.\n\n @param [String] event The event name.\n @param [Hash] data The event data.\n @param [String] channel The channel name.", "Process an event.\n\n @param [String] data The event data as JSON.", "Log any one or more of a message, an exception and structured data as TRACE.\n @return [Boolean] true\n @see Logging#debug", "Log any one or more of a message, an exception and structured data as DEBUG.\n If the block is given for delay evaluation, it returns them as an array or the one of them as a value.\n @param message [String] The message to log. Use default_message if not specified.\n @param ex [Exception] The exception or the error\n @param data [Object] Any structured data\n @yieldreturn [String|Exception|Object|Array] Any one or more of former parameters\n @return [Boolean] true", "Log any one or more of a message, an exception and structured data as INFO.\n @return [Boolean] true\n @see Logging#debug", "Log any one or more of a message, an exception and structured data as WARN.\n @return [Boolean] true\n @see Logging#debug", "Log any one or more of a message, an exception and structured data as ERROR.\n @return [Boolean] true\n @see Logging#debug", "Log any one or more of a message, an exception and structured data as FATAL.\n @return [Boolean] true\n @see Logging#debug", "Log any one or more of a message, an exception and structured data as UNKNOWN.\n @return [Boolean] true\n @see Logging#debug", "Determines all normal and nested step calls and assigns them to the corresponding step definition.\n Does direct and fuzzy matching", "Create a new changelog parser\n\n Options:\n * +changelog+:: Changelog content as a +String+.\n * +version_header_exp+ (optional):: regexp to match the starting line of version.\n   Defaults to /^#{0,3} ?([\\w\\d\\.-]+\\.[\\w\\d\\.-]+[a-zA-Z0-9])(?: \\/ (\\w+ \\d{1,2}(?:st|nd|rd|th)?,\\s\\d{4}|\\d{4}-\\d{2}-\\d{2}|\\w+))?\\n?[=-]*/\n   See http://tech-angels.github.com/vandamme/#changelogs-convention\n * +format+ (optional):: One of \"raw\", \"markdown\", \"rdoc\"\n\n\n call-seq:\n   parse => aHash\n\n Parse changelog file, filling +@changelog_hash+ with\n versions as keys, and version changelog as content.", "POST json packed torrent add command.", "Get transmission session id.", "Merge Config Hash with Hash from YAML file.", "Get file enclosures from all feeds items and call on_new_item callback\n with torrent file URL as argument.", "Define callback method.", "Executes the command synchronously. Streams the logs back to standard out\n and does not return until the command has completed or timed out.", "inspired by this code from @rdp http://tinyurl.com/y7t276bh", "the main capture", "Locate an existing column range, make a new one if not found,\n or split existing column range into multiples.", "Save the resulting XLSX file to the specified location", "Finds worksheet by its name or numerical index", "Create new simple worksheet and add it to the workbook worksheets\n\n @param [String] The name for the new worksheet", "validates Workbook, ensures that this worksheet is in @workbook", "Ensures that storage space for a cell with +row_index+ and +column_index+\n exists in +sheet_data+ arrays, growing them up if necessary.", "Changes fill color of cell", "Changes font name of cell", "Changes font size of cell", "Changes font color of cell", "Changes font italics settings of cell", "Changes font bold settings of cell", "Changes font underline settings of cell", "Helper method to update the font array and xf array", "Performs correct modification based on what type of change_type is specified", "Get raw column width value as stored in the file", "Set raw column width value", "Helper method to update the row styles array\n change_type - NAME or SIZE or COLOR etc\n main method to change font, called from each separate font mutator method", "Helper method to update the fonts and cell styles array\n main method to change font, called from each separate font mutator method", "Merges cells within a rectangular area", "Return an array of environment variables that should be set", "Return the PID that is in the instances process PID file", "Start a new instance of this process", "Send this signal the signal to stop and mark the instance in a state that\n tells us that we want it to be stopped.", "Retarts the process using the appropriate method from the process configuraiton", "Update the locally cached PID from that stored on the file system.", "Check the status of this process and handle as appropriate.", "Find a port number for this instance to listen on. We just check that nothing is already listening on it.\n The process is expected to take it straight away if it wants it.", "Is the given port available?", "If procodile is executed through rbenv it will pollute our environment which means that\n any spawned processes will be invoked with procodile's ruby rather than the ruby that\n the application wishes to use", "Return all environment variables for this process", "Return a hash", "Return an hash of possible options to settle the ambiguity", "Send data through specified mappers\n\n @return [Relation::Composite]\n\n @api public", "Determine which specific registry to use\n\n @api private", "Assign a plugin to this environment registry\n\n @param [Symbol] name The registered plugin name\n @param [Module] mod The plugin to register\n @param [Hash] options optional configuration data\n\n @api private", "Returns plugin name by instance\n\n @return [Symbol] Plugin name\n\n @api private", "Return the plugin for a given adapter\n\n @param [Symbol] name The name of the plugin\n @param [Symbol] adapter_name (:default) The name of the adapter used\n\n @raise [UnknownPluginError] if no plugin is found with the given name\n\n @api public", "Load given component files\n\n @api private", "Run the finalization process\n\n This creates relations, mappers and commands\n\n @return [Container]\n\n @api private", "Build entire relation registry from all known relation subclasses\n\n This includes both classes created via DSL and explicit definitions\n\n @api private", "Return a new changeset with provided relation\n\n New options can be provided too\n\n @param [Relation] relation\n @param [Hash] new_options\n\n @return [Changeset]\n\n @api public", "Register an event\n\n @param [String] id A unique event key\n @param [Hash] info\n\n @api public", "Apply this plugin to the provided class\n\n @param [Class] klass\n\n @api private", "Project a schema to include only specified attributes\n\n @param [*Array<Symbol, Attribute>] names Attribute names\n\n @return [Schema]\n\n @api public", "Project a schema with renamed attributes\n\n @param [Hash] mapping The attribute mappings\n\n @return [Schema]\n\n @api public", "Return new schema with all attributes marked as prefixed and wrapped\n\n This is useful when relations are joined and the right side should be marked\n as wrapped\n\n @param [Symbol] prefix The prefix used for aliasing wrapped attributes\n\n @return [Schema]\n\n @api public", "Return a new schema with uniq attributes\n\n @return [Schema]\n\n @api public", "This hook is called when relation is being build during container finalization\n\n When block is provided it'll be called just before freezing the instance\n so that additional ivars can be set\n\n @return [self]\n\n @api private", "Return coercion function using attribute read types\n\n This is used for `output_schema` in relations\n\n @return [Dry::Types::Hash]\n\n @api private", "Return coercion function using attribute types\n\n This is used for `input_schema` in relations, typically commands use it\n for processing input\n\n @return [Dry::Types::Hash]\n\n @api private", "Auto-curry a method\n\n @param [Symbol] name The name of a method\n\n @api private", "Return a command from the registry\n\n If mapper is set command will be turned into a composite command with\n auto-mapping\n\n @overload [](name)\n   @param [Symbol] name The command identifier from the registry\n   @example\n     create_user = rom.commands[:users][:create]\n     create_user[name: 'Jane']\n\n     # with mapping, assuming :entity mapper is registered for :users relation\n     create_user = rom.commands[:users].map_with(:entity)[:create]\n     create_user[name: 'Jane'] # => result is sent through :entity mapper\n\n @overload [](*args)\n   @param [Array] *args {CommandCompiler} arguments\n   @see CommandCompiler#call\n\n @return [Command,Command::Composite]\n\n @api public", "Relation definition DSL\n\n @example\n   setup.relation(:users) do\n     def names\n       project(:name)\n     end\n   end\n\n @api public", "Command definition DSL\n\n @example\n   setup.commands(:users) do\n     define(:create) do\n       input NewUserParams\n       result :one\n     end\n\n     define(:update) do\n       input UserParams\n       result :many\n     end\n\n     define(:delete) do\n       result :many\n     end\n   end\n\n @api public", "Configures a plugin for a specific adapter to be enabled for all relations\n\n @example\n   config = ROM::Configuration.new(:sql, 'sqlite::memory')\n\n   config.plugin(:sql, relations: :instrumentation) do |p|\n     p.notifications = MyNotificationsBackend\n   end\n\n   config.plugin(:sql, relations: :pagination)\n\n @param [Symbol] adapter The adapter identifier\n @param [Hash<Symbol=>Symbol>] spec Component identifier => plugin identifier\n\n @return [Plugin]\n\n @api public", "Call the command and return one or many tuples\n\n This method will apply before/after hooks automatically\n\n @api public", "Curry this command with provided args\n\n Curried command can be called without args. If argument is a graph input processor,\n lazy command will be returned, which is used for handling nested input hashes.\n\n @return [Command, Lazy]\n\n @api public", "Yields tuples for insertion or return an enumerator\n\n @api private", "Apply provided hooks\n\n Used by #call\n\n @return [Array<Hash>]\n\n @api private", "Pipes a dataset through command's relation\n\n @return [Array]\n\n @api private", "Process a relation using the transformers\n\n @api private", "Return a specific command type for a given adapter and relation AST\n\n This class holds its own registry where all generated commands are being\n stored\n\n CommandProxy is returned for complex command graphs as they expect root\n relation name to be present in the input, which we don't want to have\n in repositories. It might be worth looking into removing this requirement\n from rom core Command::Graph API.\n\n @overload [](type, adapter, ast, plugins, meta)\n   @param type [Symbol] The type of command\n   @param adapter [Symbol] The adapter identifier\n   @param ast [Array] The AST representation of a relation\n   @param plugins [Array<Symbol>] A list of optional command plugins that should be used\n   @param meta [Hash] Meta data for a command\n\n   @return [Command, CommandProxy]\n\n @api private", "Build a command object for a specific relation\n\n The command will be prepared for handling associations if it's a combined\n relation. Additional plugins will be enabled if they are configured for\n this compiler.\n\n @param [Symbol] rel_name A relation identifier from the container registry\n @param [Symbol] type The command type\n @param [Hash] meta Meta information from relation AST\n @param [Symbol] parent_relation Optional parent relation identifier\n\n @return [ROM::Command]\n\n @api private", "Sets up `associates` plugin for a given command class and relation\n\n @param [Class] klass The command class\n @param [Relation] relation The relation for the command\n\n @api private", "Build gateways using the setup interface\n\n @api private", "Return attribute type with additional meta information\n\n Return meta information hash if no opts are provided\n\n @param [Hash] opts The meta options\n\n @return [Attribute]\n\n @api public", "Return string representation of the attribute type\n\n @return [String]\n\n @api public", "Return nullable attribute\n\n @return [Attribute]\n\n @api public", "Yields relation tuples\n\n Every tuple is processed through Relation#output_schema, it's a no-op by default\n\n @yield [Hash]\n\n @return [Enumerator] if block is not provided\n\n @api public", "Create a graph node for a given association identifier\n\n @param [Symbol, Relation::Name] name\n\n @return [Relation]\n\n @api public", "Return a graph node prepared by the given association\n\n @param [Association] assoc An association object\n\n @return [Relation]\n\n @api public", "Return a new relation with provided dataset and additional options\n\n Use this method whenever you need to use dataset API to get a new dataset\n and you want to return a relation back. Typically relation API should be\n enough though. If you find yourself using this method, it might be worth\n to consider reporting an issue that some dataset functionality is not available\n through relation API.\n\n @example with a new dataset\n   users.new(users.dataset.some_method)\n\n @example with a new dataset and options\n   users.new(users.dataset.some_method, other: 'options')\n\n @param [Object] dataset\n @param [Hash] new_opts Additional options\n\n @api public", "Returns a new instance with the same dataset but new options\n\n @example\n   users.with(output_schema: -> tuple { .. })\n\n @param [Hash] opts New options\n\n @return [Relation]\n\n @api public", "Return a new relation that will map its tuples to instances of the provided class\n\n @example\n   users.map_to(MyUserModel)\n\n @param [Class] klass Your custom model class\n\n @return [Relation]\n\n @api public", "Apply this plugin to the provided configuration\n\n @param [ROM::Schema] schema A schema instance for extension\n @param [Hash] options Extension options\n\n @api private", "not quick! try to call this infrequently", "set an operation argument, expanding constants and copying images as\n required", "handy for expanding enum operations", "A new image is created with the same width, height, format,\n interpretation, resolution and offset as self, but with every pixel\n set to the specified value.\n\n You can pass an array to make a many-band image, or a single value to\n make a one-band image.\n\n @param value [Real, Array<Real>] value to put in each pixel\n @return [Image] constant image", "Write this image to a large memory buffer.\n\n @return [String] the pixels as a huge binary string", "Get the `GType` of a metadata field. The result is 0 if no such field\n exists.\n\n @see get\n @param name [String] Metadata field to fetch\n @return [Integer] GType", "Get a metadata item from an image. Ruby types are constructed\n automatically from the `GValue`, if possible.\n\n For example, you can read the ICC profile from an image like this:\n\n ```\n profile = image.get \"icc-profile-data\"\n ```\n\n and profile will be an array containing the profile.\n\n @param name [String] Metadata field to get\n @return [Object] Value of field", "Get the names of all fields on an image. Use this to loop over all\n image metadata.\n\n @return [[String]] array of field names", "Create a metadata item on an image of the specifed type. Ruby types\n are automatically transformed into the matching `GType`, if possible.\n\n For example, you can use this to set an image's ICC profile:\n\n ```\n x = y.set_type Vips::BLOB_TYPE, \"icc-profile-data\", profile\n ```\n\n where `profile` is an ICC profile held as a binary string object.\n\n @see set\n @param gtype [Integer] GType of item\n @param name [String] Metadata field to set\n @param value [Object] Value to set", "Draw a point on an image.\n\n See {Image#draw_rect}.\n\n @return [Image] modified image", "Subtract an image, constant or array.\n\n @param other [Image, Real, Array<Real>] Thing to subtract from self\n @return [Image] result of subtraction", "Divide an image, constant or array.\n\n @param other [Image, Real, Array<Real>] Thing to divide self by\n @return [Image] result of division", "Fetch bands using a number or a range\n\n @param index [Numeric, Range] extract these band(s)\n @return [Image] extracted band(s)", "Convert to an Array. This will be slow for large images.\n\n @return [Array] array of Fixnum", "Join a set of images bandwise.\n\n @param other [Image, Array<Image>, Real, Array<Real>] bands to append\n @return [Image] many band image", "Composite a set of images with a set of blend modes.\n\n @param overlay [Image, Array<Image>] images to composite\n @param mode [BlendMode, Array<BlendMode>] blend modes to use\n @param opts [Hash] Set of options\n @option opts [Vips::Interpretation] :compositing_space Composite images in this colour space\n @option opts [Boolean] :premultiplied Images have premultiplied alpha\n @return [Image] blended image", "Return the coordinates of the image maximum.\n\n @return [Real, Real, Real] maximum value, x coordinate of maximum, y\n   coordinate of maximum", "Return the coordinates of the image minimum.\n\n @return [Real, Real, Real] minimum value, x coordinate of minimum, y\n   coordinate of minimum", "return a pspec, or nil ... nil wil leave a message in the error log\n which you must clear", "return a gtype, raise an error on not found", "Set the value of a GValue. The value is converted to the type of the\n GValue, if possible.\n\n @param value [Any] The value to set", "Get the value of a GValue. The value is converted to a Ruby type in\n the obvious way.\n\n @return [Any] the value held by the GValue", "Persist the rows' model and return a `Report`", "Remove trailing white spaces and ensure we always return a string", "The model to be persisted", "Set the attribute using the column_definition and the csv_value", "Error from the model mapped back to the CSV header if we can", "Return true if column definition matches the column name passed in.", "Process templates by injecting vars and moving to location\n\n @api private", "Loads gemspec from a file and registers gems matching pattern.\n\n @param [String|Pathname] gemspec_path\n   the path to gemspec\n @param [Regex] pattern\n   the pattern to match gems by\n\n @example\n   plugins.load_from('foo.gemspec', /tty-(.*)/)\n\n @api public", "Return a list of all plugin names as strings\n\n @api public", "Extract a relative path for the app\n\n @api private", "Returns a new client object. _options_ can be one of the following\n\n * A String containing the name of a YAML file formatted like:\n    ---\n    client_id: <your_salesforce_client_id>\n    client_secret: <your_salesforce_client_secret>\n    host: login.salesforce.com\n    debugging: true\n    version: 23.0\n    sobject_module: My::Module\n    ca_file: some/ca/file.cert\n    verify_mode: OpenSSL::SSL::VERIFY_PEER\n * A Hash containing the following keys:\n    client_id\n    client_secret\n    host\n    debugging\n    version\n    sobject_module\n    ca_file\n    verify_mode\n If the environment variables DATABASEDOTCOM_CLIENT_ID, DATABASEDOTCOM_CLIENT_SECRET, DATABASEDOTCOM_HOST,\n DATABASEDOTCOM_DEBUGGING, DATABASEDOTCOM_VERSION, DATABASEDOTCOM_SOBJECT_MODULE, DATABASEDOTCOM_CA_FILE, and/or\n DATABASEDOTCOM_VERIFY_MODE are present, they override any other values provided\n Authenticate to the Force.com API.  _options_ is a Hash, interpreted as follows:\n\n * If _options_ contains the keys <tt>:username</tt> and <tt>:password</tt>, those credentials are used to authenticate. In this case, the value of <tt>:password</tt> may need to include a concatenated security token, if required by your Salesforce org\n * If _options_ contains the key <tt>:provider</tt>, it is assumed to be the hash returned by Omniauth from a successful web-based OAuth2 authentication\n * If _options_ contains the keys <tt>:token</tt> and <tt>:instance_url</tt>, those are assumed to be a valid OAuth2 token and instance URL for a Salesforce account, obtained from an external source. _options_ may also optionally contain the key <tt>:refresh_token</tt>\n\n Raises SalesForceError if an error occurs", "Returns an Array of Strings listing the class names for every type of _Sobject_ in the database. Raises SalesForceError if an error occurs.", "Returns an array of trending topic names.", "Converts a Hash of object data into a concrete SObject", "Need to refactor, fukken complicated conditions.", "Returns true if this job is currently scheduled.\n\n Takes extra care to answer true if the job is a repeat job\n currently firing.", "`git merge-base ...`. Returns common ancestor for all passed commits\n\n @param [Array<Object>] args - list of commits to process. Last argument can be options for merge-base command\n @return [String]", "Registers strategies and prepares metadata for execution map", "Runs example and collects execution map for it", "Finalizes strategies and saves map", "Adds a resource of the specified _type_ in the current object.\n If _name_ is not specified, a new name will be automatically generated.", "Iterates over the resources by _type_.", "Returns a Hash of all resources in the object or only the specified _type_.", "Iterate through each page of that node.", "Get the n-th Page object in this node, starting from 1.", "Iterates over all the ContentStreams of the Page.", "Add an Annotation to the Page.", "Iterate through each Annotation of the Page.", "Embed a SWF Flash application in the page.", "Returns a Hash of the information found in the metadata stream", "Modifies or creates a metadata stream.", "Returns the current trailer.\n This might be either a Trailer or XRefStream.", "Add a certificate into the address book", "Iterates over each Filter in the Stream.", "Set predictor type for the current Stream.\n Applies only for LZW and FlateDecode filters.", "Uncompress the stream data.", "Compress the stream data.", "Preprocess the object in case it already belongs to a document.\n If the document is the same as the current object stream, remove the duplicate object from our document.\n If the object comes from another document, use the export method to create a version without references.", "Convert String object to an UTF8 encoded Ruby string.", "Draw a polygon from a array of coordinates.", "Returns the version and level required by the current Object.", "Creates a new PDF Object.\n\n\n Sets whether the object is indirect or not.\n Indirect objects are allocated numbers at build time.", "Deep copy of an object.", "Casts an object to a new type.", "Returns an indirect reference to this object.", "Returns an array of references pointing to the current object.", "Creates an exportable version of current object.\n The exportable version is a copy of _self_ with solved references, no owning PDF and no parent.\n References to Catalog or PageTreeNode objects have been destroyed.\n\n When exported, an object can be moved into another document without hassle.", "Returns the symbol type of this Object.", "Copy the attributes of the current object to another object.\n Copied attributes do not include the file offset.", "Replace all references of an object by their actual object value.", "Attempt to promote an object using the deferred casts.", "Returns whether the document contains a digital signature.", "Verifies the ByteRange field of a digital signature and returned the signed data.", "Returns a new compound object with updated values based on the provided block.", "Modifies the compound object's values based on the provided block.", "Returns whether the current document is linearized.", "Tries to delinearize the document if it has been linearized.\n This operation is xrefs destructive, should be fixed in the future to merge tables.", "Strip the document from Hint streams given a linearization dictionary.", "Returns the object pointed to by the reference.\n The reference must be part of a document.\n Raises an InvalidReferenceError if the object cannot be found.", "Creates a new AcroForm with specified fields.", "Iterates over each Acroform Field.", "Installs the standard security dictionary, marking the document as being encrypted.\n Returns the handler and the encryption key used for protecting contents.", "Adds a new object to the PDF file.\n If this object has no version number, then a new one will be automatically\n computed and assignated to him.\n\n It returns a Reference to this Object.\n _object_:: The object to add.", "Adds a new object to a specific revision.\n If this object has no version number, then a new one will be automatically\n computed and assignated to him.\n\n It returns a Reference to this Object.\n _object_:: The object to add.\n _revision_:: The revision to add the object to.", "Ends the current Revision, and starts a new one.", "Remove an object.", "Casts a PDF object into another object type.\n The target type must be a subtype of the original type.", "Searches through an object, possibly going into object streams.\n Returns an array of matching strings, names and streams.", "Load an object from its given file offset.\n The document must have an associated Parser.", "Method called on encrypted objects loaded into the document.", "Force the loading of all objects in the document.", "Converts a logical PDF view into a physical view ready for writing.", "Instanciates basic structures required for a valid PDF file.", "Build a xref section from a set of objects.", "Returns a new Dictionary object with values modified by given block.", "Modifies the values of the Dictionary, leaving keys unchanged.", "Tries to strip any xrefs information off the document.", "Iterates over each XRef present in the stream, passing the XRef and its object number.", "Returns an XRef matching this object number.", "Check and return the internal field widths.", "in case engine was added in namespace", "Returns `true` if all keys specified by the user are satisfied by either an existing keyring or environment\n variables.", "Looks up the given class name in the configured namespaces in order,\n returning the first one that has the class name constant defined.", "swagger spec2.0 related parts\n\n required keys for SwaggerObject", "building info object", "sub-objects of info object\n license", "building path and definitions objects", "Create a Tree\n\n @param [String,Dir,Hash] data\n\n @api public\n Add node to this tree.\n\n @param [Symbol,String] name\n   the name for the node\n\n @param [Node, LeafNode] type\n   the type of node to add\n\n @example\n   TTY::Tree.new do\n     node '...' do\n       node '...'\n     end\n   end\n\n @api public", "Applies attributes and association filters", "Declares a default value for the given attribute.\n\n Sets the default value to the given options parameter unless the given options equal { :value => ... }\n\n The <tt>options</tt> can be used to specify the following things:\n * <tt>value</tt> - Sets the default value.\n * <tt>allows_nil (default: true)</tt> - Sets explicitly passed nil values if option is set to true.", "this is not really compile_js, it compiles the whole app including scss for v1 apps", "find max length for each field; start with the headers", "Converts an array to a hash mapping a numerical index to its array value.", "This method looks for an output object's view in Formatter.config and then Formatter.dynamic_config.\n If a view is found, a stringified view is returned based on the object. If no view is found, nil is returned. The options this\n class takes are a view hash as described in Formatter.config. These options will be merged with any existing helper\n config hash an output class has in Formatter.config. Any block given is passed along to a helper class.", "Returns a hash of options based on dynamic views defined for the object's ancestry. If no config is found returns nil.", "Determines if string should be paged based on configured width and height.", "Recursively merge hash1 with hash2.", "From Rubygems, determine a user's home.", "Set the query params, request headers and request body\n\n * *Args*    :\n   - +args+ -> array of args obtained from method_missing", "Build the final url\n\n * *Args*    :\n   - +query_params+ -> A hash of query parameters\n * *Returns* :\n   - The final url string", "Make the API call and return the response. This is separated into\n it's own function, so we can mock it easily for testing.\n\n * *Args*    :\n   - +http+ -> NET:HTTP request object\n   - +request+ -> NET::HTTP request object\n * *Returns* :\n   - Response object", "Build HTTP request object\n\n * *Returns* :\n   - Request object", "Allow for https calls\n\n * *Args*    :\n   - +http+ -> HTTP::NET object\n * *Returns* :\n   - HTTP::NET object", "Wraps the whole pipelining functionality.", "Allows you to sort your models using their IDs. This is much\n faster than `sort_by`. If you simply want to get records in\n ascending or descending order, then this is the best method to\n do that.\n\n Example:\n\n   class User < Ohm::Model\n     attribute :name\n   end\n\n   User.create(:name => \"John\")\n   User.create(:name => \"Jane\")\n\n   User.all.sort.map(&:id) == [\"1\", \"2\"]\n   # => true\n\n   User.all.sort(:order => \"ASC\").map(&:id) == [\"1\", \"2\"]\n   # => true\n\n   User.all.sort(:order => \"DESC\").map(&:id) == [\"2\", \"1\"]\n   # => true", "Chain new fiters on an existing set.\n\n Example:\n\n   set = User.find(:name => \"John\")\n   set.find(:age => 30)", "Replace all the existing elements of a set with a different\n collection of models. This happens atomically in a MULTI-EXEC\n block.\n\n Example:\n\n   user = User.create\n   p1 = Post.create\n   user.posts.add(p1)\n\n   p2, p3 = Post.create, Post.create\n   user.posts.replace([p2, p3])\n\n   user.posts.include?(p1)\n   # => false", "Update an attribute value atomically. The best usecase for this\n is when you simply want to update one value.\n\n Note: This method is dangerous because it doesn't update indices\n and uniques. Use it wisely. The safe equivalent is `update`.", "Persist the model attributes and update indices and unique\n indices. The `counter`s and `set`s are not touched during save.\n\n Example:\n\n   class User < Ohm::Model\n     attribute :name\n   end\n\n   u = User.new(:name => \"John\").save\n   u.kind_of?(User)\n   # => true", "Turn a relative filename into an absolute one, and make sure it exists.", "Transform the input HTML as a full document and returns the processed\n HTML.\n\n Before the transformation begins, the {#before_transformation} callback\n will be called with the parsed HTML tree and the {Document} instance, and\n after all work is complete the {#after_transformation} callback will be\n invoked in the same way.\n\n Most of the work is delegated to other classes. A list of them can be\n seen below.\n\n @see MarkupImprover MarkupImprover (improves the markup of the DOM)\n @see Inliner Inliner (inlines the stylesheets)\n @see UrlRewriter UrlRewriter (rewrites URLs and makes them absolute)\n @see #transform_partial Transforms partial documents (fragments)\n\n @return [String] the transformed HTML", "Looks for all non-ignored stylesheets, removes their references from the\n DOM and then returns them.\n\n This will mutate the DOM tree.\n\n The order of the array corresponds with the document order in the DOM.\n\n @see #find_css\n @return [Enumerable<Stylesheet>] every extracted stylesheet", "Create a new instance with the given URL options.\n\n Initializing without a host setting raises an error, as do unknown keys.\n\n @param [Hash] url_options\n @option url_options [String] :host (required)\n @option url_options [String, Integer] :port\n @option url_options [String] :path root path\n @option url_options [String] :scheme URL scheme (\"http\" is default)\n @option url_options [String] :protocol alias for :scheme\n Generate an absolute URL from a relative URL.\n\n If the passed path is already an absolute URL or just an anchor\n reference, it will be returned as-is.\n If passed a blank path, the \"root URL\" will be returned. The root URL is\n the URL that the {#url_options} would generate by themselves.\n\n An optional base can be specified. The base is another relative path from\n the root that specifies an \"offset\" from which the path was found in. A\n common use-case is to convert a relative path found in a stylesheet which\n resides in a subdirectory.\n\n @example Normal conversions\n   generator = Roadie::UrlGenerator.new host: \"foo.com\", scheme: \"https\"\n   generator.generate_url(\"bar.html\") # => \"https://foo.com/bar.html\"\n   generator.generate_url(\"/bar.html\") # => \"https://foo.com/bar.html\"\n   generator.generate_url(\"\") # => \"https://foo.com\"\n\n @example Conversions with a base\n   generator = Roadie::UrlGenerator.new host: \"foo.com\", scheme: \"https\"\n   generator.generate_url(\"../images/logo.png\", \"/css\") # => \"https://foo.com/images/logo.png\"\n   generator.generate_url(\"../images/logo.png\", \"/assets/css\") # => \"https://foo.com/assets/images/logo.png\"\n\n @param [String] base The base which the relative path comes from\n @return [String] an absolute URL", "Adds unlineable styles in the specified part of the document\n either the head or in the document\n @param [Symbol] parent  Where to put the styles\n @param [Array<StyleBlock>] blocks  Non-inlineable style blocks\n @param [Boolean]  merge_media_queries  Whether to group media queries", "The collection can contain gems of different names, this method groups them\n by name, and then sorts the different version of each name by version and\n platform.\n\n yields 'foo_gem', version_collection", "SSL certificate generation for knife-azure ssl bootstrap", "img_type = OSImages or VMImage", "Look up on cloud and not local cache", "lists subnets of only a specific virtual network address space", "lists all subnets under a virtual network or lists subnets of only a particular address space", "sort available networks pool in ascending order based on the network's\n IP address to allocate the network for the new subnet to be added in the\n existing virtual network", "sort existing subnets in ascending order based on their cidr prefix or\n netmask to have subnets with larger networks on the top", "sort used networks pool in descending order based on the number of hosts\n it contains, this helps to keep larger networks on top thereby eliminating\n more number of entries in available_networks_pool at a faster pace", "when a address space in an existing virtual network is not used at all\n then divide the space into the number of subnets based on the total\n number of hosts that network supports", "calculate and return address_prefix for the new subnet to be added in the\n existing virtual network", "add new subnet into the existing virtual network", "virtual network configuration creation for the new vnet creation or to\n handle existing vnet", "Look up hosted service on cloud and not local cache", "Iterates each rule in the list.", "Finds and returns the rule corresponding to the longest public suffix for the hostname.\n\n @param  name [#to_s] the hostname\n @param  default [PublicSuffix::Rule::*] the default rule to return in case no rule matches\n @return [PublicSuffix::Rule::*]", "Selects all the rules matching given hostame.\n\n If `ignore_private` is set to true, the algorithm will skip the rules that are flagged as\n private domain. Note that the rules will still be part of the loop.\n If you frequently need to access lists ignoring the private domains,\n you should create a list that doesn't include these domains setting the\n `private_domains: false` option when calling {.parse}.\n\n Note that this method is currently private, as you should not rely on it. Instead,\n the public interface is {#find}. The current internal algorithm allows to return all\n matching rules, but different data structures may not be able to do it, and instead would\n return only the match. For this reason, you should rely on {#find}.\n\n @param  name [#to_s] the hostname\n @param  ignore_private [Boolean]\n @return [Array<PublicSuffix::Rule::*>]", "Starts the execution monitor in a new thread", "Handle the monitoring of a cron schedule\n\n @param schedule [Minicron::Hub::Model::Schedule]", "Build the crontab multiline string that includes all the given jobs\n\n @param host [Minicron::Hub::Model::Host] a host instance with it's jobs and job schedules\n @return [String]", "Adds 'http' as default scheme, if there is none", "Normalize url to deal with characters that should be encoded,\n add trailing slash, convert to downcase...", "Returns all document data as a nested Hash", "Returns true if this command has the given option defined", "Returns full name for help command including parents\n\n Example\n\n   command :remote do |t|\n     t.command :add do |global,options,args|\n     end\n   end\n\n   @add_command.name_for_help # => [\"remote\", \"add\"]", "Loads ruby files in the load path that start with\n +path+, which are presumed to be commands for your executable.\n This is useful for decomposing your bin file into different classes, but\n can also be used as a plugin mechanism, allowing users to provide additional\n commands for your app at runtime.  All that being said, it's basically\n a glorified +require+.\n\n path:: a path from which to load <code>.rb</code> files that, presumably, contain commands.  If this is an absolute path,\n        any files in that path are loaded.  If not, it is interpretted as relative to somewhere\n        in the <code>LOAD_PATH</code>.\n\n == Example:\n\n     # loads *.rb from your app's install - great for decomposing your bin file\n     commands_from \"my_app/commands\"\n\n     # loads *.rb files from the user's home dir - great and an extension/plugin mechanism\n     commands_from File.join(ENV[\"HOME\"],\".my_app\",\"plugins\")", "Sets that this app uses a config file as well as the name of the config file.\n\n +filename+:: A String representing the path to the file to use for the config file.  If it's an absolute\n              path, this is treated as the path to the file.  If it's *not*, it's treated as relative to the user's home\n              directory as produced by <code>File.expand_path('~')</code>.", "Reset the GLI module internal data structures; mostly useful for testing", "Runs whatever command is needed based on the arguments.\n\n +args+:: the command line ARGV array\n\n Returns a number that would be a reasonable exit code", "Sets the default values for flags based on the configuration", "True if we should proceed with executing the command; this calls\n the pre block if it's defined", "Returns true if we should proceed with GLI's basic error handling.\n This calls the error block if the user provided one", "Create a flag, which is a switch that takes an argument\n\n +names+:: a String or Symbol, or an Array of String or Symbol that represent all the different names\n           and aliases for this flag.  The last element can be a hash of options:\n           +:desc+:: the description, instead of using #desc\n           +:long_desc+:: the long_description, instead of using #long_desc\n           +:default_value+:: the default value, instead of using #default_value\n           +:arg_name+:: the arg name, instead of using #arg_name\n           +:must_match+:: A regexp that the flag's value must match or an array of allowable values\n           +:type+:: A Class (or object you passed to GLI::App#accept) to trigger type coversion\n           +:multiple+:: if true, flag may be used multiple times and values are stored in an array\n\n Example:\n\n     desc 'Set the filename'\n     flag [:f,:filename,'file-name']\n\n     flag :ipaddress, :desc => \"IP Address\", :must_match => /\\d+\\.\\d+\\.\\d+\\.\\d+/\n\n     flag :names, :desc => \"list of names\", :type => Array\n\n Produces:\n\n     -f, --filename, --file-name=arg     Set the filename", "Checks that the names passed in have not been used in another flag or option", "Given the command-line argument array, returns an OptionParsingResult", "Create the parser using the given +OptionParser+ instance and exception handling\n strategy.\n\n option_parser_factory:: An +OptionParserFactory+ instance, configured to parse wherever you are on the command line\n exception_klass_or_block:: means of handling exceptions from +OptionParser+.  One of:\n                            an exception class:: will be raised on errors with a message\n                            lambda/block:: will be called with a single argument - the error message.\n Parse the given argument list, returning the unparsed arguments and options hash of parsed arguments.\n Exceptions from +OptionParser+ are given to the handler configured in the constructor\n\n args:: argument list.  This will be mutated\n\n Returns unparsed args", "Handles dealing with the \"names\" param, parsing\n it into the primary name and aliases list", "Returns a string of all possible forms\n of this flag.  Mostly intended for printing\n to the user.", "Uses Haml to render the template into an HTML string, then\n wraps it in the neccessary JavaScript to serve to the client.", "Captures a screenshot of +url+ saving it to +path+.", "Returns a file upload input tag wrapped in markup that allows dragging and dropping of files\n onto the element.\n\n @author Ian Grant\n @see file:README.md#Usage Usage section of the README\n\n @param [Symbol] method The attribute on the target model to attach the files to.\n @param [String] content The content to render inside of the drag and drop file field.\n @param [Hash] options A hash of options to customise the file field.\n\n @option options [Boolean] :disabled If set to true, the user will not be able to use this\n   input.\n @option options [Boolean] :mutiple If set to true, *in most updated browsers* the user will\n   be allowed to select multiple files.\n @option options [String] :accept If set to one or multiple mime-types, the user will be\n   suggested a filter when choosing a file. You still need to set up model validations.\n @option options [Integer] :size_limit The upper limit on filesize to accept in bytes.\n   Client-side validation only. You still need to set up model validations.\n\n @return [String] The generated file field markup.\n\n @example\n   # Accept only PNGs or JPEGs up to 5MB in size:\n   form.drag_and_drop_file_field :images, nil, accept: 'image/png, image/jpeg',\n                                               size_limit: 5_000_000\n @example\n   # Pass custom content string:\n    form.drag_and_drop_file_field :images, '<div>Drag and Drop!</div>', accept: 'image/png'\n @example\n   # Pass a block of content instead of passing a string\n   <%= form.drag_and_drop_file_field(:images, accept: 'image/png') do %>\n     <strong>Drag and Drop</strong> PNG files here or <strong>click to browse</strong>\n   <% end %>", "returns an array of tags used to pre-populate the the dropzone with tags queueing unpersisted\n file attachments for attachment at the next form submission.\n\n @author Ian Grant\n @param [Symbol] method The attribute on the target model to attach the files to.\n @param [Boolean] multiple Whether the dropzone should accept multiple attachments or not.\n @return [Array] An array of hidden field tags for each unpersisted file attachment.", "Generates a hash of default options for the embedded file input field.\n\n @author Ian Grant\n @param [Symbol] method The attribute on the target model to attach the files to.\n @return [Hash] The default options  for the file field", "Merges the user provided options with the default options overwriting the defaults to\n generate the final options passed to the embedded file input field.\n\n @author Ian Grant\n @param [Symbol] method The attribute on the target model to attach the files to.\n @param [Hash] custom_options The user provided custom options hash.\n @return [Hash] The user provided options and default options merged.", "The value that represents this state.  This will optionally evaluate the\n original block if it's a lambda block.  Otherwise, the static value is\n returned.\n\n For example,\n\n   State.new(machine, :parked, :value => 1).value                        # => 1\n   State.new(machine, :parked, :value => lambda {Time.now}).value        # => Tue Jan 01 00:00:00 UTC 2008\n   State.new(machine, :parked, :value => lambda {Time.now}).value(false) # => <Proc:0xb6ea7ca0@...>", "The list of methods that have been defined in this state's context", "Calls a method defined in this state's context on the given object.  All\n arguments and any block will be passed into the method defined.\n\n If the method has never been defined for this state, then a NoMethodError\n will be raised.", "Adds a predicate method to the owner class so long as a name has\n actually been configured for the state", "Sets the initial state of the machine.  This can be either the static name\n of a state or a lambda block which determines the initial state at\n creation time.", "Initializes the state on the given object.  Initial values are only set if\n the machine's attribute hasn't been previously initialized.\n\n Configuration options:\n * <tt>:force</tt> - Whether to initialize the state regardless of its\n   current value\n * <tt>:to</tt> - A hash to set the initial value in instead of writing\n   directly to the object", "Defines a new helper method in an instance or class scope with the given\n name.  If the method is already defined in the scope, then this will not\n override it.\n\n If passing in a block, there are two side effects to be aware of\n 1. The method cannot be chained, meaning that the block cannot call +super+\n 2. If the method is already defined in an ancestor, then it will not get\n    overridden and a warning will be output.\n\n Example:\n\n   # Instance helper\n   machine.define_helper(:instance, :state_name) do |machine, object|\n     machine.states.match(object).name\n   end\n\n   # Class helper\n   machine.define_helper(:class, :state_machine_name) do |machine, klass|\n     \"State\"\n   end\n\n You can also define helpers using string evaluation like so:\n\n   # Instance helper\n   machine.define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1\n     def state_name\n       self.class.state_machine(:state).states.match(self).name\n     end\n   end_eval\n\n   # Class helper\n   machine.define_helper :class, <<-end_eval, __FILE__, __LINE__ + 1\n     def state_machine_name\n       \"State\"\n     end\n   end_eval", "Customizes the definition of one or more states in the machine.\n\n Configuration options:\n * <tt>:value</tt> - The actual value to store when an object transitions\n   to the state.  Default is the name (stringified).\n * <tt>:cache</tt> - If a dynamic value (via a lambda block) is being used,\n   then setting this to true will cache the evaluated result\n * <tt>:if</tt> - Determines whether an object's value matches the state\n   (e.g. :value => lambda {Time.now}, :if => lambda {|state| !state.nil?}).\n   By default, the configured value is matched.\n * <tt>:human_name</tt> - The human-readable version of this state's name.\n   By default, this is either defined by the integration or stringifies the\n   name and converts underscores to spaces.\n\n == Customizing the stored value\n\n Whenever a state is automatically discovered in the state machine, its\n default value is assumed to be the stringified version of the name.  For\n example,\n\n   class Vehicle\n     state_machine :initial => :parked do\n       event :ignite do\n         transition :parked => :idling\n       end\n     end\n   end\n\n In the above state machine, there are two states automatically discovered:\n :parked and :idling.  These states, by default, will store their stringified\n equivalents when an object moves into that state (e.g. \"parked\" / \"idling\").\n\n For legacy systems or when tying state machines into existing frameworks,\n it's oftentimes necessary to need to store a different value for a state\n than the default.  In order to continue taking advantage of an expressive\n state machine and helper methods, every defined state can be re-configured\n with a custom stored value.  For example,\n\n   class Vehicle\n     state_machine :initial => :parked do\n       event :ignite do\n         transition :parked => :idling\n       end\n\n       state :idling, :value => 'IDLING'\n       state :parked, :value => 'PARKED\n     end\n   end\n\n This is also useful if being used in association with a database and,\n instead of storing the state name in a column, you want to store the\n state's foreign key:\n\n   class VehicleState < ActiveRecord::Base\n   end\n\n   class Vehicle < ActiveRecord::Base\n     state_machine :attribute => :state_id, :initial => :parked do\n       event :ignite do\n         transition :parked => :idling\n       end\n\n       states.each do |state|\n         self.state(state.name, :value => lambda { VehicleState.find_by_name(state.name.to_s).id }, :cache => true)\n       end\n     end\n   end\n\n In the above example, each known state is configured to store it's\n associated database id in the +state_id+ attribute.  Also, notice that a\n lambda block is used to define the state's value.  This is required in\n situations (like testing) where the model is loaded without any existing\n data (i.e. no VehicleState records available).\n\n One caveat to the above example is to keep performance in mind.  To avoid\n constant db hits for looking up the VehicleState ids, the value is cached\n by specifying the <tt>:cache</tt> option.  Alternatively, a custom\n caching strategy can be used like so:\n\n   class VehicleState < ActiveRecord::Base\n     cattr_accessor :cache_store\n     self.cache_store = ActiveSupport::Cache::MemoryStore.new\n\n     def self.find_by_name(name)\n       cache_store.fetch(name) { find(:first, :conditions => {:name => name}) }\n     end\n   end\n\n === Dynamic values\n\n In addition to customizing states with other value types, lambda blocks\n can also be specified to allow for a state's value to be determined\n dynamically at runtime.  For example,\n\n   class Vehicle\n     state_machine :purchased_at, :initial => :available do\n       event :purchase do\n         transition all => :purchased\n       end\n\n       event :restock do\n         transition all => :available\n       end\n\n       state :available, :value => nil\n       state :purchased, :if => lambda {|value| !value.nil?}, :value => lambda {Time.now}\n     end\n   end\n\n In the above definition, the <tt>:purchased</tt> state is customized with\n both a dynamic value *and* a value matcher.\n\n When an object transitions to the purchased state, the value's lambda\n block will be called.  This will get the current time and store it in the\n object's +purchased_at+ attribute.\n\n *Note* that the custom matcher is very important here.  Since there's no\n way for the state machine to figure out an object's state when it's set to\n a runtime value, it must be explicitly defined.  If the <tt>:if</tt> option\n were not configured for the state, then an ArgumentError exception would\n be raised at runtime, indicating that the state machine could not figure\n out what the current state of the object was.\n\n == Behaviors\n\n Behaviors define a series of methods to mixin with objects when the current\n state matches the given one(s).  This allows instance methods to behave\n a specific way depending on what the value of the object's state is.\n\n For example,\n\n   class Vehicle\n     attr_accessor :driver\n     attr_accessor :passenger\n\n     state_machine :initial => :parked do\n       event :ignite do\n         transition :parked => :idling\n       end\n\n       state :parked do\n         def speed\n           0\n         end\n\n         def rotate_driver\n           driver = self.driver\n           self.driver = passenger\n           self.passenger = driver\n           true\n         end\n       end\n\n       state :idling, :first_gear do\n         def speed\n           20\n         end\n\n         def rotate_driver\n           self.state = 'parked'\n           rotate_driver\n         end\n       end\n\n       other_states :backing_up\n     end\n   end\n\n In the above example, there are two dynamic behaviors defined for the\n class:\n * +speed+\n * +rotate_driver+\n\n Each of these behaviors are instance methods on the Vehicle class.  However,\n which method actually gets invoked is based on the current state of the\n object.  Using the above class as the example:\n\n   vehicle = Vehicle.new\n   vehicle.driver = 'John'\n   vehicle.passenger = 'Jane'\n\n   # Behaviors in the \"parked\" state\n   vehicle.state             # => \"parked\"\n   vehicle.speed             # => 0\n   vehicle.rotate_driver     # => true\n   vehicle.driver            # => \"Jane\"\n   vehicle.passenger         # => \"John\"\n\n   vehicle.ignite            # => true\n\n   # Behaviors in the \"idling\" state\n   vehicle.state             # => \"idling\"\n   vehicle.speed             # => 20\n   vehicle.rotate_driver     # => true\n   vehicle.driver            # => \"John\"\n   vehicle.passenger         # => \"Jane\"\n\n As can be seen, both the +speed+ and +rotate_driver+ instance method\n implementations changed how they behave based on what the current state\n of the vehicle was.\n\n === Invalid behaviors\n\n If a specific behavior has not been defined for a state, then a\n NoMethodError exception will be raised, indicating that that method would\n not normally exist for an object with that state.\n\n Using the example from before:\n\n   vehicle = Vehicle.new\n   vehicle.state = 'backing_up'\n   vehicle.speed               # => NoMethodError: undefined method 'speed' for #<Vehicle:0xb7d296ac> in state \"backing_up\"\n\n === Using matchers\n\n The +all+ / +any+ matchers can be used to easily define behaviors for a\n group of states.  Note, however, that you cannot use these matchers to\n set configurations for states.  Behaviors using these matchers can be\n defined at any point in the state machine and will always get applied to\n the proper states.\n\n For example:\n\n   state_machine :initial => :parked do\n     ...\n\n     state all - [:parked, :idling, :stalled] do\n       validates_presence_of :speed\n\n       def speed\n         gear * 10\n       end\n     end\n   end\n\n == State-aware class methods\n\n In addition to defining scopes for instance methods that are state-aware,\n the same can be done for certain types of class methods.\n\n Some libraries have support for class-level methods that only run certain\n behaviors based on a conditions hash passed in.  For example:\n\n   class Vehicle < ActiveRecord::Base\n     state_machine do\n       ...\n       state :first_gear, :second_gear, :third_gear do\n         validates_presence_of   :speed\n         validates_inclusion_of  :speed, :in => 0..25, :if => :in_school_zone?\n       end\n     end\n   end\n\n In the above ActiveRecord model, two validations have been defined which\n will *only* run when the Vehicle object is in one of the three states:\n +first_gear+, +second_gear+, or +third_gear.  Notice, also, that if/unless\n conditions can continue to be used.\n\n This functionality is not library-specific and can work for any class-level\n method that is defined like so:\n\n   def validates_presence_of(attribute, options = {})\n     ...\n   end\n\n The minimum requirement is that the last argument in the method be an\n options hash which contains at least <tt>:if</tt> condition support.", "Gets the current value stored in the given object's attribute.\n\n For example,\n\n   class Vehicle\n     state_machine :initial => :parked do\n       ...\n     end\n   end\n\n   vehicle = Vehicle.new                           # => #<Vehicle:0xb7d94ab0 @state=\"parked\">\n   Vehicle.state_machine.read(vehicle, :state)     # => \"parked\" # Equivalent to vehicle.state\n   Vehicle.state_machine.read(vehicle, :event)     # => nil      # Equivalent to vehicle.state_event", "Sets a new value in the given object's attribute.\n\n For example,\n\n   class Vehicle\n     state_machine :initial => :parked do\n       ...\n     end\n   end\n\n   vehicle = Vehicle.new                                   # => #<Vehicle:0xb7d94ab0 @state=\"parked\">\n   Vehicle.state_machine.write(vehicle, :state, 'idling')  # => Equivalent to vehicle.state = 'idling'\n   Vehicle.state_machine.write(vehicle, :event, 'park')    # => Equivalent to vehicle.state_event = 'park'\n   vehicle.state                                           # => \"idling\"\n   vehicle.event                                           # => \"park\"", "Defines one or more events for the machine and the transitions that can\n be performed when those events are run.\n\n This method is also aliased as +on+ for improved compatibility with\n using a domain-specific language.\n\n Configuration options:\n * <tt>:human_name</tt> - The human-readable version of this event's name.\n   By default, this is either defined by the integration or stringifies the\n   name and converts underscores to spaces.\n\n == Instance methods\n\n The following instance methods are generated when a new event is defined\n (the \"park\" event is used as an example):\n * <tt>park(..., run_action = true)</tt> - Fires the \"park\" event,\n   transitioning from the current state to the next valid state.  If the\n   last argument is a boolean, it will control whether the machine's action\n   gets run.\n * <tt>park!(..., run_action = true)</tt> - Fires the \"park\" event,\n   transitioning from the current state to the next valid state.  If the\n   transition fails, then a StateMachines::InvalidTransition error will be\n   raised.  If the last argument is a boolean, it will control whether the\n   machine's action gets run.\n * <tt>can_park?(requirements = {})</tt> - Checks whether the \"park\" event\n   can be fired given the current state of the object.  This will *not* run\n   validations or callbacks in ORM integrations.  It will only determine if\n   the state machine defines a valid transition for the event.  To check\n   whether an event can fire *and* passes validations, use event attributes\n   (e.g. state_event) as described in the \"Events\" documentation of each\n   ORM integration.\n * <tt>park_transition(requirements = {})</tt> -  Gets the next transition\n   that would be performed if the \"park\" event were to be fired now on the\n   object or nil if no transitions can be performed.  Like <tt>can_park?</tt>\n   this will also *not* run validations or callbacks.  It will only\n   determine if the state machine defines a valid transition for the event.\n\n With a namespace of \"car\", the above names map to the following methods:\n * <tt>can_park_car?</tt>\n * <tt>park_car_transition</tt>\n * <tt>park_car</tt>\n * <tt>park_car!</tt>\n\n The <tt>can_park?</tt> and <tt>park_transition</tt> helpers both take an\n optional set of requirements for determining what transitions are available\n for the current object.  These requirements include:\n * <tt>:from</tt> - One or more states to transition from.  If none are\n   specified, then this will be the object's current state.\n * <tt>:to</tt> - One or more states to transition to.  If none are\n   specified, then this will match any to state.\n * <tt>:guard</tt> - Whether to guard transitions with the if/unless\n   conditionals defined for each one.  Default is true.\n\n == Defining transitions\n\n +event+ requires a block which allows you to define the possible\n transitions that can happen as a result of that event.  For example,\n\n   event :park, :stop do\n     transition :idling => :parked\n   end\n\n   event :first_gear do\n     transition :parked => :first_gear, :if => :seatbelt_on?\n     transition :parked => same # Allow to loopback if seatbelt is off\n   end\n\n See StateMachines::Event#transition for more information on\n the possible options that can be passed in.\n\n *Note* that this block is executed within the context of the actual event\n object.  As a result, you will not be able to reference any class methods\n on the model without referencing the class itself.  For example,\n\n   class Vehicle\n     def self.safe_states\n       [:parked, :idling, :stalled]\n     end\n\n     state_machine do\n       event :park do\n         transition Vehicle.safe_states => :parked\n       end\n     end\n   end\n\n == Overriding the event method\n\n By default, this will define an instance method (with the same name as the\n event) that will fire the next possible transition for that.  Although the\n +before_transition+, +after_transition+, and +around_transition+ hooks\n allow you to define behavior that gets executed as a result of the event's\n transition, you can also override the event method in order to have a\n little more fine-grained control.\n\n For example:\n\n   class Vehicle\n     state_machine do\n       event :park do\n         ...\n       end\n     end\n\n     def park(*)\n       take_deep_breath  # Executes before the transition (and before_transition hooks) even if no transition is possible\n       if result = super # Runs the transition and all before/after/around hooks\n         applaud         # Executes after the transition (and after_transition hooks)\n       end\n       result\n     end\n   end\n\n There are a few important things to note here.  First, the method\n signature is defined with an unlimited argument list in order to allow\n callers to continue passing arguments that are expected by state_machine.\n For example, it will still allow calls to +park+ with a single parameter\n for skipping the configured action.\n\n Second, the overridden event method must call +super+ in order to run the\n logic for running the next possible transition.  In order to remain\n consistent with other events, the result of +super+ is returned.\n\n Third, any behavior defined in this method will *not* get executed if\n you're taking advantage of attribute-based event transitions.  For example:\n\n   vehicle = Vehicle.new\n   vehicle.state_event = 'park'\n   vehicle.save\n\n In this case, the +park+ event will run the before/after/around transition\n hooks and transition the state, but the behavior defined in the overriden\n +park+ method will *not* be executed.\n\n == Defining additional arguments\n\n Additional arguments can be passed into events and accessed by transition\n hooks like so:\n\n   class Vehicle\n     state_machine do\n       after_transition :on => :park do |vehicle, transition|\n         kind = *transition.args # :parallel\n         ...\n       end\n       after_transition :on => :park, :do => :take_deep_breath\n\n       event :park do\n         ...\n       end\n\n       def take_deep_breath(transition)\n         kind = *transition.args # :parallel\n         ...\n       end\n     end\n   end\n\n   vehicle = Vehicle.new\n   vehicle.park(:parallel)\n\n *Remember* that if the last argument is a boolean, it will be used as the\n +run_action+ parameter to the event action.  Using the +park+ action\n example from above, you can might call it like so:\n\n   vehicle.park                    # => Uses default args and runs machine action\n   vehicle.park(:parallel)         # => Specifies the +kind+ argument and runs the machine action\n   vehicle.park(:parallel, false)  # => Specifies the +kind+ argument and *skips* the machine action\n\n If you decide to override the +park+ event method *and* define additional\n arguments, you can do so as shown below:\n\n   class Vehicle\n     state_machine do\n       event :park do\n         ...\n       end\n     end\n\n     def park(kind = :parallel, *args)\n       take_deep_breath if kind == :parallel\n       super\n     end\n   end\n\n Note that +super+ is called instead of <tt>super(*args)</tt>.  This allow\n the entire arguments list to be accessed by transition callbacks through\n StateMachines::Transition#args.\n\n === Using matchers\n\n The +all+ / +any+ matchers can be used to easily execute blocks for a\n group of events.  Note, however, that you cannot use these matchers to\n set configurations for events.  Blocks using these matchers can be\n defined at any point in the state machine and will always get applied to\n the proper events.\n\n For example:\n\n   state_machine :initial => :parked do\n     ...\n\n     event all - [:crash] do\n       transition :stalled => :parked\n     end\n   end\n\n == Example\n\n   class Vehicle\n     state_machine do\n       # The park, stop, and halt events will all share the given transitions\n       event :park, :stop, :halt do\n         transition [:idling, :backing_up] => :parked\n       end\n\n       event :stop do\n         transition :first_gear => :idling\n       end\n\n       event :ignite do\n         transition :parked => :idling\n         transition :idling => same # Allow ignite while still idling\n       end\n     end\n   end", "Creates a new transition that determines what to change the current state\n to when an event fires.\n\n == Defining transitions\n\n The options for a new transition uses the Hash syntax to map beginning\n states to ending states.  For example,\n\n   transition :parked => :idling, :idling => :first_gear, :on => :ignite\n\n In this case, when the +ignite+ event is fired, this transition will cause\n the state to be +idling+ if it's current state is +parked+ or +first_gear+\n if it's current state is +idling+.\n\n To help define these implicit transitions, a set of helpers are available\n for slightly more complex matching:\n * <tt>all</tt> - Matches every state in the machine\n * <tt>all - [:parked, :idling, ...]</tt> - Matches every state except those specified\n * <tt>any</tt> - An alias for +all+ (matches every state in the machine)\n * <tt>same</tt> - Matches the same state being transitioned from\n\n See StateMachines::MatcherHelpers for more information.\n\n Examples:\n\n   transition all => nil, :on => :ignite                               # Transitions to nil regardless of the current state\n   transition all => :idling, :on => :ignite                           # Transitions to :idling regardless of the current state\n   transition all - [:idling, :first_gear] => :idling, :on => :ignite  # Transitions every state but :idling and :first_gear to :idling\n   transition nil => :idling, :on => :ignite                           # Transitions to :idling from the nil state\n   transition :parked => :idling, :on => :ignite                       # Transitions to :idling if :parked\n   transition [:parked, :stalled] => :idling, :on => :ignite           # Transitions to :idling if :parked or :stalled\n\n   transition :parked => same, :on => :park                            # Loops :parked back to :parked\n   transition [:parked, :stalled] => same, :on => [:park, :stall]      # Loops either :parked or :stalled back to the same state on the park and stall events\n   transition all - :parked => same, :on => :noop                      # Loops every state but :parked back to the same state\n\n   # Transitions to :idling if :parked, :first_gear if :idling, or :second_gear if :first_gear\n   transition :parked => :idling, :idling => :first_gear, :first_gear => :second_gear, :on => :shift_up\n\n == Verbose transitions\n\n Transitions can also be defined use an explicit set of configuration\n options:\n * <tt>:from</tt> - A state or array of states that can be transitioned from.\n   If not specified, then the transition can occur for *any* state.\n * <tt>:to</tt> - The state that's being transitioned to.  If not specified,\n   then the transition will simply loop back (i.e. the state will not change).\n * <tt>:except_from</tt> - A state or array of states that *cannot* be\n   transitioned from.\n\n These options must be used when defining transitions within the context\n of a state.\n\n Examples:\n\n   transition :to => nil, :on => :park\n   transition :to => :idling, :on => :ignite\n   transition :except_from => [:idling, :first_gear], :to => :idling, :on => :ignite\n   transition :from => nil, :to => :idling, :on => :ignite\n   transition :from => [:parked, :stalled], :to => :idling, :on => :ignite\n\n == Conditions\n\n In addition to the state requirements for each transition, a condition\n can also be defined to help determine whether that transition is\n available.  These options will work on both the normal and verbose syntax.\n\n Configuration options:\n * <tt>:if</tt> - A method, proc or string to call to determine if the\n   transition should occur (e.g. :if => :moving?, or :if => lambda {|vehicle| vehicle.speed > 60}).\n   The condition should return or evaluate to true or false.\n * <tt>:unless</tt> - A method, proc or string to call to determine if the\n   transition should not occur (e.g. :unless => :stopped?, or :unless => lambda {|vehicle| vehicle.speed <= 60}).\n   The condition should return or evaluate to true or false.\n\n Examples:\n\n   transition :parked => :idling, :on => :ignite, :if => :moving?\n   transition :parked => :idling, :on => :ignite, :unless => :stopped?\n   transition :idling => :first_gear, :first_gear => :second_gear, :on => :shift_up, :if => :seatbelt_on?\n\n   transition :from => :parked, :to => :idling, :on => ignite, :if => :moving?\n   transition :from => :parked, :to => :idling, :on => ignite, :unless => :stopped?\n\n == Order of operations\n\n Transitions are evaluated in the order in which they're defined.  As a\n result, if more than one transition applies to a given object, then the\n first transition that matches will be performed.", "Generates the message to use when invalidating the given object after\n failing to transition on a specific event", "Determines whether an action hook was defined for firing attribute-based\n event transitions when the configured action gets called.", "Looks up other machines that have been defined in the owner class and\n are targeting the same attribute as this machine.  When accessing\n sibling machines, they will be automatically copied for the current\n class if they haven't been already.  This ensures that any configuration\n changes made to the sibling machines only affect this class and not any\n base class that may have originally defined the machine.", "Determines if the machine's attribute needs to be initialized.  This\n will only be true if the machine's attribute is blank.", "Adds helper methods for getting information about this state machine's\n available transition paths", "Determines whether action helpers should be defined for this machine.\n This is only true if there is an action configured and no other machines\n have process this same configuration already.", "Determines whether there's already a helper method defined within the\n given scope.  This is true only if one of the owner's ancestors defines\n the method and is further along in the ancestor chain than this\n machine's helper module.", "Adds helper methods for accessing naming information about states and\n events on the owner class", "Generates the results for the given scope based on one or more states to\n filter by", "Updates this machine based on the configuration of other machines in the\n owner class that share the same target attribute.", "Adds a new transition callback of the given type.", "Tracks the given set of states in the list of all known states for\n this machine", "Tracks the given set of events in the list of all known events for\n this machine", "Determines the current state of the given object as configured by this\n state machine.  This will attempt to find a known state that matches\n the value of the attribute on the object.\n\n == Examples\n\n   class Vehicle\n     state_machine :initial => :parked do\n       other_states :idling\n     end\n   end\n\n   states = Vehicle.state_machine.states\n\n   vehicle = Vehicle.new         # => #<Vehicle:0xb7c464b0 @state=\"parked\">\n   states.match(vehicle)         # => #<StateMachines::State name=:parked value=\"parked\" initial=true>\n\n   vehicle.state = 'idling'\n   states.match(vehicle)         # => #<StateMachines::State name=:idling value=\"idling\" initial=true>\n\n   vehicle.state = 'invalid'\n   states.match(vehicle)         # => nil", "Builds a matcher strategy to use for the given options.  If neither a\n whitelist nor a blacklist option is specified, then an AllMatcher is\n built.", "Verifies that the state requirements match the given query.  If a\n matching requirement is found, then it is returned.", "Verifies that an option in the given query matches the values required\n for that option", "Verifies that the conditionals for this branch evaluate to true for the\n given object", "Gets the initial set of paths to walk", "Walks down the given path.  Each new path that matches the configured\n requirements will be added to this collection.", "Determines whether the given transition has been recently walked down in\n this path.  If a target is configured for this path, then this will only\n look at transitions walked down since the target was last reached.", "Get the next set of transitions that can be walked to starting from the\n end of this path", "Hooks in condition-merging to methods that don't exist in this module", "Gets the list of events that can be fired on the given object.\n\n Valid requirement options:\n * <tt>:from</tt> - One or more states being transitioned from.  If none\n   are specified, then this will be the object's current state.\n * <tt>:to</tt> - One or more states being transitioned to.  If none are\n   specified, then this will match any to state.\n * <tt>:on</tt> - One or more events that fire the transition.  If none\n   are specified, then this will match any event.\n * <tt>:guard</tt> - Whether to guard transitions with the if/unless\n   conditionals defined for each one.  Default is true.\n\n == Examples\n\n   class Vehicle\n     state_machine :initial => :parked do\n       event :park do\n         transition :idling => :parked\n       end\n\n       event :ignite do\n         transition :parked => :idling\n       end\n     end\n   end\n\n   events = Vehicle.state_machine(:state).events\n\n   vehicle = Vehicle.new               # => #<Vehicle:0xb7c464b0 @state=\"parked\">\n   events.valid_for(vehicle)           # => [#<StateMachines::Event name=:ignite transitions=[:parked => :idling]>]\n\n   vehicle.state = 'idling'\n   events.valid_for(vehicle)           # => [#<StateMachines::Event name=:park transitions=[:idling => :parked]>]", "Gets the list of transitions that can be run on the given object.\n\n Valid requirement options:\n * <tt>:from</tt> - One or more states being transitioned from.  If none\n   are specified, then this will be the object's current state.\n * <tt>:to</tt> - One or more states being transitioned to.  If none are\n   specified, then this will match any to state.\n * <tt>:on</tt> - One or more events that fire the transition.  If none\n   are specified, then this will match any event.\n * <tt>:guard</tt> - Whether to guard transitions with the if/unless\n   conditionals defined for each one.  Default is true.\n\n == Examples\n\n   class Vehicle\n     state_machine :initial => :parked do\n       event :park do\n         transition :idling => :parked\n       end\n\n       event :ignite do\n         transition :parked => :idling\n       end\n     end\n   end\n\n   events = Vehicle.state_machine.events\n\n   vehicle = Vehicle.new                             # => #<Vehicle:0xb7c464b0 @state=\"parked\">\n   events.transitions_for(vehicle)                   # => [#<StateMachines::Transition attribute=:state event=:ignite from=\"parked\" from_name=:parked to=\"idling\" to_name=:idling>]\n\n   vehicle.state = 'idling'\n   events.transitions_for(vehicle)                   # => [#<StateMachines::Transition attribute=:state event=:park from=\"idling\" from_name=:idling to=\"parked\" to_name=:parked>]\n\n   # Search for explicit transitions regardless of the current state\n   events.transitions_for(vehicle, :from => :parked) # => [#<StateMachines::Transition attribute=:state event=:ignite from=\"parked\" from_name=:parked to=\"idling\" to_name=:idling>]", "Gets the transition that should be performed for the event stored in the\n given object's event attribute.  This also takes an additional parameter\n for automatically invalidating the object if the event or transition are\n invalid.  By default, this is turned off.\n\n *Note* that if a transition has already been generated for the event, then\n that transition will be used.\n\n == Examples\n\n   class Vehicle < ActiveRecord::Base\n     state_machine :initial => :parked do\n       event :ignite do\n         transition :parked => :idling\n       end\n     end\n   end\n\n   vehicle = Vehicle.new                       # => #<Vehicle id: nil, state: \"parked\">\n   events = Vehicle.state_machine.events\n\n   vehicle.state_event = nil\n   events.attribute_transition_for(vehicle)    # => nil # Event isn't defined\n\n   vehicle.state_event = 'invalid'\n   events.attribute_transition_for(vehicle)    # => false # Event is invalid\n\n   vehicle.state_event = 'ignite'\n   events.attribute_transition_for(vehicle)    # => #<StateMachines::Transition attribute=:state event=:ignite from=\"parked\" from_name=:parked to=\"idling\" to_name=:idling>", "Finds and builds the next transition that can be performed on the given\n object.  If no transitions can be made, then this will return nil.\n\n Valid requirement options:\n * <tt>:from</tt> - One or more states being transitioned from.  If none\n   are specified, then this will be the object's current state.\n * <tt>:to</tt> - One or more states being transitioned to.  If none are\n   specified, then this will match any to state.\n * <tt>:guard</tt> - Whether to guard transitions with the if/unless\n   conditionals defined for each one.  Default is true.", "Attempts to perform the next available transition on the given object.\n If no transitions can be made, then this will return false, otherwise\n true.\n\n Any additional arguments are passed to the StateMachines::Transition#perform\n instance method.", "Marks the object as invalid and runs any failure callbacks associated with\n this event.  This should get called anytime this event fails to transition.", "Add the various instance methods that can transition the object using\n the current event", "Builds the collection of transitions for all event attributes defined on\n the given object.  This will only include events whose machine actions\n match the one specified.\n\n These should only be fired as a result of the action being run.", "Adds a new node to the collection.  By doing so, this will also add it to\n the configured indices.  This will also evaluate any existings contexts\n that match the new node.", "Updates the node for the given index, including the string and symbol\n versions of the index", "Evaluates the given context for a particular node.  This will only\n evaluate the context if the node matches.", "Pauses the current callback execution.  This should only occur within\n around callbacks when the remainder of the callback will be executed at\n a later point in time.", "Resumes the execution of a previously paused callback execution.  Once\n the paused callbacks complete, the current execution will continue.", "Runs the machine's +before+ callbacks for this transition.  Only\n callbacks that are configured to match the event, from state, and to\n state will be invoked.\n\n Once the callbacks are run, they cannot be run again until this transition\n is reset.", "Runs the machine's +after+ callbacks for this transition.  Only\n callbacks that are configured to match the event, from state, and to\n state will be invoked.\n\n Once the callbacks are run, they cannot be run again until this transition\n is reset.\n\n == Halting\n\n If any callback throws a <tt>:halt</tt> exception, it will be caught\n and the callback chain will be automatically stopped.  However, this\n exception will not bubble up to the caller since +after+ callbacks\n should never halt the execution of a +perform+.", "Runs each transition's callbacks recursively.  Once all before callbacks\n have been executed, the transitions will then be persisted and the\n configured actions will be run.\n\n If any transition fails to run its callbacks, :halt will be thrown.", "Runs the actions for each transition.  If a block is given method, then it\n will be called instead of invoking each transition's action.\n\n The results of the actions will be used to determine #success?.", "Resets the event attribute so it can be re-evaluated if attempted again", "Runs the callback as long as the transition context matches the branch\n requirements configured for this callback.  If a block is provided, it\n will be called when the last method has run.\n\n If a terminator has been configured and it matches the result from the\n evaluated method, then the callback chain should be halted.", "Makes a basic HTTP GET request to the URI provided allowing the user to terminate the connection", "Makes a basic HTTP POST request to the URI provided allowing the user to terminate the connection", "Initialize socket and add it to the opts", "Appends the given `script_name` after the `after_script_name`.", "Detects params from url and apply as scopes to your classes.\n\n == Options\n\n * <tt>:type</tt> - Checks the type of the parameter sent. If set to :boolean\n                    it just calls the named scope, without any argument. By default,\n                    it does not allow hashes or arrays to be given, except if type\n                    :hash or :array are set.\n\n * <tt>:only</tt> - In which actions the scope is applied. By default is :all.\n\n * <tt>:except</tt> - In which actions the scope is not applied. By default is :none.\n\n * <tt>:as</tt> - The key in the params hash expected to find the scope.\n                  Defaults to the scope name.\n\n * <tt>:using</tt> - If type is a hash, you can provide :using to convert the hash to\n                     a named scope call with several arguments.\n\n * <tt>:if</tt> - Specifies a method, proc or string to call to determine\n                  if the scope should apply\n\n * <tt>:unless</tt> - Specifies a method, proc or string to call to determine\n                      if the scope should NOT apply.\n\n * <tt>:default</tt> - Default value for the scope. Whenever supplied the scope\n                       is always called.\n\n * <tt>:allow_blank</tt> - Blank values are not sent to scopes by default. Set to true to overwrite.\n\n == Block usage\n\n has_scope also accepts a block. The controller, current scope and value are yielded\n to the block so the user can apply the scope on its own. This is useful in case we\n need to manipulate the given value:\n\n   has_scope :category do |controller, scope, value|\n     value != \"all\" ? scope.by_category(value) : scope\n   end\n\n   has_scope :not_voted_by_me, :type => :boolean do |controller, scope|\n     scope.not_voted_by(controller.current_user.id)\n   end", "Return true if all the key-value pairs in the cond Hash match the\n @attributes key-values.", "Iterate over each child of the instance yielding according to the cond\n argument value. If the cond argument is nil then all child nodes are\n yielded to. If cond is a string then only the child Elements with a\n matching name will be yielded to. If the cond is a Hash then the\n keys-value pairs in the cond must match the child attribute values with\n the same keys. Any other cond type will yield to nothing.", "Remove all the children matching the path provided\n\n Examples are:\n * <code>element.remove_children(Ox:Element)</code> removes the element passed as argument if child of the element.\n * <code>element.remove_children(Ox:Element, Ox:Element)</code> removes the list of elements passed as argument if children of the element.\n\n - +children+ [Array] array of OX", "Removes recursively children for nodes and sub_nodes\n\n - +found+ [Array] An array of Ox::Element", "This is called when a visitor is visiting a\n visitable item.\n\n By default this method calls the method\n `visit_<visitable classname>` so make sure\n you've created a method for each visitable you\n intend to visit.\n\n @param [Visitable] visitable\n                    the visitable item the visitor is visiting", "This is called when a visitor is leaving a\n visitable item.\n\n By default this method calls the method\n `leave_<visitable classname>` so make sure\n you've created a method for each visitable you\n intend to visit.\n\n @param [Visitable] visitable\n                    the visitable item the visitor has left", "Creates a new Copy Files build phase for the\n target\n\n @param   [String] name\n          the name to use for the build phase\n\n @param   [Proc] block\n          an optional block that configures the build phase through the DSL.\n\n @return [CopyFilesBuildPhase] the new xcode build phase", "Creates a new Shell Script build phase for the\n target before all of the other build phases\n\n @param   [String] name\n          the name to use for the build phase\n\n @param   [Proc] block\n          an optional block that configures the build phase through the DSL.\n\n @return [ShellScriptBuildPhase] the new xcode build phase", "Creates a new Shell Script build phase for the\n target\n\n @param   [String] name\n          the name to use for the build phase\n\n @param   [Proc] block\n          an optional block that configures the build phase through the DSL.\n\n @return [ShellScriptBuildPhase] the new xcode build phase", "Creates a new build rule for the\n target\n\n @param   [String] name\n          the name to use for the build rule\n\n @param   [Proc] block\n          an optional block that configures the build rule through the DSL.\n\n @return [BuildRule] the new xcode build rule", "This either finds a configuration\n with the same name and type or creates one.\n\n @return [Configuration] the new or existing configuration", "Defines a new application target.\n\n @param  [Symbol] platform\n         platform for the application, can be either `:ios`, `:osx`, `:tvos` or `:watchos`.\n\n @param  [Float] deployment_target\n         the minimum deployment version for the platform.\n\n @param  [Symbol] language\n         language for application, can be either `:objc` or `:swift`.\n\n @param  [Proc] block\n         an optional block that configures the target through the DSL.\n\n @return [Target] the application target\n         the newly created application target", "Defines a extension target.\n\n @param  [Target] host target\n         host target for which the extension is for.\n\n @param  [Proc] block\n         an optional block that configures the target through the DSL.\n\n @return [Target] the extension target\n         the newly created extension target", "Defines targets for watch app.\n\n @param  [Target] watch app's compantion app\n         iOS target for the watch app\n\n @param  [Proc] block\n         an optional block that configures the targets through the DSL.\n\n @return Void", "Returns an array of default system frameworks\n to use for a given platform.\n\n @param    [Symbol] platform\n           platform the frameworks are for.\n\n\n @return [Array<String>] system frameworks to use", "List of transitionable states from the current state", "Converts a time to the local time for the time zone.\n\n The result will be of type {TimeWithOffset} (if passed a `Time`),\n {DateTimeWithOffset} (if passed a `DateTime`) or {TimestampWithOffset} (if\n passed a {Timestamp}). {TimeWithOffset}, {DateTimeWithOffset} and\n {TimestampWithOffset} are subclasses of `Time`, `DateTime` and {Timestamp}\n that provide additional information about the local result.\n\n Unlike {utc_to_local}, {to_local} takes the UTC offset of the given time\n into consideration.\n\n @param time [Object] a `Time`, `DateTime` or {Timestamp}.\n @return [Object] the local equivalent of `time` as a {TimeWithOffset},\n   {DateTimeWithOffset} or {TimestampWithOffset}.\n @raise [ArgumentError] if `time` is `nil`.\n @raise [ArgumentError] if `time` is a {Timestamp} that does not have a\n   specified UTC offset.", "Converts a time in UTC to the local time for the time zone.\n\n The result will be of type {TimeWithOffset} (if passed a `Time`),\n {DateTimeWithOffset} (if passed a `DateTime`) or {TimestampWithOffset} (if\n passed a {Timestamp}). {TimeWithOffset}, {DateTimeWithOffset} and\n {TimestampWithOffset} are subclasses of `Time`, `DateTime` and {Timestamp}\n that provide additional information about the local result.\n\n The UTC offset of the `utc_time` parameter is ignored (it is treated as a\n UTC time). Use the {to_local} method instead if the the UTC offset of the\n time needs to be taken into consideration.\n\n @param utc_time [Object] a `Time`, `DateTime` or {Timestamp}.\n @return [Object] the local equivalent of `utc_time` as a {TimeWithOffset},\n   {DateTimeWithOffset} or {TimestampWithOffset}.\n @raise [ArgumentError] if `utc_time` is `nil`.", "Converts a local time for the time zone to UTC.\n\n The result will either be a `Time`, `DateTime` or {Timestamp} according to\n the type of the `local_time` parameter.\n\n The UTC offset of the `local_time` parameter is ignored (it is treated as\n a time in the time zone represented by `self`).\n\n _Warning:_ There are local times that have no equivalent UTC times (for\n example, during the transition from standard time to daylight savings\n time). There are also local times that have more than one UTC equivalent\n (for example, during the transition from daylight savings time to standard\n time).\n\n In the first case (no equivalent UTC time), a {PeriodNotFound} exception\n will be raised.\n\n In the second case (more than one equivalent UTC time), an {AmbiguousTime}\n exception will be raised unless the optional `dst` parameter or block\n handles the ambiguity.\n\n If the ambiguity is due to a transition from daylight savings time to\n standard time, the `dst` parameter can be used to select whether the\n daylight savings time or local time is used. For example, the following\n code would raise an {AmbiguousTime} exception:\n\n     tz = TZInfo::Timezone.get('America/New_York')\n     tz.period_for_local(Time.new(2004,10,31,1,30,0))\n\n Specifying `dst = true` would select the daylight savings period from\n April to October 2004. Specifying `dst = false` would return the\n standard time period from October 2004 to April 2005.\n\n The `dst` parameter will not be able to resolve an ambiguity resulting\n from the clocks being set back without changing from daylight savings time\n to standard time. In this case, if a block is specified, it will be called\n to resolve the ambiguity. The block must take a single parameter - an\n `Array` of {TimezonePeriod}s that need to be resolved. The block can\n select and return a single {TimezonePeriod} or return `nil` or an empty\n `Array` to cause an {AmbiguousTime} exception to be raised.\n\n The default value of the `dst` parameter can be specified using\n {Timezone.default_dst=}.\n\n @param local_time [Object] a `Time`, `DateTime` or {Timestamp}.\n @param dst [Boolean] whether to resolve ambiguous local times by always\n   selecting the period observing daylight savings time (`true`), always\n   selecting the period observing standard time (`false`), or leaving the\n   ambiguity unresolved (`nil`).\n @yield [periods] if the `dst` parameter did not resolve an ambiguity, an\n   optional block is yielded to.\n @yieldparam periods [Array<TimezonePeriod>] an `Array` containing all\n   the {TimezonePeriod}s that still match `local_time` after applying the\n   `dst` parameter.\n @yieldreturn [Object] to resolve the ambiguity: a chosen {TimezonePeriod}\n   or an `Array` containing a chosen {TimezonePeriod}; to leave the\n   ambiguity unresolved: an empty `Array`, an `Array` containing more than\n   one {TimezonePeriod}, or `nil`.\n @return [Object] the UTC equivalent of `local_time` as a `Time`,\n   `DateTime` or {Timestamp}.\n @raise [ArgumentError] if `local_time` is `nil`.\n @raise [PeriodNotFound] if `local_time` is not valid for the time zone\n   (there is no equivalent UTC time).\n @raise [AmbiguousTime] if `local_time` was ambiguous for the time zone and\n   the `dst` parameter or block did not resolve the ambiguity.", "Tries an operation using `string` directly. If the operation fails, the\n string is copied and encoded with `encoding` and the operation is tried\n again.\n\n @param string [String] The `String` to perform the operation on.\n @param encoding [Encoding] The `Encoding` to use if the initial attempt\n   fails.\n @yield [s] the caller will be yielded to once or twice to attempt the\n   operation.\n @yieldparam s [String] either `string` or an encoded copy of `string`.\n @yieldreturn [Object] The result of the operation. Must be truthy if\n   successful.\n @return [Object] the result of the operation or `nil` if the first attempt\n fails and `string` is already encoded with `encoding`.", "Builds the honeypot html\n\n @param honeypot [Symbol] name of honeypot, ie: subtitle => input name: subtitle\n @param scope [Symbol] name of honeypot scope, ie: topic => input name: topic[subtitle]\n @param options [Hash] html_options for input and invisible_captcha options\n\n @return [String] the generated html", "Returns an option's value, raises UnknownOption if the option does not exist.", "Set the value for an option. Raises an ArgumentError if the option\n does not exist.", "Returns an Option if it exists. Ignores any prefixed hyphens.", "Returns a hash with option key => value.", "Try and find an option to process", "Returns the last key as a symbol. Used in Options.to_hash.", "Add a separator between options. Used when displaying\n the help text.", "Handle custom option types. Will fall back to raising an\n exception if an option is not defined.", "Write summary to temporary file for runner", "Override the call to Pry.start to save off current Server, pass a\n pry_remote flag so pry-nav knows this is a remote session, and not kill\n the server right away", "Runs a block that may get paused.  If the block doesn't pause, then\n execution will continue as normal.  If the block gets paused, then it\n will take care of switching the execution context when it's resumed.\n\n This will return true if the given block halts for a reason other than\n getting paused.", "Creates a new transition that determines what to change the current state\n to when this event fires.\n\n Since this transition is being defined within an event context, you do\n *not* need to specify the <tt>:on</tt> option for the transition.  For\n example:\n\n  state_machine do\n    event :ignite do\n      transition :parked => :idling, :idling => same, :if => :seatbelt_on? # Transitions to :idling if seatbelt is on\n      transition all => :parked, :unless => :seatbelt_on?                  # Transitions to :parked if seatbelt is off\n    end\n  end\n\n See StateMachine::Machine#transition for a description of the possible\n configurations for defining transitions.", "Creates a new context for the given state\n Creates a new transition that determines what to change the current state\n to when an event fires from this state.\n\n Since this transition is being defined within a state context, you do\n *not* need to specify the <tt>:from</tt> option for the transition.  For\n example:\n\n   state_machine do\n     state :parked do\n       transition :to => :idling, :on => [:ignite, :shift_up]                          # Transitions to :idling\n       transition :from => [:idling, :parked], :on => :park, :unless => :seatbelt_on?  # Transitions to :parked if seatbelt is off\n     end\n   end\n\n See StateMachine::Machine#transition for a description of the possible\n configurations for defining transitions.", "Creates a new collection of nodes for the given state machine.  By default,\n the collection is empty.\n\n Configuration options:\n * <tt>:index</tt> - One or more attributes to automatically generate\n   hashed indices for in order to perform quick lookups.  Default is to\n   index by the :name attribute\n Creates a copy of this collection such that modifications don't affect\n the original collection", "Tracks a context that should be evaluated for any nodes that get added\n which match the given set of nodes.  Matchers can be used so that the\n context can get added once and evaluated after multiple adds.", "Sets the class which is the owner of this state machine.  Any methods\n generated by states, events, or other parts of the machine will be defined\n on the given owner class.", "Runs all of the methods configured for this callback.\n\n When running +around+ callbacks, this will evaluate each method and\n yield when the last method has yielded.  The callback will only halt if\n one of the methods does not yield.\n\n For all other types of callbacks, this will evaluate each method in\n order.  The callback will only halt if the resulting value from the\n method passes the terminator.", "Accept a client on the TCP server socket, then receive its initial HTTP request\n and use that to initialize a Web Socket.", "Send a message and block until there is a response", "Backport for Rails 3.2", "Patchy tags\n tag 'webserver', 'apache', 'myenvironment'", "Parses a document and yields the contained SVG nodeset to the given block\n if it exists.\n\n Returns a Nokogiri::XML::Document.", "For each of the given paths, recursively reads each asset and stores its\n contents alongside the full path to the asset.\n\n paths   - One or more String representing directories on disk to search\n           for asset files. Note: paths are searched recursively.\n filters - One or more Strings/Regexps to match assets against. Only\n           assets matching all filters will be cached and available to load.\n           Note: Specifying no filters will cache every file found in\n           paths.\n\n Public: Finds the named asset and returns the contents as a string.\n\n asset_name  - A string representing the name of the asset to load\n\n Returns: A String or raises InlineSvg::AssetFile::FileNotFound error", "recursively convert strings from outside a content stream into UTF-8", "Group 4, 2D", "Returns true if notifications are disabled for this object.", "Used to copy one unit to another\n @param [Unit] from Unit to copy definition from\n @return [Unit]", "Is this unit in base form?\n @return [Boolean]", "convert to base SI units\n results of the conversion are cached so subsequent calls to this will be fast\n @return [Unit]\n @todo this is brittle as it depends on the display_name of a unit, which can be changed", "Generate human readable output.\n If the name of a unit is passed, the unit will first be converted to the target unit before output.\n some named conversions are available\n\n @example\n  unit.to_s(:ft) - outputs in feet and inches (e.g., 6'4\")\n  unit.to_s(:lbs) - outputs in pounds and ounces (e.g, 8 lbs, 8 oz)\n\n You can also pass a standard format string (i.e., '%0.2f')\n or a strftime format string.\n\n output is cached so subsequent calls for the same format will be fast\n\n @note Rational scalars that are equal to an integer will be represented as integers (i.e, 6/1 => 6, 4/2 => 2, etc..)\n @param [Symbol] target_units\n @return [String]", "Compare two Unit objects. Throws an exception if they are not of compatible types.\n Comparisons are done based on the value of the unit in base SI units.\n @param [Object] other\n @return [-1|0|1|nil]\n @raise [NoMethodError] when other does not define <=>\n @raise [ArgumentError] when units are not compatible\n Compare Units for equality\n this is necessary mostly for Complex units.  Complex units do not have a <=> operator\n so we define this one here so that we can properly check complex units for equality.\n Units of incompatible types are not equal, except when they are both zero and neither is a temperature\n Equality checks can be tricky since round off errors may make essentially equivalent units\n appear to be different.\n @param [Object] other\n @return [Boolean]\n check to see if units are compatible, but not the scalar part\n this check is done by comparing signatures for performance reasons\n if passed a string, it will create a unit object with the string and then do the comparison\n @example this permits a syntax like:\n  unit =~ \"mm\"\n @note if you want to do a regexp comparison of the unit string do this ...\n  unit.units =~ /regexp/\n @param [Object] other\n @return [Boolean]", "Add two units together.  Result is same units as receiver and scalar and base_scalar are updated appropriately\n throws an exception if the units are not compatible.\n It is possible to add Time objects to units of time\n @param [Object] other\n @return [Unit]\n @raise [ArgumentError] when two temperatures are added\n @raise [ArgumentError] when units are not compatible\n @raise [ArgumentError] when adding a fixed time or date to a time span", "Multiply two units.\n @param [Numeric] other\n @return [Unit]\n @raise [ArgumentError] when attempting to multiply two temperatures", "Divide two units.\n Throws an exception if divisor is 0\n @param [Numeric] other\n @return [Unit]\n @raise [ZeroDivisionError] if divisor is zero\n @raise [ArgumentError] if attempting to divide a temperature by another temperature", "divide two units and return quotient and remainder\n when both units are in the same units we just use divmod on the raw scalars\n otherwise we use the scalar of the base unit which will be a float\n @param [Object] other\n @return [Array]", "Exponentiate.  Only takes integer powers.\n Note that anything raised to the power of 0 results in a Unit object with a scalar of 1, and no units.\n Throws an exception if exponent is not an integer.\n Ideally this routine should accept a float for the exponent\n It should then convert the float to a rational and raise the unit by the numerator and root it by the denominator\n but, sadly, floats can't be converted to rationals.\n\n For now, if a rational is passed in, it will be used, otherwise we are stuck with integers and certain floats < 1\n @param [Numeric] other\n @return [Unit]\n @raise [ArgumentError] when raising a temperature to a power\n @raise [ArgumentError] when n not in the set integers from (1..9)\n @raise [ArgumentError] when attempting to raise to a complex number\n @raise [ArgumentError] when an invalid exponent is passed", "returns the unit raised to the n-th power\n @param [Integer] n\n @return [Unit]\n @raise [ArgumentError] when attempting to raise a temperature to a power\n @raise [ArgumentError] when n is not an integer", "returns the 'unit' part of the Unit object without the scalar\n @return [String]", "automatically coerce objects to units when possible\n if an object defines a 'to_unit' method, it will be coerced using that method\n @param [Object, #to_unit]\n @return [Array]", "returns a new unit that has been scaled to be more in line with typical usage.", "calculates the unit signature vector used by unit_signature\n @return [Array]\n @raise [ArgumentError] when exponent associated with a unit is > 20 or < -20", "calculates the unit signature id for use in comparing compatible units and simplification\n the signature is based on a simple classification of units and is based on the following publication\n\n Novak, G.S., Jr. \"Conversion of units of measurement\", IEEE Transactions on Software Engineering, 21(8), Aug 1995, pp.651-661\n @see http://doi.ieeecomputersociety.org/10.1109/32.403789\n @return [Array]", "Retrieves the parent class name if using STI.", "Return Moneta store with default options or additional proxies\n\n @param [Hash] options Options to merge\n @return [Moneta store]\n\n @api public", "Fetch a value with a key\n\n @overload fetch(key, options = {}, &block)\n   retrieve a key. if the key is not available, execute the\n   block and return its return value.\n   @param [Object] key\n   @param [Hash] options\n   @option options [Integer] :expires Update expiration time (See {Expires})\n   @option options [Boolean] :raw Raw access without value transformation (See {Transformer})\n   @option options [String] :prefix Prefix key (See {Transformer})\n   @return [Object] value from store\n\n @overload fetch(key, default, options = {})\n   retrieve a key. if the key is not available, return the default value.\n   @param [Object] key\n   @param [Object] default Default value\n   @param [Hash] options\n   @option options [Integer] :expires Update expiration time (See {Expires})\n   @option options [Boolean] :raw Raw access without value transformation (See {Transformer})\n   @option options [String] :prefix Prefix key (See {Transformer})\n   @return [Object] value from store\n\n @api public", "Returns a collection of key-value pairs corresponding to those supplied\n keys which are present in the key-value store, and their associated\n values.  Only those keys present in the store will have pairs in the\n return value.  The return value can be any enumerable object that yields\n pairs, so it could be a hash, but needn't be.\n\n @note The keys in the return value may be the same objects that were\n   supplied (i.e. {Object#equal?}), or may simply be equal (i.e.\n   {Object#==}).\n\n @note Some adapters may implement this method atomically. The default\n   implmentation uses {#values_at}.\n\n @param (see #values_at)\n @option options (see #values_at)\n @return [<(Object, Object)>] A collection of key-value pairs\n @api public", "Calculates the time when something will expire.\n\n This method considers false and 0 as \"no-expire\" and every positive\n number as a time to live in seconds.\n\n @param [Hash] options Options hash\n @option options [0,false,nil,Numeric] :expires expires value given by user\n @param [0,false,nil,Numeric] default default expiration time\n\n @return [false] if it should not expire\n @return [Time] the time when something should expire\n @return [nil] if it is not known", "Calculates the number of seconds something should last.\n\n This method considers false and 0 as \"no-expire\" and every positive\n number as a time to live in seconds.\n\n @param [Hash] options Options hash\n @option options [0,false,nil,Numeric] :expires expires value given by user\n @param [0,false,nil,Numeric] default default expiration time\n\n @return [false] if it should not expire\n @return [Numeric] seconds until expiration\n @return [nil] if it is not known", "Add proxy to stack\n\n @param [Symbol/Class] proxy Name of proxy class or proxy class\n @param [Hash] options Options hash\n @api public", "Add adapter to stack\n\n @param [Symbol/Class/Moneta store] adapter Name of adapter class, adapter class or Moneta store\n @param [Hash] options Options hash\n @api public", "Run the server\n\n @note This method blocks!", "Handle the <%|= and <%|== tags", "To open certstore and return open certificate store pointer", "Check if expression is empty\n\n @param exp [Array] Temple expression\n @return true if expression is empty", "select all loggers with File log devices", "normalizes datetime objects to strings etc. more similar to what the client would see.", "Returns whether a given feature is enabled either globally or for a given\n repository.\n\n By default, this will return false.", "Return whether a feature has been enabled for a user.\n\n By default, this return false.", "must be used within a transaction", "Return exit status\n\n @return [Fixnum]\n\n @api private", "Return effective sources\n\n @return [Enumerable<CLI::Source>]\n\n @api private", "Return sources for file name\n\n @param [String] file_name\n\n @return [Enumerable<CLI::Source>]\n\n @api private\n\n ignore :reek:UtilityFunction", "Define named child\n\n @param [Symbol] name\n @param [Fixnum] index\n\n @return [undefined]\n\n @api private", "Define a group of children\n\n @param [Symbol] name\n @param [Range] range\n\n @return [undefined]\n\n @pai private", "Create name helpers\n\n @return [undefined]\n\n @api private", "Return visited children\n\n @return [Array<Parser::Ast::Node>]\n\n @api private", "Trigger write to buffer\n\n @return [self]\n\n @api private", "Visit ambiguous node\n\n @param [Parser::AST::Node] node\n\n @return [undefined]\n\n @api private", "Emit delimited body\n\n @param [Enumerable<Parser::AST::Node>] nodes\n @param [String] delimiter\n\n @return [undefined]\n\n @api private", "Write comments that appeared before source_part in the source\n\n @param [Symbol] source_part\n\n @return [undefined]\n\n @api private", "Write end-of-file comments\n\n @return [undefined]\n\n @api private", "Write each comment to a separate line\n\n @param [Array] comments\n\n @return [undefined]\n\n @api private", "Emit non nil body\n\n @param [Parser::AST::Node] node\n\n @return [undefined]\n\n @api private\n\n rubocop:disable MethodCallWithoutArgsParentheses", "Take comments appear in the source before the specified part of the node\n\n @param [Parser::AST::Node] node\n @param [Symbol] source_part\n\n @return [Array]\n\n @api private", "Unshift document comments and return the rest\n\n @param [Array] comments\n\n @return [Array]\n\n @api private", "Copy over any .bundler and Gemfile.lock files to the target gem\n directory.  This will let us run tests from under that directory.\n\n This is only on the 2-arg implementations pathway.  This is not used\n for the 3-arg version.", "This is the implementation of the 3-arg version of writing the merged lockfiles,\n when called with the 2-arg version it short-circuits, however, to the copy_bundler_env\n version above.\n\n This code does not affect the generated binstubs at all.", "prepend header and sort lines before closing output", "handle `Class.new arg` call without parens", "Ripper trips up on keyword arguments in pre-2.1 Ruby and supplies extra\n arguments that we just ignore here", "Stores the given translations.\n\n @param [String] locale the locale (ie \"en\") to store translations for\n @param [Hash] data nested key-value pairs to be added as blurbs", "fallback to translation in different locale", "tries to get `default_value` from localization_key - checks other\n localizations", "Uses the active translation provider to translate a text or array of\n texts.\n @param [String, Array] text The text (or array of texts) to translate\n @param [Symbol, String] from The language to translate from. If not given,\n   auto-detection will be attempted.\n @param [Symbol, String] to The language to translate to.\n @param [Hash] opts Additional, provider-specific optional parameters.", "Optional if provider-speciffic environment variables are set correctly.\n Configures the cloud translation provider with specific settings,\n overriding those from environment if needed.\n\n @example\n   Lit::CloudTranslation.configure do |config|\n     # For Yandex, this overrides the YANDEX_TRANSLATE_API_KEY env\n     config.api_key = 'my_awesome_api_key'\n   end", "This is mean to insert a value for a key in a given locale\n using some kind of strategy which depends on the service's options.\n\n For instance, when @raw option is true (it's the default),\n if a key already exists, it overrides the default_value of the\n existing localization key; otherwise, with @raw set to false,\n it keeps the default as it is and, no matter if a translated value\n is there, translated_value is overridden with the imported one\n and is_changed is set to true.", "Approximate an ASCII string. This works only for Western strings using\n characters that are Roman-alphabet characters + diacritics. Non-letter\n characters are left unmodified.\n\n   string = Identifier.new \"\u0141\u00f3d\u017a\n   string.transliterate                 # => \"Lodz, Poland\"\n   string = Identifier.new \"\u65e5\u672c\"\n   string.transliterate                 # => \"\u65e5\u672c\"\n\n You can pass any key(s) from +Characters.approximations+ as arguments. This allows\n for contextual approximations. Various languages are supported, you can see which ones\n by looking at the source of {Babosa::Transliterator::Base}.\n\n   string = Identifier.new \"J\u00fcrgen M\u00fcller\"\n   string.transliterate                 # => \"Jurgen Muller\"\n   string.transliterate :german         # => \"Juergen Mueller\"\n   string = Identifier.new \"\u00a1Feliz a\u00f1o!\"\n   string.transliterate                 # => \"\u00a1Feliz ano!\"\n   string.transliterate :spanish        # => \"\u00a1Feliz anio!\"\n\n The approximations are an array, which you can modify if you choose:\n\n   # Make Spanish use \"nh\" rather than \"nn\"\n   Babosa::Transliterator::Spanish::APPROXIMATIONS[\"\u00f1\"] = \"nh\"\n\n Notice that this method does not simply convert to ASCII; if you want\n to remove non-ASCII characters such as \"\u00a1\" and \"\u00bf\", use {#to_ascii!}:\n\n   string.transliterate!(:spanish)       # => \"\u00a1Feliz anio!\"\n   string.transliterate!                 # => \"\u00a1Feliz anio!\"\n\n @param *args <Symbol>\n @return String", "Normalize a string so that it can safely be used as a Ruby method name.", "Truncate the string to +max+ bytes. This can be useful for ensuring that\n a UTF-8 string will always fit into a database column with a certain max\n byte length. The resulting string may be less than +max+ if the string must\n be truncated at a multibyte character boundary.\n @example\n   \"\u00fc\u00e9\u00f8\u00e1\".to_identifier.truncate_bytes(3) #=> \"\u00fc\"\n @return String", "Used as the basis of the bangless methods.", "Determine which Ascii Nyan Cat to display. If tests are complete,\n Nyan Cat goes to sleep. If there are failing or pending examples,\n Nyan Cat is concerned.\n\n @return [String] Nyan Cat", "A Unix trick using stty to get the console columns\n\n @return [Fixnum]", "Creates a data store of pass, failed, and pending example results\n We have to pad the results here because sprintf can't properly pad color\n\n @return [Array]", "Creates a rainbow trail\n\n @return [String] the sprintf format of the Nyan cat", "Calculates the colors of the rainbow\n\n @return [Array]", "Determines how to color the example.  If pass, it is rainbowified, otherwise\n we assign red if failed or yellow if an error occurred.\n\n @return [String]", "Add font family in Prawn for a given +font+ file", "Build the PDF version of the document (@pdf)", "Determine sections of the items table to show based on provided data", "Include only items params with provided data", "Include only relevant headers", "target_uri is the base relative to which requests are made.\n\n options:\n - :authenticate_responses - boolean, default true. whether responses will be authenticated.\n   if this is true and an inauthentic response is encountered, then MAuth::InauthenticError\n   will be raised.\n - :mauth_config - configuration passed to MAuth::Client.new (see its doc). default is\n   MAuth::Client.default_config", "Changes all keys in the top level of the hash to symbols.  Does not affect nested hashes inside this one.", "Creates a new determinator instance which assumes the actor id, guid and properties given\n are always specified. This is useful for within a before filter in a webserver, for example,\n so that the determinator instance made available has the logged-in user's credentials prefilled.\n\n @param :id [#to_s] The ID of the actor being specified\n @param :guid [#to_s] The Anonymous ID of the actor being specified\n @param :default_properties [Hash<Symbol,String>] The default properties for the determinator being created\n @return [ActorControl] A helper object removing the need to know id and guid everywhere", "Determines whether a specific feature is on or off for the given actor\n\n @param name [#to_s] The name of the feature flag being checked\n @param :id [#to_s] The id of the actor being determinated for\n @param :guid [#to_s] The Anonymous id of the actor being determinated for\n @param :properties [Hash<Symbol,String>] The properties of this actor which will be used for including this actor or not\n @raise [ArgumentError] When the arguments given to this method aren't ever going to produce a useful response\n @return [true,false] Whether the feature is on (true) or off (false) for this actor", "Determines what an actor should see for a specific experiment\n\n @param name [#to_s] The name of the experiment being checked\n @param :id [#to_s] The id of the actor being determinated for\n @param :guid [#to_s] The Anonymous id of the actor being determinated for\n @param :properties [Hash<Symbol,String>] The properties of this actor which will be used for including this actor or not\n @raise [ArgumentError] When the arguments given to this method aren't ever going to produce a useful response\n @return [false,String] Returns false, if the actor is not in this experiment, or otherwise the variant name.", "Validates the given outcome for this feature.", "politely ask the process to stop, and wait for it to exit", "wait until a log line is seen that matches `regexp`, up to a timeout", "Not for every reader a cleanup is needed.\n Look for those readers with at least one single read mark", "Truncate the given string to a certain number of characters.\n\n @param [String] string\n   the string to truncate\n @param [Hash] options\n   the list of options (such as +length+)", "Rename a list of keys to the given map.\n\n @example Rename the given keys\n   rename_keys(hash, foo: :bar, zip: :zap)\n\n @param [Hash] options\n   the options to map\n @param [Hash] map\n   the map of keys to map\n\n @return [Hash]", "Slice the given list of options with the given keys.\n\n @param [Hash] options\n   the list of options to slice\n @param [Array<Object>] keys\n   the keys to slice\n\n @return [Hash]\n   the sliced hash", "Flatten an xml element with at most one child node with children\n into a hash.\n\n @param [REXML] element\n   xml element", "Set properties for this object. If no properties are given it lists the properties for this object.\n\n @example List all properties for an artifact\n   artifact.properties #=> { 'licenses'=>['Apache-2.0'] }\n\n @example Set new properties for an artifact\n   artifact.properties(maintainer: 'SuperStartup01') #=> { 'licenses'=>['Apache-2.0'], 'maintainer'=>'SuperStartup01' }\n\n @param [Hash<String, Object>] props (default: +nil+)\n   A hash of properties and corresponding values to set for the artifact\n\n @return [Hash<String, Object>]\n   the list of properties", "Download the artifact onto the local disk.\n\n @example Download an artifact\n   artifact.download #=> /tmp/cache/000adad0-bac/artifact.deb\n\n @example Download a remote artifact into a specific target\n   artifact.download('~/Desktop') #=> ~/Desktop/artifact.deb\n\n @param [String] target\n   the target directory where the artifact should be downloaded to\n   (defaults to a temporary directory). **It is the user's responsibility\n   to cleanup the temporary directory when finished!**\n @param [Hash] options\n @option options [String] filename\n   the name of the file when downloaded to disk (defaults to the basename\n   of the file on the server)\n\n @return [String]\n   the path where the file was downloaded on disk", "Upload an artifact into the repository. If the first parameter is a File\n object, that file descriptor is passed to the uploader. If the first\n parameter is a string, it is assumed to be the path to a local file on\n disk. This method will automatically construct the File object from the\n given path.\n\n @see bit.ly/1dhJRMO Artifactory Matrix Properties\n\n @example Upload an artifact from a File instance\n   artifact = Artifact.new(local_path: '/local/path/to/file.deb')\n   artifact.upload('libs-release-local', '/remote/path')\n\n @example Upload an artifact with matrix properties\n   artifact = Artifact.new(local_path: '/local/path/to/file.deb')\n   artifact.upload('libs-release-local', '/remote/path', {\n     status: 'DEV',\n     rating: 5,\n     branch: 'master'\n   })\n\n @param [String] repo\n   the key of the repository to which to upload the file\n @param [String] remote_path\n   the path where this resource will live in the remote artifactory\n   repository, relative to the repository key\n @param [Hash] headers\n   the list of headers to send with the request\n @param [Hash] properties\n   a list of matrix properties\n\n @return [Resource::Artifact]", "Helper method for reading artifact properties\n\n @example List all properties for an artifact\n   artifact.get_properties #=> { 'artifactory.licenses'=>['Apache-2.0'] }\n\n @param [TrueClass, FalseClass] refresh_cache (default: +false+)\n   wether or not to use the locally cached value if it exists and is not nil\n\n @return [Hash<String, Object>]\n   the list of properties", "Helper method for setting artifact properties\n\n @example Set properties for an artifact\n   artifact.set_properties({ prop1: 'value1', 'prop2' => 'value2' })\n\n @param [Hash<String, Object>] properties\n   A hash of properties and corresponding values to set for the artifact\n\n @return [Hash]\n   the parsed JSON response from the server", "Copy or move current artifact to a new destination.\n\n @example Move the current artifact to +ext-releases-local+\n   artifact.move(to: '/ext-releaes-local/org/acme')\n @example Copy the current artifact to +ext-releases-local+\n   artifact.move(to: '/ext-releaes-local/org/acme')\n\n @param [Symbol] action\n   the action (+:move+ or +:copy+)\n @param [String] destination\n   the server-side destination to move or copy the artifact\n @param [Hash] options\n   the list of options to pass\n\n @option options [Boolean] :fail_fast (default: +false+)\n   fail on the first failure\n @option options [Boolean] :suppress_layouts (default: +false+)\n   suppress cross-layout module path translation during copying or moving\n @option options [Boolean] :dry_run (default: +false+)\n   pretend to do the copy or move\n\n @return [Hash]\n   the parsed JSON response from the server", "The hash representation\n\n @example An example hash response\n   { 'key' => 'local-repo1', 'includesPattern' => '**/*' }\n\n @return [Hash]", "Create CGI-escaped string from matrix properties\n\n @see http://bit.ly/1qeVYQl", "Create URI-escaped querystring parameters\n\n @see http://bit.ly/1qeVYQl", "Move a build's artifacts to a new repository optionally moving or\n copying the build's dependencies to the target repository\n and setting properties on promoted artifacts.\n\n @example promote the build to 'omnibus-stable-local'\n   build.promote('omnibus-stable-local')\n @example promote a build attaching some new properites\n   build.promote('omnibus-stable-local'\n     properties: {\n       'promoted_by' => 'hipchat:schisamo@chef.io'\n     }\n   )\n\n @param [String] target_repo\n   repository to move or copy the build's artifacts and/or dependencies\n @param [Hash] options\n   the list of options to pass\n\n @option options [String] :status (default: 'promoted')\n   new build status (any string)\n @option options [String] :comment (default: '')\n   an optional comment describing the reason for promotion\n @option options [String] :user (default: +Artifactory.username+)\n   the user that invoked promotion\n @option options [Boolean] :dry_run (default: +false+)\n   pretend to do the promotion\n @option options [Boolean] :copy (default: +false+)\n   whether to copy instead of move\n @option options [Boolean] :dependencies (default: +false+)\n   whether to move/copy the build's dependencies\n @option options [Array] :scopes (default: [])\n   an array of dependency scopes to include when \"dependencies\" is true\n @option options [Hash<String, Array<String>>] :properties (default: [])\n   a list of properties to attach to the build's artifacts\n @option options [Boolean] :fail_fast (default: +true+)\n   fail and abort the operation upon receiving an error\n\n @return [Hash]\n   the parsed JSON response from the server", "Creates data about a build.\n\n @return [Boolean]", "The list of build data for this component.\n\n @example Get the list of artifacts for a repository\n   component = BuildComponent.new(name: 'wicket')\n   component.builds #=> [#<Resource::Build>, ...]\n\n @return [Collection::Build]\n   the list of builds", "Remove this component's build data stored in Artifactory\n\n @option options [Array<String>] :build_numbers (default: nil)\n   an array of build numbers that should be deleted; if not given\n   all builds (for this component) are deleted\n @option options [Boolean] :artifacts (default: +false+)\n   if true the component's artifacts are also removed\n @option options [Boolean] :delete_all (default: +false+)\n   if true the entire component is removed\n\n @return [Boolean]\n   true if the object was deleted successfully, false otherwise", "Rename a build component.\n\n @param [String] new_name\n   new name for the component\n\n @return [Boolean]\n   true if the object was renamed successfully, false otherwise", "Upload to a given repository\n\n @see Artifact#upload Upload syntax examples\n\n @return [Resource::Artifact]", "Upload an artifact with the given archive. Consult the artifactory\n documentation for the format of the archive to upload.\n\n @see Artifact#upload_from_archive More syntax examples", "The list of artifacts in this repository on the remote artifactory\n server.\n\n @see Artifact.search Search syntax examples\n\n @example Get the list of artifacts for a repository\n   repo = Repository.new('libs-release-local')\n   repo.artifacts #=> [#<Resource::Artifacts>, ...]\n\n @return [Collection::Artifact]\n   the list of artifacts", "Do nonblocking reads from `fd`, appending all data read into `buf`.\n\n @param [IO] fd The file to read from.\n @param [String] buf A buffer to append the read data to.\n\n @return [true, false] Whether `fd` was closed due to an exceptional\n   condition (`EOFError` or `EPIPE`).", "Call IO.select timing out at Time `timeout_at`. If `timeout_at` is nil, never times out.", "Delete a specific relationship", "delete item from the matrix", "Gets an access token with only the clients credentials and no user\n information.\n\n @param String resource\n   The resource being requested.\n @param ClientCredential|ClientAssertion|ClientAssertionCertificate\n   An object that validates the client application by adding\n   #request_params to the OAuth request.\n @return TokenResponse", "Gets an access token with a previously acquire authorization code.\n\n @param String auth_code\n   The authorization code that was issued by the authorization server.\n @param URI redirect_uri\n   The URI that was passed to the authorization server with the request\n   for the authorization code.\n @param ClientCredential|ClientAssertion|ClientAssertionCertificate\n   An object that validates the client application by adding\n   #request_params to the OAuth request.\n @optional String resource\n   The resource being requested.\n @return TokenResponse", "Gets an access token using a previously acquire refresh token.\n\n @param String refresh_token\n   The previously acquired refresh token.\n @param String|ClientCredential|ClientAssertion|ClientAssertionCertificate\n   The client application can be validated in four different manners,\n   depending on the OAuth flow. This object must support #request_params.\n @optional String resource\n   The resource being requested.\n @return TokenResponse", "Constructs a URL for an authorization endpoint using query parameters.\n\n @param String resource\n   The intended recipient of the requested token.\n @param String client_id\n   The identifier of the calling client application.\n @param URI redirect_uri\n   The URI that the the authorization code should be sent back to.\n @optional Hash extra_query_params\n   Any remaining query parameters to add to the URI.\n @return URI", "Creates a new ClientAssertionCertificate.\n\n @param Authority authority\n   The authority object that will recognize this certificate.\n @param [String] client_id\n   The client id of the calling application.\n @param [OpenSSL::PKCS12] pkcs12_file\n   The PKCS12 file containing the certificate and private key.\n The relevant parameters from this credential for OAuth.", "The OAuth parameters that respresent this UserCredential.\n\n @return Hash", "Constructs a new WSTrustRequest.\n\n @param String|URI endpoint\n @param String action\n @param String applies_to\n\n Performs a WS-Trust RequestSecurityToken request with a username and\n password to obtain a federated token.\n\n @param String username\n @param String password\n @return WSTrustResponse", "Constructs a MexRequest object for a specific URL endpoint.\n\n @param String|URI endpoint\n   The Metadata Exchange endpoint.\n @return MexResponse", "URI that can be used to acquire authorization codes.\n\n @optional Hash params\n   Query parameters that will added to the endpoint.\n @return [URI]", "Creates an instance discovery endpoint url for authority that this object\n represents.\n\n @return [URI]", "Performs instance discovery via a network call to well known authorities.\n\n @return [String]\n   The tenant discovery endpoint, if found. Otherwise nil.", "Constructs a WSTrustResponse.\n\n @param String token\n   The content of the returned token.\n @param WSTrustResponse::TokenType token_type\n   The type of the token contained within the WS-Trust response.\n\n Gets the OAuth grant type for the SAML token type of the response.\n\n @return TokenRequest::GrantType", "Constructs a new SelfSignedJwtFactory.\n\n @param String client_id\n   The client id of the calling application.\n @param String token_endpoint\n   The token endpoint that will accept the certificate.\n\n Creates a JWT from a client certificate and signs it with a private key.\n\n @param OpenSSL::X509::Certificate certificate\n   The certifcate object to be converted to a JWT and signed for use\n   in an authentication flow.\n @param OpenSSL::PKey::RSA private_key\n   The private key used to sign the certificate.\n @return String", "The JWT header for a certificate to be encoded.", "The JWT payload.", "Gets a token based solely on the clients credentials that were used to\n initialize the token request.\n\n @param String resource\n   The resource for which the requested access token will provide access.\n @return TokenResponse", "Gets a token based on a previously acquired authentication code.\n\n @param String auth_code\n   An authentication code that was previously acquired from an\n   authentication endpoint.\n @param String redirect_uri\n   The redirect uri that was passed to the authentication endpoint when the\n   auth code was acquired.\n @optional String resource\n   The resource for which the requested access token will provide access.\n @return TokenResponse", "Gets a token based on a previously acquired refresh token.\n\n @param String refresh_token\n   The refresh token that was previously acquired from a token response.\n @optional String resource\n   The resource for which the requested access token will provide access.\n @return TokenResponse", "Gets a token based on possessing the users credentials.\n\n @param UserCredential|UserIdentifier user_cred\n   Something that can be used to verify the user. Typically a username\n   and password. If it is a UserIdentifier, only the cache will be checked.\n   If a matching token is not there, it will fail.\n @optional String resource\n   The resource for which the requested access token will provide access.\n @return TokenResponse", "Attempts to fulfill a token request, first via the token cache and then\n through OAuth.\n\n @param Hash params\n   Any additional request parameters that should be used.\n @return TokenResponse", "Constructs a CacheDriver to interact with a token cache.\n\n @param String authority\n   The URL of the authority endpoint.\n @param ClientAssertion|ClientCredential|etc client\n   The credentials representing the calling application. We need this\n   instead of just the client id so that the tokens can be refreshed if\n   necessary.\n @param TokenCache token_cache\n   The cache implementation to store tokens.\n @optional Fixnum expiration_buffer_sec\n   The number of seconds to use as a leeway when dealing with cache expiry.\n\n Checks if a TokenResponse is successful and if so adds it to the token\n cache for future retrieval.\n\n @param SuccessResponse token_response\n   The successful token response to be cached. If it is not successful, it\n   fails silently.", "Searches the cache for a token matching a specific query of fields.\n\n @param Hash query\n   The fields to match against.\n @return TokenResponse", "All cache entries that match a query. This matches keys in values against\n a hash to method calls on an object.\n\n @param Hash query\n   The fields to be matched and the values to match them to.\n @return Array<CachedTokenResponse>", "Attempts to obtain an access token for a resource with refresh tokens from\n a list of MRRTs.\n\n @param Array[CachedTokenResponse]\n @return SuccessResponse|nil", "Searches a list of CachedTokenResponses for one that matches the resource.\n\n @param Array[CachedTokenResponse]\n @return SuccessResponse|nil", "Updates the refresh tokens of all tokens in the cache that match a given\n MRRT.\n\n @param CachedTokenResponse mrrt\n   A new MRRT containing a refresh token to update other matching cache\n   entries with.", "Checks if an array of current cache entries are still valid, attempts to\n refresh those that have expired and discards those that cannot be.\n\n @param Array[CachedTokenResponse] entries\n   The tokens to validate.\n @return Array[CachedTokenResponse]", "Constructs a new CachedTokenResponse.\n\n @param ClientCredential|ClientAssertion|ClientAssertionCertificate\n   The credentials of the calling client application.\n @param Authority authority\n   The ADAL::Authority object that the response was retrieved from.\n @param SuccessResponse token_response\n   The token response to be cached.\n\n Converts the fields in this object and its proxied SuccessResponse into\n a JSON string.\n\n @param JSON::Ext::Generator::State\n   We don't care about the state, but JSON::unparse requires this.\n @return String", "Determines if self can be used to refresh other.\n\n @param CachedTokenResponse other\n @return Boolean", "If the access token is within the expiration buffer of expiring, an\n attempt will be made to retrieve a new token with the refresh token.\n\n @param Fixnum expiration_buffer_sec\n   The number of seconds to use as leeway in determining if the token is\n   expired. A positive buffer will refresh the token early while a negative\n   buffer will refresh it late. Used to counter clock skew and network\n   latency.\n @return Boolean\n   True if the token is still valid (even if it was refreshed). False if\n   the token is expired an unable to be refreshed.", "Attempts to refresh the access token for a given resource. Note that you\n can call this method with a different resource even if the token is not\n an MRRT, but it will fail\n\n @param String resource\n   The resource that the new access token is beign requested for. Defaults\n   to using the same resource as the original token.\n @return TokenResponse", "Converts every key and value of a hash to string.\n\n @param Hash\n @return Hash", "Adds an array of objects to the cache.\n\n @param Array\n   The entries to add.\n @return Array\n   The entries after the addition.", "Requests and waits for a token from the endpoint.\n @return TokenResponse", "Adds the necessary OAuth headers.\n\n @param Net::HTTPGenericRequest", "Authenticate a response from the U2F device\n\n * *Args*:\n   - +challenge+:: Challenge string\n   - +response+:: Response from the U2F device as a +SignResponse+ object\n   - +registration_public_key+:: Public key of the registered U2F device as binary string\n   - +registration_counter+:: +Integer+ with the current counter value of the registered\n     device\n\n * *Raises*:\n   - +NoMatchingRequestError+:: if the challenge in the response doesn't match any of the\n     provided ones\n   - +ClientDataTypeError+:: if the response is of the wrong type\n   - +AuthenticationFailedError+:: if the authentication failed\n   - +UserNotPresentError+:: if the user wasn't present during the authentication\n   - +CounterTooLowError+:: if there is a counter mismatch between the registered one and\n     the one in the response", "Authenticate the response from the U2F device when registering\n\n * *Args*:\n   - +challenges+:: +Array+ of challenge strings\n   - +response+:: Response of the U2F device as a +RegisterResponse+ object\n\n * *Returns*:\n   - A +Registration+ object\n\n * *Raises*:\n   - +UnmatchedChallengeError+:: if the challenge in the response doesn't match any of\n     the provided ones\n   - +ClientDataTypeError+:: if the response is of the wrong type\n   - +AttestationSignatureError+:: if the registration failed", "Verifies the response against an app id and the public key of the\n registered device", "Verifies the registration data against the app id", "Initialize a new FakeU2F device for use in tests.\n\n app_id  - The appId/origin this is being tested against.\n options - A Hash of optional parameters (optional).\n           :counter      - The initial counter for this device.\n           :key_handle   - The raw key-handle this device should use.\n           :cert_subject - The subject field for the certificate generated\n                           for this device.\n\n Returns nothing.\n A registerResponse hash as returned by the u2f.register JavaScript API.\n\n challenge - The challenge to sign.\n error     - Boolean. Whether to return an error response (optional).\n\n Returns a JSON encoded Hash String.", "A SignResponse hash as returned by the u2f.sign JavaScript API.\n\n challenge - The challenge to sign.\n\n Returns a JSON encoded Hash String.", "The registrationData field returns in a RegisterResponse Hash.\n\n client_data_json - The JSON encoded clientData String.\n\n Returns a url-safe base64 encoded binary String.", "The signature field of a registrationData field of a RegisterResponse.\n\n client_data_json - The JSON encoded clientData String.\n\n Returns an ECDSA signature String.", "The signature field of a signatureData field of a SignResponse Hash.\n\n client_data_json - The JSON encoded clientData String.\n\n Returns an ECDSA signature String.", "The clientData hash as returned by registration and authentication\n responses.\n\n typ       - The String value for the 'typ' field.\n challenge - The String url-safe base64 encoded challenge parameter.\n\n Returns a JSON encoded Hash String.", "The self-signed device attestation certificate.\n\n Returns a OpenSSL::X509::Certificate instance.", "Generate methods for all affected types.\n @see Fast.replace", "Look recursively into @param fast to check if the expression is have\n captures.\n @return [true] if any sub expression have captures.", "Find search captures recursively.\n\n @return [Array<Object>] of captures from the expression\n @return [true] in case of no captures in the expression\n @see Fast::Capture\n @see Fast::FindFromArgument", "Prepare arguments case the expression needs to bind extra arguments.\n @return [void]", "Keep track of ok experiments depending on the current combination.\n It keep the combinations unique removing single replacements after the\n first round.\n @return void", "Writes a new file with partial replacements based on the current combination.\n Raise error if no changes was made with the given combination indices.\n @param [Array<Integer>] combination to be replaced.", "For given description, computes probabilities returned by each graders by multipying them together.\n\n @return [Float] the probability for the given description to be considered good", "Section header view methods", "UIWebViewDelegate Methods - Camelcase", "UISplitViewControllerDelegate methods\n iOS 7 and below", "iOS 8 and above", "iterate up the view hierarchy to find the parent element\n of \"type\" containing this view", "Returns true if the time of day is inside the shift, false otherwise.", "Returns true if ranges overlap, false otherwise.", "Rounding to the given nearest number of seconds", "Return a new TimeOfDay num_seconds less than self. It will wrap around\n at midnight.", "Returns a Time instance on date using self as the time of day\n Optional time_zone will build time in that zone", "Extract a SpanContext in the given format from the given carrier.\n\n @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]\n @param carrier [Carrier] A carrier object of the type dictated by the specified `format`\n @return [SpanContext, nil] the extracted SpanContext or nil if none could be found", "recipients can be filtered on a conversation basis", "Array of sitemap results\n Initialize the class with an array of SitemapResult", "Get a list of all CPP source files in a directory and its subdirectories\n @param some_dir [Pathname] The directory in which to begin the search\n @return [Array<Pathname>] The paths of the found files", "CPP files that are part of the 3rd-party libraries we're including\n @param [Array<String>] aux_libraries\n @return [Array<Pathname>]", "Find all directories in the project library that include C++ header files\n @return [Array<Pathname>]", "wrapper for the GCC command", "Arduino library directories containing sources\n @return [Array<Pathname>]", "GCC command line arguments for including aux libraries\n @param aux_libraries [Array<Pathname>] The external Arduino libraries required by this project\n @return [Array<String>] The GCC command-line flags necessary to include those libraries", "Forcibly install Arduino on linux from the web\n @return [bool] Whether the command succeeded", "Convert a preferences dump into a flat hash\n @param arduino_output [String] The raw Arduino executable output\n @return [Hash] preferences as a hash", "build and run the arduino command", "run a command and capture its output\n @return [Hash] {:out => String, :err => String, :success => bool}", "install a board by name\n @param name [String] the board name\n @return [bool] whether the command succeeded", "install a library by name\n @param name [String] the library name\n @return [bool] whether the command succeeded", "use a particular board for compilation, installing it if necessary\n @param boardname [String] The board to use\n @return [bool] whether the command succeeded", "ensure that the given library is installed, or symlinked as appropriate\n return the path of the prepared library, or nil\n @param path [Pathname] library to use\n @return [String] the path of the installed library", "validate a data source according to a schema\n print out warnings for bad fields, and return only the good ones\n @param rootname [String] the name, for printing\n @param source [Hash] source data\n @param schema [Hash] a mapping of field names to their expected type\n @return [Hash] a copy, containing only expected & valid data", "Load configuration yaml from a file\n @param path [String] the source file\n @return [ArduinoCI::CIConfig] a reference to self", "Load configuration from a hash\n @param yml [Hash] the source data\n @return [ArduinoCI::CIConfig] a reference to self", "Get the config file at a given path, if it exists, and pass that to a block.\n Many config files may exist, but only the first match is used\n @param base_dir [String] The directory in which to search for a config file\n @param val_when_no_match [Object] The value to return if no config files are found\n @yield [path] Process the configuration file at the given path\n @yieldparam [String] The path of an existing config file\n @yieldreturn [ArduinoCI::CIConfig] a settings object\n @return [ArduinoCI::CIConfig]", "Produce a configuration override taken from an Arduino library example path\n handle either path to example file or example dir\n @param path [String] the path to the settings yaml file\n @return [ArduinoCI::CIConfig] the new settings object", "This helper allows the usage of different payment integrations\n through a single form helper.  Payment integrations are the\n type of service where the user is redirected to the secure\n site of the service, like Paypal or Chronopay.\n\n The helper creates a scope around a payment service helper\n which provides the specific mapping for that service.\n\n  <% payment_service_for 1000, 'paypalemail@mystore.com',\n                               :amount => 50.00,\n                               :currency => 'CAD',\n                               :service => :paypal,\n                               :html => { :id => 'payment-form' } do |service| %>\n\n    <% service.customer :first_name => 'Cody',\n                       :last_name => 'Fauser',\n                       :phone => '(555)555-5555',\n                       :email => 'cody@example.com' %>\n\n    <% service.billing_address :city => 'Ottawa',\n                              :address1 => '21 Snowy Brook Lane',\n                              :address2 => 'Apt. 36',\n                              :state => 'ON',\n                              :country => 'CA',\n                              :zip => 'K1J1E5' %>\n\n    <% service.invoice '#1000' %>\n    <% service.shipping '0.00' %>\n    <% service.tax '0.00' %>\n\n    <% service.notify_url url_for(:only_path => false, :action => 'notify') %>\n    <% service.return_url url_for(:only_path => false, :action => 'done') %>\n    <% service.cancel_return_url 'http://mystore.com' %>\n  <% end %>", "Check if the request comes from an official IP", "Add an input in the form. Useful when gateway requires some uncommon\n fields not provided by the gem.\n\n # inside `payment_service_for do |service|` block\n service.add_field('c_id','_xclick')\n\n Gateway implementor can also use this to add default fields in the form:\n\n # in a subclass of ActiveMerchant::Billing::Integrations::Helper\n def initialize(order, account, options = {})\n super\n # mandatory fields\n add_field('Rvg2c', 1)\n end\n\n @param name [String] input name\n @param value [String] input value", "Set the given attribute to value", "Removes old and add new attributes for the record", "Returns record based given row id", "Creates a record by posting to airtable", "Replaces record in airtable based on id", "Upper triangular matrix.\n Fill the self elements below the k-th diagonal with zero.", "Lower triangular matrix.\n Fill the self elements above the k-th diagonal with zero.", "Return the k-th diagonal indices.", "Return a matrix whose diagonal is constructed by self along the last axis.", "Return the sum along diagonals of the array.\n\n If 2-D array, computes the summation along its diagonal with the\n given offset, i.e., sum of `a[i,i+offset]`.\n If more than 2-D array, the diagonal is determined from the axes\n specified by axis argument. The default is axis=[-2,-1].\n @param offset [Integer] (optional, default=0) diagonal offset\n @param axis [Array] (optional, default=[-2,-1]) diagonal axis\n @param nan [Bool] (optional, default=false) nan-aware algorithm, i.e., if true then it ignores nan.", "Dot product of two arrays.\n @param b [Numo::NArray]\n @return [Numo::NArray]  return dot product", "Kronecker product of two arrays.\n\n     kron(a,b)[k_0, k_1, ...] = a[i_0, i_1, ...] * b[j_0, j_1, ...]\n        where:  k_n = i_n * b.shape[n] + j_n\n\n @param b [Numo::NArray]\n @return [Numo::NArray]  return Kronecker product\n @example\n   Numo::DFloat[1,10,100].kron([5,6,7])\n   => Numo::DFloat#shape=[9]\n   [5, 6, 7, 50, 60, 70, 500, 600, 700]\n   Numo::DFloat[5,6,7].kron([1,10,100])\n   => Numo::DFloat#shape=[9]\n   [5, 50, 500, 6, 60, 600, 7, 70, 700]\n   Numo::DFloat.eye(2).kron(Numo::DFloat.ones(2,2))\n   => Numo::DFloat#shape=[4,4]\n   [[1, 1, 0, 0],\n    [1, 1, 0, 0],\n    [0, 0, 1, 1],\n    [0, 0, 1, 1]]", "these are pending collaborations for the current user; use the As-User Header to request for different users", "Defines an HTTP redirect\n\n @param path [String] the path that needs to be redirected\n @param options [Hash] the options to customize the redirect behavior\n @option options [Fixnum] the HTTP status to return (defaults to `301`)\n\n @return [Hanami::Routing::Route] the generated route.\n   This may vary according to the `:route` option passed to the initializer\n\n @since 0.1.0\n\n @see Hanami::Router\n\n @example\n   require 'hanami/router'\n\n   Hanami::Router.new do\n     redirect '/legacy',  to: '/new_endpoint'\n     redirect '/legacy2', to: '/new_endpoint2', code: 302\n   end\n\n @example\n   require 'hanami/router'\n\n   router = Hanami::Router.new\n   router.redirect '/legacy',  to: '/new_endpoint'", "Recognize the given env, path, or name and return a route for testing\n inspection.\n\n If the route cannot be recognized, it still returns an object for testing\n inspection.\n\n @param env [Hash, String, Symbol] Rack env, path or route name\n @param options [Hash] a set of options for Rack env or route params\n @param params [Hash] a set of params\n\n @return [Hanami::Routing::RecognizedRoute] the recognized route\n\n @since 0.5.0\n\n @see Hanami::Router#env_for\n @see Hanami::Routing::RecognizedRoute\n\n @example Successful Path Recognition\n   require 'hanami/router'\n\n   router = Hanami::Router.new do\n     get '/books/:id', to: 'books#show', as: :book\n   end\n\n   route = router.recognize('/books/23')\n   route.verb      # => \"GET\" (default)\n   route.routable? # => true\n   route.params    # => {:id=>\"23\"}\n\n @example Successful Rack Env Recognition\n   require 'hanami/router'\n\n   router = Hanami::Router.new do\n     get '/books/:id', to: 'books#show', as: :book\n   end\n\n   route = router.recognize(Rack::MockRequest.env_for('/books/23'))\n   route.verb      # => \"GET\" (default)\n   route.routable? # => true\n   route.params    # => {:id=>\"23\"}\n\n @example Successful Named Route Recognition\n   require 'hanami/router'\n\n   router = Hanami::Router.new do\n     get '/books/:id', to: 'books#show', as: :book\n   end\n\n   route = router.recognize(:book, id: 23)\n   route.verb      # => \"GET\" (default)\n   route.routable? # => true\n   route.params    # => {:id=>\"23\"}\n\n @example Failing Recognition For Unknown Path\n   require 'hanami/router'\n\n   router = Hanami::Router.new do\n     get '/books/:id', to: 'books#show', as: :book\n   end\n\n   route = router.recognize('/books')\n   route.verb      # => \"GET\" (default)\n   route.routable? # => false\n\n @example Failing Recognition For Path With Wrong HTTP Verb\n   require 'hanami/router'\n\n   router = Hanami::Router.new do\n     get '/books/:id', to: 'books#show', as: :book\n   end\n\n   route = router.recognize('/books/23', method: :post)\n   route.verb      # => \"POST\"\n   route.routable? # => false\n\n @example Failing Recognition For Rack Env With Wrong HTTP Verb\n   require 'hanami/router'\n\n   router = Hanami::Router.new do\n     get '/books/:id', to: 'books#show', as: :book\n   end\n\n   route = router.recognize(Rack::MockRequest.env_for('/books/23', method: :post))\n   route.verb      # => \"POST\"\n   route.routable? # => false\n\n @example Failing Recognition Named Route With Wrong Params\n   require 'hanami/router'\n\n   router = Hanami::Router.new do\n     get '/books/:id', to: 'books#show', as: :book\n   end\n\n   route = router.recognize(:book)\n   route.verb      # => \"GET\" (default)\n   route.routable? # => false\n\n @example Failing Recognition Named Route With Wrong HTTP Verb\n   require 'hanami/router'\n\n   router = Hanami::Router.new do\n     get '/books/:id', to: 'books#show', as: :book\n   end\n\n   route = router.recognize(:book, {method: :post}, {id: 1})\n   route.verb      # => \"POST\"\n   route.routable? # => false\n   route.params    # => {:id=>\"1\"}", "Fabricate Rack env for the given Rack env, path or named route\n\n @param env [Hash, String, Symbol] Rack env, path or route name\n @param options [Hash] a set of options for Rack env or route params\n @param params [Hash] a set of params\n\n @return [Hash] Rack env\n\n @since 0.5.0\n @api private\n\n @see Hanami::Router#recognize\n @see http://www.rubydoc.info/github/rack/rack/Rack%2FMockRequest.env_for", "Returns a sorted array based on user preference in HTTP_ACCEPT_LANGUAGE.\n Browsers send this HTTP header, so don't think this is holy.\n\n Example:\n\n   request.user_preferred_languages\n   # => [ 'nl-NL', 'nl-BE', 'nl', 'en-US', 'en' ]", "Returns the first of the user_preferred_languages that is compatible\n with the available locales. Ignores region.\n\n Example:\n\n   request.compatible_language_from I18n.available_locales", "Returns a supplied list of available locals without any extra application info\n that may be attached to the locale for storage in the application.\n\n Example:\n [ja_JP-x1, en-US-x4, en_UK-x5, fr-FR-x3] => [ja-JP, en-US, en-UK, fr-FR]", "Returns the first of the user preferred languages that is\n also found in available languages.  Finds best fit by matching on\n primary language first and secondarily on region.  If no matching region is\n found, return the first language in the group matching that primary language.\n\n Example:\n\n   request.language_region_compatible(available_languages)", "make it protected", "Returns true if the document has code callouts", "Evaluate color block\n\n @api private", "Apply ANSI color to the given string.\n\n Wraps eachline with clear escape.\n\n @param [String] string\n   text to add ANSI strings\n\n @param [Array[Symbol]] colors\n   the color names\n\n @example\n   color.decorate \"text\", :yellow, :on_green, :underline\n\n @return [String]\n   the colored string\n\n @api public", "Strip ANSI color codes from a string.\n\n Only ANSI color codes are removed, not movement codes or\n other escapes sequences are stripped.\n\n @param [Array[String]] strings\n   a string or array of strings to sanitize\n\n @example\n   strip(\"foo\\e[1mbar\\e[0m\")  # => \"foobar\"\n\n @return [String]\n\n @api public", "Return raw color code without embeding it into a string.\n\n @return [Array[String]]\n   ANSI escape codes\n\n @api public", "Define a new colors alias\n\n @param [String] alias_name\n   the colors alias to define\n @param [Array[Symbol,String]] color\n   the colors the alias will correspond to\n\n @return [Array[String]]\n   the standard color values of the alias\n\n @api public", "Create alias importer\n\n @example\n   importer = Pastel::AliasImporter.new(Pastel::Color.new, {})\n\n @api public\n Import aliases from the environment\n\n @example\n   importer = Pastel::AliasImporter.new(Pastel::Color.new, {})\n   importer.import\n\n @return [nil]\n\n @api public", "Generates JavaScript function for rendering the chart when data is URL of\n   the google spreadsheet\n\n @param (see #to_js_spreadsheet)\n @return [String] JS function to render the google chart when data is URL\n   of the google spreadsheet", "Generates JavaScript and renders the Google Chart DataTable in the\n   final HTML output\n\n @param element_id [String] The ID of the DIV element that the Google\n   Chart DataTable should be rendered in\n @return [String] Javascript code to render the Google Chart DataTable", "Generates JavaScript function for rendering the google chart table.\n\n @param element_id [String] The ID of the DIV element that the Google\n   Chart DataTable should be rendered in\n @return [String] JS function to render the google chart table", "Generates JavaScript function for rendering the google chart table when\n   data is URL of the google spreadsheet\n\n @param (see #to_js_full_script_spreadsheet)\n @return [String] JS function to render the google chart table when data\n   is URL of the google spreadsheet", "This method is not needed if `to_html` generates the same code. Here\n `to_html` generates the code with `onload`, so there is need of\n `high_chart_iruby` which doesn't use `onload` in chart script.", "Loads the dependent mapdata and dependent modules of the chart\n\n @param [String] to determine whether to load modules in IRuby or web\n   frameworks\n @return [void, String] loads the initial script of the modules for IRuby\n   notebook and returns initial script of the modules for web frameworks", "Exports chart to different formats in IRuby notebook\n\n @param type [String] format to which chart has to be exported\n @param file_name [String] The name of the file after exporting the chart\n @return [void] loads the js code of chart along with the code to export\n   in IRuby notebook", "Returns the script to export the chart in different formats for\n   web frameworks\n\n @param file_name [String] The name of the file after exporting the chart\n @param placeholder [String] The ID of the DIV element that\n   the HighChart should be rendered in\n @param type [String] format to which chart has to be exported\n @return [String] the script to export the chart in web frameworks", "Returns the script to export the chart in different formats in\n   IRuby notebook\n\n @param (see #extract_export_code)\n @return [String] the script to export the chart in IRuby notebook", "merges category_command_map and command_map,\n removing categories", "run an sv command for a specific service name", "Set global options and remove them from the args list we pass\n into commands.", "retrieves the commmand from either the command_map\n or the category_command_map, if the command is not found\n return nil", "Previously this would exit immediately with the provided\n exit code; however this would prevent post-run hooks from continuing\n Instead, we'll just track whether a an exit was requested and use that\n to determine how we exit from 'run'", "Status gets its own hook because each externalized service will\n have its own things to do in order to report status.\n As above, we may also include an output header to show that we're\n reporting on external services.\n\n Your callback for this function should be in the form\n 'external_status_#{service_name}(detail_level)\n where detail_level is :sparse|:verbose\n :sparse is used when it's a summary service status list, eg\n \"$appname-ctl status\"\n :verbose is used when the specific service has been named, eg\n \"$appname-ctl status postgresql\"", "Allow to use IP rate limit when you have a proxy between end-user and Algolia.\n This option will set the X-Forwarded-For HTTP header with the client IP and the X-Forwarded-API-Key with the API Key having rate limits.\n\n @param admin_api_key the admin API Key you can find in your dashboard\n @param end_user_ip the end user IP (you can use both IPV4 or IPV6 syntax)\n @param rate_limit_api_key the API key on which you have a rate limit", "This method allows to query multiple indexes with one API call\n\n @param queries the array of hash representing the query and associated index name\n @param options - accepts those keys:\n   - index_name_key the name of the key used to fetch the index_name (:index_name by default)\n   - strategy define the strategy applied on the sequential searches (none by default)\n   - request_options contains extra parameters to send with your query", "Move an existing index.\n\n @param src_index the name of index to copy.\n @param dst_index the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).\n @param request_options contains extra parameters to send with your query", "Move an existing index and wait until the move has been processed\n\n @param src_index the name of index to copy.\n @param dst_index the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).\n @param request_options contains extra parameters to send with your query", "Copy an existing index.\n\n @param src_index the name of index to copy.\n @param dst_index the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).\n @param scope the optional list of scopes to copy (all if not specified).\n @param request_options contains extra parameters to send with your query", "Copy an existing index and wait until the copy has been processed.\n\n @param src_index the name of index to copy.\n @param dst_index the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).\n @param scope the optional list of scopes to copy (all if not specified).\n @param request_options contains extra parameters to send with your query", "Copy an existing index settings and wait until the copy has been processed.\n\n @param src_index the name of index to copy.\n @param dst_index the new index name that will contains a copy of srcIndexName settings (destination settings will be overriten if it already exist).\n @param request_options contains extra parameters to send with your query", "Copy an existing index synonyms and wait until the copy has been processed.\n\n @param src_index the name of index to copy.\n @param dst_index the new index name that will contains a copy of srcIndexName synonyms (destination synonyms will be overriten if it already exist).\n @param request_options contains extra parameters to send with your query", "Copy an existing index rules and wait until the copy has been processed.\n\n @param src_index the name of index to copy.\n @param dst_index the new index name that will contains a copy of srcIndexName rules (destination rules will be overriten if it already exist).\n @param request_options contains extra parameters to send with your query", "Return last logs entries.\n\n @param options - accepts those keys:\n   - offset Specify the first entry to retrieve (0-based, 0 is the most recent log entry) - Default = 0\n   - length Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000 - Default = 10\n   - type Type of log entries to retrieve (\"all\", \"query\", \"build\" or \"error\") - Default = 'all'\n   - request_options contains extra parameters to send with your query", "Send a batch request targeting multiple indices and wait the end of the indexing", "Check the status of a task on the server.\n All server task are asynchronous and you can check the status of a task with this method.\n\n @param index_name the index name owning the taskID\n @param taskID the id of the task returned by server\n @param request_options contains extra parameters to send with your query", "Perform an HTTP request for the given uri and method\n with common basic response handling. Will raise a\n AlgoliaProtocolError if the response has an error status code,\n and will return the parsed JSON body on success, if there is one.", "This method returns a thread-local array of sessions", "Delete an index and wait until the deletion has been processed\n\n @param request_options contains extra parameters to send with your query\n\n return an hash of the form { \"deletedAt\" => \"2013-01-18T15:33:13.556Z\", \"taskID\" => \"42\" }", "Add an object in this index\n\n @param object the object to add to the index.\n  The object is represented by an associative array\n @param objectID (optional) an objectID you want to attribute to this object\n  (if the attribute already exist the old object will be overridden)\n @param request_options contains extra parameters to send with your query", "Add an object in this index and wait end of indexing\n\n @param object the object to add to the index.\n  The object is represented by an associative array\n @param objectID (optional) an objectID you want to attribute to this object\n  (if the attribute already exist the old object will be overridden)\n @param Request options object. Contains extra URL parameters or headers", "Add several objects in this index and wait end of indexing\n\n @param objects the array of objects to add inside the index.\n  Each object is represented by an associative array\n @param request_options contains extra parameters to send with your query", "Search inside the index\n\n @param query the full text query\n @param args (optional) if set, contains an associative array with query parameters:\n - page: (integer) Pagination parameter used to select the page to retrieve.\n                   Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9\n - hitsPerPage: (integer) Pagination parameter used to select the number of hits per page. Defaults to 20.\n - attributesToRetrieve: a string that contains the list of object attributes you want to retrieve (let you minimize the answer size).\n   Attributes are separated with a comma (for example \"name,address\").\n   You can also use a string array encoding (for example [\"name\",\"address\"]).\n   By default, all attributes are retrieved. You can also use '*' to retrieve all values when an attributesToRetrieve setting is specified for your index.\n - attributesToHighlight: a string that contains the list of attributes you want to highlight according to the query.\n   Attributes are separated by a comma. You can also use a string array encoding (for example [\"name\",\"address\"]).\n   If an attribute has no match for the query, the raw value is returned. By default all indexed text attributes are highlighted.\n   You can use `*` if you want to highlight all textual attributes. Numerical attributes are not highlighted.\n   A matchLevel is returned for each highlighted attribute and can contain:\n      - full: if all the query terms were found in the attribute,\n      - partial: if only some of the query terms were found,\n      - none: if none of the query terms were found.\n - attributesToSnippet: a string that contains the list of attributes to snippet alongside the number of words to return (syntax is `attributeName:nbWords`).\n    Attributes are separated by a comma (Example: attributesToSnippet=name:10,content:10).\n    You can also use a string array encoding (Example: attributesToSnippet: [\"name:10\",\"content:10\"]). By default no snippet is computed.\n - minWordSizefor1Typo: the minimum number of characters in a query word to accept one typo in this word. Defaults to 3.\n - minWordSizefor2Typos: the minimum number of characters in a query word to accept two typos in this word. Defaults to 7.\n - getRankingInfo: if set to 1, the result hits will contain ranking information in _rankingInfo attribute.\n - aroundLatLng: search for entries around a given latitude/longitude (specified as two floats separated by a comma).\n   For example aroundLatLng=47.316669,5.016670).\n   You can specify the maximum distance in meters with the aroundRadius parameter (in meters) and the precision for ranking with aroundPrecision\n   (for example if you set aroundPrecision=100, two objects that are distant of less than 100m will be considered as identical for \"geo\" ranking parameter).\n   At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form {\"_geoloc\":{\"lat\":48.853409, \"lng\":2.348800}})\n - insideBoundingBox: search entries inside a given area defined by the two extreme points of a rectangle (defined by 4 floats: p1Lat,p1Lng,p2Lat,p2Lng).\n   For example insideBoundingBox=47.3165,4.9665,47.3424,5.0201).\n   At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form {\"_geoloc\":{\"lat\":48.853409, \"lng\":2.348800}})\n - numericFilters: a string that contains the list of numeric filters you want to apply separated by a comma.\n   The syntax of one filter is `attributeName` followed by `operand` followed by `value`. Supported operands are `<`, `<=`, `=`, `>` and `>=`.\n   You can have multiple conditions on one attribute like for example numericFilters=price>100,price<1000.\n   You can also use a string array encoding (for example numericFilters: [\"price>100\",\"price<1000\"]).\n - tagFilters: filter the query by a set of tags. You can AND tags by separating them by commas.\n   To OR tags, you must add parentheses. For example, tags=tag1,(tag2,tag3) means tag1 AND (tag2 OR tag3).\n   You can also use a string array encoding, for example tagFilters: [\"tag1\",[\"tag2\",\"tag3\"]] means tag1 AND (tag2 OR tag3).\n   At indexing, tags should be added in the _tags** attribute of objects (for example {\"_tags\":[\"tag1\",\"tag2\"]}).\n - facetFilters: filter the query by a list of facets.\n   Facets are separated by commas and each facet is encoded as `attributeName:value`.\n   For example: `facetFilters=category:Book,author:John%20Doe`.\n   You can also use a string array encoding (for example `[\"category:Book\",\"author:John%20Doe\"]`).\n - facets: List of object attributes that you want to use for faceting.\n   Attributes are separated with a comma (for example `\"category,author\"` ).\n   You can also use a JSON string array encoding (for example [\"category\",\"author\"]).\n   Only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.\n   You can also use `*` to perform faceting on all attributes specified in **attributesForFaceting**.\n - queryType: select how the query words are interpreted, it can be one of the following value:\n    - prefixAll: all query words are interpreted as prefixes,\n    - prefixLast: only the last word is interpreted as a prefix (default behavior),\n    - prefixNone: no query word is interpreted as a prefix. This option is not recommended.\n - optionalWords: a string that contains the list of words that should be considered as optional when found in the query.\n   The list of words is comma separated.\n - distinct: If set to 1, enable the distinct feature (disabled by default) if the attributeForDistinct index setting is set.\n   This feature is similar to the SQL \"distinct\" keyword: when enabled in a query with the distinct=1 parameter,\n   all hits containing a duplicate value for the attributeForDistinct attribute are removed from results.\n   For example, if the chosen attribute is show_name and several hits have the same value for show_name, then only the best\n   one is kept and others are removed.\n @param request_options contains extra parameters to send with your query", "Browse all index content\n\n @param queryParameters The hash of query parameters to use to browse\n                        To browse from a specific cursor, just add a \":cursor\" parameters\n @param queryParameters An optional second parameters hash here for backward-compatibility (which will be merged with the first)\n @param request_options contains extra parameters to send with your query\n\n @DEPRECATED:\n @param page Pagination parameter used to select the page to retrieve.\n @param hits_per_page Pagination parameter used to select the number of hits per page. Defaults to 1000.", "Browse a single page from a specific cursor\n\n @param request_options contains extra parameters to send with your query", "Get an object from this index\n\n @param objectID the unique identifier of the object to retrieve\n @param attributes_to_retrieve (optional) if set, contains the list of attributes to retrieve as an array of strings of a string separated by \",\"\n @param request_options contains extra parameters to send with your query", "Get a list of objects from this index\n\n @param objectIDs the array of unique identifier of the objects to retrieve\n @param attributes_to_retrieve (optional) if set, contains the list of attributes to retrieve as an array of strings of a string separated by \",\"\n @param request_options contains extra parameters to send with your query", "Override the content of an object\n\n @param object the object to save\n @param objectID the associated objectID, if nil 'object' must contain an 'objectID' key\n @param request_options contains extra parameters to send with your query", "Override the content of object and wait end of indexing\n\n @param object the object to save\n @param objectID the associated objectID, if nil 'object' must contain an 'objectID' key\n @param request_options contains extra parameters to send with your query", "Override the content of several objects and wait end of indexing\n\n @param objects the array of objects to save, each object must contain an objectID attribute\n @param request_options contains extra parameters to send with your query", "Override the current objects by the given array of objects and wait end of indexing. Settings,\n synonyms and query rules are untouched. The objects are replaced without any downtime.\n\n @param objects the array of objects to save\n @param request_options contains extra parameters to send with your query", "Partially override the content of several objects\n\n @param objects an array of objects to update (each object must contains a objectID attribute)\n @param create_if_not_exits a boolean, if true create the objects if they don't exist\n @param request_options contains extra parameters to send with your query", "Partially override the content of several objects and wait end of indexing\n\n @param objects an array of objects to update (each object must contains a objectID attribute)\n @param create_if_not_exits a boolean, if true create the objects if they don't exist\n @param request_options contains extra parameters to send with your query", "Delete an object from the index\n\n @param objectID the unique identifier of object to delete\n @param request_options contains extra parameters to send with your query", "Delete an object from the index and wait end of indexing\n\n @param objectID the unique identifier of object to delete\n @param request_options contains extra parameters to send with your query", "Delete several objects\n\n @param objects an array of objectIDs\n @param request_options contains extra parameters to send with your query", "Delete several objects and wait end of indexing\n\n @param objects an array of objectIDs\n @param request_options contains extra parameters to send with your query", "Delete all objects matching a query\n This method retrieves all objects synchronously but deletes in batch\n asynchronously\n\n @param query the query string\n @param params the optional query parameters\n @param request_options contains extra parameters to send with your query", "Delete all objects matching a query and wait end of indexing\n\n @param query the query string\n @param params the optional query parameters\n @param request_options contains extra parameters to send with your query", "Delete the index content and wait end of indexing", "Set settings for this index", "Set settings for this index and wait end of indexing", "Get settings of this index", "Get ACL of a user key\n\n Deprecated: Please us `client.get_api_key` instead.", "Delete an existing user key\n\n Deprecated: Please use `client.delete_api_key` instead", "Send a batch request", "Send a batch request and wait the end of the indexing", "Search for facet values\n\n @param facet_name Name of the facet to search. It must have been declared in the\n       index's`attributesForFaceting` setting with the `searchable()` modifier.\n @param facet_query Text to search for in the facet's values\n @param search_parameters An optional query to take extra search parameters into account.\n       These parameters apply to index objects like in a regular search query.\n       Only facet values contained in the matched objects will be returned.\n @param request_options contains extra parameters to send with your query", "Perform a search with disjunctive facets generating as many queries as number of disjunctive facets\n\n @param query the query\n @param disjunctive_facets the array of disjunctive facets\n @param params a hash representing the regular query parameters\n @param refinements a hash (\"string\" -> [\"array\", \"of\", \"refined\", \"values\"]) representing the current refinements\n                    ex: { \"my_facet1\" => [\"my_value1\", [\"my_value2\"], \"my_disjunctive_facet1\" => [\"my_value1\", \"my_value2\"] }\n @param request_options contains extra parameters to send with your query", "Get a synonym\n\n @param objectID the synonym objectID\n @param request_options contains extra parameters to send with your query", "Delete a synonym and wait the end of indexing\n\n @param objectID the synonym objectID\n @param forward_to_replicas should we forward the delete to replica indices\n @param request_options contains extra parameters to send with your query", "Save a synonym\n\n @param objectID the synonym objectID\n @param synonym the synonym\n @param forward_to_replicas should we forward the delete to replica indices\n @param request_options contains extra parameters to send with your query", "Save a synonym and wait the end of indexing\n\n @param objectID the synonym objectID\n @param synonym the synonym\n @param forward_to_replicas should we forward the delete to replica indices\n @param request_options contains extra parameters to send with your query", "Clear all synonyms and wait the end of indexing\n\n @param forward_to_replicas should we forward the delete to replica indices\n @param request_options contains extra parameters to send with your query", "Replace synonyms in the index by the given array of synonyms\n\n @param synonyms the array of synonyms to add\n @param request_options contains extra parameters to send with your query", "Replace synonyms in the index by the given array of synonyms and wait the end of indexing\n\n @param synonyms the array of synonyms to add\n @param request_options contains extra parameters to send with your query", "Export the full list of synonyms\n Accepts an optional block to which it will pass each synonym\n Also returns an array with all the synonyms\n\n @param hits_per_page Amount of synonyms to retrieve on each internal request - Optional - Default: 100\n @param request_options contains extra parameters to send with your query - Optional", "Get a rule\n\n @param objectID the rule objectID\n @param request_options contains extra parameters to send with your query", "Delete a rule and wait the end of indexing\n\n @param objectID the rule objectID\n @param forward_to_replicas should we forward the delete to replica indices\n @param request_options contains extra parameters to send with your query", "Save a rule\n\n @param objectID the rule objectID\n @param rule the rule\n @param forward_to_replicas should we forward the delete to replica indices\n @param request_options contains extra parameters to send with your query", "Save a rule and wait the end of indexing\n\n @param objectID the rule objectID\n @param rule the rule\n @param forward_to_replicas should we forward the delete to replica indices\n @param request_options contains extra parameters to send with your query", "Clear all rules and wait the end of indexing\n\n @param forward_to_replicas should we forward the delete to replica indices\n @param request_options contains extra parameters to send with your query", "Replace rules in the index by the given array of rules\n\n @param rules the array of rules to add\n @param request_options contains extra parameters to send with your query", "Replace rules in the index by the given array of rules and wait the end of indexing\n\n @param rules the array of rules to add\n @param request_options contains extra parameters to send with your query", "Export the full list of rules\n Accepts an optional block to which it will pass each rule\n Also returns an array with all the rules\n\n @param hits_per_page Amount of rules to retrieve on each internal request - Optional - Default: 100\n @param request_options contains extra parameters to send with your query - Optional", "Converts a hash into arel conditions", "Node generation inside DSL blocks.\n\n @overload node_name\n   Creates a Stub. Method calls chained from this Stub will determine\n   what type of node we eventually end up with.\n   @return [Nodes::Stub] A stub with the name of the method\n @overload node_name(klass)\n   Creates a Join with a polymorphic class matching the given parameter\n   @param [Class] klass The polymorphic class of the join node\n   @return [Nodes::Join] A join node with the name of the method and the given class\n @overload node_name(first_arg, *other_args)\n   Creates a Function with the given arguments becoming the function's arguments\n   @param first_arg The first argument\n   @param *other_args Optional additional arguments\n   @return [Nodes::Function] A function node for the given method name with the given arguments", "Used by 'dup' and 'clone'", "Update the content\n @param obj [String, Pathname, Tempfile, File, Content, TempObject] can be any of these types\n @param meta [Hash] - should be json-like, i.e. contain no types other than String, Number, Boolean\n @return [Content] self", "Analyse the content using a shell command\n @param opts [Hash] passing :escape => false doesn't shell-escape each word\n @example\n   content.shell_eval do |path|\n     \"file --mime-type #{path}\"\n   end\n   # ===> \"beach.jpg: image/jpeg\"", "Set the content using a shell command\n @param opts [Hash] :ext sets the file extension of the new path and :escape => false doesn't shell-escape each word\n @example\n   content.shell_generate do |path|\n     \"/usr/local/bin/generate_text gumfry -o #{path}\"\n   end\n @return [Content] self", "Any method not defined on standard Logger class, just send it on to anyone who will listen", "Initialize the buffer.\n\n Call directly from your constructor if you wish to set some non-default\n options. Otherwise buffer_initialize will be called automatically during the\n first buffer_receive call.\n\n Options:\n * :max_items, Max number of items to buffer before flushing. Default 50.\n * :max_interval, Max number of seconds to wait between flushes. Default 5.\n * :logger, A logger to write log messages to. No default. Optional.\n * :autoflush, Whether to immediately flush all inbound messages. Default true.\n * :drop_messages_on_flush_error, Whether to drop messages when there is a flush error. Default false.\n * :drop_messages_on_full_buffer, Whether to drop messages when the buffer is full. Default false.\n\n @param [Hash] options", "Save an event for later delivery\n\n Events are grouped by the (optional) group parameter you provide.\n Groups of events, plus the group name, are later passed to +flush+.\n\n This call will block if +:max_items+ has been reached.\n\n @see Stud::Buffer The overview has more information on grouping and flushing.\n\n @param event An item to buffer for flushing later.\n @param group Optional grouping key. All events with the same key will be\n              passed to +flush+ together, along with the grouping key itself.", "Try to flush events.\n\n Returns immediately if flushing is not necessary/possible at the moment:\n * :max_items have not been accumulated\n * :max_interval seconds have not elapased since the last flush\n * another flush is in progress\n\n <code>buffer_flush(:force => true)</code> will cause a flush to occur even\n if +:max_items+ or +:max_interval+ have not been reached. A forced flush\n will still return immediately (without flushing) if another flush is\n currently in progress.\n\n <code>buffer_flush(:final => true)</code> is identical to <code>buffer_flush(:force => true)</code>,\n except that if another flush is already in progress, <code>buffer_flush(:final => true)</code>\n will block/wait for the other flush to finish before proceeding.\n\n @param [Hash] options Optional. May be <code>{:force => true}</code> or <code>{:final => true}</code>.\n @return [Fixnum] The number of items successfully passed to +flush+.", "Iterate over each tuple in the set\n\n @example\n   relation = Relation.new(header, tuples)\n   relation.each { |tuple| ... }\n\n @yield [tuple]\n\n @yieldparam [Tuple] tuple\n   each tuple in the set\n\n @return [self]\n\n @api public", "Return a relation that represents a replacement of a relation\n\n Delete the tuples from the relation that are not in the other relation,\n then insert only new tuples.\n\n @example\n   replacement = relation.delete(other)\n\n @param [Enumerable] other\n\n @return [Relation::Operation::Insertion]\n\n @api public", "Create a new method alias for the original method\n\n @param [Symbol] new_method\n\n @param [Symbol] original_method\n\n @return [undefined]\n\n @api private", "Extend a tuple with function results\n\n @example\n   new_tuple = tuple.extend(header, [func1, func2])\n\n @param [Header] header\n   the attributes to include in the tuple\n @param [Array<Object>] extensions\n   the functions to extend the tuple with\n\n @return [Tuple]\n\n @api public", "Return the predicate matching the tuple\n\n @return [Function]\n\n @api private", "Create a new geo pattern task\n\n @param [Hash] data\n   The data which should be used to generate patterns\n\n @param [Array] allowed_patterns\n   The allowed_patterns\n\n @see RakeTask\n   For other arguments accepted\n @private", "Include module in instance", "Build a path for master authentication\n\n @param local_port [Fixnum] tcp port where localhost webserver is listening\n @param invite_code [String] an invitation code generated when user was invited\n @param expires_in [Fixnum] expiration time for the requested access token\n @param remote [Boolean] true when performing a login where the code is displayed on the web page\n @return [String]", "Request a redirect to the authentication url from master\n\n @param master_url [String] master root url\n @param auth_params [Hash] auth parameters (keyword arguments of #authentication_path)\n @return [String] url to begin authentication web flow", "Figure out or create a server based on url or name.\n\n No name or url provided: try to use current_master\n A name provided with --name but no url defined: try to find a server by name from config\n An URL starting with 'http' provided: try to find a server by url from config\n An URL not starting with 'http' provided: try to find a server by name\n An URL and a name provided\n  - If a server is found by name: use entry and update URL to the provided url\n  - Else create a new entry with the url and name\n\n @param name [String] master name\n @param url [String] master url or name\n @return [Kontena::Cli::Config::Server]", "Ensure that the host weave bridge is exposed using the given CIDR address,\n and only the given CIDR address\n\n @param [String] cidr '10.81.0.X/16'", "Inspect current state of attached containers\n\n @return [Hash<String, String>] container_id[0..12] => [overlay_cidr]", "Attach container to weave with given CIDR address, first detaching any existing mismatching addresses\n\n @param [String] container_id\n @param [String] overlay_cidr '10.81.X.Y/16'\n @param [Array<String>] migrate_cidrs ['10.81.X.Y/19']", "Remove container from weave network\n\n @param [String] container_id may not exist anymore\n @param [Hash] labels Docker container labels", "Ensure weave network for container\n\n @param [Docker::Container] container", "Initialize plugin manager", "Send a debug message\n @param message [String]\n @yield optionally set the message using a block", "Send a info message\n @param message [String]\n @yield optionally set the message using a block", "Send a warning message\n @param message [String]\n @yield optionally set the message using a block", "Send an error message\n @param message [String]\n @yield optionally set the message using a block", "Add error for a key\n\n @param key [Symbol] :foo\n @param key [String] 'foo.bar'\n @param error [Symbol] :not_found\n @param error [Mutations:ErrorAtom, Mutations::ErrorArray, Mutations::ErrorHash]", "Start thread to read from stdin, and write to websocket.\n Closes websocket on stdin read errors.\n\n @param ws [Kontena::Websocket::Client]\n @param tty [Boolean]\n @return [Thread]", "Connect to server websocket, send from stdin, and write out messages\n\n @param paths [String]\n @param options [Hash] @see Kontena::Websocket::Client\n @param cmd [Array<String>] command to execute\n @param interactive [Boolean] Interactive TTY on/off\n @param shell [Boolean] Shell on/of\n @param tty [Boolean] TTY on/of\n @return [Integer] exit code", "Removes possible previous member with the same IP\n\n @param [Node] node\n @return [String] the state of the cluster member", "Finds a working etcd node from set of initial nodes\n\n @param [Node] node\n @return [Hash] The cluster members as given by etcd API", "Add new peer membership\n\n @param [Excon::Connection] etcd HTTP members API connection\n @param [String] The peer URL of the new peer to be added to the cluster", "The Observable has a value. Propagate it to any observers.\n\n This will notify any Observers, causing them to yield/return if ready.\n\n The value must be immutable and threadsafe: it must remain valid for use by other threads\n both after this update, and after any other future updates. Do not send a mutable object\n that gets invalidated in between updates.\n\n TODO: automatically freeze the value?\n\n @param value [Object]\n @raise [RuntimeError] Observable crashed\n @raise [ArgumentError] Update with nil value", "Checks if given volume exists with the expected driver\n\n @param [String] name of the volume\n @param [String] driver to expect on the volume if already existing\n @raise [DriverMismatchError] If the volume is found but using a different driver than expected", "Handles events when container has died", "User requested service restart", "Check that the given container is still running for the given service pod revision.\n\n @raise [RuntimeError] service stopped\n @raise [RuntimeError] service redeployed\n @raise [RuntimeError] container recreated\n @raise [RuntimeError] container restarted", "List changed fields of model\n @param document [Mongoid::Document]\n @return [String] field, embedded{field}", "Adds errors if save fails\n\n @param grid_service [GridService]\n @return [GridService] nil if error", "Bump grid_service.revision if changed or force, and save\n Adds errors if save fails\n\n @param grid_service [GridService]\n @param force [Boolean] force-update revision\n @return [GridService] nil if error", "Return Error for first crashed observable.\n\n Should only be used if error?\n\n @return [Exception, nil]", "Yield each set of ready? observed values while alive, or raise on error?\n\n The yield is exclusive, because suspending the observing task would mean that\n any observable messages would get discarded.\n\n @param timeout [Float] timeout between each yield", "Validates that the defined secrets exist", "Validates that the defined certificates exist", "Does not raise.\n\n @param ws [Faye::Websocket]", "parse given options to hash\n @return [Hash]", "Return an approximation of how long ago the given time was.\n @param time [String]\n @param terse [Boolean] very terse output (2-3 chars wide)", "Connect to server, and start connect_client task\n\n Calls reconnect! on errors", "Called from RpcServer, does not crash the Actor on errors.\n\n @param [String, Array] msg\n @raise [RuntimeError] not connected", "Websocket connection failed\n\n @param exc [Kontena::Websocket::Error]", "Server closed websocket connection\n\n @param code [Integer]\n @param reason [String]", "Create a subcommand loader instance\n\n @param [String] path path to command definition\n Takes something like /foo/bar/cli/master/foo_coimmand and returns [:Master, :FooCommand]\n\n @param path [String]\n @return [Array<Symbol>]", "Requests path supplied as argument and returns true if the request was a success.\n For checking if the current authentication is valid.\n\n @param [String] token_verify_path a path that requires authentication\n @return [Boolean]", "Calls the code exchange endpoint in token's config to exchange an authorization_code\n to a access_token", "Get stream request\n\n @param [String] path\n @param [Lambda] response_block\n @param [Hash,NilClass] params\n @param [Hash] headers", "Perform a HTTP request. Will try to refresh the access token and retry if it's\n expired or if the server responds with HTTP 401.\n\n Automatically parses a JSON response into a hash.\n\n After the request has been performed, the response can be inspected using\n client.last_response.\n\n @param http_method [Symbol] :get, :post, etc\n @param path [String] if it starts with / then prefix won't be used.\n @param body [Hash, String] will be encoded using #encode_body\n @param query [Hash] url query parameters\n @param headers [Hash] extra headers for request.\n @param response_block [Proc] for streaming requests, must respond to #call\n @param expects [Array] raises unless response status code matches this list.\n @param auth [Boolean] use token authentication default = true\n @return [Hash, String] response parsed response object", "Accessor to token's account settings", "Perform refresh token request to auth provider.\n Updates the client's Token object and writes changes to\n configuration.\n\n @param [Boolean] use_basic_auth? When true, use basic auth authentication header\n @return [Boolean] success?", "Encode body based on content type.\n\n @param [Object] body\n @param [String] content_type\n @return [String] encoded_content", "Convert expires_in into expires_at\n\n @param [Fixnum] seconds_till_expiration\n @return [Fixnum] expires_at_unix_timestamp", "Aborts caller on errors.\n\n @param [String] method\n @param [Array] params\n @param [Float] timeout seconds\n @raise abort\n @return [Object]", "Connection was rejected\n\n @param [Time] connected_at\n @param [Integer] code websocket close\n @param [String] reason websocket close", "Sort services with a stack, such that services come after any services that they link to.\n This can only be used to sort services within the same stack. Links to services in other stacks are ignored.\n\n @param [Array<GridService,Hash>]\n @raise [MissingLinkError] service ... has missing links: ...\n @raise [RecursiveLinkError] service ... has recursive links: ...\n @return [Array<GridService,Hash>]", "Validate grid nodes configuration and status\n\n @param grid [Hash] get(/grids/:grid) => { ... }\n @param nodes [Array<Hash>] get(/grids/:grid/nodes)[nodes] => [ { ... } ]\n @return [Symbol] health", "An accessor to the YAML Reader outcome. Passes parent name, values from command line and\n the stackname to the reader.\n\n @return [Hash]", "Sets environment variables from parameters\n @param stack [String] current stack name\n @param grid [String] current grid name\n @param platform [String] current platform name, defaults to param grid value", "An accessor to stack registry client\n @return [Kontena::StacksClient]", "Stack is upgraded if version, stack name, variables change or stack is root\n\n @param name [String]\n @return [Boolean]", "Process items from @queue", "requires etcd to be available to read log timestamps", "best-effort attempt to write etcd timestamps; may not be possible", "Preprocess data and return a ChangeResolver\n @param old_data [Hash] data from master\n @param new_data [Hash] data from files\n @return [Kontena::Cli::Stacks::ChangeRsolver]", "Serve one request and return query params.\n\n @return [Hash] query_params", "Creates new instance of MethodHandler\n\n @param [Symbol] method_name\n @param [Bool] is_class_method\n @param [Class] target - class that method got added to\n Handles method addition", "Makes a method re-definition in proper way", "Aliases original method to a special unique name, which is known\n only to this class. Usually done right before re-defining the\n method.", "Takes a mixed value coming out of a parslet and converts it to a return\n value for the user by dropping things and merging hashes.\n\n Named is set to true if this result will be embedded in a Hash result from\n naming something using <code>.as(...)</code>. It changes the folding\n semantics of repetition.", "Lisp style fold left where the first element builds the basis for\n an inject.", "Flatten results from a sequence of parslets.\n\n @api private", "Flatten results from a repetition of a single parslet. named indicates\n whether the user has named the result or not. If the user has named\n the results, we want to leave an empty list alone - otherwise it is\n turned into an empty string.\n\n @api private", "Define an entity for the parser. This generates a method of the same\n name that can be used as part of other patterns. Those methods can be\n freely mixed in your parser class with real ruby methods.\n\n   class MyParser\n     include Parslet\n\n     rule(:bar) { str('bar') }\n     rule(:twobar) do\n       bar >> bar\n     end\n\n     root :twobar\n   end", "Signals to the outside that the parse has failed. Use this in\n conjunction with .format for nice error messages.", "Consumes n characters from the input, returning them as a slice of the\n input.", "Makes the value of appropriate key of the schema an array and pushes in results of iterating through\n   records and surrealizing them\n\n @param [Hash] schema the schema defined in the object's class.\n @param [Object] instance the instance of the object which methods from the schema are called on.\n @param [Symbol] key the symbol that represents method on the instance\n @param [Any] value returned when key is called on instance\n\n @return [Hash] the schema hash", "Dumps the object's methods corresponding to the schema\n provided in the object's class and type-checks the values.\n\n @param [Boolean] [optional] camelize optional argument for converting hash to camelBack.\n @param [Boolean] [optional] include_root optional argument for having the root key of the resulting hash\n   as instance's class name.\n @param [Boolean] [optional] include_namespaces optional argument for having root key as a nested hash of\n   instance's namespaces. Animal::Cat.new.surrealize -> (animal: { cat: { weight: '3 kilos' } })\n @param [String] [optional] root optional argument for using a specified root key for the hash\n @param [Integer] [optional] namespaces_nesting_level level of namespaces nesting.\n\n @return [String] a json-formatted string corresponding to the schema\n   provided in the object's class. Values will be taken from the return values\n   of appropriate methods from the object.\n\n @raise +Surrealist::UnknownSchemaError+ if no schema was provided in the object's class.\n\n @raise +Surrealist::InvalidTypeError+ if type-check failed at some point.\n\n @raise +Surrealist::UndefinedMethodError+ if a key defined in the schema\n   does not have a corresponding method on the object.\n\n @example Define a schema and surrealize the object\n   class User\n     include Surrealist\n\n     json_schema do\n       {\n         name: String,\n         age: Integer,\n       }\n     end\n\n     def name\n       'Nikita'\n     end\n\n     def age\n       23\n     end\n   end\n\n   User.new.surrealize\n   # => \"{\\\"name\\\":\\\"Nikita\\\",\\\"age\\\":23}\"\n   # For more examples see README", "Invokes +Surrealist+'s class method +build_schema+", "Passes build_schema to Surrealist", "Maps collection and builds schema for each instance.", "Returns all arguments\n\n @return [Hash]", "Checks all boolean arguments\n @raise ArgumentError", "Checks if root is not nil, a non-empty string, or symbol\n @raise ArgumentError", "A DSL method to delegate schema in a declarative style. Must reference a valid\n class that includes Surrealist\n\n @param [Class] klass\n\n @example DSL usage example\n   class Host\n     include Surrealist\n\n     json_schema do\n       { name: String }\n     end\n\n     def name\n       'Parent'\n     end\n   end\n\n   class Guest < Host\n     delegate_surrealization_to Host\n\n     def name\n       'Child'\n     end\n   end\n\n   Guest.new.surrealize\n   # => \"{\\\"name\\\":\\\"Child\\\"}\"\n   # For more examples see README", "A DSL method for defining a class that holds serialization logic.\n\n @param [Class] klass a class that should inherit form Surrealist::Serializer\n\n @raise ArgumentError if Surrealist::Serializer is not found in the ancestors chain", "Returns either a job hash or falsy.", "Sends a heartbeat to the server, in order to prove this\n worker process is still alive.\n\n Return a string signal to process, legal values are \"quiet\" or \"terminate\".\n The quiet signal is informative: the server won't allow this process to FETCH\n any more jobs anyways.", "This method adds the `url_builder` option so we can pass in the\n mounted Rails engine's scope for will_paginate", "Fetches a list of all the available Gems and their versions.\n\n @return [String]", "Creates a new file with the given name and content.\n\n @param [String] name\n @param [String] content\n @return [Gem::MirrorFile]", "Returns an Array containing the versions that should be fetched for a\n Gem.\n\n @param [Gemirro::Gem] gem\n @return [Array]", "Tries to download gemspec from a given name and version\n\n @param [Gemirro::Gem] gem\n @param [Gem::Version] version\n @return [String]", "Tries to download the gem file from a given nam and version\n\n @param [Gemirro::Gem] gem\n @param [Gem::Version] version\n @return [String]", "Read file if exists otherwise download its from source\n\n @param [String] file name\n @param [TrueClass|FalseClass] prerelease Is prerelease or not", "Returns the filename of the gem file.\n\n @param [String] gem_version\n @return [String]", "Returns the filename of the gemspec file.\n\n @param [String] gem_version\n @return [String]", "Try to fetch gem and download its if it's possible, and\n build and install indicies.\n\n @param [String] resource\n @return [Indexer]", "Update indexes files\n\n @return [Indexer]", "Return gems list from query params\n\n @return [Array]", "List of versions and dependencies of each version\n from a gem name.\n\n @return [Array]", "Download file from source\n\n @param [String] file File path\n @return [String]", "Map gems file to specs\n\n @param [Array] gems Gems list\n @return [Array]", "Group gems by name\n\n @param [Proc] block\n @return [Array]", "Find gem by name\n\n @param [String] gemname\n @return [Array]", "Set log level\n\n @param [string]\n\n @return [Logger]", "Adds a Gem to the list of Gems to ignore.\n\n @param [String] name\n @param [String] version", "Checks if a Gem should be ignored.\n\n @param [String] name\n @param [String] version\n @return [TrueClass|FalseClass]", "Define the source to mirror.\n\n @param [String] name\n @param [String] url\n @param [Proc] block", "Reads the content of the current file.\n\n @return [String]", "Return the next URL to scrape, given the current URL and its index.\n\n Recursion stops if the fetching URL returns an empty string or an error.\n\n If @paginated is not set (the default), this method returns an empty string.\n\n If @paginated is set, this method will return the next pagination URL\n to scrape using @pagination_param and the pagination_index.\n\n If the pagination_index is greater than @pagination_max_pages, then the\n method will return an empty string.\n\n Override this method to handle pagination is an alternative way\n e.g. next_index_page_url(\"http://whatever.com/articles?page=1\", 2)\n ought to return \"http://whatever.com/articles?page=2\"", "Writes the scraped result to a CSV at the given filename.", "Handles getting pages with Downlader, which handles stashing.", "Returns the instance at `url`.\n\n If the page is stashed, returns that, otherwise, fetches it from the web.\n\n If an instance is paginated, returns the concatenated output of each\n page, e.g. if a news article has two pages.", "Just a helper for +scrape+.", "Gets various monitoring and status variables from the server.\n Authenticates using +name+ and +pwd+ for basic authentication.\n @param (see Misc.server)\n @return [Hash]", "Gets basic information about the target server, including version number,\n commit ID, and links to API endpoints.\n @return [Hash]", "Gets a base url for the associated UAA from the target server by inspecting the\n links returned from its info endpoint.\n @return [String] url of UAA (or the target itself if it didn't provide a response)", "Gets the key from the server that is used to validate token signatures. If\n the server is configured to use a symetric key, the caller must authenticate\n by providing a a +client_id+ and +client_secret+. If the server\n is configured to sign with a private key, this call will retrieve the\n public key and +client_id+ must be nil.\n @param (see Misc.server)\n @return [Hash]", "Gets information about the given password, including a strength score and\n an indication of what strength is required.\n @param (see Misc.server)\n @return [Hash]", "an attempt to hide some scim and uaa oddities", "Creates a SCIM resource.\n @param [Symbol] type can be :user, :group, :client, :user_id.\n @param [Hash] info converted to json and sent to the scim endpoint. For schema of\n   each type of object see {Scim}.\n @return [Hash] contents of the object, including its +id+ and meta-data.", "Replaces the contents of a SCIM object.\n @param (see #add)\n @return (see #add)", "Gets a set of attributes for each object that matches a given filter.\n @param (see #add)\n @param [Hash] query may contain the following keys:\n   * +attributes+: a comma or space separated list of attribute names to be\n     returned for each object that matches the filter. If no attribute\n     list is given, all attributes are returned.\n   * +filter+: a filter to select which objects are returned. See\n     {http://www.simplecloud.info/specs/draft-scim-api-01.html#query-resources}\n   * +startIndex+: for paged output, start index of requested result set.\n   * +count+: maximum number of results per reply\n @return [Hash] including a +resources+ array of results and\n   pagination data.", "Get information about a specific object.\n @param (see #delete)\n @return (see #add)", "Gets an access token in a single call to the UAA with the user\n credentials used for authentication.\n @param credentials should be an object such as a hash that can be converted\n   to a json representation of the credential name/value pairs corresponding to\n   the keys retrieved by {#prompts}.\n @return [TokenInfo]", "Constructs a uri that the client is to return to the browser to direct\n the user to the authorization server to get an authcode.\n @param [String] redirect_uri (see #authcode_uri)\n @return [String]", "Gets a token via an implicit grant.\n @param [String] implicit_uri must be from a previous call to\n   {#implicit_uri}, contains state used to validate the contents of the\n   reply from the server.\n @param [String] callback_fragment must be the fragment portion of the URL\n   received by the user's browser after the server redirects back to the\n   +redirect_uri+ that was given to {#implicit_uri}. How the application\n   gets the contents of the fragment is application specific -- usually\n   some javascript in the page at the +redirect_uri+.\n @see http://tools.ietf.org/html/rfc6749#section-4.2\n @return [TokenInfo]", "A UAA extension to OAuth2 that allows a client to pre-authenticate a\n user at the start of an authorization code flow. By passing in the\n user's credentials the server can establish a session with the user's\n browser without reprompting for authentication. This is useful for\n user account management apps so that they can create a user account,\n or reset a password for the user, without requiring the user to type\n in their credentials again.\n @param [String] credentials (see #implicit_grant_with_creds)\n @param [String] redirect_uri (see #authcode_uri)\n @return (see #authcode_uri)", "Uses the instance client credentials in addition to +callback_query+\n to get a token via the authorization code grant.\n @param [String] authcode_uri must be from a previous call to {#authcode_uri}\n   and contains state used to validate the contents of the reply from the\n   server.\n @param [String] callback_query must be the query portion of the URL\n   received by the client after the user's browser is redirected back from\n   the server. It contains the authorization code.\n @see http://tools.ietf.org/html/rfc6749#section-4.1\n @return [TokenInfo]", "Check if event has branching choice transitions or not\n\n @example\n   events_map.choice_transition?(:go, :green) # => true\n\n @param [Symbol] name\n   the event name\n\n @param [Symbol] from_state\n   the transition from state\n\n @return [Boolean]\n   true if transition has any branches, false otherwise\n\n @api public", "Find transition without checking conditions\n\n @param [Symbol] name\n   the event name\n\n @param [Symbol] from_state\n   the transition from state\n\n @return [Transition, nil]\n   returns transition, nil otherwise\n\n @api private", "Examine transitions for event name that start in from state\n and find one matching condition.\n\n @param [Symbol] name\n   the event name\n\n @param [Symbol] from_state\n   the current context from_state\n\n @return [Transition]\n   The choice transition that matches\n\n @api public", "Select transition that matches conditions\n\n @param [Symbol] name\n   the event name\n @param [Symbol] from_state\n   the transition from state\n @param [Array[Object]] conditions\n   the conditional data\n\n @return [Transition]\n\n @api public", "Find state that this machine can move to\n\n @example\n   evenst_map.move_to(:go, :green) # => :red\n\n @param [Symbol] name\n   the event name\n\n @param [Symbol] from_state\n   the transition from state\n\n @param [Array] conditions\n   the data associated with this transition\n\n @return [Symbol]\n   the transition `to` state\n\n @api public", "Return string representation of this map\n\n @return [String]\n\n @api public", "Initialize a Transition\n\n @example\n   attributes = {states: {green: :yellow}}\n   Transition.new(context, :go, attributes)\n\n @param [Object] context\n   the context this transition evaluets conditions in\n\n @param [Hash] attrs\n\n @return [Transition]\n\n @api public\n Reduce conditions\n\n @return [Array[Callable]]\n\n @api private", "Check if this transition matches from state\n\n @param [Symbol] from\n   the from state to match against\n\n @example\n   transition = Transition.new(context, states: {:green => :red})\n   transition.matches?(:green) # => true\n\n @return [Boolean]\n   Return true if match is found, false otherwise.\n\n @api public", "Initialize a ChoiceMerger\n\n @param [StateMachine] machine\n @param [String] name\n @param [Hash] transitions\n   the transitions and attributes\n\n @api private\n Create choice transition\n\n @example\n   event :stop, from: :green do\n     choice :yellow\n   end\n\n @param [Symbol] to\n   the to state\n @param [Hash] conditions\n   the conditions associated with this choice\n\n @return [FiniteMachine::Transition]\n\n @api public", "Define state helper method\n\n @param [Symbol] state\n   the state to define helper for\n\n @api private", "Register callback for a given hook type\n\n @param [HookEvent] hook_type\n @param [Symbol] state_or_event_name\n @param [Proc] callback\n\n @example\n   observer.on HookEvent::Enter, :green\n\n @api public", "Unregister callback for a given event\n\n @api public", "Execute each of the hooks in order with supplied data\n\n @param [HookEvent] event\n   the hook event\n\n @param [Array[Object]] data\n\n @return [nil]\n\n @api public", "Handle callback and decide if run synchronously or asynchronously\n\n @param [Proc] :hook\n   The hook to evaluate\n\n @param [HookEvent] :event\n   The event for which the hook is called\n\n @param [Array[Object]] :data\n\n @api private", "Defer callback execution\n\n @api private", "Create callable instance\n\n @api private", "Instantiate a new HookEvent object\n\n @param [Symbol] name\n   The action or state name\n\n @param [Symbol] event_name\n   The event name associated with this hook event.\n\n @example\n   HookEvent.new(:green, :move, :green)\n\n @return [self]\n\n @api public\n Notify subscriber about this event\n\n @param [Observer] subscriber\n   the object subscribed to be notified about this event\n\n @param [Array] data\n   the data associated with the triggered event\n\n @return [nil]\n\n @api public", "Initialize an EventDefinition\n\n @param [StateMachine] machine\n\n @api private\n Define transition event names as state machine events\n\n @param [Symbol] event_name\n   the event name for which definition is created\n\n @return [nil]\n\n @api public", "Define transition event\n\n @param [Symbol] event_name\n   the event name\n\n @param [Boolean] silent\n   if true don't trigger callbacks, otherwise do\n\n @return [nil]\n\n @api private", "Initialize top level DSL\n\n @api public\n Define initial state\n\n @param [Symbol] value\n   The initial state name.\n @param [Hash[Symbol]] options\n @option options [Symbol] :event\n   The event name.\n @option options [Symbol] :defer\n   Set to true to defer initial state transition.\n   Default false.\n @option options [Symbol] :silent\n   Set to true to disable callbacks.\n   Default true.\n\n @example\n   initial :green\n\n @example Defer initial event\n   initial state: green, defer: true\n\n @example Trigger callbacks\n   initial :green, silent: false\n\n @example Redefine event name\n   initial :green, event: :start\n\n @param [String, Hash] value\n\n @return [StateMachine]\n\n @api public", "Create event and associate transition\n\n @example\n   event :go, :green => :yellow\n   event :go, :green => :yellow, if: :lights_on?\n\n @param [Symbol] name\n   the event name\n @param [Hash] transitions\n   the event transitions and conditions\n\n @return [Transition]\n\n @api public", "Parse initial options\n\n @param [Hash] options\n   the options to extract for initial state setup\n\n @return [Array[Symbol,String]]\n\n @api private", "Check if current state matches provided state\n\n @example\n   fsm.is?(:green) # => true\n\n @param [String, Array[String]] state\n\n @return [Boolean]\n\n @api public", "Checks if event can be triggered\n\n @example\n   fsm.can?(:go) # => true\n\n @example\n   fsm.can?(:go, 'Piotr')  # checks condition with parameter 'Piotr'\n\n @param [String] event\n\n @return [Boolean]\n\n @api public", "Check if state is reachable\n\n @param [Symbol] event_name\n   the event name for all transitions\n\n @return [Boolean]\n\n @api private", "Notify about event all the subscribers\n\n @param [HookEvent] :hook_event_type\n   The hook event type.\n @param [FiniteMachine::Transition] :event_transition\n   The event transition.\n @param [Array[Object]] :data\n   The data associated with the hook event.\n\n @return [nil]\n\n @api private", "Attempt performing event trigger for valid state\n\n @return [Boolean]\n   true is trigger successful, false otherwise\n\n @api private", "Trigger transition event with data\n\n @param [Symbol] event_name\n   the event name\n @param [Array] data\n\n @return [Boolean]\n   true when transition is successful, false otherwise\n\n @api public", "Trigger transition event without raising any errors\n\n @param [Symbol] event_name\n\n @return [Boolean]\n   true on successful transition, false otherwise\n\n @api public", "Find available state to transition to and transition\n\n @param [Symbol] event_name\n\n @api private", "Update this state machine state to new one\n\n @param [Symbol] new_state\n\n @raise [TransitionError]\n\n @api private", "Forward the message to observer or self\n\n @param [String] method_name\n\n @param [Array] args\n\n @return [self]\n\n @api private", "Test if a message can be handled by state machine\n\n @param [String] method_name\n\n @param [Boolean] include_private\n\n @return [Boolean]\n\n @api private", "Raise error when the method is already defined\n\n @example\n   detect_event_conflict!(:test, \"test=\")\n\n @raise [FiniteMachine::AlreadyDefinedError]\n\n @return [nil]\n\n @api public", "Raise error when the callback name is not valid\n\n @example\n   ensure_valid_callback_name!(HookEvent::Enter, \":state_name\")\n\n @raise [FiniteMachine::InvalidCallbackNameError]\n\n @return [nil]\n\n @api public", "Check if event name exists\n\n @param [Symbol] name\n\n @param [FiniteMachine::HookEvent] event_type\n\n @return [Boolean]\n\n @api private", "Check if state name exists\n\n @param [Symbol] name\n\n @param [FiniteMachine::HookEvent] event_type\n\n @return [Boolean]\n\n @api private", "Add listener to the queue to receive messages\n\n @api public", "Shut down this event queue and clean it up\n\n @example\n   event_queue.shutdown\n\n @return [Boolean]\n\n @api public", "Process all the events\n\n @return [Thread]\n\n @api private", "Visit subscribers and notify\n\n @param [HookEvent] hook_event\n   the callback event to notify about\n\n @return [undefined]\n\n @api public", "Initialize a TransitionBuilder\n\n @example\n   TransitionBuilder.new(machine, {})\n\n @api public\n Converts user transitions into internal {Transition} representation\n\n @example\n   transition_builder.call([:green, :yellow] => :red)\n\n @param [Hash[Symbol]] transitions\n   The transitions to extract states from\n\n @return [self]\n\n @api public", "Rescue exception raised in state machine\n\n @param [Array[Exception]] exceptions\n\n @example\n   handle TransitionError, with: :pretty_errors\n\n @example\n   handle TransitionError do |exception|\n     logger.info exception.message\n     raise exception\n   end\n\n @api public", "Catches error and finds a handler\n\n @param [Exception] exception\n\n @return [Boolean]\n   true if handler is found, nil otherwise\n\n @api public", "Find constant in state machine namespace\n\n @param [String] class_name\n\n @api private", "Executes given handler\n\n @api private", "Check if exception inherits from Exception class and add to error handlers\n\n @param [Array[Exception]] exceptions\n\n @param [Hash] options\n\n @api private", "Get the Github team ID using its slug\n\n This depends on the `octo()` method from LitaGithub::Octo being within the same scope\n\n @author Tim Heckman <tim@pagerduty.com>\n @param slug [String] the slug of the team you're getting the ID for\n @param org [String] the organization this team should belong in\n @return [Nil] if no team was found nil is returned\n @return [Integer] if a team is found the team's ID is returned", "Get the team id based on either the team slug or the team id\n\n @author Tim Heckman <tim@pagerduty.com>\n @param team [String,Integer] this is either the team's slug or the team's id\n @return [Integer] the team's id", "Parse the options in the command using the option regex\n\n @author Tim Heckman <tim@pagerduty.com>\n @param cmd [String] the full command line provided to Lita\n @return [Hash] the key:value pairs that were in the command string", "Determine if the team is already on the repository\n\n @param full_name [String] the canonical name of the repository\n @param team_id [Integer] the id for the Github team\n @return [TrueClass] if the team is already on the repo\n @return [FalseClass] if the team is not on the repo", "SMART p, Salton p, Chisholm IDFP", "SMART L, Chisholm LOGN", "Tokenizes the text and counts terms and total tokens.", "Return the term's inverse document frequency.\n\n @param [String] term a term\n @return [Float] the term's inverse document frequency", "Returns the term's frequency in the document.\n\n @param [Document] document a document\n @param [String] term a term\n @return [Float] the term's frequency in the document\n\n @note Like Lucene, we use a b value of 0.75 and a k1 value of 1.2.", "Render the view\n\n @param format [Symbol] template format to use\n @param context [Context] context object to use\n @param input input data for preparing exposure values\n\n @return [Rendered] rendered view object\n @api public", "For now, when an overlap is found, just open a binding.pry to make fixing it easier.", "Poor man's content_tag. No HTML escaping included", "returns not_covered, ignored", "Public API\n Search self and descendants for a particular Class or type", "Shortcut to access children", "Yields its children and itself", "If a file wasn't required, it won't be in the trackers. This adds those mossing files", "returns a TrackerHitsPerPath", "In JRuby, ObjectSpace.each_object is allowed for Module and Class, so we are good.", "We need to remove the interceptor hooks, otherwise, the problem if manually requiring\n something that is autoloaded will cause issues.", "Returns true if the code would have continued, false if the rescue was triggered.", "Loads a given ruby file, and runs instance_eval against it in the context of the current\n object.\n\n Raises an IOError if the file cannot be found, or is not readable.\n\n === Parameters\n filename<String>:: A filename to read from", "Resets all config options to their defaults.", "Makes a copy of any non-default values.\n\n This returns a shallow copy of the hash; while the hash itself is\n duplicated a la dup, modifying data inside arrays and hashes may modify\n the original Config object.\n\n === Returns\n\n Hash of values the user has set.\n\n === Examples\n\n For example, this config class:\n\n     class MyConfig < Mixlib::Config\n       default :will_be_set, 1\n       default :will_be_set_to_default, 1\n       default :will_not_be_set, 1\n       configurable(:computed_value) { |x| x*2 }\n       config_context :group do\n         default :will_not_be_set, 1\n       end\n       config_context :group_never_set\n     end\n\n     MyConfig.x = 2\n     MyConfig.will_be_set = 2\n     MyConfig.will_be_set_to_default = 1\n     MyConfig.computed_value = 2\n     MyConfig.group.x = 3\n\n produces this:\n\n     MyConfig.save == {\n       :x => 2,\n       :will_be_set => 2,\n       :will_be_set_to_default => 1,\n       :computed_value => 4,\n       :group => {\n         :x => 3\n       }\n     }", "Restore non-default values from the given hash.\n\n === Parameters\n hash<Hash>: a hash in the same format as output by save.\n\n === Returns\n self", "Merge an incoming hash with our config options\n\n === Parameters\n hash<Hash>: a hash in the same format as output by save.\n\n === Returns\n self", "Allows you to create a new config context where you can define new\n options with default values.\n\n This method allows you to open up the configurable more than once.\n\n For example:\n\n config_context :server_info do\n   configurable(:url).defaults_to(\"http://localhost\")\n end\n\n === Parameters\n symbol<Symbol>: the name of the context\n block<Block>: a block that will be run in the context of this new config\n class.", "Allows you to create a new list of config contexts where you can define new\n options with default values.\n\n This method allows you to open up the configurable more than once.\n\n For example:\n\n config_context_list :listeners, :listener do\n   configurable(:url).defaults_to(\"http://localhost\")\n end\n\n === Parameters\n symbol<Symbol>: the plural name for contexts in the list\n symbol<Symbol>: the singular name for contexts in the list\n block<Block>: a block that will be run in the context of this new config\n class.", "Allows you to create a new hash of config contexts where you can define new\n options with default values.\n\n This method allows you to open up the configurable more than once.\n\n For example:\n\n config_context_hash :listeners, :listener do\n   configurable(:url).defaults_to(\"http://localhost\")\n end\n\n === Parameters\n symbol<Symbol>: the plural name for contexts in the list\n symbol<Symbol>: the singular name for contexts in the list\n block<Block>: a block that will be run in the context of this new config\n class.", "Internal dispatch setter for config values.\n\n === Parameters\n symbol<Symbol>:: Name of the method (variable setter)\n value<Object>:: Value to be set in config hash", "Adds a link to remove the associated record. The first argment is the name of the link.\n\n   f.link_to_remove(\"Remove Task\")\n\n You can pass HTML options in a hash at the end and a block for the content.\n\n   <%= f.link_to_remove(:class => \"remove_task\", :href => \"#\") do %>\n     Remove Task\n   <% end %>\n\n See the README for more details on where to call this method.", "Resolve the given dependency tree and return a list of concrete packages\n that meet all dependency requirements.\n\n The following stages are involved:\n - Create permutations of possible version combinations for all dependencies\n - Remove invalid permutations\n - Select the permutation with the highest versions", "Converts a simplified dependency tree into an array of dependencies,\n containing a sub-array for each top-level dependency. Each such sub-array\n contains, in its turn, version permutations for the top-level dependency\n and any transitive dependencies.", "Remove invalid permutations, that is permutations that contain multiple\n versions of the same package, a scenario which could arrive in the case of\n circular dependencies, or when different dependencies rely on different\n versions of the same transitive dependency.", "Select the highest versioned permutation of package versions", "Sort permutations by version numbers", "Find packages meeting the version requirement", "Find available packaging matching the package specifier, and queue them for\n processing any include files or transitive dependencies.", "Remove redundant older versions of dependencies by collating package\n versions by package specifiers, then removing older versions for any\n package for which a single package specifier exists.", "Return a hash mapping packages to package specifiers to spec objects, to\n be used to eliminate older versions from the dependency tree", "Recursively remove any dependency for which no version is locally\n available. If no version is found for any of the dependencies specified\n by the user, an error is raised.\n\n The processed hash is used for keeping track of dependencies that were\n already processed, and thus deal with circular dependencies.", "Adds a filter to the filter chain. Sorts filters by weight.\n\n @param [#call] filter The filter object (proc, class, module, etc)\n @return [void]", "Deletes a filter from the the filter chain.\n\n @param [Class] filter_class The class of the filter you want to delete\n @return [void]\n @since v3.1.0", "Replaces invalid characters in a string with arbitrary encoding.\n\n @param [String] str The string to replace characters\n @return [String] a UTF-8 encoded string\n @see https://github.com/flori/json/commit/3e158410e81f94dbbc3da6b7b35f4f64983aa4e3", "Asynchronously sends a notice to Airbrake.\n\n @param [Airbrake::Notice] notice A notice that was generated by the\n   library\n @return [Airbrake::Promise]", "Writes a value to the payload hash. Restricts unrecognized writes.\n\n @example\n   notice[:params][:my_param] = 'foobar'\n\n @return [void]\n @raise [Airbrake::Error] if the notice is ignored\n @raise [Airbrake::Error] if the +key+ is not recognized\n @raise [Airbrake::Error] if the root value is not a Hash", "Run swiftlint on each file and aggregate collect the issues\n\n @return [Array] swiftlint issues", "Find swift files from the files glob\n If files are not provided it will use git modifield and added files\n\n @return [Array] swift files", "Get the configuration file", "Find all requested environment variables in the given string and replace them with the correct values.", "Return whether the file exists within a specified collection of paths\n\n @return [Bool] file exists within specified collection of paths", "Parses the configuration file and return the specified files in path\n\n @return [Array] list of files specified in path", "Create a markdown table from swiftlint issues\n\n @return  [String]", "Checks signature against secret and returns boolean", "Configure Pusher connection by providing a url rather than specifying\n scheme, key, secret, and app_id separately.\n\n @example\n   Pusher.url = http://KEY:SECRET@api.pusherapp.com/apps/APP_ID", "Trigger an event on one or more channels\n\n POST /apps/[app_id]/events\n\n @param channels [String or Array] 1-10 channel names\n @param event_name [String]\n @param data [Object] Event data to be triggered in javascript.\n   Objects other than strings will be converted to JSON\n @param params [Hash] Additional parameters to send to api, e.g socket_id\n\n @return [Hash] See Pusher API docs\n\n @raise [Pusher::Error] Unsuccessful response - see the error message\n @raise [Pusher::HTTPError] Error raised inside http client. The original error is wrapped in error.original_error", "Trigger event, catching and logging any errors.\n\n [Deprecated] This method will be removed in a future gem version. Please\n switch to Pusher.trigger or Pusher::Client#trigger instead\n\n @note CAUTION! No exceptions will be raised on failure\n @param (see #trigger!)", "Compute authentication string required as part of the authentication\n endpoint response. Generally the authenticate method should be used in\n preference to this one\n\n @param socket_id [String] Each Pusher socket connection receives a\n   unique socket_id. This is sent from pusher.js to your server when\n   channel authentication is required.\n @param custom_string [String] Allows signing additional data\n @return [String]\n\n @raise [Pusher::Error] if socket_id or custom_string invalid", "Override to return html as string.", "Create query that can be used for role comparisons\n\n @param [User] user\n   Required. Membership user to check.\n @param [Pageflow::Account] account\n   Required. Membership entity to check.\n Return true if there is a membership with at least role for\n user/account\n\n @param [String] role\n   Required. Minimum role that we compare against.\n @return [Boolean]", "Add a section to the help dialog displayed in the editor.\n\n Translation keys for the help entry are derived from its name by\n appending \".menu_item\" and \".text\". Text is parsed as markdown.\n\n @param [String] name  Translation key prefix\n @param [Hash] options\n @option options [String] :parent  Name of the parent help entry\n @option options [Fixnum] :priority (10) Entries with higher\n          priority come first in the entry list.", "Rack app handler.", "Parse request and fill env with rpc data.\n Returns a bad_route error if something went wrong.", "Configure service rpc methods.", "Find one of the child classes by calling the given method\n and passing all the rest of the parameters to that method in\n each child", "Capture log messages from the Logging framework and make them\n available via a @log_output instance variable. The @log_output\n supports a readline method to access the log messages.", "Returns the name of the parent for the logger identified by the given\n _key_. If the _key_ is for the root logger, then +nil+ is returned.", "We use meta-programming here to define the `sufficiently_aged?` method for\n the rolling appender. The `sufficiently_aged?` method is responsible for\n determining if the current log file is older than the rolling criteria -\n daily, weekly, etc.\n\n Returns this rolling file appender instance", "Configure the auto-flushing threshold. Auto-flushing is used to flush\n the contents of the logging buffer to the logging destination\n automatically when the buffer reaches a certain threshold.\n\n By default, the auto-flushing will be configured to flush after each\n log message.\n\n The allowed settings are as follows:\n\n   N      : flush after every N messages (N is an integer)\n   true   : flush after each log message\n   false  OR\n   nil    OR\n   0      : only flush when the buffer is full (500 messages)\n\n If the default buffer size of 500 is too small, then you can manually\n configure it to be as large as you want. This will consume more memory.\n\n   auto_flushing = 42_000", "Using the flush_period, create a new AsyncFlusher attached to this\n appender. If the flush_period is nil, then no action will be taken. If a\n AsyncFlusher already exists, it will be stopped and a new one will be\n created.\n\n Returns `nil`", "Allow the scheme to be set like a Hash.", "Return a normalized representation of a color setting.", "Set the appender encoding to the given value. The value can either be an\n Encoding instance or a String or Symbol referring to a valid encoding.\n\n This method only applies to Ruby 1.9 or later. The encoding will always be\n nil for older Rubies.\n\n value - The encoding as a String, Symbol, or Encoding instance.\n\n Raises ArgumentError if the value is not a valid encoding.", "Check to see if the event should be processed by the appender. An event will\n be rejected if the event level is lower than the configured level for the\n appender. Or it will be rejected if one of the filters rejects the event.\n\n event - The LogEvent to check\n\n Returns the event if it is allowed; returns `nil` if it is not allowed.", "Returns the Hash acting as the storage for this MappedDiagnosticContext.\n A new storage Hash is created for each Thread running in the\n application.", "Returns the stack of Hash objects that are storing the diagnostic\n context information. This stack is guarnteed to always contain at least\n one Hash.", "Given a Hash convert all keys into Strings. The values are not altered\n in any way. The converted keys and their values are stored in the target\n Hash if provided. Otherwise a new Hash is created and returned.\n\n hash   - The Hash of values to push onto the context stack.\n target - The target Hash to store the key value pairs.\n\n Returns a new Hash with all keys converted to Strings.\n Raises an ArgumentError if hash is not a Hash.", "Returns the Array acting as the storage stack for this\n NestedDiagnosticContext. A new storage Array is created for each Thread\n running in the application.", "Convert the given `time` into an ISO8601 formatted time string.", "Use instance variables to build a json object. Instance\n variables that begin with a single underscore are elided.\n Instance variables that begin with two underscores have one of\n them removed.", "Gets a Broadcast object for the given broadcast ID.\n\n @param [String] broadcast_id The broadcast ID.\n\n @return [Broadcast] The broadcast object, which includes properties defining the broadcast.\n\n @raise [OpenTokBroadcastError] No matching broadcast found.\n @raise [OpenTokAuthenticationError] Authentication failed.\n   Invalid API key.\n @raise [OpenTokError] OpenTok server error.", "Stops an OpenTok broadcast\n\n Note that broadcasts automatically stop after 120 minute\n\n @param [String] broadcast_id The broadcast ID.\n\n @return [Broadcast] The broadcast object, which includes properties defining the broadcast.\n\n @raise [OpenTokBroadcastError] The broadcast could not be stopped. The request was invalid.\n @raise [OpenTokAuthenticationError] Authentication failed.\n   Invalid API key.\n @raise [OpenTokError] OpenTok server error.", "Create a new OpenTok object.\n\n @param [String] api_key The OpenTok API key for your\n   {https://tokbox.com/account OpenTok project}.\n @param [String] api_secret Your OpenTok API key.\n @option opts [Symbol] :api_url Do not set this parameter. It is for internal use by TokBox.\n @option opts [Symbol] :ua_addendum Do not set this parameter. It is for internal use by TokBox.\n Creates a new OpenTok session and returns the session ID, which uniquely identifies\n the session.\n\n For example, when using the OpenTok JavaScript library, use the session ID when calling the\n OT.initSession()</a> method (to initialize an OpenTok session).\n\n OpenTok sessions do not expire. However, authentication tokens do expire (see the\n generateToken() method). Also note that sessions cannot explicitly be destroyed.\n\n A session ID string can be up to 255 characters long.\n\n Calling this method results in an OpenTokException in the event of an error.\n Check the error message for details.\n\n You can also create a session using the OpenTok REST API (see\n http://www.tokbox.com/opentok/api/#session_id_production) or at your\n {https://tokbox.com/account OpenTok account page}.\n\n @param [Hash] opts (Optional) This hash defines options for the session.\n\n @option opts [Symbol] :media_mode Determines whether the session will transmit streams the\n   using OpenTok Media Router (<code>:routed</code>) or not (<code>:relayed</code>).\n   By default, this property is set to <code>:relayed</code>.\n\n   With the <code>media_mode</code> property set to <code>:relayed</code>, the session\n   will attempt to transmit streams directly between clients. If clients cannot connect due to\n   firewall restrictions, the session uses the OpenTok TURN server to relay audio-video\n   streams.\n\n   With the <code>media_mode</code> property set to <code>:routed</code>, the session will use\n   the {https://tokbox.com/opentok/tutorials/create-session/#media-mode OpenTok Media Router}.\n   The OpenTok Media Router provides the following benefits:\n\n   * The OpenTok Media Router can decrease bandwidth usage in multiparty sessions.\n     (When the <code>media_mode</code> property is set to <code>:relayed</code>,\n     each client must send a separate audio-video stream to each client subscribing to\n     it.)\n   * The OpenTok Media Router can improve the quality of the user experience through\n     {https://tokbox.com/platform/fallback audio fallback and video recovery}. With\n     these features, if a client's connectivity degrades to a degree that\n     it does not support video for a stream it's subscribing to, the video is dropped on\n     that client (without affecting other clients), and the client receives audio only.\n     If the client's connectivity improves, the video returns.\n   * The OpenTok Media Router supports the\n     {https://tokbox.com/opentok/tutorials/archiving archiving}\n     feature, which lets you record, save, and retrieve OpenTok sessions.\n\n @option opts [String] :location  An IP address that the OpenTok servers will use to\n     situate the session in its global network. If you do not set a location hint,\n     the OpenTok servers will be based on the first client connecting to the session.\n\n @option opts [Symbol] :archive_mode Determines whether the session will be archived\n     automatically (<code>:always</code>) or not (<code>:manual</code>). When using automatic\n     archiving, the session must use the <code>:routed</code> media mode.\n\n @return [Session] The Session object. The session_id property of the object is the session ID.", "Use this method to get information on all OpenTok streams in a session.\n\n For example, you can call this method to get information about layout classes used by OpenTok streams.\n The layout classes define how the stream is displayed in the layout of a live streaming\n broadcast or a composed archive. For more information, see\n {https://tokbox.com/developer/guides/broadcast/live-streaming/#assign-layout-classes-to-streams Assigning layout classes to streams in live streaming broadcasts}\n and {https://tokbox.com/developer/guides/archiving/layout-control.html Customizing the video layout for composed archives}.\n\n @param [String] session_id The session ID of the OpenTok session.\n @return [StreamList] The StreamList of Stream objects.\n @raise [ArgumentError] The stream_id or session_id is invalid.\n @raise [OpenTokAuthenticationError] You are not authorized to fetch the stream information. Check your authentication credentials.\n @raise [OpenTokError] An OpenTok server error.", "Gets an Archive object for the given archive ID.\n\n @param [String] archive_id The archive ID.\n\n @return [Archive] The Archive object.\n @raise [OpenTokArchiveError] The archive could not be retrieved. The archive ID is invalid.\n @raise [OpenTokAuthenticationError] Authentication failed while retrieving the archive.\n   Invalid API key.\n @raise [OpenTokArchiveError] The archive could not be retrieved.", "Returns an ArchiveList, which is an array of archives that are completed and in-progress,\n for your API key.\n\n @param [Hash] options  A hash with keys defining which range of archives to retrieve.\n @option options [integer] :offset Optional. The index offset of the first archive. 0 is offset\n   of the most recently started archive. 1 is the offset of the archive that started prior to\n   the most recent archive. If you do not specify an offset, 0 is used.\n @option options [integer] :count Optional. The number of archives to be returned. The maximum\n   number of archives returned is 1000.\n @option options [String] :session_id Optional. The session ID that archives belong to. This is\n   useful when listing multiple archives for an {https://tokbox.com/developer/guides/archiving/#automatic-archives automatically archived session}.\n\n @return [ArchiveList] An ArchiveList object, which is an array of Archive objects.", "Stops an OpenTok archive that is being recorded.\n\n Archives automatically stop recording after 120 minutes or when all clients have disconnected\n from the session being archived.\n\n @param [String] archive_id The archive ID of the archive you want to stop recording.\n\n @return [Archive] The Archive object corresponding to the archive being stopped.\n\n @raise [OpenTokArchiveError] The archive could not be stopped. The request was invalid.\n @raise [OpenTokAuthenticationError] Authentication failed while stopping an archive.\n @raise [OpenTokArchiveError] The archive could not be stopped. The archive ID does not exist.\n @raise [OpenTokArchiveError] The archive could not be stopped. The archive is not currently\n   recording.\n @raise [OpenTokArchiveError] The archive could not be started.", "Deletes an OpenTok archive.\n\n You can only delete an archive which has a status of \"available\", \"uploaded\", or \"deleted\".\n Deleting an archive removes its record from the list of archives. For an \"available\" archive,\n it also removes the archive file, making it unavailable for download. For a \"deleted\"\n archive, the archive remains deleted.\n\n @param [String] archive_id The archive ID of the archive you want to delete.\n\n @raise [OpenTokAuthenticationError] Authentication failed or an invalid archive ID was given.\n @raise [OpenTokArchiveError] The archive could not be deleted. The status must be\n   'available', 'deleted', or 'uploaded'.\n @raise [OpenTokArchiveError] The archive could not be deleted.", "Should be able to accept String or Regexp options.", "Internal method to split a path into components", "Internal method called when the web browser navigates", "Internal method to match a path to the most likely route\n\n @param [String] path Url to match\n @param [String] search Url search parameters", "Internal method to match a path to possible routes\n\n @param [String] path Url to match", "Internal method to add a match score\n\n @param [String] parts Parts of a route\n @param [String] path Url to match", "Internal method to split search parameters\n\n @param [String] search Url search parameters", "Convert a Ruby classname to a dasherized name for use with CSS.\n\n @param [String] class_name The Ruby class name\n @return [String] CSS class name", "Convert a state-name to a list of CSS class names.\n\n @param [String] class_name Ruby class name\n @param [String] state State name\n @return [String] A list of CSS class names", "Internal method\n Composite CSS classes from Ruby class name", "Internal method to get mapping from selected map.", "Internal method to switch to a new theme.", "Internal method.", "Add a child element.\n\n @param [String] name A unique name for the element that is not\n   in RESERVED_NAMES\n @param [String] element_class Ruby class name for the new element\n @param [Hash] options Options to pass to the element. Any option key\n   that is not recognized is set as an attribute on the DOM element.\n   Recognized keys are:\n     prepend Prepend the new element before this DOM element\n     content Add the value of content as a textnode to the DOM element", "Recursively iterate all child elements\n\n param [Block] block A block to execute for every child element\n                     and the element itself", "Internal method to substitute placeholders with a value.", "Delete a key from the elements options hash. Will be renamed\n to option_delete.\n\n @param [key] key Key of the option hash to be removed\n @param [value] default Optional value to use if option value is nil\n @return [value] Return the current option value or value of\n   default parameter", "Update the value of the state.\n\n @param [String] state The state name\n @param [Boolean] active The new value of the state. Pass\n   true to enable and set the CSS class\n   false to disable and remove the CSS class\n   nil to skip altering state and the CSS class", "Toggle the boolean value of the state\n\n @param [String] state The state name", "Route a message. If the route block accepts arguments, it passes any\n captured params. Named params are available from the +params+ helper. The\n message is available from the +message+ helper.\n @param [Mail::Message] the message to route.", "Checks whether a message matches the route.\n @param [Mail::Message] message the message to match against\n @return [Hash] the +:block+ and +:klass+ associated with the route, the\n   +:params+ hash, and the block +:args+ array.", "Runs the application.", "Run the polling loop for the email inbox connection", "enqueue a render into the current request's hypernova batch", "shortcut method to render a react component\n @param [String] name the hypernova bundle name, like 'packages/p3/foo.bundle.js' (for now)\n @param [Hash] props the props to be passed to the component\n :^)k|8 <-- this is a chill peep riding a skateboard", "Modifies response.body to have all batched hypernova render results", "creates a hash with each index mapped to the value at that index", "Creates a nested example group named by the submitted `attribute`,\n and then generates an example using the submitted block.\n\n @example\n\n   # This ...\n   describe Array do\n     its(:size) { should eq(0) }\n   end\n\n   # ... generates the same runtime structure as this:\n   describe Array do\n     describe \"size\" do\n       it \"should eq(0)\" do\n         subject.size.should eq(0)\n       end\n     end\n   end\n\n The attribute can be a `Symbol` or a `String`. Given a `String`\n with dots, the result is as though you concatenated that `String`\n onto the subject in an expression.\n\n @example\n\n   describe Person do\n     subject do\n       Person.new.tap do |person|\n         person.phone_numbers << \"555-1212\"\n       end\n     end\n\n     its(\"phone_numbers.first\") { should eq(\"555-1212\") }\n   end\n\n When the subject is a `Hash`, you can refer to the Hash keys by\n specifying a `Symbol` or `String` in an array.\n\n @example\n\n   describe \"a configuration Hash\" do\n     subject do\n       { :max_users => 3,\n         'admin' => :all_permissions.\n         'john_doe' => {:permissions => [:read, :write]}}\n     end\n\n     its([:max_users]) { should eq(3) }\n     its(['admin']) { should eq(:all_permissions) }\n     its(['john_doe', :permissions]) { should eq([:read, :write]) }\n\n     # You can still access its regular methods this way:\n     its(:keys) { should include(:max_users) }\n     its(:count) { should eq(2) }\n   end\n\n With an implicit subject, `is_expected` can be used as an alternative\n to `should` (e.g. for one-liner use). An `are_expected` alias is also\n supplied.\n\n @example\n\n   describe Array do\n     its(:size) { is_expected.to eq(0) }\n   end\n\n With an implicit subject, `will` can be used as an alternative\n to `expect { subject.attribute }.to matcher` (e.g. for one-liner use).\n\n @example\n\n   describe Array do\n     its(:foo) { will raise_error(NoMethodError) }\n   end\n\n With an implicit subject, `will_not` can be used as an alternative\n to `expect { subject.attribute }.to_not matcher` (e.g. for one-liner use).\n\n @example\n\n   describe Array do\n     its(:size) { will_not raise_error }\n   end\n\n You can pass more than one argument on the `its` block to add\n some metadata to the generated example\n\n @example\n\n   # This ...\n   describe Array do\n     its(:size, :focus) { should eq(0) }\n   end\n\n   # ... generates the same runtime structure as this:\n   describe Array do\n     describe \"size\" do\n       it \"should eq(0)\", :focus do\n         subject.size.should eq(0)\n       end\n     end\n   end\n\n Note that this method does not modify `subject` in any way, so if you\n refer to `subject` in `let` or `before` blocks, you're still\n referring to the outer subject.\n\n @example\n\n   describe Person do\n     subject { Person.new }\n     before { subject.age = 25 }\n     its(:age) { should eq(25) }\n   end", "Refresh the state of the lamp", "Update the statistics kept by this timer. If the amount of nanoseconds\n passed is negative, the value will be ignored.", "Create a new MeterId with a given key and value", "lazyily compute a key to be used in hashes for efficiency", "Initialize a new DistributionSummary instance with a given id\n Update the statistics kept by the summary with the specified amount.", "Get a list of measurements, and reset the stats\n The stats returned are the current count, the total amount,\n the sum of the square of the amounts recorded, and the max value", "Create a new instance using the given registry\n to record stats for the requests performed\n Send a JSON payload to a given endpoing", "Stop publishing measurements", "Get the operation to be used for the given Measure\n Gauges are aggregated using MAX_OP, counters with ADD_OP", "Gauges are sent if they have a value\n Counters if they have a number of increments greater than 0", "Build a string table from the list of measurements\n Unique words are identified, and assigned a number starting from 0 based\n on their lexicographical order", "Generate a payload from the list of measurements\n The payload is an array, with the number of elements in the string table\n The string table, and measurements", "Send the current measurements to our aggregator service", "Set the timestamp attribute.\n @raise [ArgumentError] timestamp should be either a String, Symbol or true", "Returns the name of the timestamp attribute for this event\n If the timestamp was simply true it returns the default_timestamp_name\n otherwise, returns the user-specified timestamp name", "Preview an email", "Render headers partial. Used by the CMS integration to refetch headers after editing.", "Render email body iframe HTML. Used by the CMS integration to provide a link back to Show from Edit.", "mysql text and blobs fields are handled the same way internally\n this is not true for other databases so we must check if the field is\n actually text and manually convert it back to a string", "try to detect server side errors to\n give the client a more useful error message", "keep a record of the average chunksize within the first few hundred thousand records, after chunksize\n goes below 100 or maybe if offset is > 1000", "this one is used inside the server process", "Stops execution of the handler. This means stopping and killing\n all associated threads.\n\n @return [void]", "Executes the handler.\n\n @param [Message] message Message that caused the invocation\n @param [Array] captures Capture groups of the pattern that are\n   being passed as arguments\n @return [Thread]", "Blocks until the object is synced.\n\n @return [void]\n @api private", "Loads a configuration from a hash by merging the hash with\n either the current configuration or the default configuration.\n\n @param [Hash] new_config The configuration to load\n @param [Boolean] from_default If true, the configuration won't\n   be merged with the currently set up configuration (by prior\n   calls to {#load} or {Bot#configure}) but with the default\n   configuration.\n @return [void]", "Finds a user.\n\n @param [String] nick nick of a user\n @return [User, nil]", "Queries the IRC server for information on the user. This will\n set the User's state to not synced. After all information are\n received, the object will be set back to synced.\n\n @return [void]\n @note The alias `whois` is deprecated and will be removed in a\n   future version.", "Generates a mask for the user.\n\n @param [String] s a pattern for generating the mask.\n\n     - %n = nickname\n     - %u = username\n     - %h = host\n     - %r = realname\n     - %a = authname\n\n @return [Mask]", "Starts monitoring a user's online state by either using MONITOR\n or periodically running WHOIS.\n\n @since 2.0.0\n @return [void]\n @see #unmonitor", "Updates the user's online state and dispatch the correct event.\n\n @since 2.0.0\n @return [void]\n @api private", "Establish a connection.\n\n @return [void]\n @since 2.0.0", "Logs a message.\n\n @param [String, Array] messages The message(s) to log\n @param [:debug, :incoming, :outgoing, :info, :warn,\n   :exception, :error, :fatal] event The kind of event that\n   triggered the message\n @param [:debug, :info, :warn, :error, :fatal] level The level of the message\n @return [void]\n @version 2.0.0", "Finds or creates a channel.\n\n @param [String] name name of a channel\n @return [Channel]\n @see Helpers#Channel", "Sets the topic.\n\n @param [String] new_topic the new topic\n @raise [Exceptions::TopicTooLong] Raised if the bot is operating\n   in {Bot#strict? strict mode} and when the new topic is too long.", "Kicks a user from the channel.\n\n @param [String, User] user the user to kick\n @param [String] reason a reason for the kick\n @raise [Exceptions::KickReasonTooLong]\n @return [void]", "Joins the channel\n\n @param [String] key the channel key, if any. If none is\n   specified but @key is set, @key will be used\n @return [void]", "Sends a PRIVMSG to the target.\n\n @param [#to_s] text the message to send\n @param [Boolean] notice Use NOTICE instead of PRIVMSG?\n @return [void]\n @see #safe_msg\n @note The aliases `msg` and `privmsg` are deprecated and will be\n   removed in a future version.", "Connects the bot to a server.\n\n @param [Boolean] plugins Automatically register plugins from\n   `@config.plugins.plugins`?\n @return [void]", "Part a channel.\n\n @param [String, Channel] channel either the name of a channel or a {Channel} object\n @param [String] reason an optional reason/part message\n @return [Channel] The channel that was left\n @see Channel#part", "Try to create a free nick, first by cycling through all\n available alternatives and then by appending underscores.\n\n @param [String] base The base nick to start trying from\n @api private\n @return [String]\n @since 2.0.0", "represents the representer's schema in JSON format", "Check if the current resource is the same as the requester.\n The resource must respond to `resource.id` method.", "Check if options are valid or not\n\n @param [Hash] options\n\n @return [Boolean]\n\n @api public", "Setup this configuration\n\n @api public\n Convert all properties into hash\n\n @return [Hash]\n\n @api public", "Adds breadcrumbs inside view.\n\n @param [String] name\n   the breadcrumb name\n @param [Object] url\n   the breadcrumb url\n @param [Hash] options\n   the breadcrumb options\n\n @api public", "Renders breadcrumbs inside view.\n\n @param [Hash] options\n\n @api public", "Expand url in the current context of the view\n\n @api private", "Translate breadcrumb title\n\n @param [String] :title\n @param [Hash] options\n @option options [String] :scope\n   The translation scope\n @option options [String] :default\n   The default translation\n\n @return [String]\n\n @api public", "Breaks apart the host input string into chunks suitable for processing\n by the generator. Returns an array of substrings of the input spec string.\n\n The input string is expected to be properly formatted using the dash `-`\n character as a delimiter. Dashes may also be used within braces `{...}`,\n which are used to define arbitrary key-values on a node.\n\n @param spec [String] Well-formatted string specification of the hosts to\n                      generate. For example `\"centos6-64m-debian8-32a\"`.\n @returns [Array<String>] Input string split into substrings suitable for\n                          processing by the generator. For example\n                          `[\"centos6\", \"64m\", \"debian8\", \"32a\"]`.", "Transforms the arbitrary host settings map from a string representation\n to a proper hash map data structure for merging into the host\n configuration. Supports arbitrary nested hashes and arrays.\n\n The string is expected to be of the form \"{key1=value1,key2=[v2,v3],...}\".\n Nesting looks like \"{key1={nested_key=nested_value},list=[[list1, list2]]}\".\n Whitespace is expected to be properly quoted as it will not be treated\n any different than non-whitespace characters.\n\n Throws an exception of the string is malformed in any way.\n\n @param host_settings [String] Non-nil user input string that defines host\n                               specific settings.\n\n @returns [Hash{String=>String|Array|Hash}] The host_settings string as a map.", "Returns the fully parsed map of information of the specified OS platform\n for the specified hypervisor. This map should be suitable for outputting\n to the user as it will have the intermediate organizational branches of\n the `get_osinfo` map removed.\n\n This is intended to be the primary way to access OS info from hypervisor\n implementations when generating host definitions.\n\n @param [Integer] bhg_version The version of OS info to use.\n\n @param [String] platform The OS platform to access from the OS info map.\n\n @param [Symbol] hypervisor The symbol representing which hypervisor submap\n                 to extract from the general OS info map.\n\n @example Getting CentOS 6 64-bit information for the VMPooler hypervisor\n     Given the OS info map looks like:\n         ...\n         'centos6-64' => {\n           :general => { 'platform' => 'el-6-x86_64' },\n           :vmpooler => { 'template' => 'centos-6-x86_64' }\n         }\n         ...\n\n     Then get_platform_info(0, 'centos6-64', :vmpooler) returns:\n         {\n           'platform' => 'el-6-x86_64',\n           'template' => 'centos-6-x86_64'\n         }", "Given an existing, fully-specified host configuration, count the number of\n hosts using each template, and return a map of template name to host count.\n\n For example, given the following config (parts omitted for brevity):\n    {\"HOSTS\"=>\n     {\"centos6-64-1\"=>\n        {\"template\"=>\"centos-6-x86_64\", ...},\n      \"redhat7-64-1\"=>\n        {\"template\"=>\"redhat-7-x86_64\", ...},\n      \"centos6-64-2\"=>\n        {\"template\"=>\"centos-6-x86_64\", ...}},\n     ...\n    }}\n\n Returns the following map:\n     {\"centos-6-x86_64\"=>2, \"redhat-7-x86_64\"=>1}", "Main host generation entry point, returns a Ruby map for the given host\n specification and optional configuration.\n\n @param layout [String] The raw hosts specification user input.\n                        For example `\"centos6-64m-redhat7-64a\"`.\n @param options [Hash] Global, optional configuration such as the default\n                       hypervisor or OS info version.\n\n @returns [Hash] A complete Ruby map as defining the HOSTS and CONFIG\n                 sections as required by Beaker.", "assigns natural permalinks to documents and prioritizes documents with\n active_lang languages over others", "performs any necesarry operations on the documents before rendering them", "Different versions of rails have different\n method signatures here, path is always first", "Initialize an APIService\n\n @param url [String] the URL to make requests to\n @param key [String] the API Key ID to use\n @param secret [String] the API key secret to use\n @param options [Hash] additional options to use when creating the service\n Make a request to the API\n\n @param method [Symbol] the method to use to make the request\n @param path [String] the URL (without the base domain) to make the request to\n @param options [Hash] the options hash", "initialize a paginator\n @param options [Hash]\n @option options :service the service class to use to make requests to\n @option options :options additional options to send with the requests\n Get a lazy enumerable for listing data from the API", "Get customized options.", "Extracts Ruby code from an ERB template.\n @return [String] The extracted ruby code", "Executes the custom Rake task.\n @private", "Performs static analysis on the provided directory.\n @param [Array<String>] dir The directories / files to analyze.", "Logs a message to stderr. Unless otherwise specified, the message will\n be printed in red.", "XML 11.0", "11.4 Begin", "Called when you wish to finish adding batches to your request, this method rewrites the aggregate\n batch file to the final LitleRequest xml doc with the appropos LitleRequest tags.", "Parses an Array of command-line arguments into an equivalent Hash.\n\n The results of this can be used to control the behavior of the rest\n of the library.\n\n @params argv [Array] An array of command-line arguments, e.g. +ARGV+.\n @return [Hash] A Hash containing data used to control Inq's behavior.", "Load the config files as specified via +files+.\n\n @param files [Array<String>] The path(s) for config files.\n @return [Config] The config hash. (+self+)", "Take a collection of config hashes and cascade them, meaning values\n in later ones override values in earlier ones.\n\n E.g., this results in +{'a'=>'x', 'c'=>'d'}+:\n     load({'a'=>'b'}, {'c'=>'d'}, {'a'=>'x'})\n\n And this results in +{'a'=>['b', 'c']}+:\n     load({'a'=>['b']}, {'a'=>['c']})\n\n @param [Array<Hash>] The configuration hashes.\n @return [Config] The final configuration value.", "Load config info from environment variables.\n\n Supported environment variables:\n - INQ_GITHUB_TOKEN: a GitHub authentication token.\n - INQ_GITHUB_USERNAME: the GitHub username corresponding to the token.\n\n @return [Config] The resulting configuration.", "Check if +left+ is less than or equal to +right+, where both are string\n representations of a date.\n\n @param left [String] A string representation of a date.\n @param right [String] A string representation of a date.\n @return [Boolean] True if +left+ is less-than-or-equal to +right+,\n   otherwise false.", "Check if +left+ is greater than or equal to +right+, where both are string\n representations of a date.\n\n @param left [String] A string representation of a date.\n @param right [String] A string representation of a date.\n @return [Boolean] True if +left+ is greater-than-or-equal to +right+,\n   otherwise false.", "Generates the metadata for the collection of Reports.", "Converts a ReportCollection to a Hash.\n\n Also good for giving programmers nightmares, I suspect.", "Save all of the reports to the corresponding files.\n\n @return [Array<String>] An array of file paths.", "Called from asset helpers to alert you if you reference an asset URL that\n isn't precompiled and hence won't be available in production.", "Lazy-load the precompile list so we don't cause asset compilation at app\n boot time, but ensure we cache the list so we don't recompute it for each\n request or test case.", "Decides how to handle an item, depending on where we are in the arguments", "Apply the weightings to the hashes", "Originally lifted from redis-rb", "Create a UUID\n\n @param value [Time,String,Integer] timestamp to assign to the UUID, or\n   numeric or string representation of the UUID\n @return a UUID appropriate for use with Cequel", "Find records using a simple ActiveRecord-like syntax.\n\n Examples:\n   table = DBF::Table.new 'mydata.dbf'\n\n   # Find record number 5\n   table.find(5)\n\n   # Find all records for Keith Morrison\n   table.find :all, first_name: \"Keith\", last_name: \"Morrison\"\n\n   # Find first record\n   table.find :first, first_name: \"Keith\"\n\n The <b>command</b> may be a record index, :all, or :first.\n <b>options</b> is optional and, if specified, should be a hash where the\n keys correspond to column names in the database.  The values will be\n matched exactly with the value in the database.  If you specify more\n than one key, all values must match in order for the record to be\n returned.  The equivalent SQL would be \"WHERE key1 = 'value1'\n AND key2 = 'value2'\".\n\n @param [Integer, Symbol] command\n @param [optional, Hash] options Hash of search parameters\n @yield [optional, DBF::Record, NilClass]", "Retrieve a record by index number.\n The record will be nil if it has been deleted, but not yet pruned from\n the database.\n\n @param [Integer] index\n @return [DBF::Record, NilClass]", "Dumps all records to a CSV file.  If no filename is given then CSV is\n output to STDOUT.\n\n @param [optional String] path Defaults to STDOUT", "Get the response from a URL, from the cache if possible.\n Stores to the cache on misses.\n\n Different versions and locales are stored separately in the cache.\n\n @param version [Integer] The version to pass in headers, as `Accept: application/json;v=2`\n @param locale [String] The language to request in the `Accept-Language`\n header.\n\n @return [Response], which responds to `status`, `headers`, and `body`.", "Allow to inject pre-built Redis clients\n\n Before storing a new connection, ensures that any previously\n set client is properly closed.", "this is a horrible hack, to make sure that it's done what it needs to do\n before we do our next step", "run the passed bower block in appropriate folders", "Fix connection to given shard in block\n @param [ActiveRecord::Base, Symbol, ActiveRecord::Turntable::Shard, Numeric, String] shard which you want to fix\n @param shard [ActiveRecord::Base] AR Object\n @param shard [Symbol] shard name symbol that defined in turntable.yml\n @param shard [ActiveRecord::Turntable::Shard] Shard object\n @param shard [String, Numeric] Raw sharding id", "Send queries to all shards in this cluster\n @param [Boolean] continue_on_error when a shard raises error, ignore exception and continue", "Send queries to default connection and all shards in this cluster\n @param [Boolean] continue_on_error when a shard raises error, ignore exception and continue", "Called by the C code to parse and set the headers", "Set the type of authentication to use for this request.\n\n @param [String, Symbol]type The type of authentication to use for this request, can be one of\n   :basic, :digest, or :any\n\n @example\n   sess.username = \"foo\"\n   sess.password = \"sekrit\"\n   sess.auth_type = :digest", "Sets the HTTP verb for the request\n\n @param action[String] the name of the HTTP verb", "Create a new Session object for performing requests.\n\n @param args[Hash] options for the Session (same names as the writable attributes of the Session)\n @yield self\n Turn on cookie handling for this session, storing them in memory by\n default or in +file+ if specified. The `file` must be readable and\n writable. Calling multiple times will add more files.\n\n @todo the cookie jar and cookie file path options should be split\n @param file_path[String] path to an existing cookie jar file, or nil to store cookies in memory\n @return self", "Uploads the passed `data` to the specified `url` using an HTTP POST.\n\n @param url[String] the URL to fetch\n @param data[Hash, #to_s, #to_path] a Hash of form fields/values,\n   or an object that can be converted to a String\n   to create the request body, or an object that responds to #to_path to upload the\n   entire request body from that file\n @param headers[Hash] the hash of header keys to values\n @return [Patron::Response]", "Uploads the contents of `filename` to the specified `url` using an HTTP POST,\n in combination with given form fields passed in `data`.\n\n @param url[String] the URL to fetch\n @param data[Hash] hash of the form fields\n @param filename[String] path to the file to be uploaded\n @param headers[Hash] the hash of header keys to values\n @return [Patron::Response]", "Builds a request object that can be used by ++handle_request++\n Note that internally, ++handle_request++ uses instance variables of\n the Request object, and not it's public methods.\n\n @param action[String] the HTTP verb\n @param url[#to_s] the addition to the base url component, or a complete URL\n @param headers[Hash] a hash of headers, \"Accept\" will be automatically set to an empty string if not provided\n @param options[Hash] any overriding options (will shadow the options from the Session object)\n @return [Patron::Request] the request that will be passed to ++handle_request++", "Find non-asterisk content that is enclosed by two or\n more asterisks. Ensure that only one whitespace occurs\n in the border area.\n Same for underscores and brackets.", "Allows to search for files an map these onto other strings.\n\n @example\n   require 'mustermann/file_utils'\n\n   Mustermann::FileUtils.glob_map(':base.:ext' => ':base.bak.:ext') # => {'example.txt' => 'example.bak.txt'}\n   Mustermann::FileUtils.glob_map(':base.:ext' => :base) { |file, mapped| mapped } # => ['example']\n\n @see Mustermann::Mapper", "Copies files based on a pattern mapping.\n\n @example\n   require 'mustermann/file_utils'\n\n   # copies example.txt to example.bak.txt\n   Mustermann::FileUtils.cp(':base.:ext' => ':base.bak.:ext')\n\n @see #glob_map", "Moves files based on a pattern mapping.\n\n @example\n   require 'mustermann/file_utils'\n\n   # moves example.txt to example.bak.txt\n   Mustermann::FileUtils.mv(':base.:ext' => ':base.bak.:ext')\n\n @see #glob_map", "Creates links based on a pattern mapping.\n\n @example\n   require 'mustermann/file_utils'\n\n   # creates a link from bin/example to lib/example.rb\n   Mustermann::FileUtils.ln('lib/:name.rb' => 'bin/:name')\n\n @see #glob_map", "Creates symbolic links based on a pattern mapping.\n Overrides potentailly existing files.\n\n @example\n   require 'mustermann/file_utils'\n\n   # creates a symbolic link from bin/example to lib/example.rb\n   Mustermann::FileUtils.ln_sf('lib/:name.rb' => 'bin/:name')\n\n @see #glob_map", "Create a Mustermann pattern from whatever the input is and turn it into\n a glob pattern.\n\n @!visibility private", "used to generate results for various methods by scanning through an input string\n @!visibility private", "generates one big AST from all patterns\n will not check if patterns support AST generation\n @!visibility private", "Creates a pattern that matches any string matching either one of the patterns.\n If a string is supplied, it is treated as a fully escaped Sinatra pattern.\n\n If the other pattern is also a Sintara pattern, it might join the two to a third\n sinatra pattern instead of generating a composite for efficiency reasons.\n\n This only happens if the sinatra pattern behaves exactly the same as a composite\n would in regards to matching, parsing, expanding and template generation.\n\n @example\n   pattern = Mustermann.new('/foo/:name') | Mustermann.new('/:first/:second')\n   pattern === '/foo/bar' # => true\n   pattern === '/fox/bar' # => true\n   pattern === '/foo'     # => false\n\n @param [Mustermann::Pattern, String] other the other pattern\n @return [Mustermann::Pattern] a composite pattern\n @see Mustermann::Pattern#|", "Checks if the given pattern matches any substring starting at any position after the current position.\n\n If it does, it will advance the current {#position} to the end of the substring and merges any params parsed\n from the substring into {#params}.\n\n @param (see Mustermann.new)\n @return [Mustermann::StringScanner::ScanResult, nil] the matched substring, nil if it didn't match", "Reverts the last operation that advanced the position.\n\n Operations advancing the position: {#terminate}, {#scan}, {#scan_until}, {#getch}.\n @return [Mustermann::StringScanner] the scanner itself", "Checks if the given pattern matches any substring starting at the current position.\n\n Does not affect {#position} or {#params}.\n\n @param (see Mustermann.new)\n @return [Mustermann::StringScanner::ScanResult, nil] the matched substring, nil if it didn't match", "Identity patterns support expanding.\n\n This implementation does not use {Mustermann::Expander} internally to save memory and\n compilation time.\n\n @example (see Mustermann::Pattern#expand)\n @param (see Mustermann::Pattern#expand)\n @return (see Mustermann::Pattern#expand)\n @raise (see Mustermann::Pattern#expand)\n @see Mustermann::Pattern#expand\n @see Mustermann::Expander", "Checks if class has mulitple versions available and picks one that matches the version option.\n @!visibility private", "Defines a new version.\n @!visibility private", "Resolve a subclass for a given version string.\n @!visibility private", "Transforms a Hash.\n @param [Hash] hash pre-transform Hash\n @return [Hash] post-transform Hash\n @!visibility private", "Creates a new mapper.\n\n @overload initialize(**options)\n   @param options [Hash] options The options hash\n   @yield block for generating mappings as a hash\n   @yieldreturn [Hash] see {#update}\n\n   @example\n     require 'mustermann/mapper'\n     Mustermann::Mapper.new(type: :rails) {{\n       \"/:foo\" => [\"/:foo.html\", \"/:foo.:format\"]\n     }}\n\n @overload initialize(**options)\n   @param  options [Hash] options The options hash\n   @yield block for generating mappings as a hash\n   @yieldparam mapper [Mustermann::Mapper] the mapper instance\n\n   @example\n     require 'mustermann/mapper'\n     Mustermann::Mapper.new(type: :rails) do |mapper|\n       mapper[\"/:foo\"] = [\"/:foo.html\", \"/:foo.:format\"]\n     end\n\n @overload initialize(map = {}, **options)\n   @param map [Hash] see {#update}\n   @param [Hash] options The options hash\n\n   @example map before options\n     require 'mustermann/mapper'\n     Mustermann::Mapper.new(\"/:foo\" => \"/:foo.html\", type: :rails)\n\n   @example map after options\n     require 'mustermann/mapper'\n     Mustermann::Mapper.new(type: :rails, \"/:foo\" => \"/:foo.html\")\n Add multiple mappings.\n\n @param map [Hash{String, Pattern: String, Pattern, Arry<String, Pattern>, Expander}] the mapping", "Convert a string according to mappings. You can pass in additional params.\n\n @example mapping with and without additional parameters\n   mapper = Mustermann::Mapper.new(\"/:example\" => \"(/:prefix)?/:example.html\")", "Clones libcurl session handle. This means that all options that is set in\n   the current handle will be set on duplicated handle.\n Url escapes the value.\n\n @example Url escape.\n   easy.escape(value)\n\n @param [ String ] value The value to escape.\n\n @return [ String ] The escaped value.\n\n @api private", "Returns a sorted two-dimensional array where each member array is a token and its frequency.\n The array is sorted by frequency in descending order.\n\n @example\n  Counter.new(%w[one two two three three three]).token_frequency\n  # => [ ['three', 3], ['two', 2], ['one', 1] ]\n\n @return [Array<Array<String, Integer>>] An array of tokens and their frequencies", "Returns a sorted two-dimensional array where each member array is a token and its length.\n The array is sorted by length in descending order.\n\n @example\n  Counter.new(%w[one two three four five]).token_lenghts\n  # => [ ['three', 5], ['four', 4], ['five', 4], ['one', 3], ['two', 3] ]\n\n @return [Array<Array<String, Integer>>] An array of tokens and their lengths", "Returns a sorted two-dimensional array where each member array is a token and its density\n as a float, rounded to a precision of two decimal places. It accepts a precision argument\n which defaults to `2`.\n\n @example\n  Counter.new(%w[Maj. Major Major Major]).token_density\n  # => [ ['major', .75], ['maj', .25] ]\n\n @example with `precision`\n  Counter.new(%w[Maj. Major Major Major]).token_density(precision: 4)\n  # => [ ['major', .7500], ['maj', .2500] ]\n\n @param [Integer] precision    The number of decimal places to round density to\n @return [Array<Array<String, Float>>] An array of tokens and their densities", "Initialises state with the string to be tokenised.\n\n @param [String] input   The string to tokenise\n Converts a string into an array of tokens using a regular expression.\n If a regexp is not provided a default one is used. See `Tokenizer.TOKEN_REGEXP`.\n\n Use `exclude` to remove tokens from the final list. `exclude` can be a string,\n a regular expression, a lambda, a symbol, or an array of one or more of those types.\n This allows for powerful and flexible tokenisation strategies.\n\n If a symbol is passed, it must name a predicate method.\n\n @example\n  WordsCounted::Tokeniser.new(\"Hello World\").tokenise\n  # => ['hello', 'world']\n\n @example With `pattern`\n  WordsCounted::Tokeniser.new(\"Hello-Mohamad\").tokenise(pattern: /[^-]+/)\n  # => ['hello', 'mohamad']\n\n @example With `exclude` as a string\n  WordsCounted::Tokeniser.new(\"Hello Sami\").tokenise(exclude: \"hello\")\n  # => ['sami']\n\n @example With `exclude` as a regexp\n  WordsCounted::Tokeniser.new(\"Hello Dani\").tokenise(exclude: /hello/i)\n  # => ['dani']\n\n @example With `exclude` as a lambda\n  WordsCounted::Tokeniser.new(\"Goodbye Sami\").tokenise(\n    exclude: ->(token) { token.length > 6 }\n  )\n  # => ['sami']\n\n @example With `exclude` as a symbol\n  WordsCounted::Tokeniser.new(\"Hello \u0645\u062d\u0645\u062f\").tokenise(exclude: :ascii_only?)\n  # => ['\u0645\u062d\u0645\u062f']\n\n @example With `exclude` as an array of strings\n  WordsCounted::Tokeniser.new(\"Goodbye Sami and hello Dani\").tokenise(\n    exclude: [\"goodbye hello\"]\n  )\n  # => ['sami', 'and', dani']\n\n @example With `exclude` as an array of regular expressions\n  WordsCounted::Tokeniser.new(\"Goodbye and hello Dani\").tokenise(\n    exclude: [/goodbye/i, /and/i]\n  )\n  # => ['hello', 'dani']\n\n @example With `exclude` as an array of lambdas\n  t = WordsCounted::Tokeniser.new(\"Special Agent 007\")\n  t.tokenise(\n    exclude: [\n      ->(t) { t.to_i.odd? },\n      ->(t) { t.length > 5}\n    ]\n  )\n  # => ['agent']\n\n @example With `exclude` as a mixed array\n  t = WordsCounted::Tokeniser.new(\"Hello! \u0627\u0633\u0645\u0627\u0621\u0646\u0627 \u0647\u064a \u0645\u062d\u0645\u062f\u060c \u0643\u0627\u0631\u0648\u0644\u064a\u0646\u0627\u060c \u0633\u0627\u0645\u064a\u060c \u0648\u062f\u0627\u0646\u064a\")\n  t.tokenise(\n    exclude: [\n      :ascii_only?,\n      /\u0645\u062d\u0645\u062f/,\n      ->(t) { t.length > 6},\n      \"\u0648\"\n    ]\n  )\n  # => [\"\u0647\u064a\", \"\u0633\u0627\u0645\u064a\", \"\u0648\u062f\u0627\u0646\u064a\"]\n\n @param [Regexp] pattern   The string to tokenise\n @param [Array<String, Regexp, Lambda, Symbol>, String, Regexp, Lambda, Symbol, nil] exclude     The filter to apply\n @return [Array] The array of filtered tokens", "The following methods convert any arguments into a callable object. The return value of this\n lambda is then used to determine whether a token should be excluded from the final list.\n\n `filter` can be a string, a regular expression, a lambda, a symbol, or an array\n of any combination of those types.\n\n If `filter` is a string, it converts the string into an array, and returns a lambda\n that returns true if the token is included in the resulting array.\n\n @see {Tokeniser#filter_proc_from_string}.\n\n If `filter` is a an array, it creates a new array where each element of the origingal is\n converted to a lambda, and returns a lambda that calls each lambda in the resulting array.\n If any lambda returns true the token is excluded from the final list.\n\n @see {Tokeniser#filter_procs_from_array}.\n\n If `filter` is a proc, then the proc is simply called. If `filter` is a regexp, a `lambda`\n is returned that checks the token for a match.\n\n If a symbol is passed, it is converted to a proc. The symbol must name a predicate method.\n\n This method depends on `nil` responding `to_a` with an empty array, which\n avoids having to check if `exclude` was passed.\n @api private", "Return the Configuration object as a hash, with symbols as keys.\n @return [Hash]", "concatenate documents, can optionally specify page ranges\n\n args: in_file1, {in_file2 => [\"1-2\", \"4-10\"]}, ... , in_file_n, output", "generate PDF content in this data format", "Start automatic spinning animation\n\n @api public", "Run spinner while executing job\n\n @param [String] stop_message\n   the message displayed when block is finished\n\n @yield automatically animate and finish spinner\n\n @example\n   spinner.run('Migrated DB') { ... }\n\n @api public", "Perform a spin\n\n @return [String]\n   the printed data\n\n @api public", "Find frames by token name\n\n @param [Symbol] token\n   the name for the frames\n\n @return [Array, String]\n\n @api private", "Detects and casts numbers, date, time in text", "Converts Time objects to OLE Automation Date", "Array of yajl library names prepended with the libyajl2 path to use to\n load those directly and bypass the system libyajl by default.  Since\n these are full paths, this API checks to ensure that the file exists on\n the filesystem.  May return an empty array.\n\n @api private\n @return [Array<String>] Array of full paths to libyajl2 gem libraries", "Iterate across the expanded library names in the libyajl2-gem and then\n attempt to load the system libraries.  Uses the native dlopen extension\n that ships in this gem.\n\n @api private", "Iterate across the expanded library names in the libyajl2-gem and attempt\n to load them.  If they are missing just use `ffi_lib 'yajl'` to accept\n the FFI default algorithm to find the library.\n\n @api private", "This method is expected to be called in trap context\n @params timeout [Boolean] timeout error could be raised or not\n @return [void]", "Returns a new instance of Node where non-nil arguments replace the\n corresponding fields of `self`.\n\n For example, `Node.new(:foo, [ 1, 2 ]).updated(:bar)` would yield\n `(bar 1 2)`, and `Node.new(:foo, [ 1, 2 ]).updated(nil, [])` would\n yield `(foo)`.\n\n If the resulting node would be identical to `self`, does nothing.\n\n @param  [Symbol, nil] type\n @param  [Array, nil]  children\n @param  [Hash, nil]   properties\n @return [AST::Node]", "Converts `self` to a pretty-printed s-expression.\n\n @param  [Integer] indent Base indentation level.\n @return [String]", "Converts `self` to an Array where the first element is the type as a Symbol,\n and subsequent elements are the same representation of its children.\n\n @return [Array<Symbol, [...Array]>]", "Returns a proc that, when called with the payload, parses it according to the configuration.\n\n By default, this will assume the payload is JSON, parse it, and return a HashWithIndifferentAccess.", "True if we should omit the payload from the log\n\n ::level_of_message_with_payload the level of the message about to be logged", "Returns an array of all detected duplicate entries. An entry is\n represented by a has with file path under 'file' key and the\n Localizable.strings key under 'key' key.\n\n @return  [Array of duplicate Localizable.strings entries]", "Initialize abstract ProxyFetcher HTML Document\n\n @return [Document]\n\n Searches elements by XPath selector.\n\n @return [Array<ProxyFetcher::Document::Node>]\n   collection of nodes", "Searches elements by CSS selector.\n\n @return [Array<ProxyFetcher::Document::Node>]\n   collection of nodes", "Initialize new ProxyValidator instance\n\n @param proxy_addr [String] proxy address or IP\n @param proxy_port [String, Integer] proxy port\n\n @return [ProxyValidator]\n\n Checks if proxy is connectable (can be used to connect\n resources via proxy server).\n\n @return [Boolean]\n   true if connection to the server using proxy established, otherwise false", "Returns a class for specific provider if it is registered\n in the registry. Otherwise throws an exception.\n\n @param provider_name [String, Symbol]\n   provider name\n\n @return [Class]\n   provider class\n\n @raise [ProxyFetcher::Exceptions::UnknownProvider]\n   provider is unknown", "Checks if custom class has some required class methods", "Initialize HTTP client instance\n\n @return [HTTPClient]\n\n Fetches resource content by sending HTTP request to it.\n\n @return [String]\n   response body", "Initialize ProxyFetcher Manager instance for managing proxies\n\n refresh: true - load proxy list from the remote server on initialization\n refresh: false - just initialize the class, proxy list will be empty ([])\n\n @return [Manager]\n\n Update current proxy list using configured providers.\n\n @param filters [Hash] providers filters", "Deletes the records matching +conditions+ by instantiating each\n record and calling its +delete+ method.\n\n ==== Parameters\n\n * +conditions+ - A string, array, or hash that specifies which records\n   to destroy. If omitted, all records are destroyed.\n\n ==== Examples\n\n   PersonMock.destroy_all(status: \"inactive\")\n   PersonMock.where(age: 0..18).destroy_all\n\n If a limit scope is supplied, +delete_all+ raises an ActiveMocker error:\n\n   Post.limit(100).delete_all\n   # => ActiveMocker::Error: delete_all doesn't support limit scope", "Finds the first record matching the specified conditions. There\n is no implied ordering so if order matters, you should specify it\n yourself.\n\n If no record is found, returns <tt>nil</tt>.\n\n   Post.find_by name: 'Spartacus', rating: 4", "Specifies a limit for the number of records to retrieve.\n\n   User.limit(10)", "Calculates the sum of values on a given column. The value is returned\n with the same data type of the column, 0 if there's no row.\n\n   Person.sum(:age) # => 4562", "Calculates the average value on a given column. Returns +nil+ if there's\n no row.\n\n   PersonMock.average(:age) # => 35.8", "Returns a hash of the given methods with their names as keys and returned values as values.", "Reads a file with JSON Xcode summary and reports its warning and error count.\n\n @param    [String] file_path Path for Xcode summary in JSON format.\n @return   [String] JSON string with warningCount and errorCount", "Generates the result of each contained group\n and adds the filled group of each result to itself", "Displays a Bootstrap-styled button.\n @see http://getbootstrap.com/css/#buttons\n @return [String] the HTML to display a Bootstrap-styled button.\n @overload button(caption, options = {})\n   @param [#to_s] caption the caption to display in the button.\n   @param [Hash] options the options for the button. Any option not\n     listed below is passed as an HTML attribute to the `<button>` tag.\n   @option options [#to_s] :context (:default) the contextual alternative\n     to apply to the button. Can be `:danger`, `:info`, `:link`,\n     `:primary`, `:success` or `:warning`.\n   @option options [#to_s] :size the size of the button.\n     Can be `:extra_small` (alias `:xs`), `:large` (alias `:lg`) or\n     `:small` (alias `:sm`).\n   @option options [#to_s] :layout if set to `:block`, span the button\n     for the full width of the parent.\n   @example Display a button styled as a link.\n       button 'Click here', context: :link\n @overload button(options = {}, &block)\n   @param [Hash] options the options for the button (see above).\n   @yieldreturn [#to_s] the caption to display in the button.\n   @example Display a button with an HTML caption.\n       button do\n         content_tag :strong, 'Click here'\n       end", "Wraps a set of Bootstrap-styled panels in a row.\n @see http://getbootstrap.com/components/#panels\n @see http://getbootstrap.com/css/#grid\n @return [String] the HTML to display a row of Bootstrap-styled panels.\n @param [Hash] options the options for the row. Any option not\n   listed below is passed as an HTML attribute to the row\u2019s `<div>`.\n @option options [#to_s] :column_class the class to wrap each panel with.\n   Useful to specify a grid size for the column such as 'col-sm-4' to\n   indicate how many columns of the row each panel should occupy.\n @yieldreturn [#to_s] the panels to display in a row.\n @example Display a row of two panels with the same width.\n   panel_row column_class: 'col-sm-6' do\n     panel 'Panel #1', context: :success\n     panel 'Panel #2', context: :info\n   end", "Displays a Bootstrap-styled panel.\n @see http://getbootstrap.com/components/#panels\n @return [String] the HTML to display a Bootstrap-styled panel.\n @overload panel(body, options = {})\n   @param [#to_s] body the content to display as the panel body.\n   @param [Hash] options the options for the panel. Any option not\n     listed below is passed as an HTML attribute to the panel\u2019s `<div>`.\n   @option options [#to_s] :title the text to display as the panel title.\n   @option options [#to_s] :heading the text to display as the panel\n     heading.\n   @option options [#to_s] :body the text to display as the panel body.\n     Using this option is equivalent to passing the body as an argument.\n   @option options [#to_s] :context (#to_s) (:default) the contextual\n     alternative to apply to the panel heading and border. Can be\n     `:danger`, `:info`, `:primary`, `:success` or `:warning`.\n   @option options [#to_s] :tag (#to_s) (:div) the HTML tag to wrap the\n     panel into.\n   @example Display an informative panel with plain-text content.\n       panel 'You accepted the Terms of service.', context: :success\n @overload panel(options = {}, &block)\n   @param [Hash] options the options for the panel (see above).\n   @yieldreturn [#to_s] the content to display in the panel.\n   @example Display a panel with HTML content.\n       panel title: 'Thanks' do\n         content_tag :div, class: 'panel-body' do\n           content_tag :em, 'ou accepted the Terms of service.'\n         end\n       end", "Displays a Bootstrap-styled modal.\n @see http://getbootstrap.com/javascript/#modals\n @return [String] the HTML to display a Bootstrap-styled modal.\n @overload modal(body, options = {})\n   @param [#to_s] body the content to display as the modal body.\n   @param [Hash] options the options for the modal. Any option not listed\n     below is ignored, except for `:id` which is passed as an HTML\n     attribute to the modal\u2019s `<div>`.\n   @option options [#to_s] :title ('Modal') the title of the modal.\n   @option options [#to_s] :body the content to display as the modal body.\n     Using this option is equivalent to passing the body as an argument.\n   @option options [#to_s] :size the size of the modal. Can be `:large`\n     (alias `:lg`) or `:small` (alias `:sm`).\n   @option options [Hash] :button the options for the toggle button.\n     * :caption (#to_s) ('Modal') the caption of the toggle button.\n     * :context (#to_s) (:default) the contextual alternative to apply to\n        the toggle button. Can be `:danger`, `:info`, `:link`, `:primary`,\n       `:success` or `:warning`.\n     * :size (#to_s) the size of the toggle button. Can be `:extra_small`\n       (alias `:xs`), `:large` (alias `:lg`) or `:small` (alias `:sm`).\n     * :layout (#to_s) if set to `:block`, span the button for the full\n       width of the parent.\n   @example Display a simple modal toggled by a blue button.\n       modal 'You clicked me!', title: 'Click me', button: {context: :info}\n @overload modal(options = {}, &block)\n   @param [Hash] options the options for the modal (see above).\n   @yieldreturn [#to_s] the content to display in the modal.\n   @example Display a modal with HTML content.\n       modal title: 'Click me' do\n         content_tag :div, class: 'modal-body' do\n           content_tag :em, 'You clicked me!'\n         end\n       end", "Displays a Bootstrap-styled nav.\n @see http://getbootstrap.com/components/#nav\n @return [String] the HTML to display a Bootstrap-styled nav.\n @param [Hash] options the options for the nav. Any option not listed below\n   is passed as an HTML attribute to the alert\u2019s `<ul>`.\n @option options [#to_s] :as (:tabs) the style of the nav. Can be `:tabs`\n   or `:pills`.\n @option options [#to_s] :layout the layout of the nav. Can be\n   `:justified` or `:stacked`.\n @yieldreturn [#to_s] the content to display in the nav.\n @example Display a pills-styled nav with a link.\n   nav as: :pills do\n     link_to 'Home', '/'\n   end", "Displays the collapsable portion of a Bootstrap-styled navbar.\n @see http://getbootstrap.com/components/#navbar\n @return [String] the HTML to display the collapsable portion of a\n   Bootstrap-styled navbar.\n @overload horizontal(content, options = {})\n   @param [#to_s] content the collapsable content to display in the navbar.\n   @param [Hash] options the options to pass to the wrapping `<div>`.\n     Note that the `:id` option is ignored since the id must generated\n     by the navbar in order to match with the target of the toggle button.\n @overload horizontal(options = {}, &block)\n   @param [Hash] options the options to pass to the wrapping `<div>`.\n   @yieldreturn [#to_s] the collapsable content to display in the navbar.\n @example Display a navbar with two collapsable links.\n   navbar do\n     horizontal do\n       nav do\n         link_to 'Home', '/'\n         link_to 'Profile', '/profile'\n       end\n     end\n   end", "Displays a Bootstrap-styled vector icon.\n @see http://getbootstrap.com/components/#glyphicons\n @see http://fortawesome.github.io/Font-Awesome/examples/#bootstrap\n @return [String] the HTML to display a vector (font) icon.\n @param [#to_s] name the name of the icon to display, with either dashes\n   or underscores to separate multiple words.\n @param [Hash] options the options for the icon tag. Any option not\n   listed below is passed as an HTML attribute to the icon\u2019s `<span>`.\n @option options [#to_s] :library (:glyphicons) the vector icon library\n   to use. Valid values are 'glyphicon', 'glyphicons' (for Glyphicons),\n   'font-awesome', 'font_awesome' and 'fa' (for Font Awesome).\n @example Display the \"fire\" font awesome icon with a title\n   icon 'fire', library: :font_awesome, title: 'Hot'", "Displays the non-collapsable portion of a Bootstrap-styled navbar.\n @see http://getbootstrap.com/components/#navbar\n @return [String] the HTML to display the non-collapsable portion of a\n   Bootstrap-styled navbar.\n @overload vertical(content, options = {})\n   @param [#to_s] content the non-collapsable content to display in the\n     navbar.\n   @param [Hash] options the options to pass to the wrapping `<div>`.\n @overload vertical(options = {}, &block)\n   @param [Hash] options the options to pass to the wrapping `<div>`.\n   @yieldreturn [#to_s] the non-collapsable content to display in the\n     navbar.\n @example Display a navbar a non-collapsable links.\n   navbar do\n     vertical do\n       link_to 'Home', '/'\n     end\n   end", "Displays one or more Bootstrap-styled progress bars.\n @see http://getbootstrap.com/components/#progress\n @return [String] the HTML to display Bootstrap-styled progress bars.\n @overload progress_bar(bar_options = {}, container_options = {})\n   @param [Hash] bar_options the options to display a single progress bar.\n     Any option not listed below is passed as an HTML attribute to the\n     bar\u2019s `<div>`.\n   @option bar_options [Boolean, #to_s] :label (false) the label to display\n     on top of the progress bar. If set to false, the label is hidden. If\n     set to true, the label is generated from the percentage value. Any\n     other provided value is used directly as the label.\n   @option bar_options [Boolean] :striped (false) whether to display a\n     striped version of the progress bar (rather than solid color).\n   @option bar_options [Boolean] :animated (false) whether to display an\n     animated version of the progress bar (rather than solid color).\n   @option bar_options [#to_s] :context (:default) the contextual\n     alternative to apply to the progress bar. Can be `:success`, `:info`,\n     `:warning` or `:danger`.\n   @param [Hash] container_options the options to pass as HTML attributes\n     to the container\u2019s `<div>`.\n   @example Display a 30% warning progress bar.\n       progress_bar percentage: 30, context: :warning\n @overload progress_bar(stacked_bars_options = [], container_options = {})\n   @param [Hash] stacked_bars_options an array of bar_options (see above).\n     When an array is provided, a group of stacked progress bars is\n     displayed, each one matching the corresponding bar options.\n   @param [Hash] container_options the options to pass as HTML attributes\n     to the container\u2019s `<div>`.\n   @example Display two stacked progress bars.\n       progress_bar [{percentage: 30, context: :warning}, {percentage: 20}]", "Displays a Bootstrap-styled navbar.\n @see http://getbootstrap.com/components/#navbar\n @return [String] the HTML to display a Bootstrap-styled navbar.\n @param [Hash] options the options for the navbar. Any option not listed\n   below is ignored, except for `:id` which is passed as an HTML\n   attribute to the navbar\u2019s collapsable `<div>`.\n @option options [Boolean] :fluid (false) whether to use a fluid container\n   to surround the navbar content.\n @option options [Boolean] :inverted (false) whether to use an inverted\n   palette of colors.\n @option options [#to_s] :position the position of the navbar. Can be\n   `:top` (alias `:fixed_top`), `:bottom` (alias `:fixed_bottom`) or\n   `:static` (alias `:static_top`).\n @option options [#to_s] :padding (70) if position is set to :top or\n   :bottom, the padding to at the top (or bottom) of <body> to prevent the\n   navbar from overlaying the content.\n @yieldreturn [#to_s] the content to display in the navbar.\n @example Display an inverted navbar with three links.\n   navbar inverted: true do\n     vertical do\n       image_tag('logo')\n     end\n     horizontal do\n       nav do\n         link_to 'Home', '/'\n         link_to 'Profile', '/profile'\n       end\n     end\n   end", "Overrides `link_to` to display a Bootstrap-styled link.\n Can only be used in Ruby frameworks that provide the `link_to` method.\n @see http://getbootstrap.com/components/#dropdowns\n @see http://getbootstrap.com/components/#nav\n @see http://getbootstrap.com/components/#navbar-brand-image\n @see http://getbootstrap.com/components/#navbar-links\n @see http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to\n @see http://www.rubydoc.info/github/padrino/padrino-framework/Padrino/Helpers/AssetTagHelpers#link_to-instance_method\n @return [String] the HTML to display a Bootstrap-styled link.\n @overload link_to(caption, url, options = {})\n   @param [#to_s] caption the caption to display in the link.\n   @param [#to_s] url the URL to link to.\n   @param [Hash] options the options for the original `link_to` method.\n   @example Display a plain-text link inside an alert-box.\n       alert_box do\n         link_to 'Check the terms and conditions', '/#terms'\n       end\n @overload button_to(url, options = {}, &block)\n   @param [#to_s] url the URL to link to (see above).\n   @param [Hash] options the options for the original `link_to` method.\n   @yieldreturn [#to_s] the caption to display in the link.\n   @example Display a link with HTML inside a dropdown.\n       dropdown 'Menu' do\n         link_to '/#terms' do\n           content_tag :strong, 'Check the terms and conditions'\n         end\n       end", "Displays a Bootstrap-styled alert message.\n @see http://getbootstrap.com/components/#alerts\n @return [String] the HTML to display a Bootstrap-styled alert message.\n @overload alert_box(content, options = {})\n   @param [#to_s] content the content to display in the alert.\n   @param [Hash] options the options for the alert box. Any option not\n     listed below is passed as an HTML attribute to the alert\u2019s `<div>`.\n   @option options [Boolean] :dismissible (false) whether to display an\n     '\u00d7' to the right of the box that can be clicked to dismiss the alert.\n   @option options [#to_s] :context (:info) the contextual alternative to\n     apply to the alert. Can be `:danger`, `:info`, `:success` or\n     `:warning`.\n   @option options [#to_s] :priority if set to one of the priority levels\n     of Rails flash contents, determines the context of the alert box.\n     Can be :alert or :notice.\n   @example Display a dismissible alert box with a plain-text content.\n       alert_box 'User updated successfully', dismissible: true\n @overload alert_box(options = {}, &block)\n   @param [Hash] options the options for the alert box (see above).\n   @yieldreturn [#to_s] the content to display in the alert.\n   @example Display a success alert box with an HTML content.\n       alert_box context: :success do\n         content_tag :strong, 'User updated successfully'\n       end", "Returns the first argument if it's not nil or empty otherwise it returns\n the second one.\n\n   {{ post.author | otherwise:site.author }}", "Returns the audio file name of a given hash. Is no key as second parameter given, it\n trys first \"mp3\", than \"m4a\" and than it will return a more or less random\n value.\n\n   {{ post.audio | audio:\"m4a\" }} => \"my-episode.m4a\"", "Returns the audio-type of a given hash. Is no key as second parameter given, it\n trys first \"mp3\", than \"m4a\" and than it will return a more or less random\n value.\n\n   {{ post.audio | audiotype }} => \"my-episode.m4a\"", "Splits a chapter, like it is written to the post YAML front matter into\n the components 'start' which refers to a single point in time relative to\n the beginning of the media file nad 'title' which defines the text to be\n the title of the chapter.\n\n   {{ '00:00:00.000 Welcome to Octopod!' | split_chapter }}\n     => { 'start' => '00:00:00.000', 'title' => 'Welcome to Octopod!' }\n\n   {{ '00:00:00.000 Welcome to Octopod!' | split_chapter:'title' }}\n     => 'Welcome to Octopod!'\n\n   {{ '00:00:00.000 Welcome to Octopod!' | split_chapter:'start' }}\n     => '00:00:00.000'", "Gets a number of bytes and returns an human readable string of it.\n\n   {{ 1252251 | string_of_size }} => \"1.19M\"", "Generates the config for disqus integration\n If a page object is given, it generates the config variables only for this\n page. Otherwise it generate only the global config variables.\n\n   {{ site | disqus_config }}\n   {{ site | disqus_config:page }}", "Returns the hex-encoded hash value of a given string. The optional\n second argument defines the length of the returned string.\n\n   {{ \"Octopod\" | sha1 }} => \"8b20a59c\"\n   {{ \"Octopod\" | sha1:23 }} => \"8b20a59c8e2dcb5e1f845ba\"", "Formats date by given date format", "Generates the query string part for the flattr load.js from the\n configurations in _config.yml\n\n   {{ site | flattr_loader_options }}", "Returns a flattr button\n\n   {{ site | flattr_button:page }}", "Removes all leading \"flattr_\" from the keys of the given hash.\n\n   flattrize({ 'octopod' => 'awesome', 'flattr_uid' => 'pattex' })\n   => { \"octopod\" => \"awesome\", \"uid\" => \"pattex\" }", "Initialise a Registry.\n\n env - A Hash used as a source for environment variables. Usually, ENV\n       will be used.\n See Prius.load for documentation.", "groups_sources is a hash from type => options for each group source\n host_sources is a hash from type => options for each host source\n destinations is a similar hash from type => options for each alerter", "unfortunately, this appears to be the only way to get your account number", "Performs op. If an Op was created with arguments, just performs all\n operations on them and returns the result. If it was created without\n arguments, performs all operations on arguments provided to `call`.\n\n @param tms one, or several, or an array of time-y values; should not\n   be passed if Op was created with arguments.\n @return [Time,Date,DateTime,Array] one, or an array of processed arguments", "Get or set the alias indices", "Get or set the alias routing", "Return a Hash suitable for JSON serialization", "Raises an exception for unsuccessful responses", "0 - hidden input of sku\n 1 - checkbox itemOffer\n 2 - actions\n 3 - status\n 4 - sku\n 5 - asin\n 6 - product name\n 7 - date created\n 8 - qty\n 9 - your price\n 10 - condition\n 11 - low price\n 12 - buy-box price\n 13 - fulfilled by", "You can set a theme manually. Assign a hash to this method before you\n send your data.\n\n  graph.theme = {\n    :colors => %w(orange purple green white red),\n    :marker_color => 'blue',\n    :background_colors => ['black', 'grey', :top_bottom]\n  }\n\n :background_image => 'squirrel.png' is also possible.\n\n (Or hopefully something better looking than that.)", "Parameters are an array where the first element is the name of the dataset\n and the value is an array of values to plot.\n\n Can be called multiple times with different datasets for a multi-valued\n graph.\n\n If the color argument is nil, the next color from the default theme will\n be used.\n\n NOTE: If you want to use a preset theme, you must set it before calling\n data().\n\n Example:\n   data(\"Bart S.\", [95, 45, 78, 89, 88, 76], '#ffcc00')", "Overridden by subclasses to do the actual plotting of the graph.\n\n Subclasses should start by calling super() for this method.", "Make copy of data with values scaled between 0-100", "Calculates size of drawable area, general font dimensions, etc.", "Draw the optional labels for the x axis and y axis.", "Draws horizontal background lines and labels", "Draws a legend with the names of the datasets matched\n to the colors used to draw them.", "Draws a title on the graph.", "Draws the data value over the data point in bar graphs", "Shows an error message because you have no data.", "Use with a theme definition method to draw a gradiated background.", "Sort with largest overall summed value at front of array.", "Sort with largest overall summed value at front of array so it shows up\n correctly in the drawn graph.", "Used by StackedBar and child classes.\n\n May need to be moved to the StackedBar class.", "Return a formatted string representing a number value that should be\n printed as a label.", "Returns the width of a string at this pointsize.\n\n Not scaled since it deals with dimensions that the regular\n scaling will handle.", "Additional method to scale annotation text since Draw.scale doesn't.", "Get registered limit parameters for an action.\n\n @see #register\n @param action [Symbol] action name\n @return [Hash] max and period parameters in a hash\n @raise [TrafficJam::LimitNotFound] if action is not registered", "Attempt to increment the limits by the given amount. Does not increment\n if incrementing would exceed any limit.\n\n @param amount [Integer] amount to increment by\n @param time [Time] optional time of increment\n @return [Boolean] whether increment operation was successful", "Increment the limits by the given amount. Raises an error and does not\n increment if doing so would exceed any limit.\n\n @param amount [Integer] amount to increment by\n @param time [Time] optional time of increment\n @return [nil]\n @raise [TrafficJam::LimitExceededError] if increment would exceed any\n   limits", "Decrement the limits by the given amount.\n\n @param amount [Integer] amount to decrement by\n @param time [Time] optional time of decrement\n @return [true]", "Return the first limit to be exceeded if incrementing by the given amount,\n or nil otherwise. Does not change amount used for any limit.\n\n @param amount [Integer]\n @return [TrafficJam::Limit, nil]", "Increment the amount used by the given number. Does not perform increment\n if the operation would exceed the limit. Returns whether the operation was\n successful.\n\n @param amount [Integer] amount to increment by\n @param time [Time] time is ignored\n @return [Boolean] true if increment succeded and false if incrementing\n   would exceed the limit", "Increment the amount used by the given number. Does not perform increment\n if the operation would exceed the limit. Returns whether the operation was\n successful. Time of increment can be specified optionally with a keyword\n argument, which is useful for rolling back with a decrement.\n\n @param amount [Integer] amount to increment by\n @param time [Time] time when increment occurs\n @return [Boolean] true if increment succeded and false if incrementing\n   would exceed the limit", "Return amount of limit used\n\n @return [Integer] amount used", "Dispatch takes an incoming Task from the client and runs it on the\n server, returning the result to the client.\n Tasks returning a promise will wait to return.", "Check if it is safe to use this method", "Do the actual dispatching, should be running inside of a worker thread at\n this point.", "Called on the model inside of a validations block.  Allows the user to\n control if validations should be run.", "Marks all fields, useful for when a model saves.", "Returns true if any of the changed fields now has an error\n @return [Boolean] true if one of the changed fields has an error.", "Runs through each of the normal validations.\n @param [Array] An array of validations to run\n @return [Promise] a promsie to run all validations", "Runs an individual validation\n @returns [Promise]", "used internally, clears out the array, triggers the change events, but\n does not call clear on the persistors.  Used when models are updated\n externally.", "When errors come in, we mark all fields and return a rejected promise.", "Returns a buffered version of the model", "Convert the model to a hash all of the way down.", "Convert the model to an array all of the way down", "called form <<, append, and create.  If a hash is passed in, it converts\n it to a model.  Then it takes the model and inserts it into the ArrayModel\n then persists it.", "Full url rebuilds the url from it's constituent parts.\n The params passed in are used to generate the urls.", "Assigning the params is tricky since we don't want to trigger changed on\n any values that have not changed.  So we first loop through all current\n url params, removing any not present in the params, while also removing\n them from the list of new params as added.  Then we loop through the\n remaining new parameters and assign them.", "Assign any new params, which weren't in the old params.", "Generate the key for a nested param attribute", "Create controller handler loads up a controller inside of the controller handler for the paths", "Yield for every folder where we might find components", "returns an array of every folder that is a component", "Return every asset folder we need to serve from", "Finds each of the binding anchors in the temp dom, then stores a reference\n to them so they can be quickly updated without using xpath to find them again.", "Takes in a lookup path and returns the full path for the matching\n template.  Also returns the controller and action name if applicable.\n\n Looking up a path is fairly simple.  There are 4 parts needed to find\n the html to be rendered.  File paths look like this:\n app/{component}/views/{controller_name}/{view}.html\n Within the html file may be one or more sections.\n 1. component (app/{comp})\n 2. controller\n 3. view\n 4. sections\n\n When searching for a file, the lookup starts at the section, and moves up.\n when moving up, default values are provided for the section, then view/section, etc..\n until a file is either found or the component level is reached.\n\n The defaults are as follows:\n 1. component - main\n 2. controller - main\n 3. view - index\n 4. section - body", "Walks the dom_nodes range until it finds an element.  Typically this will\n be the container element without the whitespace text nodes.", "yield_html renders the content passed into a tag as a string.  You can ```.watch!```\n ```yield_html``` and it will be run again when anything in the template changes.", "Sets the current model on this controller", "loaded? is a quick way to see if the model for the controller is loaded\n yet.  If the model is there, it asks the model if its loaded.  If the model\n was set to a promise, it waits for the promise to resolve.", "Raw marks a string as html safe, so bindings can be rendered as html.\n With great power comes great responsibility.", "Looks at the value", "Initialzed with the params parsed from the route and the HttpRequest", "When using bindings, we have to change the binding id so we don't reuse\n the same id when rendering a binding multiple times.", "Takes in our html and bindings, and rezero's the comment names, and the\n bindings.  Returns an updated bindings hash", "Generate code for the view that can be evaled.", "Returns a string representation of the duration.\n\n @param How many places in time units to show.\n @param The minimum unit to show, anything below will be ignored.  Results\n        will be rounded up the the nearest min_unit.", "When a request is sent to the backend, it can attach a callback,\n this is called from the backend to pass to the callback.", "Called when the backend sends a notification to change the results of\n a query.", "Setup a new dependency.\n\n @param on_dep [Proc] a proc to be called the first time a computation depends\n   on this dependency.\n @param on_stop_dep [Proc] a proc to be called when no computations are depending\n   on this dependency anymore.", "Assign multiple attributes as a hash, directly.", "Do the assignment to a model and trigger a changed event", "Get a new model, make it easy to override", "Update tries to update the model and returns", "Called when this scope should be closed out", "Compares with the value on another Duration if Duration is passed\n or just compares value with the other object\n Adds durations or duration to a VoltTime or seconds to the duration", "Findings the end of a binding", "Find the correct controller and call the correct action on it.\n The controller name and actions need to be set as params for the\n matching route", "When a changed event happens, we update to the new size.", "When items are added or removed in the middle of the list, we need\n to update each templates index value.", "When this each_binding is removed, cleanup.", "Create rest endpoints", "Takes in params and generates a path and the remaining params\n that should be shown in the url.  The extra \"unused\" params\n will be tacked onto the end of the url ?param1=value1, etc...\n\n returns the url and new params, or nil, nil if no match is found.", "Takes in a path and returns the matching params.\n returns params as a hash", "Recursively walk the @indirect_routes hash, return the params for a route, return\n false for non-matches.", "The params out of match_path will have integers in the params that came from bindings\n in the url.  This replaces those with the values from the url.", "Takes in a hash of params and checks to make sure keys in param_matcher\n are in test_params.  Checks for equal value unless value in param_matcher\n is nil.\n\n returns false or true, new_params - where the new params are a the params not\n used in the basic match.  Later some of these may be inserted into the url.", "Currently the has_many and belongs_to associations only work on the store collection,\n this method checks to make sure we are on store and returns the root reference to it.", "called from the child when the boot failes.  Sets up an error page rack\n app to show the user the error and handle reloading requests.", "Take the attributes and create any bindings", "Takes a string and splits on bindings, returns the string split on bindings\n and the number of bindings.", "The path passed in is the path used to lookup view's.  The path from the tag is passed in\n as tag_name", "Returns script tags that should be included", "Returns an array of all css files that should be included.", "Looks up the path without generating a new one", "Merge another set of errors in", "Called from the view scope when an asset_url binding is hit.", "The client argument is for if this code is being generated for the client", "For cretain values, we wrap them to make the behave as a\n model.", "Generate an analogous palette.\n\n @example\n   'red'.paint.palette.analogous                        #=> [red, #ff0066, #ff0033, red, #ff3300, #ff6600]\n   'red'.paint.palette.analogous(as: :hex)              #=> ['#f00', '#f06', '#f03', '#f00', '#f30', '#f60']\n   'red'.paint.palette.analogous(size: 3)               #=> [red, #ff001a, #ff1a00]\n   'red'.paint.palette.analogous(size: 3, slice_by: 60) #=> [red, #ff000d, #ff0d00]\n\n @param options [Hash]\n @option options :size     [Symbol] (6) number of results to return\n @option options :slice_by [Symbol] (30)\n   the angle in degrees to slice the hue circle per color\n @option options :as       [Symbol] (nil) optional format to output colors as strings\n @return [Array<Color>, Array<String>] depending on presence of `options[:as]`", "Generate a monochromatic palette.\n\n @example\n   'red'.paint.palette.monochromatic           #=> [red, #2a0000, #550000, maroon, #aa0000, #d40000]\n   'red'.paint.palette.monochromatic(as: :hex) #=> ['#ff0000', '#2a0000', '#550000', '#800000', '#aa0000', '#d40000']\n   'red'.paint.palette.monochromatic(size: 3)  #=> [red, #550000, #aa0000]\n\n @param options [Hash]\n @option options :size [Symbol] (6) number of results to return\n @option options :as   [Symbol] (nil) optional format to output colors as strings\n @return [Array<Color>, Array<String>] depending on presence of `options[:as]`", "Receive a message from SQS queue.\n @return [Barbeque::Message::Base]", "setup the sources table and model attributes for all applications", "replace self by other URI object", "returns a charset parameter in Content-Type field.\n It is downcased for canonicalization.\n\n If charset parameter is not given but a block is given,\n the block is called and its result is returned.\n It can be used to guess charset.\n\n If charset parameter and block is not given,\n nil is returned except text type in HTTP.\n In that case, \"iso-8859-1\" is returned as defined by RFC2616 3.7.1.", "Deletes all messages on the server.\n\n If called with a block, yields each message in turn before deleting it.\n\n === Example\n\n     n = 1\n     pop.delete_all do |m|\n       File.open(\"inbox/#{n}\") do |f|\n         f.write m.pop\n       end\n       n += 1\n     end\n\n This method raises a POPError if an error occurs.", "This method fetches the message.  If called with a block, the\n message is yielded to the block one chunk at a time.  If called\n without a block, the message is returned as a String.  The optional\n +dest+ argument will be prepended to the returned String; this\n argument is essentially obsolete.\n\n === Example without block\n\n     POP3.start('pop.example.com', 110,\n                'YourAccount, 'YourPassword') do |pop|\n       n = 1\n       pop.mails.each do |popmail|\n         File.open(\"inbox/#{n}\", 'w') do |f|\n           f.write popmail.pop\n         end\n         popmail.delete\n         n += 1\n       end\n     end\n\n === Example with block\n\n     POP3.start('pop.example.com', 110,\n                'YourAccount, 'YourPassword') do |pop|\n       n = 1\n       pop.mails.each do |popmail|\n         File.open(\"inbox/#{n}\", 'w') do |f|\n           popmail.pop do |chunk|            \n             f.write chunk\n           end\n         end\n         n += 1\n       end\n     end\n\n This method raises a POPError if an error occurs.", "Declare a set of files tasks to create the given directories on\n demand.\n\n Example:\n   directory \"testdata/doc\"", "Create a new rake namespace and use it for evaluating the given\n block.  Returns a NameSpace object that can be used to lookup\n tasks defined in the namespace.\n\n E.g.\n\n   ns = namespace \"nested\" do\n     task :run\n   end\n   task_run = ns[:run] # find :run in the given namespace.", "Removes a namespace from this node.  This only works if the namespace is\n actually declared in this node.  If no argument is passed, deletes the\n default namespace.\n\n Evaluates to: this element\n  doc = Document.new \"<a xmlns:foo='bar' xmlns='twiddle'/>\"\n  doc.root.delete_namespace\n  puts doc     # -> <a xmlns:foo='bar'/>\n  doc.root.delete_namespace 'foo'\n  puts doc     # -> <a/>", "Iterates over the attributes of an Element.  Yields actual Attribute\n nodes, not String values.\n\n  doc = Document.new '<a x=\"1\" y=\"2\"/>'\n  doc.root.attributes.each_attribute {|attr|\n    p attr.expanded_name+\" => \"+attr.value\n  }", "Overwrite this so that gems in the gems directory get preferred over gems\n from any other location. If there are two gems of different versions in\n the gems directory, the later one will load as usual.\n\n @return [Array<Array>] The object used for sorting gem specs.", "Shuts down the server and all listening sockets.  New listeners must be\n provided to restart the server.", "Formats +arg+ for the logger\n\n * If +arg+ is an Exception, it will format the error message and\n   the back trace.\n * If +arg+ responds to #to_str, it will return it.\n * Otherwise it will return +arg+.inspect.", "Extract the query parameters and append them to the url", "Return a hash of headers whose keys are capitalized strings", "Merge _arr_ with receiver, producing the union of receiver & _arr_\n\n   s = Extlib::SimpleSet.new([:a, :b, :c])\n   s.merge([:c, :d, :e, f])  #=> #<SimpleSet: {:e, :c, :f, :a, :d, :b}>\n\n @param [Array] arr Values to merge with set.\n\n @return [SimpleSet] The set after the Array was merged in.\n\n @api public", "Execute specific task action", "Method serializes itself to a hash and sends post request with the hash to specified URI\n @param anUri [URI] URI for post request", "Checks has source code changes for each platform", "FIXME\n The next two methods are BAD MOJO!\n This is my achilles heel.  If anybody thinks of a better\n way of doing this, be my guest.  This really sucks, but\n it is a wonder it works at all.", "Reorders an array of nodes so that they are in document order\n It tries to do this efficiently.\n\n FIXME: I need to get rid of this, but the issue is that most of the XPath\n interpreter functions as a filter, which means that we lose context going\n in and out of function calls.  If I knew what the index of the nodes was,\n I wouldn't have to do this.  Maybe add a document IDX for each node?\n Problems with mutable documents.  Or, rewrite everything.", "Cases for the invocation of the scope defining the lambda still active\n on the call stack when the lambda is invoked.", "Opens a TCP connection and starts the SMTP session.\n\n === Parameters\n\n +helo+ is the _HELO_ _domain_ that you'll dispatch mails from; see\n the discussion in the overview notes.\n\n If both of +user+ and +secret+ are given, SMTP authentication\n will be attempted using the AUTH command.  +authtype+ specifies\n the type of authentication to attempt; it must be one of\n :login, :plain, and :cram_md5.  See the notes on SMTP Authentication\n in the overview.\n\n === Block Usage\n\n When this methods is called with a block, the newly-started SMTP\n object is yielded to the block, and automatically closed after\n the block call finishes.  Otherwise, it is the caller's\n responsibility to close the session when finished.\n\n === Example\n\n This is very similar to the class method SMTP.start.\n\n     require 'net/smtp'\n     smtp = Net::SMTP.new('smtp.mail.server', 25)\n     smtp.start(helo_domain, account, password, authtype) do |smtp|\n       smtp.send_message msgstr, 'from@example.com', ['dest@example.com']\n     end\n\n The primary use of this method (as opposed to SMTP.start)\n is probably to set debugging (#set_debug_output) or ESMTP\n (#esmtp=), which must be done before the session is\n started.\n\n === Errors\n\n If session has already been started, an IOError will be raised.\n\n This method may raise:\n\n * Net::SMTPAuthenticationError\n * Net::SMTPServerBusy\n * Net::SMTPSyntaxError\n * Net::SMTPFatalError\n * Net::SMTPUnknownError\n * Net::OpenTimeout\n * Net::ReadTimeout\n * IOError", "This method sends a message.\n If +msgstr+ is given, sends it as a message.\n If block is given, yield a message writer stream.\n You must write message before the block is closed.\n\n   # Example 1 (by string)\n   smtp.data(<<EndMessage)\n   From: john@example.com\n   To: betty@example.com\n   Subject: I found a bug\n\n   Check vm.c:58879.\n   EndMessage\n\n   # Example 2 (by block)\n   smtp.data {|f|\n     f.puts \"From: john@example.com\"\n     f.puts \"To: betty@example.com\"\n     f.puts \"Subject: I found a bug\"\n     f.puts \"\"\n     f.puts \"Check vm.c:58879.\"\n   }", "Searches installed gems for Generators files and loads all code blocks in them that match\n the given scope.\n\n === Parameters\n scope<String>:: The name of the scope to search for", "Visit all subnodes of +self+ recursively", "The cookie string suitable for use in an HTTP header", "Disconnects from the server.", "Sends a STARTTLS command to start TLS session.", "Sends an IDLE command that waits for notifications of new or expunged\n messages.  Yields responses from the server during the IDLE.\n\n Use #idle_done() to leave IDLE.", "Retrieves data from +path+ on the connected-to host which may be an\n absolute path String or a URI to extract the path from.\n\n +initheader+ must be a Hash like { 'Accept' => '*/*', ... },\n and it defaults to an empty hash.\n If +initheader+ doesn't have the key 'accept-encoding', then\n a value of \"gzip;q=1.0,deflate;q=0.6,identity;q=0.3\" is used,\n so that gzip compression is used in preference to deflate\n compression, which is used in preference to no compression.\n Ruby doesn't have libraries to support the compress (Lempel-Ziv)\n compression, so that is not supported.  The intent of this is\n to reduce bandwidth by default.   If this routine sets up\n compression, then it does the decompression also, removing\n the header as well to prevent confusion.  Otherwise\n it leaves the body as it found it.\n\n This method returns a Net::HTTPResponse object.\n\n If called with a block, yields each fragment of the\n entity body in turn as a string as it is read from\n the socket.  Note that in this case, the returned response\n object will *not* contain a (meaningful) body.\n\n +dest+ argument is obsolete.\n It still works but you must not use it.\n\n This method never raises an exception.\n\n     response = http.get('/index.html')\n\n     # using block\n     File.open('result.txt', 'w') {|f|\n       http.get('/~foo/') do |str|\n         f.write str\n       end\n     }", "Sends a PATCH request to the +path+ and gets a response,\n as an HTTPResponse object.", "Sends a PROPPATCH request to the +path+ and gets a response,\n as an HTTPResponse object.", "Sends a LOCK request to the +path+ and gets a response,\n as an HTTPResponse object.", "Sends a UNLOCK request to the +path+ and gets a response,\n as an HTTPResponse object.", "Sends a PROPFIND request to the +path+ and gets a response,\n as an HTTPResponse object.", "Sends a MKCOL request to the +path+ and gets a response,\n as an HTTPResponse object.", "Sends a POST request to the +path+.\n\n Returns the response as a Net::HTTPResponse object.\n\n When called with a block, the block is passed an HTTPResponse\n object.  The body of that response will not have been read yet;\n the block can process it using HTTPResponse#read_body, if desired.\n\n Returns the response.\n\n This method never raises Net::* exceptions.\n\n     # example\n     response = http.request_post('/cgi-bin/nice.rb', 'datadatadata...')\n     p response.status\n     puts response.body          # body is already read in this case\n\n     # using block\n     http.request_post('/cgi-bin/nice.rb', 'datadatadata...') {|response|\n       p response.status\n       p response['content-type']\n       response.read_body do |str|   # read body now\n         print str\n       end\n     }", "Sends an HTTPRequest object +req+ to the HTTP server.\n\n If +req+ is a Net::HTTP::Post or Net::HTTP::Put request containing\n data, the data is also sent. Providing data for a Net::HTTP::Head or\n Net::HTTP::Get request results in an ArgumentError.\n\n Returns an HTTPResponse object.\n\n When called with a block, passes an HTTPResponse object to the block.\n The body of the response will not have been read yet;\n the block can process it using HTTPResponse#read_body,\n if desired.\n\n This method never raises Net::* exceptions.", "Executes a request which uses a representation\n and returns its body.", "Creates an instance of OpenSSL's configuration class.\n\n This can be used in contexts like OpenSSL::X509::ExtensionFactory.config=\n\n If the optional +filename+ parameter is provided, then it is read in and\n parsed via #parse_config.\n\n This can raise IO exceptions based on the access, or availability of the\n file. A ConfigError exception may be raised depending on the validity of\n the data being configured.\n\n\n Gets the value of +key+ from the given +section+\n\n Given the following configurating file being loaded:\n\n   config = OpenSSL::Config.load('foo.cnf')\n     #=> #<OpenSSL::Config sections=[\"default\"]>\n   puts config.to_s\n     #=> [ default ]\n     #   foo=bar\n\n You can get a specific value from the config if you know the +section+\n and +key+ like so:\n\n   config.get_value('default','foo')\n     #=> \"bar\"", "Sets a specific +section+ name with a Hash +pairs+\n\n Given the following configuration being created:\n\n   config = OpenSSL::Config.new\n     #=> #<OpenSSL::Config sections=[]>\n   config['default'] = {\"foo\"=>\"bar\",\"baz\"=>\"buz\"}\n     #=> {\"foo\"=>\"bar\", \"baz\"=>\"buz\"}\n   puts config.to_s\n     #=> [ default ]\n     #   foo=bar\n     #   baz=buz\n\n It's important to note that this will essentially merge any of the keys\n in +pairs+ with the existing +section+. For example:\n\n   config['default']\n     #=> {\"foo\"=>\"bar\", \"baz\"=>\"buz\"}\n   config['default'] = {\"foo\" => \"changed\"}\n     #=> {\"foo\"=>\"changed\"}\n   config['default']\n     #=> {\"foo\"=>\"changed\", \"baz\"=>\"buz\"}", "Get the parsable form of the current configuration\n\n Given the following configuration being created:\n\n   config = OpenSSL::Config.new\n     #=> #<OpenSSL::Config sections=[]>\n   config['default'] = {\"foo\"=>\"bar\",\"baz\"=>\"buz\"}\n     #=> {\"foo\"=>\"bar\", \"baz\"=>\"buz\"}\n   puts config.to_s\n     #=> [ default ]\n     #   foo=bar\n     #   baz=buz\n\n You can parse get the serialized configuration using #to_s and then parse\n it later:\n\n   serialized_config = config.to_s\n   # much later...\n   new_config = OpenSSL::Config.parse(serialized_config)\n     #=> #<OpenSSL::Config sections=[\"default\"]>\n   puts new_config\n     #=> [ default ]\n         foo=bar\n         baz=buz", "For a block.\n\n Receive the section and its pairs for the current configuration.\n\n   config.each do |section, key, value|\n     # ...\n   end", "Inserts an child before another child\n @param child1 this is either an xpath or an Element.  If an Element,\n child2 will be inserted before child1 in the child list of the parent.\n If an xpath, child2 will be inserted before the first child to match\n the xpath.\n @param child2 the child to insert\n @return the parent (self)", "Fetches the index of a given child\n @param child the child to get the index of\n @return the index of the child, or nil if the object is not a child\n of this parent.", "Replaces one child with another, making sure the nodelist is correct\n @param to_replace the child to replace (must be a Child)\n @param replacement the child to insert into the nodelist (must be a\n Child)", "Deeply clones this object.  This creates a complete duplicate of this\n Parent, including all descendants.", "Constructs a new Instruction\n @param target can be one of a number of things.  If String, then\n the target of this instruction is set to this.  If an Instruction,\n then the Instruction is shallowly cloned (target and content are\n copied).  If a Source, then the source is scanned and parsed for\n an Instruction declaration.\n @param content Must be either a String, or a Parent.  Can only\n be a Parent if the target argument is a Source.  Otherwise, this\n String is set as the content of this instruction.\n == DEPRECATED\n See the rexml/formatters package", "Checks if the given argument is valid according to this description\n\n === Parameters\n argument<Object>:: Checks if the given argument is valid.\n === Returns\n Boolean:: Validity of the argument", "Constructs a socket with +host+ and +port+.\n\n If SOCKSSocket is defined and the environment (ENV) defines\n SOCKS_SERVER, then a SOCKSSocket is returned, else a TCPSocket is\n returned.", "Constructs a connection for transferring data", "Retrieves +remotefile+ in binary mode, storing the result in +localfile+.\n If +localfile+ is nil, returns retrieved data.\n If a block is supplied, it is passed the retrieved data in +blocksize+\n chunks.", "Returns an array of filenames in the remote directory.", "Renames a file on the server.", "Deletes a file on the server.", "Starts the CGI process with the given environment +env+ and standard\n input and output +stdin+ and +stdout+.", "Remove the generator with the given name from the manifold\n\n === Parameters\n name<Symbol>:: The name of the generator to be removed.", "A Shortcut method for invoking the command line interface provided with Templater.\n\n === Parameters\n destination_root<String>:: Where the generated files should be put, this would usually be Dir.pwd\n name<String>:: The name of the executable running this generator (such as 'merb-gen')\n version<String>:: The version number of the executable.\n args<Array[String]>:: An array of arguments to pass into the generator. This would usually be ARGV", "use djb hash function to generate temp object id", "Compares names optionally WITH namespaces", "Iterates over the request headers", "Consumes any remaining body and updates keep-alive status", "Formats +params+ according to +format_string+ which is described in\n setup_params.", "Run the given block with the thread startup and shutdown.", "Provide standard exception handling for the given block.", "Display the tasks and prerequisites", "Finds and returns all templates whose options match the generator options.\n\n === Returns\n [Templater::Generator]:: The found templates.", "Finds and returns all templates and files for this generators whose options match its options.\n\n === Parameters\n type<Symbol>:: The type of actions to look up (optional)\n === Returns\n [Templater::Actions::*]:: The found templates and files.", "Finds and returns all templates and files for this generators and any of those generators it invokes,\n whose options match that generator's options.\n\n === Returns\n [Templater::Actions::File, Templater::Actions::Template]:: The found templates and files.", "Creates a self-signed certificate with the given number of +bits+,\n the issuer +cn+ and a +comment+ to be stored in the certificate.", "Updates +listen+ to enable SSL when the SSL configuration is active.", "Readies a log for writing.\n\n ==== Parameters\n log<IO, String>:: Either an IO object or a name of a logfile.", "Appends a message to the log. The methods yield to an optional block and\n the output of this block will be appended to the message.\n\n ==== Parameters\n string<String>:: The message to be logged. Defaults to nil.\n\n ==== Returns\n String:: The resulting message added to the log file.", "Write +string+ to the host.\n\n Does not perform any conversions on +string+.  Will log +string+ to the\n dumplog, if the Dump_log option is set.", "Send a command to the host.\n\n More exactly, sends a string to the host, and reads in all received\n data until is sees the prompt or other matched sequence.\n\n If a block is given, the received data will be yielded to it as\n it is read in.  Whether a block is given or not, the received data\n will be return as a string.  Note that the received data includes\n the prompt and in most cases the host's echo of our command.\n\n +options+ is either a String, specified the string or command to\n send to the host; or it is a hash of options.  If a hash, the\n following options can be specified:\n\n String:: the command or other string to send to the host.\n Match:: a regular expression, the sequence to look for in\n         the received data before returning.  If not specified,\n         the Prompt option value specified when this instance\n         was created will be used, or, failing that, the default\n         prompt of /[$%#>] \\z/n.\n Timeout:: the seconds to wait for data from the host before raising\n           a Timeout error.  If not specified, the Timeout option\n           value specified when this instance was created will be\n           used, or, failing that, the default value of 10 seconds.\n\n The command or other string will have the newline sequence appended\n to it.", "Login to the host with a given username and password.\n\n The username and password can either be provided as two string\n arguments in that order, or as a hash with keys \"Name\" and\n \"Password\".\n\n This method looks for the strings \"login\" and \"Password\" from the\n host to determine when to send the username and password.  If the\n login sequence does not follow this pattern (for instance, you\n are connecting to a service other than telnet), you will need\n to handle login yourself.\n\n The password can be omitted, either by only\n provided one String argument, which will be used as the username,\n or by providing a has that has no \"Password\" key.  In this case,\n the method will not look for the \"Password:\" prompt; if it is\n sent, it will have to be dealt with by later calls.\n\n The method returns all data received during the login process from\n the host, including the echoed username but not the password (which\n the host should not echo).  If a block is passed in, this received\n data is also yielded to the block as it is received.", "Normalizes a request path.  Raises an exception if the path cannot be\n normalized.", "Loads Apache-compatible mime.types in +file+.", "Parses a Range header value +ranges_specifier+", "Parses q values in +value+ as used in Accept headers.", "Parses the query component of a URI in +str+", "Escapes path +str+", "FileList version of partition.  Needed because the nested arrays should\n be FileLists in this version.", "Add matching glob patterns.", "Create a promise to do the chore specified by the block.\n Return the value of this promise.\n\n If the promised chore is not yet complete, then do the work\n synchronously. We will wait.", "Perform the chore promised", "Sets the header field corresponding to the case-insensitive key.", "Iterates for each header names and values.", "Gets entity body.  If the block given, yields it to +block+.\n The body is provided in fragments, as it is read in from the socket.\n\n Calling this method a second or subsequent time will return the\n already read string.\n\n   http.request_get('/index.html') {|res|\n     puts res.read_body\n   }\n\n   http.request_get('/index.html') {|res|\n     p res.read_body.object_id   # 538149362\n     p res.read_body.object_id   # 538149362\n   }\n\n   # using iterator\n   http.request_get('/index.html') {|res|\n     res.read_body do |segment|\n       print segment\n     end\n   }", "Follow a redirection", "Parse a cookie value and return its content in an Hash", "Find a matching task for +task_name+.", "Creates a new HTTP server according to +config+\n\n An HTTP server uses the following attributes:\n\n :AccessLog:: An array of access logs.  See WEBrick::AccessLog\n :BindAddress:: Local address for the server to bind to\n :DocumentRoot:: Root path to serve files from\n :DocumentRootOptions:: Options for the default HTTPServlet::FileHandler\n :HTTPVersion:: The HTTP version of this server\n :Port:: Port to listen on\n :RequestCallback:: Called with a request and response before each\n                    request is serviced.\n :RequestTimeout:: Maximum time to wait between requests\n :ServerAlias:: Array of alternate names for this server for virtual\n                hosting\n :ServerName:: Name for this server for virtual hosting\n\n Processes requests on +sock+", "Services +req+ and fills in +res+", "Mounts +servlet+ on +dir+ passing +options+ to the servlet at creation\n time", "Finds a servlet for +path+", "Adds +server+ as a virtual host.", "Finds the appropriate virtual host to handle +req+", "Logs +req+ and +res+ in the access logs.  +config+ is used for the\n server name.", "Sets IO operations on +io+ to be non-blocking", "Sets the close on exec flag for +io+", "Changes the process's uid and gid to the ones of +user+", "Generates a random string of length +len+", "Executes the passed block and raises +exception+ if execution takes more\n than +seconds+.\n\n If +seconds+ is zero or nil, simply executes the block", "Create an FTP uploader targeting the directory +path+ on +host+\n using the given account and password.  +path+ will be the root\n path of the uploader.\n Create the directory +path+ in the uploader root path.", "updates the digest with the contents of a given file _name_ and\n returns self.", "Generate an authorization URL for user authorization", "exchange for AccessToken on server", "construct an authorization url", "See 9.1 in specs", "URI, including OAuth parameters", "Authorization header for OAuth", "Creates and signs an http request.\n It's recommended to use the Token classes to set this up correctly", "Creates a request and parses the result as url_encoded. This is used internally for the RequestToken and AccessToken requests.", "Sign the Request object. Use this if you have an externally generated http request object you want to sign.", "Return the signature_base_string", "create the http request object for a given http_method and path", "Escape +value+ by URL encoding all non-reserved character.\n\n See Also: {OAuth core spec version 1.0, section 5.1}[http://oauth.net/core/1.0#rfc.section.5.1]", "Normalize a +Hash+ of parameter values. Parameters are sorted by name, using lexicographical\n byte value ordering. If two or more parameters share the same name, they are sorted by their value.\n Parameters are concatenated in their sorted order into a single string. For each parameter, the name\n is separated from the corresponding value by an \"=\" character, even if the value is empty. Each\n name-value pair is separated by an \"&\" character.\n\n See Also: {OAuth core spec version 1.0, section 9.1.1}[http://oauth.net/core/1.0#rfc.section.9.1.1]", "mainly for testing purposes", "Converts Hoptoad-specific keys in +@hash+ to Graylog2-specific.", "Sets or gets the parent breadcrumb.\n If you supply a parent key and optional arguments, it will set the parent.\n If nothing is supplied, it will return the parent, if this has been set.\n\n Example:\n   parent :category, category\n\n Or short, which will infer the key from the model's `model_name`:\n   parent category", "Enables accessors and predicate methods for values in the +options+ hash.\n This can be used to pass information to links when rendering breadcrumbs\n manually.\n\n   link = Link.new(:my_crumb, \"My Crumb\", my_path, title: \"Test Title\", other_value: \"Other\")\n   link.title?       # => true\n   link.title        # => \"Test Title\"\n   link.other_value? # => true\n   link.other_value  # => \"Other\"\n   link.some_other?  # => false\n   link.some_other   # => nil", "Yields a block where inside the block you have a different breadcrumb than outside.\n\n   <% breadcrumb :about %>\n\n   <%= breadcrumbs # shows the :about breadcrumb %>\n\n   <% with_breadcrumb :product, Product.first do %>\n     <%= breadcrumbs # shows the :product breadcrumb %>\n   <% end %>\n\n   <%= breadcrumbs # shows the :about breadcrumb %>", "Renders the breadcrumbs HTML.", "Returns merged options for rendering breadcrumbs.", "Array of links with applied options.", "Array of links for the path of the breadcrumb.\n Also reloads the breadcrumb configuration if needed.", "Returns parent links for the crumb.", "Resets all instance variables and calls +reset!+ on all child modules and\n classes. Used for testing.", "Extract the given tarball to the target directory", "Update existing config with the one from .pkgr.yml file, if any", "Check configuration, and verifies that the current distribution's requirements are satisfied", "Setup the build directory structure", "Pass the app through the buildpack", "Write startup scripts.", "Write cron files", "Launch the FPM command that will generate the package.", "Buildpacks detected for the app, if any. If multiple buildpacks are explicitly specified, all are used", "Takes in a list of valid option keys and a hash of options. If one of the\n keys in the hash is invalid an ArgumentError will be raised.\n\n @param valid_option_keys List of valid keys for the options hash.\n @param options [Hash] Options hash.", "Takes in a hash containing all the attributes required to initialize the\n object.\n\n Each hash entry should have a key which identifies a field and its value,\n so a valid call would be something like this:\n\n     DropboxApi::Metadata::File.new({\n       \"name\" => \"a.jpg\",\n       \"path_lower\" => \"/a.jpg\",\n       \"path_display\" => \"/a.jpg\",\n       \"id\" => \"id:evvfE6q6cK0AAAAAAAAB2w\",\n       \"client_modified\" => \"2016-10-19T17:17:34Z\",\n       \"server_modified\" => \"2016-10-19T17:17:34Z\",\n       \"rev\" => \"28924061bdd\",\n       \"size\" => 396317\n     })\n\n @raise [ArgumentError] If a required attribute is missing.\n @param metadata [Hash]", "If it validates, returns a hash with the JWT payload from the ID Token.\n  You have to provide an \"aud\" value, which must match the\n  token's field with that name, and will similarly check cid if provided.\n\n If something fails, raises an error\n\n @param [String] token\n   The string form of the token\n @param [String] aud\n   The required audience value\n @param [String] cid\n   The optional client-id (\"azp\" field) value\n\n @return [Hash] The decoded ID token", "tries to validate the token against each cached cert.\n Returns the token payload or raises a ValidationError or\n  nil, which means none of the certs validated.", "Set up options for wkhtmltopdf\n @param [String] parameters\n Convert the html to pdf and write it to file\n @param [String] html the html input\n @param [String] filename the name of the output file", "Initialize the converter with a File\n @param [Array] files The list of Gimli::MarkupFile to convert (passing a single file will still work)\n @param [Gimli::Config] config\n Convert the file and save it as a PDF file", "Rewrite relative image urls to absolute\n @param [String] html some html to parse\n @return [String] the html with all image urls replaced to absolute", "Create the pdf\n @param [String] html the html input\n @param [String] filename the name of the output file", "Load the stylesheets to pdfkit loads the default and the user selected if any", "Generate the name of the output file\n @return [String]\n @param [Gimli::MarkupFile] file optionally, specify a file, otherwise use output filename", "Generate cover file if optional cover was given", "Find all of the events associated with this calendar that start in the given time frame.\n The lower bound is inclusive, whereas the upper bound is exclusive.\n Events that overlap the range are included.\n\n the +options+ parameter accepts\n :max_results => the maximum number of results to return defaults to 25 the largest number Google accepts is 2500\n :order_by => how you would like the results ordered, can be either 'startTime' or 'updated'. Defaults to 'startTime'. Note: it must be 'updated' if expand_recurring_events is set to false.\n :expand_recurring_events => When set to true each instance of a recurring event is returned. Defaults to true.\n\n  Returns:\n   an empty array if nothing found.\n   an array with one element if only one found.\n   an array of events if many found.", "Find all events that match at least one of the specified extended properties.\n\n the +extended_properties+ parameter is set up the same way that it is configured when creating an event\n for example, providing the following hash { 'shared' => {'p1' => 'v1', 'p2' => v2} } will return the list of events\n that contain either v1 for shared extended property p1 or v2 for p2.\n\n the +options+ parameter accepts\n :max_results => the maximum number of results to return defaults to 25 the largest number Google accepts is 2500\n :order_by => how you would like the results ordered, can be either 'startTime' or 'updated'. Defaults to 'startTime'. Note: it must be 'updated' if expand_recurring_events is set to false.\n :expand_recurring_events => When set to true each instance of a recurring event is returned. Defaults to true.\n\n  Returns:\n   an empty array if nothing found.\n   an array with one element if only one found.\n   an array of events if many found.", "Find all events that match at least one of the specified extended properties within a given time frame.\n The lower bound is inclusive, whereas the upper bound is exclusive.\n Events that overlap the range are included.\n\n the +extended_properties+ parameter is set up the same way that it is configured when creating an event\n for example, providing the following hash { 'shared' => {'p1' => 'v1', 'p2' => v2} } will return the list of events\n that contain either v1 for shared extended property p1 or v2 for p2.\n\n the +options+ parameter accepts\n :max_results => the maximum number of results to return defaults to 25 the largest number Google accepts is 2500\n :order_by => how you would like the results ordered, can be either 'startTime' or 'updated'. Defaults to 'startTime'. Note: it must be 'updated' if expand_recurring_events is set to false.\n :expand_recurring_events => When set to true each instance of a recurring event is returned. Defaults to true.\n\n  Returns:\n   an empty array if nothing found.\n   an array with one element if only one found.\n   an array of events if many found.", "Looks for the specified event id.\n If it is found it, updates it's vales and returns it.\n If the event is no longer on the server it creates a new one with the specified values.\n Works like the create_event method.", "Saves the specified event.\n This is a callback used by the Event class.", "Utility method used to centralize the parsing of common query parameters.", "Utility method used to centralize the parsing of extended query parameters.", "Utility method used to centralize event lookup.", "Prepare the JSON", "Send a request to google.", "Utility method to centralize handling of 403 errors.", "Returns whether the Event is an all-day event, based on whether the event starts at the beginning and ends at the end of the day.", "Google JSON representation of an event object.", "Hash representation of attendees", "Hash representation of local timezone", "Hash representation of recurrence rules for repeating events", "Setup and connect to the user's list of Google Calendars.\n\n The +params+ parameter accepts\n * :client_id => the client ID that you received from Google after registering your application with them (https://console.developers.google.com/). REQUIRED\n * :client_secret => the client secret you received from Google after registering your application with them. REQUIRED\n * :redirect_url => the url where your users will be redirected to after they have successfully permitted access to their calendars. Use 'urn:ietf:wg:oauth:2.0:oob' if you are using an 'application'\" REQUIRED\n * :refresh_token => if a user has already given you access to their calendars, you can specify their refresh token here and you will be 'logged on' automatically (i.e. they don't need to authorize access again). OPTIONAL\n\n See Readme.rdoc or readme_code.rb for an explication on the OAuth2 authorization process.\n\n\n Find all entries on the user's calendar list. Returns an array of CalendarListEntry objects.", "Save current container attribute values to redis", "Delete current container data from redis", "Reflect the fact that a job has been killed in redis", "Merge-in given data to the current container\n\n @private\n @param [Hash] data", "Dump current container attribute values to json-serializable hash\n\n @private\n @return [Hash] Data for subsequent json-serialization", "Conversations\n Send a conversation message", "Start a conversation", "Create a new message.", "Create a new voice message.", "Dynamically call generate_n_words or generate_n_sentences\n if an Int is substituted for the n in the method call.\n\n @since 0.1.4\n @example Generate a 40 and a 1 word long string of words.\n   markov.generate_40_words\n   markov.generate_1_word\n @example Generate 2 sentences\n   markov.generate_2_sentences\n @return [String] the sentence generated by the dictionary.", "Run the event loop and dispatch events back to Ruby.  If there\n are no watchers associated with the event loop it will return\n immediately.  Otherwise, run will continue blocking and making\n event callbacks to watchers until all watchers associated with\n the loop have been disabled or detached.  The loop may be\n explicitly stopped by calling the stop method on the loop object.", "Read from the input buffer and dispatch to on_read", "Write the contents of the output buffer", "Send a request to the DNS server", "Called by the subclass when the DNS response is available", "Called by precreate during asyncronous DNS resolution", "Connect to the given host and port using the given connection class", "Look up a connection class by its name", "\"Safely\" read the contents of a file on disk, catching any permission\n errors or not found errors and raising a nicer exception.\n\n @example Reading a file that does not exist\n   safe_read('/non-existent/file') #=> Error::FileNotFound\n\n @example Reading a file with improper permissions\n   safe_read('/bad-permissions') #=> Error::InsufficientFilePermissions\n\n @example Reading a regular file\n   safe_read('my-file.txt') #=> [\"my-file\", \"...\"]\n\n @param [String] path\n   the path to the file on disk\n\n @return [Array<String>]\n   A array where the first value is the basename of the file and the\n   second value is the literal contents from +File.read+.", "Quickly iterate over a collection using native Ruby threads, preserving\n the original order of elements and being all thread-safe and stuff.\n\n @example Parse a collection of JSON files\n\n   fast_collect(Dir['**/*.json']) do |item|\n     JSON.parse(File.read(item))\n   end\n\n @param [#each] collection\n   the collection to iterate\n @param [Proc] block\n   the block to evaluate (typically an expensive operation)\n\n @return [Array]\n   the result of the iteration", "Commit the resource and any changes to the remote Chef Server. Any errors\n will raise an exception in the main thread and the resource will not be\n committed back to the Chef Server.\n\n Any response errors (such as server-side responses) that ChefAPI failed\n to account for in validations will also raise an exception.\n\n @return [Boolean]\n   true if the resource was saved", "Update a single attribute in the attributes hash.\n\n @raise", "Run all of this resource's validations, raising an exception if any\n validations fail.\n\n @raise [Error::InvalidResource]\n   if any of the validations fail\n\n @return [Boolean]\n   true if the validation was successful - this method will never return\n   anything other than true because an exception is raised if validations\n   fail", "Determine if the current resource is valid. This relies on the\n validations defined in the schema at initialization.\n\n @return [Boolean]\n   true if the resource is valid, false otherwise", "Calculate a differential of the attributes on the local resource with\n it's remote Chef Server counterpart.\n\n @example when the local resource is in sync with the remote resource\n   bacon = Bacon.first\n   bacon.diff #=> {}\n\n @example when the local resource differs from the remote resource\n   bacon = Bacon.first\n   bacon.description = \"My new description\"\n   bacon.diff #=> { :description => { :local => \"My new description\", :remote => \"Old description\" } }\n\n @note This is a VERY expensive operation - use it sparringly!\n\n @return [Hash]", "The hash representation of this resource. All attributes are serialized\n and any values that respond to +to_hash+ are also serialized.\n\n @return [Hash]", "Custom inspect method for easier readability.\n\n @return [String]", "Overload the super method to capture the type attribute in the options\n hash.", "Hash the given object.\n\n @param [String, IO] object\n   a string or IO object to hash\n\n @return [String]\n   the hashed value\n\n\n Digest the given IO, reading in 1024 bytes at one time.\n\n @param [IO] io\n   the IO (or File object)\n\n @return [String]", "Fetch a specific resource in the collection by id.\n\n @example Fetch a resource\n   Bacon.first.items.fetch('crispy')\n\n @param [String, Symbol] id\n   the id of the resource to fetch\n\n @return [Resource::Base, nil]\n   the fetched class, or nil if it does not exists", "The custom iterator for looping over each object in this collection. For\n more information, please see the +Enumerator+ module in Ruby core.", "The detailed string representation of this collection proxy.\n\n @return [String]", "Adds the default headers to the request object.\n\n @param [Net::HTTP::Request] request", "DSL method for defining an attribute.\n\n @param [Symbol] key\n   the key to use\n @param [Hash] options\n   a list of options to create the attribute with\n\n @return [Symbol]\n   the attribute", "Returns the original version number that this version was.", "Updates the last version's changes by appending the current version changes.", "Adds the instance methods required to reset an object to a previous version.\n Similar to +revert_to!+, the +reset_to!+ method reverts an object to a previous version,\n only instead of creating a new record in the version history, +reset_to!+ deletes all of\n the version history that occurs after the version reverted to.\n\n The action taken on each version record after the point of reversion is determined by the\n <tt>:dependent</tt> option given to the +versioned+ method. See the +versioned+ method\n documentation for more details.", "Adds an instance method which allows version tagging through the parent object.\n Accepts a single string argument which is attached to the version record associated with\n the current version number of the parent object.\n\n Returns the given tag if successful, nil if not. Tags must be unique within the scope of\n the parent object. Tag creation will fail if non-unique.\n\n Version records corresponding to version number 1 are not typically created, but one will\n be built to house the given tag if the parent object's current version number is 1.", "Accepts a value corresponding to a specific version record, builds a history of changes\n between that version and the current version, and then iterates over that history updating\n the object's attributes until the it's reverted to its prior state.\n\n The single argument should adhere to one of the formats as documented in the +at+ method of\n VestalVersions::Versions.\n\n After the object is reverted to the target version, it is not saved. In order to save the\n object after the reversion, use the +revert_to!+ method.\n\n The version number of the object will reflect whatever version has been reverted to, and\n the return value of the +revert_to+ method is also the target version number.", "Consume all new events", "Register a handler for reporting of stack events.\n @param [Proc] event_handler", "Create or update the stack.\n\n @param [Hash] options create/update options\n   accepts a superset of the options supported by\n   +Aws::CloudFormation::Stack#update+\n   (see http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Stack.html#update-instance_method)\n @option options [Array<String>] :capabilities (CAPABILITY_NAMED_IAM)\n   list of capabilities required for stack template\n @option options [boolean] :disable_rollback (false)\n   if true, disable rollback if stack creation fails\n @option options [String] :notification_arns\n   ARNs for the Amazon SNS topics associated with this stack\n @option options [String] :on_failure (ROLLBACK)\n   if stack creation fails: DO_NOTHING, ROLLBACK, or DELETE\n @option options [Hash, Array<Hash>] :parameters\n   stack parameters, either as a Hash, or an Array of\n   +Aws::CloudFormation::Types::Parameter+ structures\n @option options [Hash, Array<Hash>] :tags\n   stack tags, either as a Hash, or an Array of\n   +Aws::CloudFormation::Types::Tag+ structures\n @option options [Array<String>] :resource_types\n   resource types that you have permissions to work with\n @option options [Hash] :stack_policy\n   stack policy, as Ruby data\n @option options [String] :stack_policy_body\n   stack policy, as JSON\n @option options [String] :stack_policy_url\n   location of stack policy\n @option options [Hash] :stack_policy_during_update\n   temporary stack policy, as Ruby data\n @option options [String] :stack_policy_during_update_body\n   temporary stack policy, as JSON\n @option options [String] :stack_policy_during_update_url\n   location of temporary stack policy\n @option options [Hash] :template\n   stack template, as Ruby data\n @option options [String] :template_body\n   stack template, as JSON or YAML\n @option options [String] :template_url\n   location of stack template\n @option options [Integer] :timeout_in_minutes\n   stack creation timeout\n @option options [boolean] :use_previous_template\n   if true, reuse the existing template\n @return [String] resulting stack status\n @raise [Stackup::StackUpdateError] if operation fails", "Execute a block, to modify the stack.\n\n @return the stack status", "Execute a block, reporting stack events, until the stack is stable.\n\n @return the final stack status", "Extract data from a collection attribute of the stack.\n\n @param [Symbol] collection_name collection attribute name\n @param [Symbol] key_name name of item attribute that provides key\n @param [Symbol] value_name name of item attribute that provides value\n @return [Hash<String, String>] mapping of collection", "Create the change-set.\n\n Refer +Aws::CloudFormation::Client#create_change_set+\n   (see http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html#create_change_set-instance_method)\n\n @param [Hash] options change-set options\n @option options [Array<String>] :capabilities (CAPABILITY_NAMED_IAM)\n   list of capabilities required for stack template\n @option options [String] :description\n   change-set description\n @option options [String] :notification_arns\n   ARNs for the Amazon SNS topics associated with this stack\n @option options [Hash, Array<Hash>] :parameters\n   stack parameters, either as a Hash, or an Array of\n   +Aws::CloudFormation::Types::Parameter+ structures\n @option options [Hash, Array<Hash>] :tags\n   stack tags, either as a Hash, or an Array of\n   +Aws::CloudFormation::Types::Tag+ structures\n @option options [Array<String>] :resource_types\n   resource types that you have permissions to work with\n @option options [Hash] :template\n   stack template, as Ruby data\n @option options [String] :template_body\n   stack template, as JSON or YAML\n @option options [String] :template_url\n   location of stack template\n @option options [boolean] :use_previous_template\n   if true, reuse the existing template\n @option options [boolean] :force\n   if true, delete any existing change-set of the same name\n\n @return [String] change-set id\n @raise [Stackup::NoSuchStack] if the stack doesn't exist", "should take user and options args here ???", "This is the central method. It does the actual request to the flickr server.\n\n Raises FailedResponse if the response status is _failed_.", "Get an oauth access token.\n\n  flickr.get_access_token(token['oauth_token'], token['oauth_token_secret'], oauth_verifier)", "This method is used to capture content from an ERB filter evaluation. It\n is useful to helpers that need to process chunks of data during ERB filter\n processing.\n\n ==== Parameters\n *args:: Arguments to pass to the block.\n &block:: The ERB block to call.\n\n ==== Returns\n String:: The output of the block.\n\n ==== Examples\n Capture being used in an ERB page:\n\n   <% @foo = capture_erb do %>\n     <p>Some Foo content!</p>\n   <% end %>", "use it to dump content before erb merge", "Initialzie ltree for active model\n\n @param column [String] ltree column name", "Re-generate .rubocop_todo.yml and run git commit.\n\n @return [Array<String>]\n  Returns the versions of RuboCop which created \".rubocop_todo.yml\" before\n  and after re-generate.", "Run rubocop challenge.\n\n @param before_version [String]\n   The version of RuboCop which created \".rubocop_todo.yml\" before\n   re-generate.\n @param after_version [String]\n   The version of RuboCop which created \".rubocop_todo.yml\" after\n   re-generate\n @return [Rubocop::Rule]\n   The corrected rule\n @raise [Errors::NoAutoCorrectableRule]\n   Raises if there is no auto correctable rule in \".rubocop_todo.yml\"", "If still exist the rule after a challenge, the rule regard as cannot\n correct automatically then add to ignore list and it is not chosen as\n target rule from next time.\n\n @param rule [Rubocop::Rule] The corrected rule", "Checks the challenge result. If the challenge is successed, the rule\n should not exist in the \".rubocop_todo.yml\" after regenerate.\n\n @param rule [Rubocop::Rule] The corrected rule\n @return [Boolean] Return true if the challenge successed", "Creates a pull request for the Rubocop Challenge\n\n @param rule [Rubocop::Rule]\n   The corrected rule\n @param template_file_path [String, nil]\n   The template file name which use to generate the pull request body\n @return [Boolean]\n   Return true if its successed", "Creates a pull request which re-generate \".rubocop_todo.yml\" with new\n version RuboCop.\n\n @param before_version [String]\n   The version of RuboCop which created \".rubocop_todo.yml\" before\n   re-generate.\n @param after_version [String]\n   The version of RuboCop which created \".rubocop_todo.yml\" after\n   re-generate\n @return [Boolean]\n   Return true if its successed", "Visualization method for printing out the top +words_per_topic+ words\n for each topic.\n\n See also +top_words+.", "String representation displaying current settings.", "Call the method of the same name defined in the next delegate stored in your object\n\n Because Casting creates an alternative method lookup path using a collection of delegates,\n you may use `super_delegate` to work like `super`.\n\n If you use this feature, be sure that you have created a delegate collection which does\n have the method you need or you'll see a NoMethodError.\n\n Example:\n\n module Greeter\n   def greet\n     \"Hello\"\n   end\n end\n\n module FormalGreeter\n   include Casting::Super\n\n   def greet\n     \"#{super_delegate}, how do you do?\"\n   end\n end\n\n some_object.cast_as(Greeter, FormalGreeter)\n some_object.greet #=> 'Hello, how do you do?'", "This returns the \"merch month\" number for a date\n Month 1 is Feb for the retail calendar\n Month 1 is August for the fiscal calendar\n\n @return [Integer]", "The the first date of the retail year\n\n @param year [Integer] the retail year\n @return [Date] the first date of the retail year", "The starting date of the given merch month\n\n @param year [Integer] the retail year\n @param merch_month [Integer] the nth merch month of the retail calendar\n @return [Date] the start date of the merch month", "Return the starting date for a particular quarter\n\n @param year [Integer] the retail year\n @param quarter [Integer] the quarter of the year, a number from 1 - 4\n @return [Date] the start date of the quarter", "Return the ending date for a particular quarter\n\n @param year [Integer] the retail year\n @param quarter [Integer] the quarter of the year, a number from 1 - 4\n @return [Date] the end date of the quarter", "Given any julian date it will return what retail year it belongs to\n\n @param date [Date] the julian date to convert to its Retail Year\n @return [Integer] the retail year that the julian date falls into", "Given beginning and end dates it will return an array of Retail Month's Start date\n\n @param start_date [Date] the starting date\n @param end_date [Date] the ending date\n @return [Array] Array of start dates of each Retail Month from given dates", "Returns an array of Merch Weeks that pertains to the Julian Month of a Retail Year\n\n @param year [Integer] the Retail year\n @param month_param [Integer] the julian month\n @return [Array] Array of MerchWeeks", "Given any julian date it will return what Fiscal Year it belongs to\n\n @param date [Date] the julian date to convert to its Fiscal Year\n @return [Integer] the fiscal year that the julian date falls into", "Given beginning and end dates it will return an array of Fiscal Month's Start date\n\n @param start_date [Date] the starting date\n @param end_date [Date] the ending date\n @return [Array] Array of start dates of each Fiscal Month from given dates", "Returns an array of merch_months and year combination that falls in and between the start and end date\n\n Ex: if start_date = August 1, 2018 and end_date = October 1, 2018\n it returns [[2019, 1], [ 2019, 2], [2019, 3]]", "The start date of the week\n\n @param year [Integer] the merch year\n @param month [Integer] an integer specifying the julian month.\n @param week [Integer] an integer specifying the merch week.\n\n @return [Date] the starting date of the specified week", "The end date of the week\n\n @param year [Integer] the merch year\n @param month [Integer] an integer specifying the julian month.\n @param week [Integer] an integer specifying the merch week.\n\n @return [Date] the ending date of the specified week", "The start date of the month\n\n @example\n  # The following are all equivalent, and refer to May 2015\n  MerchCalendar.start_of_month(2015, 5)\n  MerchCalendar.start_of_month(2015, month: 5)\n  MerchCalendar.start_of_month(2015, julian_month: 5)\n  MerchCalendar.start_of_month(2015, merch_month: 4)\n\n @param year [Integer] the merch year\n @param month_param [Integer,Hash] an integer specifying the julian month. This can also be a named hash\n @option month_param [Integer] :month the julian month\n @option month_param [Integer] :julian_month the julian month\n @option month_param [Integer] :merch_month the MERCH month\n\n @return [Date] the starting date of the specified month", "The end date of the month\n\n @param year [Integer] the merch year\n @param month_param [Hash] month hash\n\n @see #start_of_month The start_of_month method for examples using month_param\n\n @return [Date]", "adding mount point to base class", "Validate each property_type's property.\n\n If the property_type doesn't respond to valid?, then it means it must be a\n native type, or at least not something which inherits Ninetails::Property, so we will class it\n as valid blindly.", "Because the submitted data is always strings, send everything through virtus attrs so it\n gets cast to the correct class.\n\n Then, use the newly cast attributes to store in the settings json blob", "Validate all sections and rebuild the sections array with the instances which now\n contain error messages", "Check the url is unique across revisions, but only if a container has a matching revision\n set as its `current_revision`. Otherwise it'd be impossible to change one page's url\n to a url which was previously used by another page in the past.", "Add a formatter for a class. The formatter can be specified as either an object\n that responds to the +call+ method or as a symbol representing one of the predefined\n formatters, or as a block to the method call.\n\n The predefined formatters are: <tt>:inspect</tt>, <tt>:string</tt>, <tt>:exception</tt>, and <tt>:pretty_print</tt>.\n\n === Examples\n\n   # Use a predefined formatter\n   formatter.add(MyClass, :pretty_print)\n\n   # Pass in a formatter object\n   formatter.add(MyClass, Lumberjack::Formatter::PrettyPrintFormatter.new)\n\n   # Use a block\n   formatter.add(MyClass){|obj| obj.humanize}\n\n   # Add statements can be chained together\n   formatter.add(MyClass, :pretty_print).add(YourClass){|obj| obj.humanize}", "Find the formatter for a class by looking it up using the class hierarchy.", "Add a message to the log with a given severity. The message can be either\n passed in the +message+ argument or supplied with a block. This method\n is not normally called. Instead call one of the helper functions\n +fatal+, +error+, +warn+, +info+, or +debug+.\n\n The severity can be passed in either as one of the Severity constants,\n or as a Severity label.\n\n === Example\n\n   logger.add(Lumberjack::Severity::ERROR, exception)\n   logger.add(Lumberjack::Severity::INFO, \"Request completed\")\n   logger.add(:warn, \"Request took a long time\")\n   logger.add(Lumberjack::Severity::DEBUG){\"Start processing with options #{options.inspect}\"}", "Set a local value for a thread tied to this object.", "Set a local value for a thread tied to this object within a block.", "Open a logging device.", "Create a thread that will periodically call flush.", "Compile the template string into a value that can be used with sprintf.", "used by host.clone", "Returns the timestamp used to generate this UUID", "Generates a string representation for this UUID.\n\n @api private", "Initializes a Resource with the given data.\n\n agent - The Sawyer::Agent that made the API request.\n data  - Hash of key/value properties.\n Processes an individual value of this resource.  Hashes get exploded\n into another Resource, and Arrays get their values processed too.\n\n value - An Object value of a Resource's data.\n\n Returns an Object to set as the value of a Resource key.", "Provides access to a resource's attributes.", "Makes a request through Faraday.\n\n method  - The Symbol name of an HTTP method.\n url     - The String URL to access.  This can be relative to the Agent's\n           endpoint.\n data    - The Optional Hash or Resource body to be sent.  :get or :head\n           requests can have no body, so this can be the options Hash\n           instead.\n options - Hash of option to configure the API request.\n           :headers - Hash of API headers to set.\n           :query   - Hash of URL query params to set.\n\n Returns a Sawyer::Response.", "Turns parsed contents from an API response into a Resource or\n collection of Resources.\n\n data - Either an Array or Hash parsed from JSON.\n\n Returns either a Resource or Array of Resources.", "Finds link relations from 'Link' response header\n\n Returns an array of Relations", "Assume the worst", "Initialize with the password\n\n @param [String] password\n @param [Integer] size\n @param [String] mode", "Expects a public key at the minumum\n\n @param [#to_s] key public or private\n @param [String] passphrase to key\n\n Encrypt data using the key\n\n @param [#to_s] data\n @param [Hash] opts\n @option opts [Boolean] :binary (false) encode the data in binary, not Base64", "Decrypt data using the key\n\n @param [#to_s] data\n @param [Hash] opts\n @option opts [Boolean] :binary (false) don't decode the data as Base64", "When invoked, it enriches the current model with the\n class and instance methods to act as api.", "Adds a field to the api template\n\n The value passed can be one of the following:\n  * Symbol - the method with the same name will be called on the model when rendering.\n  * String - must be in the form \"method1.method2.method3\", will call this method chain.\n  * Hash - will be added as a sub hash and all its items will be resolved the way described above.\n\n Possible options to pass:\n  * :template - Determine the template that should be used to render the item if it is\n    +api_accessible+ itself.", "Decides if the passed item should be added to\n the response based on the conditional options passed.", "Generates a hash that represents the api response based on this\n template for the passed model instance.", "Provides an alternative to the +render+ method used within the controller\n to simply generate API outputs.\n\n The default Rails serializers are used to serialize the data.", "The collection checks all its items if they respond to the +as_api_response+ method.\n If they do, the result of this method will be collected.\n If they don't, the item itself will be collected.", "Provide a conditionnal block\n\n condition(->(u) { u.is_a?(Admin) }) do\n   attributes :secret\n end", "Make sure that we have a readable configuration file. The @jammit@\n command can't run without one.", "Creating a new Packager will rebuild the list of assets from the\n Jammit.configuration. When assets.yml is being changed on the fly,\n create a new Packager.\n Ask the packager to precache all defined assets, along with their gzip'd\n versions. In order to prebuild the MHTML stylesheets, we need to know the\n base_url, because IE only supports MHTML with absolute references.\n Unless forced, will only rebuild assets whose source files have been\n changed since their last package build.", "Caches a single prebuilt asset package and gzips it at the highest\n compression level. Ensures that the modification time of both both\n variants is identical, for web server caching modules, as well as MHTML.", "Return the compressed contents of a stylesheet package.", "Look up a package asset list by name, raising an exception if the\n package has gone missing.", "The \"package\" action receives all requests for asset packages that haven't\n yet been cached. The package will be built, cached, and gzipped.", "If embed_assets is turned on, writes out links to the Data-URI and MHTML\n versions of the stylesheet package, otherwise the package is regular\n compressed CSS, and in development the stylesheet URLs are passed verbatim.", "Writes out the URL to the bundled and compressed javascript package,\n except in development, where it references the individual scripts.", "HTML tags, in order, for all of the individual stylesheets.", "HTML tags for the stylesheet packages.", "HTML tags for the 'datauri', and 'mhtml' versions of the packaged\n stylesheets, using conditional comments to load the correct variant.", "Generate the stylesheet tags for a batch of packages, with options, by\n yielding each package to a block.", "Compiles a single JST file by writing out a javascript that adds\n template properties to a top-level template namespace object. Adds a\n JST-compilation function to the top of the package, unless you've\n specified your own preferred function, or turned it off.\n JST templates are named with the basename of their file.", "Given a set of paths, find a common prefix path.", "In order to support embedded assets from relative paths, we need to\n expand the paths before contatenating the CSS together and losing the\n location of the original stylesheet path. Validate the assets while we're\n at it.", "Get the site-absolute public path for an asset file path that may or may\n not be relative, given the path of the stylesheet that contains it.", "Similar to the AssetTagHelper's method of the same name, this will\n determine the correct asset id for a file.", "An asset is valid for embedding if it exists, is less than 32K, and is\n stored somewhere inside of a folder named \"embed\". IE does not support\n Data-URIs larger than 32K, and you probably shouldn't be embedding assets\n that large in any case. Because we need to check the base64 length here,\n save it so that we don't have to compute it again later.", "Return the Base64-encoded contents of an asset on a single line.", "abstraction over Bot.deliver to send messages declaratively and directly", "Changes the file's dylib ID to `new_id`. If the file is not a dylib,\n  does nothing.\n @example\n  file.change_dylib_id('libFoo.dylib')\n @param new_id [String] the new dylib ID\n @param options [Hash]\n @option options [Boolean] :strict (true) if true, fail if one slice fails.\n  if false, fail only if all slices fail.\n @return [void]\n @raise [ArgumentError] if `new_id` is not a String\n @see MachOFile#linked_dylibs", "Changes all dependent shared library install names from `old_name` to\n `new_name`. In a fat file, this changes install names in all internal\n Mach-Os.\n @example\n  file.change_install_name('/usr/lib/libFoo.dylib', '/usr/lib/libBar.dylib')\n @param old_name [String] the shared library name being changed\n @param new_name [String] the new name\n @param options [Hash]\n @option options [Boolean] :strict (true) if true, fail if one slice fails.\n  if false, fail only if all slices fail.\n @return [void]\n @see MachOFile#change_install_name", "Change the runtime path `old_path` to `new_path` in the file's Mach-Os.\n @param old_path [String] the old runtime path\n @param new_path [String] the new runtime path\n @param options [Hash]\n @option options [Boolean] :strict (true) if true, fail if one slice fails.\n  if false, fail only if all slices fail.\n @return [void]\n @see MachOFile#change_rpath", "Add the given runtime path to the file's Mach-Os.\n @param path [String] the new runtime path\n @param options [Hash]\n @option options [Boolean] :strict (true) if true, fail if one slice fails.\n  if false, fail only if all slices fail.\n @return [void]\n @see MachOFile#add_rpath", "Delete the given runtime path from the file's Mach-Os.\n @param path [String] the runtime path to delete\n @param options [Hash]\n @option options [Boolean] :strict (true) if true, fail if one slice fails.\n  if false, fail only if all slices fail.\n @return void\n @see MachOFile#delete_rpath", "Obtain the fat header from raw file data.\n @return [Headers::FatHeader] the fat header\n @raise [TruncatedFileError] if the file is too small to have a\n  valid header\n @raise [MagicError] if the magic is not valid Mach-O magic\n @raise [MachOBinaryError] if the magic is for a non-fat Mach-O file\n @raise [JavaClassFileError] if the file is a Java classfile\n @api private", "Obtain an array of fat architectures from raw file data.\n @return [Array<Headers::FatArch>] an array of fat architectures\n @api private", "Obtain an array of Mach-O blobs from raw file data.\n @return [Array<MachOFile>] an array of Mach-Os\n @api private", "Repopulate the raw Mach-O data with each internal Mach-O object.\n @return [void]\n @api private", "Yield each Mach-O object in the file, rescuing and accumulating errors.\n @param options [Hash]\n @option options [Boolean] :strict (true) whether or not to fail loudly\n  with an exception if at least one Mach-O raises an exception. If false,\n  only raises an exception if *all* Mach-Os raise exceptions.\n @raise [RecoverableModificationError] under the conditions of\n  the `:strict` option above.\n @api private", "Inserts a load command at the given offset.\n @param offset [Integer] the offset to insert at\n @param lc [LoadCommands::LoadCommand] the load command to insert\n @param options [Hash]\n @option options [Boolean] :repopulate (true) whether or not to repopulate\n  the instance fields\n @raise [OffsetInsertionError] if the offset is not in the load command region\n @raise [HeaderPadError] if the new command exceeds the header pad buffer\n @note Calling this method with an arbitrary offset in the load command\n  region **will leave the object in an inconsistent state**.", "Replace a load command with another command in the Mach-O, preserving location.\n @param old_lc [LoadCommands::LoadCommand] the load command being replaced\n @param new_lc [LoadCommands::LoadCommand] the load command being added\n @return [void]\n @raise [HeaderPadError] if the new command exceeds the header pad buffer\n @see #insert_command\n @note This is public, but methods like {#dylib_id=} should be preferred.", "Delete a load command from the Mach-O.\n @param lc [LoadCommands::LoadCommand] the load command being deleted\n @param options [Hash]\n @option options [Boolean] :repopulate (true) whether or not to repopulate\n  the instance fields\n @return [void]\n @note This is public, but methods like {#delete_rpath} should be preferred.\n  Setting `repopulate` to false **will leave the instance in an\n  inconsistent state** unless {#populate_fields} is called **immediately**\n  afterwards.", "The segment alignment for the Mach-O. Guesses conservatively.\n @return [Integer] the alignment, as a power of 2\n @note This is **not** the same as {#alignment}!\n @note See `get_align` and `get_align_64` in `cctools/misc/lipo.c`", "Changes the Mach-O's dylib ID to `new_id`. Does nothing if not a dylib.\n @example\n  file.change_dylib_id(\"libFoo.dylib\")\n @param new_id [String] the dylib's new ID\n @param _options [Hash]\n @return [void]\n @raise [ArgumentError] if `new_id` is not a String\n @note `_options` is currently unused and is provided for signature\n  compatibility with {MachO::FatFile#change_dylib_id}", "Changes the shared library `old_name` to `new_name`\n @example\n  file.change_install_name(\"abc.dylib\", \"def.dylib\")\n @param old_name [String] the shared library's old name\n @param new_name [String] the shared library's new name\n @param _options [Hash]\n @return [void]\n @raise [DylibUnknownError] if no shared library has the old name\n @note `_options` is currently unused and is provided for signature\n  compatibility with {MachO::FatFile#change_install_name}", "Changes the runtime path `old_path` to `new_path`\n @example\n  file.change_rpath(\"/usr/lib\", \"/usr/local/lib\")\n @param old_path [String] the old runtime path\n @param new_path [String] the new runtime path\n @param _options [Hash]\n @return [void]\n @raise [RpathUnknownError] if no such old runtime path exists\n @raise [RpathExistsError] if the new runtime path already exists\n @note `_options` is currently unused and is provided for signature\n  compatibility with {MachO::FatFile#change_rpath}", "Add the given runtime path to the Mach-O.\n @example\n  file.rpaths # => [\"/lib\"]\n  file.add_rpath(\"/usr/lib\")\n  file.rpaths # => [\"/lib\", \"/usr/lib\"]\n @param path [String] the new runtime path\n @param _options [Hash]\n @return [void]\n @raise [RpathExistsError] if the runtime path already exists\n @note `_options` is currently unused and is provided for signature\n  compatibility with {MachO::FatFile#add_rpath}", "Delete the given runtime path from the Mach-O.\n @example\n  file.rpaths # => [\"/lib\"]\n  file.delete_rpath(\"/lib\")\n  file.rpaths # => []\n @param path [String] the runtime path to delete\n @param _options [Hash]\n @return void\n @raise [RpathUnknownError] if no such runtime path exists\n @note `_options` is currently unused and is provided for signature\n  compatibility with {MachO::FatFile#delete_rpath}", "The file's Mach-O header structure.\n @return [Headers::MachHeader] if the Mach-O is 32-bit\n @return [Headers::MachHeader64] if the Mach-O is 64-bit\n @raise [TruncatedFileError] if the file is too small to have a valid header\n @api private", "Read just the file's magic number and check its validity.\n @return [Integer] the magic\n @raise [MagicError] if the magic is not valid Mach-O magic\n @raise [FatBinaryError] if the magic is for a Fat file\n @api private", "All load commands in the file.\n @return [Array<LoadCommands::LoadCommand>] an array of load commands\n @raise [LoadCommandError] if an unknown load command is encountered\n @api private", "Updates the number of load commands in the raw data.\n @param ncmds [Integer] the new number of commands\n @return [void]\n @api private", "Updates the size of all load commands in the raw data.\n @param size [Integer] the new size, in bytes\n @return [void]\n @api private", "MOVE\n to method scanner class", "Executes a request, validates and returns the response.\n\n @param  [String] method The HTTP method\n @param  [String] path The path, relative to {#base_url}\n @param  [Hash] data The body for the request\n @param  [Hash] options The query and header params for the request\n @return [HTTParty::Response]\n @raise  [RequestError]\n @raise  [NotFoundError]\n @raise  [AuthenticationFailed]\n @raise  [TwoFactorAuthenticationRequired]", "Make a HTTP request.\n\n This method doesn't validate the response and never raise errors\n even in case of HTTP error codes, except for connection errors raised by\n the underlying HTTP client.\n\n Therefore, it's up to the caller to properly handle and validate the response.\n\n @param  [String] method The HTTP method\n @param  [String] path The path, relative to {#base_url}\n @param  [Hash] data The body for the request\n @param  [Hash] options The query and header params for the request\n @return [HTTParty::Response]", "for reverse proxy.", "for view selector", "answer will delegate its validation to question, and question\n will inturn add validations on answer on the fly!", "cache each section of diary\n used in update_proc", "categorize sections of category of years\n\n {\"category\" => {\"yyyymmdd\" => [[idx, title, excerpt], ...], ...}, ...}", "categorize sections of diary\n\n {\"category\" => {\"yyyymmdd\" => [[idx, title, excerpt], ...]}}", "FIXME rename method name to more suitable one.", "FIXME dirty hack", "loading tdiary.conf in @data_path.", "loading tdiary.conf in current directory", "Calls the class method close! in each note\n Sometimes notes need to finish their work even after being read\n This method allows this kind of work", "Process notes to get javascript code to close them.\n This method is only used when multiple_notes is false.", "Helper that creates the link and javascript code when note is clicked", "Spawns a number of threads with persistent HTTP connection to the specified URI.\n Sets a default timeout of 60 seconds.\n Create an asynchronous request and response package, put it in the pending queue, and return the response object.", "Returns PredictionIO's status in string.", "Get a hash presentation of the image.", "Dispatch to EXIF.  When no EXIF data is available but the\n +method+ does exist for EXIF data +nil+ will be returned.", "Dispatch to first image.", "Get GPS location, altitude and image direction return nil when not available.", "To be run in a `before_filter`; ensure this controller action is allowed for the user\n Can be used directly within a controller action as well, given an instance or class with or\n without options to delegate to the authorizer.\n\n @param [Class] authority_resource, the model class associated with this controller\n @param [Hash] options, arbitrary options hash to forward up the chain to the authorizer\n @raise [MissingAction] if controller action isn't a key in `config.controller_action_map`", "Renders a static file to minimize the chances of further errors.\n\n @param [Exception] error, an error that indicates the user tried to perform a forbidden action.", "The `before_filter` that will be setup to run when the class method\n `authorize_actions_for` is called", "Since the Registry API v2 does not support a search the v1 endpoint is used\n Newer registries will fail, the v2 catalog endpoint is used", "Returns the response as a particular response_class type", "This method_missing does all the heavy lifting for the DSL", "Validates the config and resolves conflicting settings.", "Merges configs such that those earlier in the lookup chain override those\n later in the chain.", "Connect if necessary, execute the given block, retry if a recoverable error\n occurs, die if an unrecoverable error occurs.", "Gets the IMAP mailbox specified in the URI, or +nil+ if none.", "Tries to identify server implementations with certain quirks that we'll need\n to work around.", "Common setup to stablish which object this request is querying", "Used to setup the records from the selected resource that are\n going to be rendered, if authorized", "The response for index action, which can be a pagination of a\n record collection or a grouped count of attributes", "Information that gets inserted on `register_api_request` as auditing data\n about the request. Returns a Hash with UUID, URL, HTTP Headers and IP", "Method that initializes CanCanCan with the scope of\n permissions based on current key from request\n @param key [Object] a key object by APIcasso to CanCanCan with ability", "Define a new builder\n\n @example a simple builder\n   MyFactory.define(:user) do |f|\n     f.name \"Jane\"\n     f.email \"jane@doe.org\"\n   end\n\n @example a builder using auto-generated fake values\n   MyFactory.define(:user) do |f|\n     f.name { fake(:name) }\n     f.email { fake(:internet, :email) }\n   end\n\n @example a builder using sequenced values\n   MyFactory.define(:user) do |f|\n     f.sequence(:name) { |n| \"user-#{n}\" }\n   end\n\n @example a builder using values from other attribute(s)\n   MyFactory.define(:user) do |f|\n     f.name \"Jane\"\n     f.email { |name| \"#{name.downcase}@rom-rb.org\" }\n   end\n\n @example a builder with \"belongs-to\" association\n   MyFactory.define(:group) do |f|\n     f.name \"Admins\"\n   end\n\n   MyFactory.define(:user) do |f|\n     f.name \"Jane\"\n     f.association(:group)\n   end\n\n @example a builder with \"has-many\" association\n   MyFactory.define(:group) do |f|\n     f.name \"Admins\"\n     f.association(:users, count: 2)\n   end\n\n   MyFactory.define(:user) do |f|\n     f.sequence(:name) { |n| \"user-#{n}\" }\n   end\n\n @example a builder which extends another builder\n   MyFactory.define(:user) do |f|\n     f.name \"Jane\"\n     f.admin false\n   end\n\n   MyFactory.define(admin: :user) do |f|\n     f.admin true\n   end\n\n @param [Symbol, Hash<Symbol=>Symbol>] spec Builder identifier, can point to a parent builder too\n @param [Hash] opts Additional options\n @option opts [Symbol] relation An optional relation name (defaults to pluralized builder name)\n\n @return [ROM::Factory::Builder]\n\n @api public", "Get factories with a custom struct namespace\n\n @example\n   EntityFactory = MyFactory.struct_namespace(MyApp::Entities)\n\n   EntityFactory[:user]\n   # => #<MyApp::Entities::User id=2 ...>\n\n @param [Module] namespace\n\n @return [Factories]\n\n @api public", "Get the hour of the WallClock.\n @param [Symbol] system The houring system to use (either `:twelve_hour` or `:twenty_four_hour`; default `:twenty_four_hour`)\n @return [Integer] The hour component of the WallClock", "Returns the time `self` later than the given time.\n\n @param [Time] time The initial time.\n @return [Time] The time after this {Duration} has elapsed past the\n   given time.\n\n @example 5 minutes after January 1st, 2000 at noon\n   5.minutes.after(Time.new(2000, 1, 1, 12, 00, 00))\n   # => 2000-01-01 12:05:00 -0800\n\n @see #ago\n @see #before\n @see #from_now", "Convert the duration to a given unit.\n\n @param [Symbol] unit The unit to convert to. See {UNIT_ALIASES} for a list\n   of valid unit names.\n\n @return [Integer] The quantity of the given unit present in `self`. Note\n   that, if `self` cannot be represented exactly by `unit`, then the result\n   will be truncated (rounded toward 0 instead of rounding down, unlike\n   normal Ruby integer division).\n\n @raise ArgumentError if the given unit could not be resolved.\n\n @example\n   1.hour.to_unit(:minutes)\n   # => 60\n   121.seconds.to_unit(:minutes)\n   # => 2\n\n @note The duration is normalized or denormalized first, depending on the\n   unit requested. This means that, by default, the returned unit will\n   be an approximation if it cannot be represented exactly by the duration,\n   such as when converting a duration of months to seconds, or vice versa.\n\n @see #to_units", "Subtract two durations.\n\n @param [Duration] other The duration to subtract.\n\n @return [Duration] The resulting duration with each component subtracted\n   from the input duration.\n\n @example\n   1.day - 1.hour == 23.hours", "Multiply a duration by a scalar.\n\n @param [Integer] other The scalar to multiply by.\n\n @return [Duration] The resulting duration with each component multiplied\n   by the scalar.\n\n @example\n   1.day * 7 == 1.week", "Convert a duration to a human-readable string.\n\n @param [Symbol, Hash] format The format type to format the duration with.\n   `format` can either be a key from the {FORMATS} hash or a hash with\n   the same shape as `options`.\n @param [Hash, nil] options Additional options to use to override default\n   format options.\n\n @option options [Hash<Symbol, String>] :units The full list of unit names\n   to use. Keys are unit names (see {UNIT_ALIASES} for a full list) and\n   values are strings to use when converting that unit to a string. Values\n   can also be an array, where the first item of the array will be used\n   for singular unit names and the second item will be used for plural\n   unit names. Note that this option will completely override the input\n   formats' list of names, so all units that should be used must be\n   specified!\n @option options [String] :separator The separator to use between a unit\n   quantity and the unit's name. For example, the string `\"1 second\"` uses\n   a separator of `\" \"`.\n @option options [String] :delimiter The delimiter to use between separate\n   units. For example, the string `\"1 minute, 1 second\"` uses a separator\n   of `\", \"`\n @option options [Integer, nil, :all] :count The number of significant\n   units to use in the string, or `nil` / `:all` to use all units.\n   For example, if the given duration is `1.day 1.week 1.month`, and\n   `options[:count]` is 2, then the resulting string will only include\n   the month and the week components of the string.\n\n @return [String] The duration formatted as a string.", "Convert a Duration to a human-readable string using a rounded value.\n\n By 'rounded', we mean that the resulting value is rounded up if the input\n includes a value of more than half of one of the least-significant unit to\n be returned. For example, `(17.hours 43.minutes 31.seconds)`, when rounded\n to two units (hours and minutes), would return \"17 hours, 44 minutes\". By\n contrast, `#to_s`, with a `:count` option of 2, would return a value of\n \"17 hours, 43 minutes\": truncating, rather than rounding.\n\n Note that this method overloads the meaning of the `:count` option value\n as documented below. If the passed-in option value is numeric, it will be\n honored, and rounding will take place to that number of units. If the\n value is either `:all` or the default `nil`, then _rounding_ will be done\n to two units, and the rounded value will be passed on to `#to_s` with the\n options specified (which will result in a maximum of two time units being\n output).\n\n @param [Symbol, Hash] format The format type to format the duration with.\n   `format` can either be a key from the {FORMATS} hash or a hash with\n   the same shape as `options`. The default is `:min_long`, which strongly\n   resembles `:long` with the omission of `:weeks` units and a default\n   `:count` of 2.\n @param [Hash, nil] options Additional options to use to override default\n   format options.\n\n @option options [Hash<Symbol, String>] :units The full list of unit names\n   to use. Keys are unit names (see {UNIT_ALIASES} for a full list) and\n   values are strings to use when converting that unit to a string. Values\n   can also be an array, where the first item of the array will be used\n   for singular unit names and the second item will be used for plural\n   unit names. Note that this option will completely override the input\n   formats' list of names, so all units that should be used must be\n   specified!\n @option options [String] :separator The separator to use between a unit\n   quantity and the unit's name. For example, the string `\"1 second\"` uses\n   a separator of `\" \"`.\n @option options [String] :delimiter The delimiter to use between separate\n   units. For example, the string `\"1 minute, 1 second\"` uses a separator\n   of `\", \"`\n @option options [Integer, nil, :all] :count The number of significant\n   units to use in the string, or `nil` / `:all` to use all units.\n   For example, if the given duration is `1.day 1.week 1.month`, and\n   `options[:count]` is 2, then the resulting string will only include\n   the month and the week components of the string.\n\n @return [String] The rounded duration formatted as a string.", "Given an API descriptor name and a set of request parameters, select those\n params that are accepted by the API endpoint.\n\n api  - the api descriptor name as a String\n from - the Hash containing the request params\n\n Returns a new Hash containing the valid params for the api", "Given an API descriptor name and a single request parameter, returns\n `true` if the parameter is valid for the given API. This method always\n returns `true` if the API is unknown.\n\n api   - the api descriptor name as a String\n param - the request parameter name as a String\n\n Returns `true` if the param is valid for the API.", "Given an API descriptor name and a set of request path parts, select those\n parts that are accepted by the API endpoint.\n\n api  - the api descriptor name as a String\n from - the Hash containing the path parts\n\n Returns a new Hash containing the valid path parts for the api", "Given an API descriptor name and a single path part, returns `true` if the\n path part is valid for the given API. This method always returns `true` if\n the API is unknown.\n\n api  - the api descriptor name as a String\n part - the path part name as a String\n\n Returns `true` if the path part is valid for the API.", "Select the common request parameters from the given params.\n\n from - the Hash containing the request params\n\n Returns a new Hash containing the valid common request params", "Given an API descriptor name and a set of request parameters, ensure that\n all the request parameters are valid for the API endpoint. If an invalid\n parameter is found then an IllegalArgument exception is raised.\n\n api  - the api descriptor name as a String\n from - the Hash containing the request params\n\n Returns the params unmodified\n Raises an IllegalArgument exception if an invalid parameter is found.", "Execute an array of searches in bulk. Results are returned in an\n array in the order the queries were sent.\n\n The `multi_search` method can be used in two ways. Without a block\n the method will perform an API call, and it requires a bulk request\n body and optional request parameters.\n\n See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html\n\n body   - Request body as a String (required if a block is not given)\n params - Optional request parameters as a Hash\n block  - Passed to a MultiSearch instance which assembles the searches\n          into a single request.\n\n Examples\n\n   # index and type in request body\n   multi_search(request_body)\n\n   # index in URI\n   multi_search(request_body, index: 'default-index')\n\n   # block form\n   multi_search(index: 'default-index') do |m|\n     m.search({query: {match_all: {}}, size: 0)\n     m.search({query: {field: {\"foo\" => \"bar\"}}}, type: 'default-type')\n     ...\n   end\n\n Returns the response body as a Hash", "Execute an array of percolate actions in bulk. Results are returned in an\n array in the order the actions were sent.\n\n The `multi_percolate` method can be used in two ways. Without a block\n the method will perform an API call, and it requires a bulk request\n body and optional request parameters.\n\n See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html#_multi_percolate_api\n\n body   - Request body as a String (required if a block is not given)\n params - Optional request parameters as a Hash\n block  - Passed to a MultiPercolate instance which assembles the\n          percolate actions into a single request.\n\n Examples\n\n   # index and type in request body\n   multi_percolate(request_body)\n\n   # index in URI\n   multi_percolate(request_body, index: 'default-index')\n\n   # block form\n   multi_percolate(index: 'default-index') do |m|\n     m.percolate({ author: \"pea53\" }, { type: 'default-type' })\n     m.count({ author: \"pea53\" }, { type: 'type2' })\n     ...\n   end\n\n Returns the response body as a Hash", "The `bulk` method can be used in two ways. Without a block the method\n will perform an API call, and it requires a bulk request body and\n optional request parameters. If given a block, the method will use a\n Bulk instance to assemble the operations called in the block into a\n bulk request and dispatch it at the end of the block.\n\n See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html\n\n body   - Request body as a String (required if a block is _not_ given)\n params - Optional request parameters as a Hash\n   :request_size - Optional maximum request size in bytes\n   :action_count - Optional maximum action size\n block  - Passed to a Bulk instance which assembles the operations\n          into one or more bulk requests.\n\n Examples\n\n   bulk(request_body, :index => 'default-index')\n\n   bulk(:index => 'default-index') do |b|\n     b.index(document1)\n     b.index(document2, :_type => 'default-type')\n     b.delete(document3)\n     ...\n   end\n\n Returns the response body as a Hash", "Stream bulk actions from an Enumerator.\n\n Examples\n\n   ops = [\n     [:index, document1, {:_type => \"foo\", :_id => 1}],\n     [:create, document2],\n     [:delete, {:_type => \"bar\", :_id => 42}]\n   ]\n   bulk_stream_responses(ops, :index => 'default-index').each do |response|\n     puts response\n   end\n\n Returns an Enumerator of responses.", "Stream bulk actions from an Enumerator and passes the response items to\n the given block.\n\n Examples\n\n   ops = [\n     [:index, document1, {:_type => \"foo\", :_id => 1}],\n     [:create, document2],\n     [:delete, {:_type => \"bar\", :_id => 42}]\n   ]\n   bulk_stream_items(ops, :index => 'default-index') do |item|\n     puts item\n   end\n\n   # return value:\n   # {\n   #   \"took\" => 256,\n   #   \"errors\" => false,\n   #   \"success\" => 3,\n   #   \"failure\" => 0\n   # }\n\n   # sample response item:\n   # {\n   #   \"delete\": {\n   #     \"_index\": \"foo\",\n   #     \"_type\": \"bar\",\n   #     \"_id\": \"42\",\n   #     \"_version\": 3,\n   #     \"status\": 200,\n   #     \"found\": true\n   #   }\n   # }\n\n Returns a Hash of stats about items from the responses.", "The URI for the object\n\n @note If the URI can't be made from the provided information it constructs one from the Ruby ID\n @return [String]", "Accepts a hash and returns a new hash with symbolized keys", "embedded resources are under '_embedded' in the original document, similarly to links they can\n contain an array or a single embedded resource. An embedded resource is a full document so\n we create a new HaleDeserializer for each.", "Adds an attribute to the Representor. We are creating a hash where the keys are the\n names of the attributes", "Adds a transition to the Representor, each transition is a hash of values\n The transition collection is an Array", "Adds directly an array to our array of transitions", "Creates a record with custom create method\n and returns its id.", "Updates the associated record with custom update method\n Returns the number of affected rows.", "Redeem a coupon with a given account or account code.\n\n @return [true]\n @param account_or_code [Account, String]\n @param currency [String] Three-letter currency code\n @param extra_opts [Hash] extra options that go into the {Redemption}\n @example\n   coupon = Coupon.find(coupon_code)\n   coupon.redeem(account_code, 'USD', subscription_uuid: 'ab3b1dbabc3195')\n\n   coupon = Coupon.find(coupon_code)\n   account = Account.find(account_code)\n   coupon.redeem(account)", "Generate unique coupon codes on the server. This is based on the unique_template_code.\n\n @param amount [Integer]\n @return [Pager<Coupon>] A pager that yields the coupon-code type Coupons\n @example\n   unique_codes = coupon.generate(10)\n   unique_codes.each do |c|\n     puts c.coupon_code\n   end", "Redeem a coupon on the given account code\n\n @param account_code [String] Acccount's account code\n @param currency [String] Three-letter currency code\n @raise [Invalid] If the coupon cannot be redeemed\n @return [Redemption] The Coupon Redemption", "The value of a specified attribute, lazily fetching any defined\n association.\n\n @param key [Symbol, String] The name of the attribute to be fetched.\n @example\n   account.read_attribute :first_name # => \"Ted\"\n   account[:last_name]                # => \"Beneke\"\n @see #write_attribute", "Sets the value of a specified attribute.\n\n @param key [Symbol, String] The name of the attribute to be set.\n @param value [Object] The value the attribute will be set to.\n @example\n   account.write_attribute :first_name, 'Gus'\n   account[:company_name] = 'Los Pollos Hermanos'\n @see #read_attribute", "Apply a given hash of attributes to a record.\n\n @return [Hash]\n @param attributes [Hash] A hash of attributes.", "Fetch the value of a link by following the associated href.\n\n @param key [Symbol, String] The name of the link to be followed.\n @param options [Hash] A hash of API options.\n @example\n   account.read_link :billing_info # => <Recurly::BillingInfo>", "Serializes the record to XML.\n\n @return [String] An XML string.\n @param options [Hash] A hash of XML options.\n @example\n   Recurly::Account.new(:account_code => 'code').to_xml\n   # => \"<account><account_code>code</account_code></account>\"", "Attempts to save the record, returning the success of the request.\n\n @return [true, false]\n @raise [Transaction::Error] A monetary transaction failed.\n @example\n   account = Recurly::Account.new\n   account.save # => false\n   account.account_code = 'account_code'\n   account.save # => true\n @see #save!", "Attempts to destroy the record.\n\n @return [true, false] +true+ if successful, +false+ if unable to destroy\n (if the record does not persist on Recurly).\n @raise [NotFound] The record cannot be found.\n @example\n   account = Recurly::Account.find account_code\n   race_condition = Recurly::Account.find account_code\n   account.destroy        # => true\n   account.destroy        # => false (already destroyed)\n   race_condition.destroy # raises Recurly::Resource::NotFound", "Creates an invoice from the pending charges on the account.\n Raises an error if it fails.\n\n @return [InvoiceCollection] A newly-created invoice.\n @raise [Invalid] Raised if the account cannot be invoiced.", "Builds an invoice from the pending charges on the account but does not persist the invoice.\n Raises an error if it fails.\n\n @return [InvoiceCollection] The newly-built invoice that has not been persisted.\n @raise [Invalid] Raised if the account cannot be invoiced.", "Verify a cvv code for the account's billing info.\n\n @example\n   acct = Recurly::Account.find('benjamin-du-monde')\n   begin\n     # If successful, returned billing_info will contain\n     # updated billing info details.\n     billing_info = acct.verify_cvv!(\"504\")\n   rescue Recurly::API::BadRequest => e\n     e.message # => \"This credit card has too many cvv check attempts.\"\n   rescue Recurly::Transaction::Error => e\n     # this will be the errors coming back from gateway\n     e.transaction_error_code # => \"fraud_security_code\"\n     e.gateway_error_code # => \"fraud\"\n   rescue Recurly::Resource::Invalid => e\n     e.message # => \"verification_value must be three digits\"\n   end\n\n @param [String] verification_value The CVV code to check\n @return [BillingInfo] The updated billing info\n @raise [Recurly::Transaction::Error] A Transaction Error will be raised if the gateway declines\n the cvv code.\n @raise [API::BadRequest] A BadRequest error will be raised if you attempt to check too many times\n and are locked out.\n @raise [Resource::Invalid] An Invalid Error will be raised if you send an invalid request (such as\n a value that is not a propert verification number).", "Posts an offline payment on this invoice\n\n @return [Transaction]\n @raise [Error] If the transaction fails.", "Preview the GiftCard. Runs and validates the GiftCard but\n does not persist it. Errors are applied to the GiftCard if there\n are any errors.", "Postpone a subscription's renewal date.\n\n @return [true, false] +true+ when successful, +false+ when unable to\n   (e.g., the subscription is not active).\n @param next_renewal_date [Time] when the subscription should renew.\n @param bulk [boolean] set to true for bulk updates (bypassing 60 second wait).", "Update the notes sections of the subscription. This endpoint also allows you to\n update the custom fields.\n\n @example\n   subscription.custom_fields.first.value = nil\n   subscription.update_notes(terms_and_conditions: 'New T&C')\n   #=>\n   #   <subscription>\n   #     <custom_fields><custom_field><name>food</name><value nil=\"nil\"/><custom_field></custom_fields>\n   #     <terms_and_conditions>New T&C</terms_and_conditions>\n   #   </subscription>\n   # it's also okay to call without notes\n   subscription.update_notes({})\n\n @param notes [Hash] should be the notes parameters you wish to update\n @return [true, false] +true+ when successful, +false+ when unable to", "Pauses a subscription or cancels a scheduled pause.\n\n * For an active subscription without a pause scheduled already,\n this will schedule a pause period to begin at the next renewal\n date for the specified number of billing cycles (remaining_pause_cycles).\n * When a scheduled pause already exists, this will update the remaining\n pause cycles with the new value sent. When zero (0) remaining_pause_cycles\n is sent for a subscription with a scheduled pause, the pause will be canceled.\n * For a paused subscription, the remaining_pause_cycles will adjust the\n length of the current pause period. Sending zero (0) in the remaining_pause_cycles\n field will cause the subscription to be resumed at the next renewal date.\n\n @param remaining_pause_cycles [Integer] The number of billing cycles that the subscription will be paused.\n @return true", "Adds an element to the root.", "add all resources from catalog declared in module test_module", "Should this resource be excluded from coverage reports?\n\n The resource is not included in coverage reports if any of the conditions hold:\n\n   * The resource has been explicitly filtered out.\n     * Examples: autogenerated resources such as 'Stage[main]'\n   * The resource is a class but does not belong to the module under test.\n     * Examples: Class dependencies included from a fixture module\n   * The resource was declared in a file outside of the test module or site.pp\n     * Examples: Resources declared in a dependency of this module.\n\n @param resource [Puppet::Resource] The resource that may be filtered\n @param test_module [String] The name of the module under test\n @return [true, false]", "Find all paths that may contain testable resources for a module.\n\n @return [Array<String>]", "get a compiler with an attached compiled catalog", "Return array of tuples device block ids, data block ids, addresses, and lengths to\n read from them to read the specified device offset & length.\n\n Note: data blocks may not amount to total requested length (if requesting\n data from unallocated space).\n\n @see DataMap#block?", "Load attributes of requested type", "This now behaves exactly like a normal read.", "Gets data for the next cluster given current, or nil if end.", "Count the number of continuous clusters from some beginning cluster.", "Deallocate all clusters on a chain from a starting cluster number.", "Start from defined cluster number and write data, following allocated cluster chain.", "Write a FAT entry for a cluster.", "From \"File System Forensic Analysis\" by Brian Carrier\n\n The $Bitmap file, which is located in MFT entry 6, has a $DATA attribute that is used\n to manage the allocation status of clusters.  The bitmap data are organized into 1-byte\n values, and the least significant bit of each byte corresponds to the cluster that follows\n the cluster that the most significant bit of the previous byte corresponds to.", "Use data run to convert mft record number to byte pos.", "Dumps object.", "If the inode has the IF_HASH_INDEX bit set,\n then the first directory block is to be interpreted as the root of an HTree index.", "Dump page statistics like db_dump.", "Find a name in this index.", "Return all names in this index as a sorted string array.", "Keys are 1-based", "Pointers are 0-based", "This is a raw dump with no character set conversion.", "This method is used for both extents and BTree leaf nodes", "Client-side RPM DB processing.", "Conary DB processing", "Parse product edition and append to product_name if needed.", "stores HTML code for a detached filter", "returns HTML code for a detached filter", "+export_grid_if_requested+ is a controller method which should be called at the end of each action containing grids with enabled\n CSV export.\n\n CSV export will only work if each WiceGrid helper is placed in a partial of its own (requiring it from the master template\n of course for the usual flow).\n +export_grid_if_requested+ intercepts CSV export requests and evaluates the corresponding partial with the required  grid helper.\n By default for each grid +export_grid_if_requested+ will look for a partial\n whose name follows the following pattern:\n\n     _GRID_NAME_grid.html.erb\n\n For example, a grid named +orders+ is supposed to be found in a template called <tt>_orders_grid.html.erb</tt>,\n Remember that the default name of grids is +grid+.\n\n This convention can be easily overridden by supplying a hash parameter to +export_grid_if_requested+ where each key is the name of\n a grid, and the value is the name of the template (like it is specified for +render+, i.e. without '_' and extensions):\n\n   export_grid_if_requested('grid' => 'orders', 'grid2' => 'invoices')\n\n If the request is not a CSV export request, the method does nothing and returns +false+, if it is a CSV export request,\n the method returns +true+.\n\n If the action has no explicit +render+ call, it's OK to just place +export_grid_if_requested+ as the last line of the action. Otherwise,\n to avoid double rendering, use the return value of the method to conditionally call your +render+ :\n\n    export_grid_if_requested || render(action: 'index')\n\n It's also possible to supply a block which will be called if no CSV export is requested:\n\n    export_grid_if_requested do\n     render(action: 'index')\n    end", "+wice_grid_custom_filter_params+ generates HTTP parameters understood by WiceGrid custom filters.\n Combined with Rails route helpers it allows to generate links leading to\n grids with pre-selected custom filters.\n\n Parameters:\n * <tt>:grid_name</tt> - The name of the grid. Just like parameter <tt>:name</tt> of\n   <tt>initialize_grid</tt>, the parameter is optional, and when absent, the name\n   <tt>'grid'</tt> is assumed\n * <tt>:attribute</tt> and <tt>:model</tt> - should be the same as <tt>:attribute</tt> and\n   <tt>:model</tt> of the column declaration with the target custom filter.\n * <tt>:value</tt> - the value of the column filter.", "This method dumps all HTTP parameters related to filtering and ordering of a certain grid as hidden form fields.\n This might be required if you want to keep the state of a grid while reloading the page using other forms.\n\n The only parameter is a grid object returned by +initialize_grid+ in the controller.", "This method dumps all HTTP parameters related to filtering and ordering of a certain grid in the form of a hash.\n This might be required if you want to keep the state of a grid while reloading the page using Rails routing helpers.\n\n The only parameter is a grid object returned by +initialize_grid+ in the controller.", "secret but stupid weapon - takes an ActiveRecord and using reflection tries to build all the column clauses by itself.\n WiceGrid is not a scaffolding solution, I hate scaffolding and how certain idiots associate scaffolding with Rails,\n so I do not document this method to avoid contributing to this misunderstanding.", "Adds a column with checkboxes for each record. Useful for actions with multiple records, for example, deleting\n selected records. Please note that +action_column+ only creates the checkboxes and the 'Select All' and\n 'Deselect All' buttons, and the form itelf as well as processing the parameters should be taken care of\n by the application code.\n\n * <tt>:param_name</tt> - The name of the HTTP parameter.\n   The complete HTTP parameter is <tt>\"#{grid_name}[#{param_name}][]\"</tt>.\n   The default param_name is 'selected'.\n * <tt>:html</tt> - a hash of HTML attributes to be included into the <tt>td</tt> tag.\n * <tt>:select_all_buttons</tt> - show/hide buttons 'Select All' and 'Deselect All' in the column header.\n   The default is +true+.\n * <tt>:object_property</tt> - a method used to obtain the value for the HTTP parameter. The default is +id+.\n * <tt>:html_check_box</tt> - can be used to switch from a real check box to two images. The default is +true+.\n\n You can hide a certain action checkbox if you add the usual block to +g.action_column+, just like with the\n +g.column+ definition. If the block returns +nil+ or +false+ no checkbox will be rendered.", "with this variant we get even those values which do not appear in the resultset", "View helper for rendering the grid.\n\n The first parameter is a grid object returned by +initialize_grid+ in the controller.\n\n The second parameter is a hash of options:\n * <tt>:html</tt> - a hash of HTML attributes to be included into the <tt>table</tt> tag.\n * <tt>:class</tt> - a shortcut for <tt>html: {class: 'css_class'}</tt>\n * <tt>:header_tr_html</tt> - a hash of HTML attributes to be included into the first <tt>tr</tt> tag\n   (or two first <tt>tr</tt>'s if the filter row is present).\n * <tt>:show_filters</tt> - defines when the filter is shown. Possible values are:\n   * <tt>:when_filtered</tt> - the filter is shown when the current table is the result of filtering\n   * <tt>:always</tt> or <tt>true</tt>  - show the filter always\n   * <tt>:no</tt> or <tt>false</tt>     - never show the filter\n * <tt>:upper_pagination_panel</tt> - a boolean value which defines whether there is an additional pagination\n   panel on top of the table. By default it is false.\n * <tt>:extra_request_parameters</tt> - a hash which will be added as additional HTTP request parameters to all\n   links generated by the grid, be it sorting links, filters, or the 'Reset Filter' icon.\n   Please note that WiceGrid respects and retains all request parameters already present in the URL which\n   formed the page, so there is no need to enumerate them in <tt>:extra_request_parameters</tt>. A typical\n   usage of <tt>:extra_request_parameters</tt> is a page with javascript tabs - changing the active tab\n   does not reload the page, but if one such tab contains a WiceGrid, it could be required that if the user\n   orders or filters the grid, the result page should have the tab with the grid activated. For this we\n   need to send an additional parameter specifying from which tab the request was generated.\n * <tt>:sorting_dependant_row_cycling</tt> - When set to true (by default it is false) the row styles +odd+\n   and +even+ will be changed only when the content of the cell belonging to the sorted column changes.\n   In other words, rows with identical values in the ordered column will have the same style (color).\n * <tt>:allow_showing_all_records</tt> - allow or prohibit the \"All Records\" mode.\n * <tt>:hide_reset_button</tt> - Do not show the default Filter Reset button.\n   Useful when using a custom reset button.\n   By default it is false.\n * <tt>:hide_submit_button</tt> - Do not show the default Filter Submit button.\n   Useful when using a custom submit button\n   By default it is false.\n * <tt>:hide_csv_button</tt> - a boolean value which defines whether the default Export To CSV button\n   should be rendered. Useful when using a custom Export To CSV button.\n   By default it is false.\n   Please read README for more insights.\n\n The block contains definitions of grid columns using the +column+ method sent to the object yielded into\n the block. In other words, the value returned by each of the blocks defines the content of a cell, the\n first block is called for cells of the first column for each row (each ActiveRecord instance), the\n second block is called for cells of the second column, and so on. See the example:\n\n   <%= grid(@accounts_grid, html: {class: 'grid_style', id: 'accounts_grid'}, header_tr_html: {class: 'grid_headers'}) do |g|\n\n     g.column name: 'Username', attribute: 'username' do |account|\n       account.username\n     end\n\n     g.column name: 'application_account.field.identity_id'._, attribute: 'firstname', model:  Person do |account|\n       link_to(account.identity.name, identity_path(account.identity))\n     end\n\n     g.column do |account|\n       link_to('Edit', edit_account_path(account))\n     end\n\n   end -%>\n\n\n Defaults for parameters <tt>:show_filters</tt> and <tt>:upper_pagination_panel</tt>\n can be changed in <tt>lib/wice_grid_config.rb</tt> using constants <tt>Wice::Defaults::SHOW_FILTER</tt> and\n <tt>WiceGrid::Defaults::SHOW_UPPER_PAGINATION_PANEL</tt>, this is convenient if you want to set a project wide setting\n without having to repeat it for every grid instance.\n\n Pease read documentation about the +column+ method to achieve the enlightenment.", "Outputs smart list container", "Given a middleware sequence, filter out items not applicable to the\n current request, and set up a chain of instantiated middleware objects,\n ready to serve a request.", "Remove middleware that have been included multiple times with the same\n config, leaving only the first instance", "Receives an array of symbols that represent actions for which the default traits\n should be used, and then lastly an optional trait configuration.\n\n Example is...\n\n   [ :index, :show, { refund: { url: ':id/refund', method: 'post' } } ]\n\n ...which will load the default route for `show` and `index`, while also configuring\n a refund route.", "Make values available to middleware further down the stack. Accepts a\n hash of name => value pairs. Names must have been declared by calling\n `provides` on the class.", "Use ActiveSupport to instrument the execution of the subsequent chain.", "Aggregates provided keys from the given middleware, and all the middleware it uses.\n Can raise at any level assuming a used middleware is missing a required dependency.", "Serialize the results of the benchmarking", "Receives a handler.finish event, with processed benchmark. Publishes to\n request.coach notification.", "Returns a collection of targeting criteria available to the current line item.\n\n @param id [String] The TargetingCriteria ID value.\n @param opts [Hash] A Hash of extended options.\n @option opts [Boolean] :with_deleted Indicates if deleted items should be included.\n @option opts [String] :sort_by The object param to sort the API response by.\n\n @since 0.3.1\n\n @return A Cursor or object instance.", "Method to iterate through all items until the Cursor is exhausted.\n\n @return [Cursor] The current Cursor instance.\n\n @since 0.1.0", "Sets up the object with the correct account and client information.\n\n @example\n   metric_filter = TwitterAds::Metric.new('xyz1')\n\n @param account_id [String] The ID for the account to be used.\n @param client [Client] Optional client instance to be used. Will default to ~/.twurlrc info.\n @param mact_enabled [Boolean] Indicates the account has a MACT partner setup (default: false).\n\n @return [self] The configured object instance.\n Determines relevant metrics from a list of line item IDs.\n\n @example\n   metric_filter.filter(line_item_ids)\n\n @param line_items [String/Array] A list of one or more line item IDs.\n\n @return [Hash] A hash with relevant metrics for each line item.", "Returns a collection of features available to the current account.\n\n @return [Array] The list of features enabled for the account.\n\n @since 0.1.0", "Returns the most recent promotable Tweets created by one or more specified Twitter users.\n\n @param ids [Array] An Array of Twitter user IDs.\n @param opts [Hash] A Hash of extended options.\n\n @return [Array] An Array of Tweet objects.\n\n @since 0.2.3", "Saves or updates the current object instance depending on the presence of `object.id`.\n\n @example\n   object.save\n\n @return [self] Returns the instance refreshed from the API.\n\n @since 0.1.0", "Deletes the current object instance depending on the presence of `object.id`.\n\n @example\n   object.delete!\n\n Note: calls to this method are destructive and irreverisble for most API objects.\n\n @return [self] Returns the instance refreshed from the API.\n\n @since 0.1.0", "Creates a new TONUpload object instance.\n\n @example\n   request = TONUpload.new(client, '/path/to/file')\n\n @param client [Client] The Client object instance.\n @param file_path [String] The path to the file to be uploaded.\n\n @since 0.3.0\n\n @return [TONUpload] The TONUpload request instance.\n Executes the current TONUpload object.\n\n @example\n   request = TONUpload.new(client, '/path/to/file')\n   request.perform\n\n @since 0.3.0\n\n @return [String] The upload location provided by the TON API.", "performs a single chunk upload", "initialization for a multi-chunk upload", "uploads a single chunk of a multi-chunk upload", "Updates the current tailored audience instance.\n\n @example\n   audience = account.tailored_audiences('xyz')\n   audience.update('/path/to/file', 'EMAIL', 'REPLACE')\n\n @param file_path [String] The path to the file to be uploaded.\n @param list_type [String] The tailored audience list type.\n @param operation [String] The update operation type (Default: 'ADD').\n\n @since 0.3.0\n\n @return [TailoredAudience] [description]", "Returns the status of all changes for the current tailored audience instance.\n\n @example\n   audience.status\n\n @since 0.3.0\n\n @return [Hash] Returns a hash object representing the tailored audience status.", "This is a private API and requires whitelisting from Twitter.\n\n This endpoint will allow partners to add, update and remove users from a given\n tailored_audience_id.\n The endpoint will also accept multiple user identifier types per user as well.\n\n @example\n   tailored_audience.users(\n     account,\n     [\n       {\n         \"operation_type\": \"Update\",\n         \"params\": {\n           \"effective_at\": \"2018-05-15T00:00:00Z\",\n           \"expires_at\": \"2019-01-01T07:00:00Z\",\n           \"users\": [\n             {\n               \"twitter_id\": [\n                 \"4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3\"\n               ]\n             }\n           ]\n         }\n       }\n     ]\n   )\n\n @since 4.0\n\n @return success_count, total_count", "Returns a collection of advertiser Accounts available to the current access token.\n\n @example\n   client.accounts\n   client.accounts('3ofs6l')\n   client.accounts('3ofs6l', with_deleted: true)\n\n @param id=nil [String] The account ID string.\n @param opts={} [Hash] Hash of optional values.\n\n @option opts [String] :with_deleted Indicates whether or not to included deleted objects.\n\n @since 0.1.0\n\n @return [Account] The instance of the Account object.", "Evaluate the method in the context of the supplied relation and parameter", "Verifies an input field or textarea exists on the current page, and stores a value for\n it which will be sent when the form is submitted.\n\n Examples:\n   fill_in \"Email\", :with => \"user@example.com\"\n   fill_in \"user[email]\", :with => \"user@example.com\"\n\n The field value is required, and must be specified in <tt>options[:with]</tt>.\n <tt>field</tt> can be either the value of a name attribute (i.e. <tt>user[email]</tt>)\n or the text inside a <tt><label></tt> element that points at the <tt><input></tt> field.", "Asserts that the body of the response contain\n the supplied string or regexp", "remove protocol, host and anchor", "iterate over all form fields to build a request querystring to get params from it,\n for file_field we made a work around to pass a digest as value to later replace it\n in params hash with the real file.", "Asserts that the body of the response contains\n the supplied selector", "If we need to run commands from pod-try we should let the users know\n what is going to be running on their device.", "Runs the pre_install_commands from\n\n @param  [Bool] prompt\n         Should CocoaPods-Try show a prompt with the commands to the user.", "Sets current logger's level\n\n @params [String] log level\n @returns [String] log level", "Creates a daemon object.\n\n Optionally takes a block that is the action of the daemon. If\n not provided, you must extend this class and override {#action}\n if you want the daemon to actually do anything. The block will\n be passed the daemon object.\n\n @param name [String] The name of this daemon. Needs to be the\n   same across a cluster for :singleton to work, and must be\n   unique.\n @param options [Hash] Options for the daemon.\n @option options :singleton [true, false] (true)\n @option options :on_error [Proc] A custom error handler, will be\n   passed the daemon object and the error (see {#on_error})\n @option options :on_stop [Proc] A custom stop handler, will be\n   passed the daemon object (see {#on_stop})\n @option options :stop_timeout [Number] (30_000) Milliseconds to\n   wait for the daemon thread to exit when stopping.\n Starts the daemon. If :singleton and in a cluster, the daemon\n may not be running on the current node after calling start.\n @return [Daemon] self", "Parse a dumped value using the embedded options.\n\n @param [String] string Option embedded string to load\n @return [String] The original dumped string, restored\n\n @example\n\n   entity.load(dumped)", "Decompose an option embedded string into marshal, compression and value.\n\n @param  [String] string Option embedded string to\n @return [Array<Module, Boolean, String>] An array comprised of the\n   marshal, compression flag, and the base string.", "Writes data to the cache using the given key. Will overwrite whatever\n value is already stored at that key.\n\n @param [String] key Key for lookup\n @param [Hash] options Optional overrides\n\n @example\n\n   cache.write('some-key', 'a bunch of text')                     # => 'OK'\n   cache.write('some-key', 'short lived', expires_in: 60)         # => 'OK'\n   cache.write('some-key', 'lives elsehwere', namespace: 'cache') # => 'OK'", "Delete the value stored at the specified key. Returns `true` if\n anything was deleted, `false` otherwise.\n\n @param [String] key The key for lookup\n @param [Hash] options Optional overrides\n\n @example\n\n   cache.delete('existing-key') # => true\n   cache.delete('random-key')   # => false", "Fetches data from the cache, using the given key. If there is data in the\n cache with the given key, then that data is returned.\n\n If there is no such data in the cache (a cache miss), then `nil` will be\n returned. However, if a block has been passed, that block will be passed\n the key and executed in the event of a cache miss. The return value of\n the block will be written to the cache under the given cache key, and\n that return value will be returned.\n\n @param [String] key Key for lookup\n @param options [Hash] Optional overrides\n @option options [Boolean] :force Force a cache miss\n @yield [String] Gives a missing key to the block, which is used to\n   generate the missing value\n\n @example Typical\n\n   cache.write('today', 'Monday')\n   cache.fetch('today') # => \"Monday\"\n   cache.fetch('city')  # => nil\n\n @example With a block\n\n   cache.fetch('city') do\n     'Duckburgh'\n   end\n\n   cache.fetch('city') # => \"Duckburgh\"\n\n @example Cache Miss\n\n   cache.write('today', 'Monday')\n   cache.fetch('today', force: true) # => nil", "Increment a key in the store.\n\n If the key doesn't exist it will be initialized at 0. If the key exists\n but it isn't a Fixnum it will be coerced to 0.\n\n Note that this method does *not* use Redis' native `incr` or `incrby`\n commands. Those commands only work with number-like strings, and are\n incompatible with the encoded values Readthis writes to the store. The\n behavior of `incrby` is preserved as much as possible, but incrementing\n is not an atomic action. If multiple clients are incrementing the same\n key there will be a \"last write wins\" race condition, causing incorrect\n counts.\n\n If you absolutely require correct counts it is better to use the Redis\n client directly.\n\n @param [String] key Key for lookup\n @param [Fixnum] amount Value to increment by\n @param [Hash] options Optional overrides\n\n @example\n\n   cache.increment('counter') # => 1\n   cache.increment('counter', 2) # => 3", "Decrement a key in the store.\n\n If the key doesn't exist it will be initialized at 0. If the key exists\n but it isn't a Fixnum it will be coerced to 0. Like `increment`, this\n does not make use of the native `decr` or `decrby` commands.\n\n @param [String] key Key for lookup\n @param [Fixnum] amount Value to decrement by\n @param [Hash] options Optional overrides\n\n @example\n\n   cache.write('counter', 20) # => 20\n   cache.decrement('counter') # => 19\n   cache.decrement('counter', 2) # => 17", "Efficiently read multiple values at once from the cache. Options can be\n passed in the last argument.\n\n @overload read_multi(keys)\n   Return all values for the given keys.\n   @param [String] One or more keys to fetch\n   @param [Hash] options Configuration to override\n\n @return [Hash] A hash mapping keys to the values found.\n\n @example\n\n   cache.read_multi('a', 'b') # => { 'a' => 1 }\n   cache.read_multi('a', 'b', retain_nils: true) # => { 'a' => 1, 'b' => nil }", "Write multiple key value pairs simultaneously. This is an atomic\n operation that will always succeed and will overwrite existing\n values.\n\n This is a non-standard, but useful, cache method.\n\n @param [Hash] hash Key value hash to write\n @param [Hash] options Optional overrides\n\n @example\n\n   cache.write_multi({ 'a' => 1, 'b' => 2 }) # => true", "Fetches multiple keys from the cache using a single call to the server\n and filling in any cache misses. All read and write operations are\n executed atomically.\n\n @overload fetch_multi(keys)\n   Return all values for the given keys, applying the block to the key\n   when a value is missing.\n   @param [String] One or more keys to fetch\n\n @example\n\n   cache.fetch_multi('alpha', 'beta') do |key|\n     \"#{key}-was-missing\"\n   end\n\n   cache.fetch_multi('a', 'b', expires_in: 60) do |key|\n     key * 2\n   end", "Returns `true` if the cache contains an entry for the given key.\n\n @param [String] key Key for lookup\n @param [Hash] options Optional overrides\n\n @example\n\n   cache.exist?('some-key') # => false\n   cache.exist?('some-key', namespace: 'cache') # => true", "Clear the entire cache by flushing the current database.\n\n This flushes everything in the current database, with no globbing\n applied. Data in other numbered databases will be preserved.\n\n @option options [Hash] :async Flush the database asynchronously, only\n   supported in Redis 4.0+\n\n @example\n\n   cache.clear #=> 'OK'\n   cache.clear(async: true) #=> 'OK'", "Automatically adds an \"order\" hidden field in your form to preserve how the data\n is being ordered.", "Load rules for names", "Load rules for genders", "other will always be a QueryString, not a QueryHash, as it will have ben created\n from the actual query string.", "Iterate through data object and recursively mark\n any found string as html_safe\n\n Safe HTML can be passed to components, simulate\n by marking any string that comes from YAML as safe", "Command definition functions", "Get activities directly, via ID or Foreign ID + timestamp\n\n @param [Hash<:ids, :foreign_id_times>] params the request params (ids or list of <:foreign_id, :time> objects)\n\n @return the found activities, if any.\n\n @example Retrieve by activity IDs\n   @client.get_activities(\n     ids: [\n       '4b39fda2-d6e2-42c9-9abf-5301ef071b12',\n       '89b910d3-1ef5-44f8-914e-e7735d79e817'\n     ]\n   )\n\n @example Retrieve by Foreign IDs + timestamps\n   @client.get_activities(\n     foreign_id_times: [\n       { foreign_id: 'post:1000', time: '2016-11-10T13:20:00.000000' },\n       { foreign_id: 'like:2000', time: '2018-01-07T09:15:59.123456' }\n     ]\n   )", "Starting from base, traverse each path element in arcs. Since the path\n may contain wildcards, this function returns a list of matches.", "Follows many feeds in one single request\n\n @param [Array<Hash<:source, :target>>] follows the list of follows\n\n @return [nil]\n\n @example\n   follows = [\n     {:source => 'flat:1', :target => 'user:1'},\n     {:source => 'flat:1', :target => 'user:3'}\n   ]\n   @client.follow_many(follows)", "Adds an activity to many feeds in one single request\n\n @param [Hash] activity_data the activity do add\n @param [Array<string>] feeds list of feeds (eg. 'user:1', 'flat:2')\n\n @return [nil]", "Finish script or style tag content, wrapping it in CDATA if necessary,\n and add it to our original @already buffer.", "Properly handles a formatting error.\n All such errors go through this method.\n\n The behavior depends on {MaRuKu::Globals `MaRuKu::Globals[:on_error]`}.\n If this is `:warning`, this prints the error to stderr\n (or `@error_stream` if it's defined) and tries to continue.\n If `:on_error` is `:ignore`, this doesn't print anything\n and tries to continue. If it's `:raise`, this raises a {MaRuKu::Exception}.\n\n By default, `:on_error` is set to `:warning`.\n\n @overload def maruku_error(s, src = nil, con = nil)\n @param s [String] The text of the error\n @param src [#describe, nil] The source of the error\n @param con [#describe, nil] The context of the error\n @param recover [String, nil] Recovery text\n @raise [MaRuKu::Exception] If `:on_error` is set to `:raise`", "This returns the position of the first non-list character\n in a list item.\n\n @example\n spaces_before_first_char('*Hello') #=> 1\n spaces_before_first_char('* Hello') #=> 2\n spaces_before_first_char(' * Hello') #=> 3\n spaces_before_first_char(' *   Hello') #=> 5\n spaces_before_first_char('1.Hello') #=> 2\n spaces_before_first_char(' 1.  Hello') #=> 5\n\n @param s [String]\n @return [Fixnum]", "Input is a LineSource", "Convert this fragment to an HTML or XHTML string.\n @return [String]", "Get all span-level descendents of the given element, recursively,\n as a flat NodeSet.\n\n @param e [Nokogiri::XML::Node] An element.\n @return [Nokogiri::XML::NodeSet]", "Get all span-level descendents of the given element, recursively,\n as an Array.\n\n @param e [REXML::Element] An element.\n @return [Array]", "tracks the timing hit type\n @param block [#call] block is executed and time recorded", "collects the parameters from options for this hit type", "Add a measurement by its symbol name with options\n\n @param key [Symbol] any one of the measurable classes lookup key\n @param options [Hash or Object] for the measurement", "collects the parameters from options for this measurement\n @return [Hash]", "Remove any files not directly referenced by the manifest.", "Remove manifest, any fingerprinted files.", "Validate the LineItem record according to what will be valid by the gateway.\n\n Usage:\n  line_item.valid?     # Returns true/false\n\n  Additionally sets line_item.errors array to an array of field/error.", "Return a list of all accounts matching account_type.", "Return a list of all accounts matching tax_type.", "Validate the Contact record according to what will be valid by the gateway.\n\n Usage:\n  contact.valid?     # Returns true/false\n\n  Additionally sets contact.errors array to an array of field/error.", "The consumer key and secret here correspond to those provided\n to you by Xero inside the API Previewer.\n\n Retrieve all contacts from Xero\n\n Usage : get_contacts(:order => :name)\n         get_contacts(:modified_since => Time)\n\n Note  : modified_since is in UTC format (i.e. Brisbane is UTC+10)", "Factory method for building new Contact objects associated with this gateway.", "Updates an existing Xero contact\n\n Usage :\n\n contact = xero_gateway.get_contact(some_contact_id)\n contact.email = \"a_new_email_ddress\"\n\n xero_gateway.update_contact(contact)", "Updates an array of contacts in a single API operation.\n\n Usage :\n  contacts = [XeroGateway::Contact.new(:name => 'Joe Bloggs'), XeroGateway::Contact.new(:name => 'Jane Doe')]\n  result = gateway.update_contacts(contacts)\n\n Will update contacts with matching contact_id, contact_number or name or create if they don't exist.", "Retreives all contact groups from Xero\n\n Usage:\n   groups = gateway.get_contact_groups()", "Retreives a contact group by its id.", "Retrieves all invoices from Xero\n\n Usage : get_invoices\n         get_invoices(:invoice_id => \"297c2dc5-cc47-4afd-8ec8-74990b8761e9\")\n         get_invoices(:invoice_number => \"175\")\n         get_invoices(:contact_ids => [\"297c2dc5-cc47-4afd-8ec8-74990b8761e9\"] )\n\n Note  : modified_since is in UTC format (i.e. Brisbane is UTC+10)", "Retrieves a single invoice\n\n You can get a PDF-formatted invoice by specifying :pdf as the format argument\n\n Usage : get_invoice(\"297c2dc5-cc47-4afd-8ec8-74990b8761e9\") # By ID\n         get_invoice(\"OIT-12345\") # By number", "Factory method for building new Invoice objects associated with this gateway.", "Creates an array of invoices with a single API request.\n\n Usage :\n  invoices = [XeroGateway::Invoice.new(...), XeroGateway::Invoice.new(...)]\n  result = gateway.create_invoices(invoices)", "Retrieves all credit_notes from Xero\n\n Usage : get_credit_notes\n         get_credit_notes(:credit_note_id => \" 297c2dc5-cc47-4afd-8ec8-74990b8761e9\")\n\n Note  : modified_since is in UTC format (i.e. Brisbane is UTC+10)", "Retrieves a single credit_note\n\n Usage : get_credit_note(\"297c2dc5-cc47-4afd-8ec8-74990b8761e9\") # By ID\n         get_credit_note(\"OIT-12345\") # By number", "Factory method for building new CreditNote objects associated with this gateway.", "Creates an credit_note in Xero based on an credit_note object.\n\n CreditNote and line item totals are calculated automatically.\n\n Usage :\n\n    credit_note = XeroGateway::CreditNote.new({\n      :credit_note_type => \"ACCREC\",\n      :due_date => 1.month.from_now,\n      :credit_note_number => \"YOUR CREDIT_NOTE NUMBER\",\n      :reference => \"YOUR REFERENCE (NOT NECESSARILY UNIQUE!)\",\n      :line_amount_types => \"Inclusive\"\n    })\n    credit_note.contact = XeroGateway::Contact.new(:name => \"THE NAME OF THE CONTACT\")\n    credit_note.contact.phone.number = \"12345\"\n    credit_note.contact.address.line_1 = \"LINE 1 OF THE ADDRESS\"\n    credit_note.line_items << XeroGateway::LineItem.new(\n      :description => \"THE DESCRIPTION OF THE LINE ITEM\",\n      :unit_amount => 100,\n      :tax_amount => 12.5,\n      :tracking_category => \"THE TRACKING CATEGORY FOR THE LINE ITEM\",\n      :tracking_option => \"THE TRACKING OPTION FOR THE LINE ITEM\"\n    )\n\n    create_credit_note(credit_note)", "Creates an array of credit_notes with a single API request.\n\n Usage :\n  credit_notes = [XeroGateway::CreditNote.new(...), XeroGateway::CreditNote.new(...)]\n  result = gateway.create_credit_notes(credit_notes)", "Retrieves all bank transactions from Xero\n\n Usage : get_bank_transactions\n         get_bank_transactions(:bank_transaction_id => \" 297c2dc5-cc47-4afd-8ec8-74990b8761e9\")\n\n Note  : modified_since is in UTC format (i.e. Brisbane is UTC+10)", "Retrieves a single bank transaction\n\n Usage : get_bank_transaction(\"297c2dc5-cc47-4afd-8ec8-74990b8761e9\") # By ID\n         get_bank_transaction(\"OIT-12345\") # By number", "Retrieves all manual journals from Xero\n\n Usage : get_manual_journal\n         getmanual_journal(:manual_journal_id => \" 297c2dc5-cc47-4afd-8ec8-74990b8761e9\")\n\n Note  : modified_since is in UTC format (i.e. Brisbane is UTC+10)", "Retrieves a single manual journal\n\n Usage : get_manual_journal(\"297c2dc5-cc47-4afd-8ec8-74990b8761e9\") # By ID\n         get_manual_journal(\"OIT-12345\") # By number", "Create Payment record in Xero", "Gets all Payments for a specific organisation in Xero", "Gets a single Payment for a specific organsation in Xero", "Get the Payroll calendars for a specific organization in Xero", "Get the Pay Runs for a specific organization in Xero", "Retrieves reports from Xero\n\n Usage : get_report(\"BankStatement\", bank_account_id: \"AC993F75-035B-433C-82E0-7B7A2D40802C\")\n         get_report(\"297c2dc5-cc47-4afd-8ec8-74990b8761e9\", bank_account_id: \"AC993F75-035B-433C-82E0-7B7A2D40802C\")", "Create or update a contact record based on if it has a contact_id or contact_number.", "Create or update an invoice record based on if it has an invoice_id.", "Create or update a bank transaction record based on if it has an bank_transaction_id.", "Create or update a manual journal record based on if it has an manual_journal_id.", "Helper method to create the associated contact object.", "Renewing access tokens only works for Partner applications", "Update instance variables with those from the AccessToken.", "Validate the BankTransaction record according to what will be valid by the gateway.\n\n Usage:\n  bank_transaction.valid?     # Returns true/false\n\n  Additionally sets bank_transaction.errors array to an array of field/error.", "Validate the ManualJournal record according to what will be valid by the gateway.\n\n Usage:\n  manual_journal.valid?     # Returns true/false\n\n  Additionally sets manual_journal.errors array to an array of field/error.", "When a tracking category is serialized as part of an invoice it may only have a single\n option, and the Options tag is omitted", "Generates JavaScript and renders the Google Chart in the final HTML output.\n\n Parameters:\n  *div_id            [Required] The ID of the DIV element that the Google Chart should be rendered in.", "Generates JavaScript function for rendering the chart.\n\n Parameters:\n  *div_id            [Required] The ID of the DIV element that the Google Chart should be rendered in.", "Adds multiple columns to the data_table.\n\n Parameters:\n   * columns         [Required] An array of column objects {:type, :label, :id, :role, :pattern}. Calls new_column for each column object.", "Sets a column in data_table, specified by column_index with an array of column_values. column_index starts from 0.\n\n Parameters\n   * column_index    [Required] The column to assign column_values. column_index starts from 0.\n   * column_values   [Required] An array of cell values.", "Adds a new row to the data_table.\n Call method without any parameters to add an empty row, otherwise, call method with a row object.\n\n Parameters:\n   * row             [Optional] An array of cell values specifying the data for the new row.\n     - You can specify a value for a cell (e.g. 'hi') or specify a formatted value using cell objects (e.g. {v:55, f:'Fifty-five'}) as described in the constructor section.\n     - You can mix simple values and cell objects in the same method call.\n     - To create an empty cell, use nil or empty string.", "Adds multiple rows to the data_table. You can call this method with data to populate a set of new rows or create new empty rows.\n\n Parameters:\n   * array_or_num    [Required] Either an array or a number.\n     - Array: An array of row objects used to populate a set of new rows. Each row is an object as described in add_row().\n     - Number: A number specifying the number of new empty rows to create.", "Gets a cell value from the visualization, at row_index, column_index. row_index and column_index start from 0.\n\n Parameters:\n   * row_index       [Required] row_index starts from 0.\n   * column_index    [Required] column_index starts from 0.", "Returns the JavaScript equivalent for this data_table instance.", "Create a new callback instance\n\n @param ui [Bogo::Ui]\n @param config [Smash] configuration hash\n @param arguments [Array<String>] arguments from the CLI\n @param api [Provider] API connection\n\n @return [self]\n Wrap action within status text\n\n @param msg [String] action text\n @yieldblock action to perform\n @return [Object] result of yield", "Store stack attribute changes\n\n @param stack_id [String]\n @param stack_attributes [Hash]\n @return [TrueClass]", "Remove stack from the cache\n\n @param stack_id [String]\n @return [TrueClass, FalseClass]", "Expand all lazy loaded attributes within stack\n\n @param stack [Miasma::Models::Orchestration::Stack]", "Request stack information and store in cache\n\n @return [TrueClass]", "Start async stack list update. Creates thread that loops every\n `self.stack_list_interval` seconds and refreshes stack list in cache\n\n @return [TrueClass, FalseClass]", "Load API provider specific overrides to customize behavior\n\n @return [TrueClass, FalseClass]", "Start with current working directory and traverse to root\n looking for a `.sfn` configuration file\n\n @param opts [Slop]\n @return [Slop]", "Create new instance\n\n @param key [String, Array]\n Initialize a new data type\n\n @param name [Symbol] name of data\n @param kind [Symbol] data type\n @param args [Hash] options for data type", "Fetch item from storage\n\n @param store_type [Symbol]\n @param data_type [Symbol]\n @param name [Symbol] name of data\n @param args [Hash] options for underlying storage\n @return [Object]", "Fetch item from redis storage\n\n @param data_type [Symbol]\n @param full_name [Symbol]\n @param args [Hash]\n @return [Object]", "Fetch item from local storage\n\n @param data_type [Symbol]\n @param full_name [Symbol]\n @param args [Hash]\n @return [Object]\n @todo make proper singleton for local storage", "Check if cache time has expired\n\n @param key [String, Symbol] value key\n @param stamp [Time, Integer]\n @return [TrueClass, FalseClass]", "Apply time limit for data type\n\n @param kind [String, Symbol] data type\n @param seconds [Integer]\n return [Integer]", "Perform action within lock\n\n @param lock_name [String, Symbol] name of lock\n @param raise_on_locked [TrueClass, FalseClass] raise execption if lock wait times out\n @return [Object] result of yield", "look ahead in the new array to see if the current item appears later\n thereby having new items added", "look ahead in the old array to see if the current item appears later\n thereby having items removed", "Invoked when a value that is returned from the database needs to be\n displayed into something readable again.", "Invoked when the provided value needs to be serialized before storing\n it to the database.", "A UUID consists of 5 groups of characters.\n   8 chars - 4 chars - 4 chars - 4 chars - 12 characters\n\n This function re-introduces the dashes since we removed them during\n serialization, so:\n\n   add_dashes(\"2b4a233152694c6e9d1e098804ab812b\")\n     => \"2b4a2331-5269-4c6e-9d1e-098804ab812b\"", "Sign in a user\n\n @note Uses the {Oath::Services::SignIn} service to create a session\n\n @param user [User] the user object to sign in\n @yield Yields to the block if the user is successfully signed in\n @return [Object] returns the value from calling perform on the {Oath::Services::SignIn} service", "Sign up a user\n\n @note Uses the {Oath::Services::SignUp} service to create a user\n\n @param user_params [Hash] params containing lookup and token fields\n @yield Yields to the block if the user is signed up successfully\n @return [Object] returns the value from calling perform on the {Oath::Services::SignUp} service", "Authenticates a session.\n\n @note Uses the {Oath::Services::Authentication} service to verify the user's details\n\n @param session_params [Hash] params containing lookup and token fields\n @param field_map [Hash] Field map used for allowing users to sign in with multiple fields e.g. email and username\n @return [User] if authentication succeeded\n @return [nil] if authentication failed\n @example Basic usage\n   class SessionsController < ApplicationController\n     def create\n       user = authenticate_session(session_params)\n\n        if sign_in(user)\n          redirect_to(root_path)\n        else\n          render :new\n        end\n      end\n\n      private\n\n      def session_params\n        params.require(:session).permit(:email, :password)\n      end\n\n    end\n @example Using the field map to authenticate using multiple lookup fields\n   class SessionsController < ApplicationController\n     def create\n       user = authenticate_session(session_params, email_or_username: [:email, :username])\n\n        if sign_in(user)\n          redirect_to(root_path)\n        else\n          render :new\n        end\n      end\n\n      private\n\n      def session_params\n        params.require(:session).permit(:email_or_username, :password)\n      end\n\n    end", "Authenticates a user given a password\n\n @note Uses the {Oath::Services::Authentication} service to verify the user's credentials\n\n @param user [User] the user\n @param password [String] the password\n @return [User] if authentication succeeded\n @return [nil] if authentication failed", "Resets a user's password\n\n @note Uses the {Oath::Services::PasswordReset} service to change a user's password\n\n @param user [User] the user\n @param password [String] the password", "Initialize parameter transformer\n\n @param params [ActionController::Parameters] parameters to be altered\n Returns the transformed parameters", "Make a GET request to given URL\n\n @param url              The URL to Google's API we'll make a request to\n @param instrumentation  A hash with instrumentation payload\n @param options          Other options we don't care about, for example we'll capture\n                         `configuration` option which we are not using, but the ClientCache\n                         is using.\n\n @return Hash with data from parsed response body", "Initialize a new encoder\n\n Arguments\n   array_of_lat_lng_pairs    - The array of lat/lng pairs, like [[lat, lng], [lat, lng], ..etc]\n   delta                     - An object responsible for rounding and calculate the deltas\n                               between the given lat/lng pairs.\n   value_encoder             - After deltas are calculated each value is passed to the encoder\n                               to be encoded in to ASCII characters\n\n @see ::encode\n Encode and returns the encoded string", "Returns the filtered query expression", "Returns the editable field as html for use in editing dynamic fields from a Job class.", "Map the values for each column", "Parse Shared string table file\n @param file [String] path to file\n @return [SharedStringTable]", "Parse OldDocxGroup object\n @param node [Nokogiri::XML:Element] node to parse\n @return [OldDocxGroup] result of parsing", "Parse View3D object\n @param node [Nokogiri::XML:Element] node to parse\n @return [View3D] result of parsing", "Parse DisplayLabelsProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DisplayLabelsProperties] result of parsing", "Parse DocxPatternFill object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxPatternFill] result of parsing", "Parse OldDocxShapeFill object\n @param node [Nokogiri::XML:Element] node to parse\n @return [OldDocxShapeFill] result of parsing", "Parse Paragraph Borders data\n @param [Nokogiri::XML:Element] node with Paragraph Borders data\n @return [ParagraphBorders] value of Paragraph Borders data", "Parse PresentationAlternateContent object\n @param node [Nokogiri::XML:Element] node to parse\n @return [PresentationAlternateContent] result of parsing", "Parse DocxColorScheme object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxColorScheme] result of parsing", "Parse DocumentBackground object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocumentBackground] result of parsing", "Parse OleObjects object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Array] list of OleObjects", "Parse single document style\n @return [DocumentStyle]", "Parse list of drawings in file", "Do work for parsing shared comments file", "Parse StringIndex data\n @param [Nokogiri::XML:Element] node with StringIndex data\n @return [StringIndex] value of StringIndex data", "Parse BookmarkStart object\n @param node [Nokogiri::XML:Element] node to parse\n @return [BookmarkStart] result of parsing", "Parse Behavior object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Behavior] result of parsing", "Parse Abstract Numbering data\n @param [Nokogiri::XML:Element] node with Abstract Numbering data\n @return [AbstractNumbering] value of Abstract Numbering data", "Parse XlsxRow object\n @param node [Nokogiri::XML:Element] node to parse\n @return [XlsxRow] result of parsing", "Parse Accent object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Accent] result of parsing", "To compare color, which look alike\n @param [String or Color] color_to_check color to compare\n @param [Integer] delta max delta for each of specters", "Parse ChartCellsRange object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ChartCellsRange] result of parsing", "Parse XlsxAlignment object\n @param node [Nokogiri::XML:Element] node to parse\n @return [XlsxAlignment] result of parsing", "Parse TableStyle object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TableStyle] result of parsing", "Parse ParagraphRun object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ParagraphRun] result of parsing", "Get all values of formulas.\n @param [Fixnum] precision of formulas counting\n @return [Array, String] all formulas", "Do work for parsing shared strings file", "Parse TablePosition object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TablePosition] result of parsing", "Parse Shape object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Shape] result of parsing", "Parse TextField object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TextField] result of parsing", "Parse DocxColor object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxColor] result of parsing", "Parse PageProperties data\n @param [Nokogiri::XML:Element] node with PageProperties data\n @return [PageProperties] value of PageProperties data", "Parse ChartAxisTitle object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ChartAxisTitle] result of parsing", "Parse XlsxDrawing object\n @param node [Nokogiri::XML:Element] node to parse\n @return [XlsxDrawing] result of parsing", "Parse Borders object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Borders] result of parsing", "Get transform property of object, by object type\n @param object [Symbol] type of object: :image, :chart, :table, :shape\n @return [OOXMLDocumentObject] needed object", "Parse BlipFill object\n @param node [Nokogiri::XML:Element] node to parse\n @return [BlipFill] result of parsing", "Parse OldDocxShapeProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [OldDocxShapeProperties] result of parsing", "Parse Slide object\n @return [Slide] result of parsing", "Parse DocxPicture object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxPicture] result of parsing", "Parse GradientColor object\n @param node [Nokogiri::XML:Element] node to parse\n @return [GradientColor] result of parsing", "Parse ParagraphTab object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ParagraphTab] result of parsing", "Parse TableStyleInfo data\n @param [Nokogiri::XML:Element] node with TableStyleInfo data\n @return [TableStyleInfo] value of TableStyleInfo data", "Parse FieldSimple object\n @param node [Nokogiri::XML:Element] node to parse\n @return [FieldSimple] result of parsing", "Parse PresentationPattern object\n @param node [Nokogiri::XML:Element] node to parse\n @return [PresentationPattern] result of parsing", "Parse Settings object\n @return [DocumentSettings] result of parsing", "Parse LineJoin object\n @param node [Nokogiri::XML:Element] node to parse\n @return [LineJoin] result of parsing", "Parse ExtensionList data\n @param [Nokogiri::XML:Element] node with ExtensionList data\n @return [ExtensionList] value of ExtensionList data", "Parse XlsxCell object\n @param node [Nokogiri::XML:Element] node to parse\n @return [XlsxCell] result of parsing", "Get shared string by it's number\n @return [Nothing]", "Parse ShapeTree object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ShapeTree] result of parsing", "Parse PresentationNotes object\n @param file [String] file to parse\n @return [PresentationNotes] result of parsing", "Parse TargetElement object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TargetElement] result of parsing", "Parse Table object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Table] result of parsing", "Parse Matrix object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Matrix] result of parsing", "Parse SDTProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [SDTProperties] result of parsing", "Parse TextBody object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TextBody] result of parsing", "Parse AnimationEffect object\n @param node [Nokogiri::XML:Element] node to parse\n @return [AnimationEffect] result of parsing", "Parse Xf object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Xf] result of parsing", "Parse Pane object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Pane] result of parsing", "Parse PresentationComment object\n @param node [Nokogiri::XML:Element] node to parse\n @return [PresentationComment] result of parsing", "Fill all empty tables styles with default value\n To make last changes in parsing table styles compatible\n with `ooxml_parser` 0.1.2 and earlier\n @return [Nothing]", "Parse FilterColumn data\n @param [Nokogiri::XML:Element] node with FilterColumn data\n @return [FilterColumn] value of FilterColumn data", "Parse TableCell object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TableCell] result of parsing", "Parse Delimiter object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Delimiter] result of parsing", "Parse ChartAxis object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ChartAxis] result of parsing", "Parse ChartLegend object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ChartLegend] result of parsing", "Parse PresentationComments object\n @param file [Nokogiri::XML:Element] node to parse\n @return [PresentationComments] result of parsing", "Convert all values to one same base unit\n @return [OoxmlSize] base unit", "Parse Document properties\n @return [DocumentProperties]", "Parse CommonNonVisualProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [CommonNonVisualProperties] result of parsing", "Chroma - The \"colorfulness relative to the brightness of a similarly illuminated white\".", "Parse TransitionProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TransitionProperties] result of parsing", "Parse Inserted object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Inserted] result of parsing", "Parse table style property\n @param node [Nokogiri::XML::Element] node to parse\n @return [TableStyleProperties]", "Parse Background object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Background] result of parsing", "Parse StructuredDocumentTag object\n @param node [Nokogiri::XML:Element] node to parse\n @return [StructuredDocumentTag] result of parsing", "Parse Autofilter data\n @param [Nokogiri::XML:Element] node with Autofilter data\n @return [Autofilter] value of Autofilter data", "Parse Paragraph object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Paragraph] result of parsing", "Parse Extension data\n @param [Nokogiri::XML:Element] node with Extension data\n @return [Extension] value of Extension data", "Parse DocxShapeProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxShapeProperties] result of parsing", "Parse ColorProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ColorProperties] result of parsing", "Parse DocxShapeLine object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxShapeLine] result of parsing", "Parse TableProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TableProperties] result of parsing", "Parse CommonSlideData object\n @param node [Nokogiri::XML:Element] node to parse\n @return [CommonSlideData] result of parsing", "Parse TableCellLine object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TableCellLine] result of parsing", "Parse DocxShape object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxShape] result of parsing", "Parse SDTContent object\n @param node [Nokogiri::XML:Element] node to parse\n @return [SDTContent] result of parsing", "Parse CommonTiming object\n @param node [Nokogiri::XML:Element] node to parse\n @return [CommonTiming] result of parsing", "Parse OOXMLCustomGeometry object\n @param node [Nokogiri::XML:Element] node to parse\n @return [OOXMLCustomGeometry] result of parsing", "Parse OldDocxPicture object\n @param node [Nokogiri::XML:Element] node to parse\n @return [OldDocxPicture] result of parsing", "Parse DocxFormula object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxFormula] result of parsing", "Parse NonVisualShapeProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [NonVisualShapeProperties] result of parsing", "Parse XlsxColumnProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [XlsxColumnProperties] result of parsing", "Parse OOXMLTextBox object\n @param node [Nokogiri::XML:Element] node to parse\n @return [OOXMLTextBox] result of parsing", "Return document style by its name\n @param name [String] name of style\n @return [DocumentStyle, nil]", "Return document style by its id\n @param id [String] id of style\n @return [DocumentStyle, nil]", "Parse Box object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Box] result of parsing", "Parse ImageFill object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ImageFill] result of parsing", "Parse Timing object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Timing] result of parsing", "Parse StyleParametres data\n @param [Nokogiri::XML:Element] node with StyleParametres data\n @return [StyleParametres] value of Columns data", "Parse data for Spacing\n @param [Nokogiri::XML:Element] node with Spacing\n @return [Nothing]", "Parse GradientStop object\n @param node [Nokogiri::XML:Element] node to parse\n @return [GradientStop] result of parsing", "Parse AlphaModFix object\n @param node [Nokogiri::XML:Element] node to parse\n @return [AlphaModFix] result of parsing", "Parse TablePart object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TablePart] result of parsing", "Parse SheetView object\n @param node [Nokogiri::XML:Element] node to parse\n @return [SheetView] result of parsing", "Parse DocxDrawingPosition object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxDrawingPosition] result of parsing", "Parse OldDocxShape object\n @param node [Nokogiri::XML:Element] node to parse\n @return [OldDocxShape] result of parsing", "Parse Formula object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Formula] parsed object", "Parse .rels file\n @param file_path [String] path to file\n @return [Relationships]", "Get target names by type\n @param type [String] type of target\n @return [Array<String>] target names", "Parse Numbering Level data\n @param [Nokogiri::XML:Element] node with Numbering Level data\n @return [NumberingLevel] value of Numbering Level data", "Parse CellXfs data\n @param [Nokogiri::XML:Element] node with CellXfs data\n @return [CellXfs] value of CellXfs data", "Parse DocxBlip object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxBlip] result of parsing", "Parse GraphicFrame object\n @param node [Nokogiri::XML:Element] node to parse\n @return [GraphicFrame] result of parsing", "Parse DocxShapeSize object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxShapeSize] result of parsing", "Parse DocxWrapDrawing object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxWrapDrawing] result of parsing", "Parse DocxShapeLinePath object\n @param node [Nokogiri::XML:Element] node to parse\n @return [DocxShapeLinePath] result of parsing", "Parse PresentationFill object\n @param node [Nokogiri::XML:Element] node to parse\n @return [PresentationFill] result of parsing", "Parse ParagraphProperties object\n @param node [Nokogiri::XML:Element] node to parse\n @return [ParagraphProperties] result of parsing", "Parse TableRow object\n @param node [Nokogiri::XML:Element] node to parse\n @return [TableRow] result of parsing", "Parse XlsxDrawingPositionParameters object\n @param node [Nokogiri::XML:Element] node to parse\n @return [XlsxDrawingPositionParameters] result of parsing", "Parse Fill data\n @param [Nokogiri::XML:Element] node with Fill data\n @return [Fill] value of Fill data", "Parse Bookmark object\n @param node [Nokogiri::XML:Element] node to parse\n @return [Bookmark] result of parsing", "Parse PatternFill data\n @param [Nokogiri::XML:Element] node with PatternFill data\n @return [PatternFill] value of PatternFill data", "Sets the base url in redis.  If the first page is a redirect, it sets the base_url to the destination", "convert takes in the key to the emoji to be converted and an optional block\n If block is provided, conversion will be done only if this block evaluates to true.", "Retrieves the document by ID.\n Normally this returns the contents of _source, however, if the 'raw' flag is passed in, it will return the full response hash.\n Returns nil if the document does not exist.\n\n The :fields argument can either be a csv String or an Array. e.g. [:field1,'field2] or \"field1,field2\".\n If the fields parameter is passed in those fields are returned instead of _source.\n\n If, you include _source as a field, along with other fields you MUST set the raw flag to true to\n receive both fields and _source. Otherwise, only _source will be returned", "Deletes the document with the given ID", "Check if this index type is defined, if passed an id\n this will check if the given document exists", "Many of the methods marked protected are called by one line shims in subclasses. This is mostly to facilitate\n better looking rdocs", "Internal use only\n Check response codes from request", "Create the alias in elastic search with the given options\n\n   my_alias.create({ filter: { term: { user_id: 1 } } })", "Creates a new Task instance\n\n @param [Provider] provider The provider to send the message to\n @param [Symbol] The method you wish to call on the provider\n @param [Hash] provider_options={} A hash of options to be passed when\n   invoking the method on the provider.  Any lambda values will be called\n   during the execution stage when {#call} is invoked\n\n Call invokes the task on the provider instance.  Additional parameters can be\n passed in that are merged into the parameters that were provided in {initialize}.\n Proc values will be evaluated before being passed to the provider.\n\n @param [Array] args=[] Additional arguments to pass to the provider method\n @return [#success?] Response of the provider's method", "For each value in the args array, evaluate any procs.\n If the value is a hash, evaluate any values in the hash\n that are procs.", "Send SMTP template - terminal mailing part", "If a source is set, tag the user with it", "Send the org invite and update the status", "Check current user is logged in\n Check organization is valid if specified", "ActiveRecord Compatibility for Her", "Return the role of this user for the provided\n organization", "Redirect to previous url and reset it", "Return all the organizations linked to this dashboard and to which the user has access\n If the dashboard is a template, return all the current user's organizations", "Filter widgets list based on config", "Invoke the command that has already been defined.\n\n This will run the command, processing any tasks defined by {#perform} and\n {#validate} in order, stopping execution if any of the tasks fails.\n Arguments passed in here will be merged with the provider options defined\n in each task.\n @param args [Hash] arguments to be passed to each task", "Returns a list of any optional parameters\n\n Optional parameters are generated automatically by inspecting the optional\n parameters for the definition lambda\n @return [Array<Symbol>] An array of symbols representing optional parameters", "Save current style to theme-previewer-tmp.less stylesheet\n This file overrides theme-previewer-published.less", "Save style to theme-previewer-published.less and discard theme-previewer-tmp.less", "Convert a theme provided as a hash into a properly\n formatted LESS file", "Generate the document content\n by adding body, header, footer and\n page numbering", "Add a repeated header to the document", "Add a repeated footer to the document", "Add page number on every page", "Regular Best Bets", "This method should return a list of search suggestions for a given searcher\n It should return errors if there is no param called 'searcher', if the searcher does not exist\n or if the searcher doesn't implement the 'typeahead' method\n Otherwise, it should return the result of calling the 'typeahead' method as JSON", "Logs a search to the database\n\n This is an API endpoint for logging a search. It requires that at least a search query and a page are\n present in the query parameters. It returns a 200 OK HTTP status if the request was successful, or\n an 400 BAD REQUEST HTTP status if any parameters are missing.", "Logs an event to the database. Typically, these can be clicks or serves.\n\n This is an API endpoint for logging an event. It requires that at least a TODO are\n present in the query parameters. It returns a 200 OK HTTP status if the request was successful, or\n an 400 BAD REQUEST HTTP status if any parameters are missing. This endpoint supports JSONP requests.", "Creates a new session, and logs it in the database\n\n A session is tracked by a UUID that is stored in a cookie, and has a 5 minute expiry time.\n Sessions are stored in the database with the time they were initiated, their expiry time (or end time),\n whether the request originated from a campus IP address, and whether the request originated from a mobile device", "Updates a session's expiration time on cookie and in database\n\n When a request is made with a non-expired session, the expiration time is updated to 5 minutes from the current time.\n This update is reflected in the cookie as well as in the database entry for the session.", "Returns a String representing the link to use when no results are\n found for a search.\n\n This default implementation first looks for the \"i18n_key\" and\n \"default_i18n_key\" in the I18N locale files. If no entry is found\n the \"no_results_link\" from the searcher configuration is returned.\n\n Using the I18N locale files is considered legacy behavior (but\n is preferred in this method to preserve existing functionality).\n Use of the searcher configuration file is preferred.", "The following searches for individual sections of the page.\n This allows us to do client-side requests in cases where the original server-side\n request times out or otherwise fails.", "Set a named constant and make it private", "Creates the methods for the executable with the given name.\n\n @param  [Symbol] name\n         the name of the executable.\n\n @return [void]", "Gets the simulators and transforms the simctl json into Simulator objects", "for use with additionalProperties and strictProperties", "custom split method to account for blank segments", "ReportBuilder Main method", "Call this to exit the program immediately\n with the given error code and message.\n\n +exit_code+:: exit status you'd like to exit with\n +message+:: message to display to the user explaining the problem\n\n If +exit_code+ is a String and +message+ is omitted, +exit_code+ will be used as the message\n and the actual exit code will be 1.\n\n === Examples\n\n     exit_now!(4,\"Oh noes!\")\n       # => exit app with status 4 and show the user \"Oh noes!\" on stderr\n     exit_now!(\"Oh noes!\")\n       # => exit app with status 1 and show the user \"Oh noes!\" on stderr\n     exit_now!(4)\n       # => exit app with status 4 and dont' give the user a message (how rude of you)", "Checks that the basedir can be used, either by\n not existing, or by existing and force is true.\n In that case, we clean it out entirely\n\n +basedir+:: base directory where the user wants to create a new project\n +force+:: if true, and +basedir+ exists, delete it before proceeding\n\n This will exit the app if the dir exists and force is false", "Add content to a file\n\n +file+:: path to the file\n +lines+:: Array of String representing the lines to add\n +options+:: Hash of options:\n             <tt>:before</tt>:: A regexp that will appear right after the new content. i.e.\n                                this is where to insert said content.", "Copies a file, running it through ERB\n\n +relative_path+:: path to the file, relative to the project root, minus the .erb extension\n                   You should use forward slashes to separate paths; this method\n                   will handle making the ultimate path OS independent.\n +options+:: Options to affect how the copy is done:\n             <tt>:from</tt>:: The name of the profile from which to find the file, \"full\" by default\n             <tt>:as</tt>:: The name the file should get if not the one in relative_path\n             <tt>:executable</tt>:: true if this file should be set executable\n             <tt>:binding</tt>:: the binding to use for the template", "Parses +string+, returning an array that can be placed into ARGV or given to OptionParser", "Start your command-line app, exiting appropriately when\n complete.\n\n This *will* exit your program when it completes.  If your\n #main block evaluates to an integer, that value will be sent\n to Kernel#exit, otherwise, this will exit with 0\n\n If the command-line options couldn't be parsed, this\n will exit with 64 and whatever message OptionParser provided.\n\n If a required argument (see #arg) is not found, this exits with\n 64 and a message about that missing argument.", "Normalized all defaults to both string and symbol forms, so\n the user can access them via either means just as they would for\n non-defaulted options", "Handle calling main and trapping any exceptions thrown", "Create the proxy\n\n +option_parser+:: An OptionParser instance\n +options+:: a hash that will store the options\n             set via automatic setting.  The caller should\n             retain a reference to this", "Sets the banner to include these arg names", "Run a shell command, capturing and logging its output.\n If the command completed successfully, it's output is logged at DEBUG.\n If not, its output as logged at INFO.  In either case, its\n error output is logged at WARN.\n\n command:: the command to run as a String or Array of String.  The String form is simplest, but\n           is open to injection.  If you need to execute a command that is assembled from some portion\n           of user input, consider using an Array of String.  This form prevents tokenization that occurs\n           in the String form.  The first element is the command to execute,\n           and the remainder are the arguments. See Methadone::ExecutionStrategy::Base for more info.\n options:: options to control the call. Currently responds to:\n           +:expected+:: an Int or Array of Int representing error codes, <b>in addition to 0</b>, that are\n                         expected and therefore constitute success.  Useful for commands that don't use\n                         exit codes the way you'd like\n block:: if provided, will be called if the command exited nonzero.  The block may take 0, 1, 2, or 3 arguments.\n         The arguments provided are the standard output as a string, standard error as a string, and\n         the exitstatus as an Int.\n         You should be safe to pass in a lambda instead of a block, as long as your\n         lambda doesn't take more than three arguments\n\n Example\n\n     sh \"cp foo /tmp\"\n     sh \"ls /tmp\" do |stdout|\n       # stdout contains the output of ls /tmp\n     end\n     sh \"ls -l /tmp foobar\" do |stdout,stderr|\n       # ...\n     end\n\n Returns the exit status of the command.  Note that if the command doesn't exist, this returns 127.", "Safely call our block, even if the user passed in a lambda", "fakes associations like much like ActiveRecord according to the cached OpenERP data model", "talk OpenERP cryptic associations API", "Generic OpenERP on_change method", "wrapper for OpenERP exec_workflow Business Process Management engine", "Flushes the current object and loads the +attributes+ Hash\n containing the attributes and the associations into the current object", "OpenERP copy method, load persisted copied Object", "Real validations happens on OpenERP side, only pre-validations can happen here eventually", "Creates an instance of `Model` with `to_param` stubbed using a\n generated value that is unique to each object. If `Model` is an\n `ActiveRecord` model, it is prohibited from accessing the database.\n\n For each key in `stubs`, if the model has a matching attribute\n (determined by `respond_to?`) it is simply assigned the submitted values.\n If the model does not have a matching attribute, the key/value pair is\n assigned as a stub return value using RSpec's mocking/stubbing\n framework.\n\n <tt>persisted?</tt> is overridden to return the result of !id.nil?\n This means that by default persisted? will return true. If  you want\n the object to behave as a new record, sending it `as_new_record` will\n set the id to nil. You can also explicitly set :id => nil, in which\n case persisted? will return false, but using `as_new_record` makes the\n example a bit more descriptive.\n\n While you can use stub_model in any example (model, view, controller,\n helper), it is especially useful in view examples, which are\n inherently more state-based than interaction-based.\n\n @example\n\n     stub_model(Person)\n     stub_model(Person).as_new_record\n     stub_model(Person, :to_param => 37)\n     stub_model(Person) {|person| person.first_name = \"David\"}", "Stop the child process by issuing a kill -9.\n\n We then call waitpid() with the pid, which waits for that particular\n child and reaps it.\n\n kill() can set errno to ESRCH if, for some reason, the file\n is gone; regardless the final outcome of this method\n will be to set our @pid variable to nil.\n\n Technically, kill() can also fail with EPERM or EINVAL (wherein\n the signal isn't sent); but we have permissions, and\n we're not doing anything invalid here.", "Our 'rpc'-ish request to mentos. Requires a method name, and then optional\n args, kwargs, code.", "Based on the header we receive, determine if we need\n to read more bytes, and read those bytes if necessary.\n\n Then, do a sanity check with the ids.\n\n Returns a result \u2014\u00a0either highlighted text or metadata.", "Read the header via the pipe.\n\n Returns a header.", "Return the final result for the API. Return Ruby objects for the methods that\n want them, text otherwise.", "Convert a text header into JSON for easy access.", "returns an array of integers suitable for a SQL IN statement.", "we don't evaluate tbe block immediatelly, but postpone it till all the\n action classes are loaded, because we can use them to reference output format", "recursively traverses hash-array structure and converts all to hashes\n accepts more hashes which are then merged", "Helper for creating sub plans", "Returns the items in the current batch", "adds dependencies to graph that +step+ has based\n on the steps referenced in its +input+", "reload actions classes, intended only for devel", "What strategy should be used for rescuing from error in\n the action or its sub actions\n\n @return Strategy\n\n When determining the strategy, the algorithm starts from the\n entry action that by default takes the strategy from #rescue_strategy_for_self\n and #rescue_strategy_for_planned_actions and combines them together.", "Override when different approach should be taken for combining\n the suggested strategies", "Creates a validation error", "analyses the provided csv and builds errors, warnings and info messages", "Creates an order reference for the given object\n @see https://pay.amazon.com/documentation/apireference/201751630#201751670\n @param id [String]\n @param id_type [String]\n @optional inherit_shipping_address [Boolean]\n @optional confirm_now [Boolean]\n @optional amount [String] (required when confirm_now is set to true)\n @optional currency_code [String]\n @optional platform_id [String]\n @optional seller_note [String]\n @optional seller_order_id [String]\n @optional store_name [String]\n @optional custom_information [String]\n @optional supplementary_data [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Returns details about the Billing Agreement object and its current state\n @see https://pay.amazon.com/documentation/apireference/201751630#201751690\n @param amazon_billing_agreement_id [String]\n @optional address_consent_token [String]\n @optional access_token [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Sets billing agreement details such as a description of the agreement\n and other information about the seller.\n @see https://pay.amazon.com/documentation/apireference/201751630#201751700\n @param amazon_billing_agreement_id [String]\n @optional platform_id [String]\n @optional seller_note [String]\n @optional seller_billing_agreement_id [String]\n @optional custom_information [String]\n @optional store_name [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Confirms that the billing agreement is free of constraints and all\n required information has been set on the billing agreement\n @see https://pay.amazon.com/documentation/apireference/201751630#201751710\n @param amazon_billing_agreement_id [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Validates the status of the BillingAgreement object and the payment\n method associated with it\n @see https://pay.amazon.com/documentation/apireference/201751630#201751720\n @param amazon_billing_agreement_id [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Confirms that you want to terminate the billing agreement with the buyer\n and that you do not expect to create any new order references or\n authorizations on this billing agreement\n @see https://pay.amazon.com/documentation/apireference/201751630#201751950\n @param amazon_billing_agreement_id [String]\n @optional closure_reason [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Allows the search of any Amazon Pay order made using secondary\n seller order IDs generated manually, a solution provider, or a custom\n order fulfillment service.\n @param query_id [String]\n @param query_id_type [String]\n @optional created_time_range_start [String]\n @optional created_time_range_end [String]\n @optional sort_order [String]\n @optional page_size [Integer]\n @optional order_reference_status_list_filter Array[String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Returns status of the merchant\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Returns details about the Order Reference object and its current state\n @see https://pay.amazon.com/documentation/apireference/201751630#201751970\n @param amazon_order_reference_id [String]\n @optional address_consent_token [String]\n @optional access_token [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Sets order reference details such as the order total and a description\n for the order\n @see https://pay.amazon.com/documentation/apireference/201751630#201751960\n @param amazon_order_reference_id [String]\n @param amount [String]\n @optional currency_code [String]\n @optional platform_id [String]\n @optional seller_note [String]\n @optional seller_order_id [String]\n @optional request_payment_authorization [Boolean]\n @optional store_name [String]\n @optional order_item_categories Array[String]\n @optional custom_information [String]\n @optional supplementary_data [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Sets order attributes such as the order total and a description\n for the order\n @see https://pay.amazon.com/documentation/apireference/201751630#201751960\n @param amazon_order_reference_id [String]\n @optional amount [String]\n @optional currency_code [String]\n @optional platform_id [String]\n @optional seller_note [String]\n @optional seller_order_id [String]\n @optional request_payment_authorization [Boolean]\n @optional store_name [String]\n @optional order_item_categories Array[String]\n @optional custom_information [String]\n @optional supplementary_data [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Confirms that the order reference is free of constraints and all required\n information has been set on the order reference\n @see https://pay.amazon.com/documentation/apireference/201751630#201751980\n @param amazon_order_reference_id [String]\n @optional success_url [String]\n @optional failure_url [String]\n @optional authorization_amount [String]\n @optional currency_code [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Cancels a previously confirmed order reference\n @see https://pay.amazon.com/documentation/apireference/201751630#201751990\n @param amazon_order_reference_id [String]\n @optional cancelation_reason [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Returns the status of a particular authorization and the total amount\n captured on the authorization\n @see https://pay.amazon.com/documentation/apireference/201751630#201752030\n @param amazon_authorization_id [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Captures funds from an authorized payment instrument.\n @see https://pay.amazon.com/documentation/apireference/201751630#201752040\n @param amazon_authorization_id [String]\n @param capture_reference_id [String]\n @param amount [String]\n @optional currency_code [String]\n @optional seller_capture_note [String]\n @optional soft_descriptor [String]\n @optional provider_credit_details [Array of Hash]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Returns the status of a particular capture and the total amount refunded\n on the capture\n @see https://pay.amazon.com/documentation/apireference/201751630#201752060\n @param amazon_capture_id [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Refunds a previously captured amount\n @see https://pay.amazon.com/documentation/apireference/201751630#201752080\n @param amazon_capture_id [String]\n @param refund_reference_id [String]\n @param amount [String]\n @optional currency_code [String]\n @optional seller_refund_note [String]\n @optional soft_descriptor [String]\n @optional provider_credit_reversal_details [Array of Hash]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Returns the status of a particular refund\n @see https://pay.amazon.com/documentation/apireference/201751630#201752100\n @param amazon_refund_id [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Closes an authorization\n @see https://pay.amazon.com/documentation/apireference/201751630#201752070\n @param amazon_authorization_id [String]\n @optional closure_reason [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "This method builds the provider credit details hash\n that will be combined with either the authorize or capture\n API call.", "This method builds the provider credit reversal\n details hash that will be combined with the refund\n API call.", "This method combines the required and optional\n parameters to sign the post body and generate\n the post url.", "This method signs the post body that is being sent\n using the secret key provided.", "This method performs the post to the MWS endpoint.\n It will retry three times after the initial post if\n the status code comes back as either 500 or 503.", "This method combines multiple API calls to perform\n a complete transaction with minimum requirements.\n @param amazon_reference_id [String]\n @param authorization_reference_id [String]\n @param charge_amount [String]\n @optional charge_currency_code [String]\n @optional charge_note [String]\n @optional charge_order [String]\n @optional store_name [String]\n @optional custom_information [String]\n @optional soft_descriptor [String]\n @optional platform_id [String]\n @optional merchant_id [String]\n @optional mws_auth_token [String]", "Add RoutesRefine to Router\n @param routes_refine [Flame::Router::RoutesRefine] refined routes", "Find the nearest route by path\n @param path [Flame::Path] path for route finding\n @return [Flame::Route, nil] return the found nearest route or `nil`", "Find the path of route\n @param route_or_controller [Flame::Router::Route, Flame::Controller]\n   route or controller\n @param action [Symbol, nil] action (or not for route)\n @return [Flame::Path] mounted path to action of controller", "Create a new instance from controller, by path and with options\n @param controller [Flame::Controller]\n   controller for default scope, views directory and cache\n @param path [Symbol, String] path (full or the last part) for view search\n @param options [Hash] options for template\n @option options [Object] :scope (controller)\n   scope of visibility in rendering\n @option options [Symbol, String, false] :layout ('layout.*')\n   name of the layout file\n @option options [Hash] :tilt options for Tilt\n @option options [Hash] :locals ({}) local variables for rendering\n Render template with layout\n @param cache [Boolean] cache compiles or not\n @return [String] compiled template", "Compile file with Tilt engine\n @param filename [String] filename", "Find template-file by path", "Find layout-files by path", "Find possible directories for the controller", "Make combinations in order with different sizes\n @example Make parts for ['project', 'namespace', 'controller']\n   # => [\n          ['project', 'namespace', 'controller'],\n          ['project', 'namespace'],\n          ['namespace', 'controller'],\n          ['namespace']\n        ]", "Render the layout with template\n @param result [String] result of template rendering", "Compare by parts count and the first arg position\n @param other [Flame::Path] other path\n @return [-1, 0, 1] result of comparing\n Compare with other path by parts\n @param other [Flame::Path, String] other path\n @return [true, false] equal or not\n Complete path for the action of controller\n @param ctrl [Flame::Controller] to which controller adapt\n @param action [Symbol] to which action of controller adapt\n @return [Flame::Path] adapted path\n @todo Add :arg:type support (:id:num, :name:str, etc.)", "Path parts as keys of nested Hashes\n @return [Array(Flame::Router::Routes, Flame::Router::Routes)]\n   whole Routes (parent) and the endpoint (most nested Routes)", "Helpers for `assign_arguments`", "Acccess to the status of response\n @param value [Ineger, nil] integer value for new status\n @return [Integer] current status\n @example Set status value\n   status 200", "Parameters of the request", "Add error's backtrace to @env['rack.errors'] (terminal or file)\n @param error [Exception] exception for class, message and backtrace", "Return response if HTTP-method is OPTIONS", "Redirect for response\n @overload redirect(path, status)\n   Redirect to the string path\n   @param path [String] path\n   @param status [Ingeter, nil] HTTP status\n   @return [nil]\n   @example Redirect to '/hello'\n     redirect '/hello'\n   @example Redirect to '/hello' with status 301\n     redirect '/hello', 301\n @overload redirect(uri, status)\n   Redirect to the URI location\n   @param uri [URI] URI object\n   @param status [Ingeter, nil] HTTP status\n   @return [nil]\n   @example Redirect to 'http://example.com'\n     redirect URI::HTTP.build(host: 'example.com')\n   @example Redirect to 'http://example.com' with status 301\n     redirect URI::HTTP.build(host: 'example.com'), 301\n @overload redirect(*args, status)\n   Redirect to the path of `path_to` method\n   @param args arguments for `path_to` method\n   @param status [Ingeter, nil] HTTP status\n   @return [nil]\n   @example Redirect to `show` method of `ArticlesController` with id = 2\n     redirect ArticlesController, :show, id: 2\n   @example Redirect to method of controller with status 301\n     redirect ArticlesController, :show, { id: 2 }, 301", "Set the Content-Disposition to \"attachment\" with the specified filename,\n instructing the user agents to prompt to save,\n and set Content-Type by filename.\n @param filename [String, nil] filename of attachment\n @param disposition [Symbol, String] main content for Content-Disposition\n @example Set Content-Disposition header without filename\n   attachment\n @example Set Content-Disposition header with filename and Content-Type\n   attachment 'style.css'", "Execute any action from any controller\n @example Execute `new` action of `ArticlesController`\n   reroute ArticlesController, :new\n @example Execute `index` action of `ArticlesController`\n   reroute ArticlesController\n @example Execute `foo` action of current controller\n   reroute :foo", "Request recieving method", "Create a new client.\n @param endpoint [String] the base endpoint to make all requests from\n @param user_agent [String] a user agent string\n Make an HTTP request.\n @param verb [:get, :post, :put, :patch, :delete] the HTTP verb to use\n @param path [String] the path relative to the endpoint\n @param options [Hash] the request parameters\n @option options [Hash] :params the parameters to supply with the url\n @option options [Hash] :form the parameters to supply in the body\n @option options [Hash] :body the direct body contents\n @return [Response] the response", "Creates a unique state and redirects the user to reddit for authentication.", "Do any cleanup or changes after calling the application.", "Assigns a single string representing a reddit authentication errors.", "Store the access token and other details in the user's browser, assigning any errors to\n the 'redd.error' env variable.", "Makes a request, ensuring not to break the rate limit by sleeping.\n @see Client#request", "Convert a hash to an instance of nested model class\n\n This is the default implementation; the resulting object is based on HashModel\n To be overridden by subclasses", "make config.rb based on input data", "Persist changes passed in as a Hash and return a\n representation of that object to the caller.\n\n Example:\n    project = connection.api.projects.find 2\n    project.update_attributes!(:name => 'test')\n\n    # The values passed to update_attributes! are available in calling object\n    project.name            # => 'test'\n Errors:\n    Any error raised by the API will be returned and logged", "convert a hash to an instance of nested model class", "View statistics based on statType, group, season, and organization.\n @see https://statsapi.mlb.com/docs/#operation/stats", "View standings for a league.\n @see https://statsapi.mlb.com/docs/#operation/standings", "View All-Star Ballots per league.\n @see https://statsapi.mlb.com/docs/#operation/allStarBallot", "View All-Star Write-ins per league.\n @see https://statsapi.mlb.com/docs/#operation/allStarWriteIns", "View All-Star Final Vote per league.\n @see https://statsapi.mlb.com/docs/#operation/allStarFinalVote", "View one or more person's stats and biographical information.\n @see https://statsapi.mlb.com/docs/#operation/person", "Runs the RSpec binary.", "Configures RSpec so it allows the `should` syntax that works across all RSpec versions.", "Returns a hash of ActiveRecord adapter options for the currently activated database gem.", "Runs the given `block` for each matrix row that is compatible with the current Ruby.\n\n The row's gemfile will be set as an environment variable, so Bundler will use that gemfile if you shell out in `block`.\n\n At the end it will print a summary of which rows have passed, failed or were skipped (due to incompatible Ruby version).", "Changes the gemfile to the given `path`, runs the given `block`, then resets\n the gemfile to its original path.\n\n @example\n   Gemika::Env.with_gemfile('gemfiles/Gemfile.rails3') do\n     system('rspec spec') or raise 'RSpec failed'\n   end", "Check if the given gem was activated by the current gemfile.\n It might or might not have been `require`d yet.\n\n @example\n   Gemika::Env.gem?('activerecord')\n   Gemika::Env.gem?('activerecord', '= 5.0.0')\n   Gemika::Env.gem?('activerecord', '~> 4.2.0')", "Apply arel predicate on collection", "Returns the catalog message that this Journal Entry references, if any.\n @option opts [Boolean] :replace set to false to not replace placeholder\n   strings in the catalog with the associated values in this Journal Entry.\n   defaults to true.\n @return [String] the catalog provided message for this Journal Entry, or\n   nil if non exists.", "Get the list of unique values stored in the journal for the given field.\n If passed a block, each possible value will be yielded.\n @return [Array] the list of possible values.\n @example Fetch all possible boot ids from the journal\n   j = Systemd::Journal.new\n   j.query_unique('_BOOT_ID')", "Get the maximum length of a data field that will be returned.\n Fields longer than this will be truncated.  Default is 64K.\n @return [Integer] size in bytes.", "Download a file to the specified path.", "Actions have a backticks command that raises a CommandFailed exception\n on failure, so that processing doesn't just blithely continue.", "Convert an unsafe URL into a filesystem-friendly filename.", "If the input is a URL, download the file before beginning processing.", "Dispatch a WorkUnit to this node. Places the node at back at the end of\n the rotation. If we fail to send the WorkUnit, we consider the node to be\n down, and remove this record, freeing up all of its checked-out work units.\n If the Node responds that it's overloaded, we mark it as busy. Returns\n true if the WorkUnit was dispatched successfully.", "Mark this unit as having failed. May attempt a retry.", "A new Worker customizes itself to its WorkUnit at instantiation.\n Return output to the central server, marking the WorkUnit done.", "Mark the WorkUnit failed, returning the exception to central.", "We expect and require internal communication between the central server\n and the workers to succeed. If it fails for any reason, log it, and then\n keep trying the same request.", "Executes the WorkUnit by running the Action, catching all exceptions as\n failures. We capture the thread so that we can kill it from the outside,\n when exiting.", "Run this worker inside of a fork. Attempts to exit cleanly.\n Wraps run_work_unit to benchmark the execution time, if requested.", "When signaled to exit, make sure that the Worker shuts down without firing\n the Node's at_exit callbacks.", "Convenience command for quickly spinning up the central server. More\n sophisticated deployments, load-balancing across multiple app servers,\n should use the config.ru rackup file directly. This method will start\n a single Thin server.", "Install the required CloudCrowd configuration files into the specified\n directory, or the current one.", "Check for configuration files, either in the current directory, or in\n the CLOUD_CROWD_CONFIG environment variable. Exit if they're not found.", "Install a file and log the installation. If we're overwriting a file,\n offer a chance to back out.", "After work units are marked successful, we check to see if all of them have\n finished, if so, continue on to the next phase of the job.", "How complete is this Job?\n Unfortunately, with the current processing sequence, the percent_complete\n can pull a fast one and go backwards. This happens when there's a single\n large input that takes a long time to split, and when it finally does it\n creates a whole swarm of work units. This seems unavoidable.", "A JSON representation of this job includes the statuses of its component\n WorkUnits, as well as any completed outputs.", "When the WorkUnits are all finished, gather all their outputs together\n before removing them from the database entirely. Returns their merged JSON.", "When starting a new job, or moving to a new stage, split up the inputs\n into WorkUnits, and queue them. Workers will start picking them up right\n away.", "When creating a node, specify the port it should run on.\n Starting up a Node registers with the central server and begins to listen\n for incoming WorkUnits.", "Checking in with the central server informs it of the location and\n configuration of this Node. If it can't check-in, there's no point in\n starting.", "The current amount of free memory in megabytes.", "Launch a monitoring thread that periodically checks the node's load\n average and the amount of free memory remaining. If we transition out of\n the overloaded state, let central know.", "If communication is interrupted for external reasons, the central server\n will assume that the node has gone down. Checking in will let central know\n it's still online.", "Trap exit signals in order to shut down cleanly.", "Perform API request; return hash with html content", "Return response from API and write to cache\n @api private", "Return an `ApiRequest` with the url and arguments\n @api private", "Checks for a breach of contract and applies consequences for a breach\n\n @api private\n @param [#call] contracts a callable object\n @return [void]", "Executes a remote call on the current object and serializes it's attributes and\n errors from the response.\n\n Defaults request args to the scope key hash (e.g., { guid: 'ABC-123' }) when none are given.\n Returns false if the response contained errors; otherwise, returns true.", "Read attribute from the attributes hash", "Update an attribute in the attributes hash", "Add the given errors to our internal errors list\n\n ====Examples\n\n   response = remote_call(:action_that_returns_errors, { :stuff => 'foo' })\n\n   add_errors(response.errors)", "Returns a cache key that can be used to identify this record.\n\n ==== Examples\n\n   Product.new.cache_key     # => \"products/new\"\n   Person.search(:guid => \"derp-5\").cache_key  # => \"people/derp-5-20071224150000\" (include updated_at)\n   Product.search(:guid => \"derp-5\").cache_key # => \"products/derp-5\"", "Saves current remote file as local file.\n\n Unfinished download is stored as +target_name.incomplete+ and renamed upon completion.\n\n @param target_name [String] desired local filename, a relative path to current directory or an absolute path\n @param overwrite [Boolean] whether to overwrite local file, or skip this\n @param resume [Boolean] whether to resume an unfinished download, or start over anyway\n\n @yield [event, status] for receive progress notification\n @yieldparam event [Symbol] event of this notification\n @yieldparam status [{Symbol => String,Integer}] details", "Change last modified time for a remote file.\n\n NOTICE: OneDrive by default keeps multiple history version for this operation.\n NOTICE: You must turn off versioning to prevent multiple counts on disk quota.\n\n 3 attempts will be made due to delay after a file upload.\n\n @param time [Time] desired last modified time\n @return [OneDriveFile] new file object returned by API", "Instanciates with app id and secret.\n Issues requests to API endpoint.\n\n @param uri [String] relative path of the API\n @param data [Hash] JSON data to be post\n @param verb [Symbol] HTTP request verb if data is given\n\n @return [Hash] response from API.", "Get a child object by name inside current directory.\n\n @param path [String] name of a child\n\n @return [OneDriveDir,OneDriveFile,OneDrive404] the drive item you asked", "Recursively creates empty directories.\n\n @param name [String] directories you'd like to create\n @return [OneDriveDir] the directory you created", "Uploads a local file into current remote directory using simple upload mode.\n\n @return [OneDriveFile,nil] uploaded file", "Save as OCF\n\n @param [String] output_path the output file path of ePub", "Convert to xml of container item\n\n @return [String] the xml of container item", "Convert options for xml attributes\n\n @param [Hash<Symbol, Object>] hash the hash of symbols and objects for xml attributes\n @return [Hash<String, Object>] the options for xml attributes", "get the witness commitment of coinbase tx.\n if this tx does not coinbase or not have commitment, return nil.", "serialize tx with old tx format", "check this tx is standard.", "get signature hash\n @param [Integer] input_index input index.\n @param [Integer] hash_type signature hash type\n @param [Bitcoin::Script] output_script script pubkey or script code. if script pubkey is P2WSH, set witness script to this.\n @param [Integer] amount bitcoin amount locked in input. required for witness input only.\n @param [Integer] skip_separator_index If output_script is P2WSH and output_script contains any OP_CODESEPARATOR,\n the script code needs  is the witnessScript but removing everything up to and including the last executed OP_CODESEPARATOR before the signature checking opcode being executed.", "verify input signature.\n @param [Integer] input_index\n @param [Bitcoin::Script] script_pubkey the script pubkey for target input.\n @param [Integer] amount the amount of bitcoin, require for witness program only.\n @param [Array] flags the flags used when execute script interpreter.", "generate sighash with legacy format", "verify input signature for legacy tx.", "verify input signature for witness tx.", "get ExtPubkey from priv_key", "serialize extended private key", "Base58 encoded extended private key", "derive new key\n @param [Integer] number a child index\n @param [Boolean] harden whether hardened key or not. If true, 2^31 is added to +number+.\n @return [Bitcoin::ExtKey] derived new key.", "convert privkey version to pubkey version", "serialize extended pubkey", "derive child key", "whether this script is a P2PKH format script.", "whether data push only script which dose not include other opcode", "A witness program is any valid Script that consists of a 1-byte push opcode followed by a data push between 2 and 40 bytes.", "get witness commitment", "If this script is witness program, return its script code,\n otherwise returns the self payload. ScriptInterpreter does not use this.", "get witness version and witness program", "append object to payload", "append opcode to payload\n @param [Integer] opcode append opcode which defined by Bitcoin::Opcodes\n @return [Script] return self", "append data to payload with pushdata opcode\n @param [String] data append data. this data is not binary\n @return [Script] return self", "Check the item is in the chunk of the script.", "removes chunks matching subscript byte-for-byte and returns as a new object.", "Returns a script that deleted the script before the index specified by separator_index.", "generate p2pkh address. if script dose not p2pkh, return nil.", "generate p2sh address. if script dose not p2sh, return nil.", "return bech32 address for payload", "generate entropy from mnemonic word\n @param [Array[String]] words the array of mnemonic word.\n @return [String] an entropy with hex format.", "generate mnemonic words from entropy.\n @param [String] entropy an entropy with hex format.\n @return [Array] the array of mnemonic word.", "generate seed from mnemonic\n if mnemonic protected with passphrase, specify that passphrase.\n @param [Array] mnemonic a array of mnemonic word.\n @param [String] passphrase a passphrase which protects mnemonic. the default value is an empty string.\n @return [String] seed", "calculate entropy checksum\n @param [String] entropy an entropy with bit string format\n @return [String] an entropy checksum with bit string format", "export private key with wif format", "sign +data+ with private key\n @param [String] data a data to be signed with binary format\n @param [Boolean] low_r flag to apply low-R.\n @param [String] extra_entropy the extra entropy for rfc6979.\n @return [String] signature data with binary format", "verify signature using public key\n @param [String] sig signature data with binary format\n @param [String] origin original message\n @return [Boolean] verify result", "generate pubkey ec point\n @return [ECDSA::Point]", "Supported violations include negative integers, excessive padding, garbage\n at the end, and overly long length descriptors. This is safe to use in\n Bitcoin because since the activation of BIP66, signatures are verified to be\n strict DER before being passed to this module, and we know it supports all\n violations present in the blockchain before that point.", "encode hex value to base58 string.", "decode base58 string to hex value.", "calculate witness commitment from tx list.", "return this block height. block height is included in coinbase.\n if block version under 1, height does not include in coinbase, so return nil.", "generate binary payload", "generate sha256-ripemd160 hash for value", "encode Base58 check address.\n @param [String] hex the address payload.\n @param [String] addr_version the address version for P2PKH and P2SH.\n @return [String] Base58 check encoding address.", "decode Base58 check encoding address.\n @param [String] addr address.\n @return [Array] hex and address version", "check transaction validation", "initialize runner\n eval script\n @param [Bitcoin::Script] script_sig a signature script (unlock script which data push only)\n @param [Bitcoin::Script] script_pubkey a script pubkey (locking script)\n @param [Bitcoin::ScriptWitness] witness a witness script\n @return [Boolean] result", "pop the item with the int value for the number specified by +count+ from the stack.", "cast item to int value.", "Returns true if the given data matches the filter\n @param [String] data The data to check the current filter\n @return [Boolean] true if the given data matches the filter", "Hash a data element to an integer in the range [0, F).\n @param [String] element with binary format.\n @return [Integer]", "Checks if the elements may be in the set.\n @param [Array[Integer]] hashes the query hash list.\n @param [Integer] size query size.\n @return [Boolean] whether elements in set.", "encode golomb rice", "decode golomb rice", "Returns Boolean value indicating whether the file at +full_path+ matches +content+.  Checks if file\n is equivalent to content by checking whether or not the MD5 of the remote content is the same as the\n MD5 of the String in +content+.", "Returns Boolean indicating whether the remote file is present and has the same contents as\n the String in +content+.", "Adapts the AST sub-tree that is rooted at the given tag node.", "Adapts the AST sub-tree that is rooted at the given comment node.", "Returns a string representation of this model. For a feature model,\n this will be Gherkin text that is equivalent to the feature being modeled.", "Returns a string representation of this model. For a step model,\n this will be Gherkin text that is equivalent to the step being modeled.", "Adapts the AST sub-tree that is rooted at the given doc string node.", "Returns a string representation of this model. For an outline model,\n this will be Gherkin text that is equivalent to the outline being modeled.", "Executes the given code block with every model that is a child of this model.", "Returns the ancestor model of this model that matches the given type.", "Returns a string representation of this model. For an example model,\n this will be Gherkin text that is equivalent to the example being modeled.", "Send the stanza to all recipients, stamping it with from and\n to addresses first.", "Returns true if this stanza should be processed locally. Returns false\n if it's destined for a remote domain or external component.", "Broadcast unavailable presence from the user's available resources to the\n recipient's available resources. Route the stanza to a remote server if\n the recipient isn't hosted locally.", "Return an unavailable presence stanza addressed from the given JID.", "Route the stanzas to a remote server, stamping a bare JID as the\n to address. Bare JIDs are required for presence subscription stanzas\n sent to the remote contact's server. Return true if the stanzas were\n routed, false if they must be delivered locally.", "Send the stanzas to the local recipient streams, stamping a full JID as\n the to address. It's important to use full JIDs, even when sending to\n local clients, because the stanzas may be routed to other cluster nodes\n for delivery. We need the receiving cluster node to send the stanza just\n to this full JID, not to lookup all JIDs for this user.", "Update this user's information from the given user object.", "Returns the contact with this jid or nil if not found.", "Removes the contact with this jid from the user's roster.", "Update the contact's jid on this user's roster to signal that this user\n has requested the contact's permission to receive their presence updates.", "Add the user's jid to this contact's roster with a subscription state of\n 'from.' This signals that this contact has approved a user's subscription.", "Returns this user's roster contacts as an iq query element.", "Write an iq stanza to the recipient stream representing this contact's\n current roster item state.", "Run the command line application to parse arguments and run sub-commands.\n Exits the process with a non-zero return code to indicate failure.\n\n Returns nothing.", "Many commands must be run in the context of a vines server directory\n created with `vines init`. If the command can't find the server's config\n file, print an error message and exit.\n\n Returns nothing.", "Returns the PubSub system for the domain or nil if pubsub is not enabled\n for this domain.", "Return true if all JIDs belong to components hosted by this server.", "Return the password for the component or nil if it's not hosted here.", "Return true if all of the JIDs are hosted by this server.", "Return true if the two JIDs are allowed to send messages to each other.\n Both domains must have enabled cross_domain_messages in their config files.", "Return the third-level JID's domain with the first subdomain stripped off\n to create a second-level domain. For example, alice@tea.wonderland.lit\n returns wonderland.lit.", "Return true if all JIDs are allowed to exchange cross domain messages.", "Join this node to the cluster by broadcasting its state to the\n other nodes, subscribing to redis channels, and scheduling periodic\n heartbeat broadcasts. This method must be called after initialize\n or this node will not be a cluster member.", "Turn an asynchronous redis query into a blocking call by pausing the\n fiber in which this code is running. Return the result of the query\n from this method, rather than passing it to a callback block.", "Validate the username and password pair.\n\n username - The String login JID to verify.\n password - The String password the user presented to the server.\n\n Examples\n\n   user = storage.authenticate('alice@wonderland.lit', 'secr3t')\n   puts user.nil?\n\n This default implementation validates the password against a bcrypt hash\n of the password stored in the database. Sub-classes not using bcrypt\n passwords must override this method.\n\n Returns a Vines::User object on success, nil on failure.", "Bind to the LDAP server using the provided username and password. If\n authentication succeeds, but the user is not yet stored in our database,\n save the user to the database.\n\n username - The String JID to authenticate.\n password - The String password the user provided.\n block    - The block that receives the authenticated User or nil.\n\n Returns the authenticated User or nil if authentication failed.", "Save missing users to the storage database after they're authenticated\n with LDAP. This allows admins to define users once in LDAP and have them\n sync to the chat database the first time they successfully sign in.\n\n user  - The User to persist, possibly nil.\n block - The block that receives the saved User, possibly nil.\n\n Returns nothing.", "Returns streams for all connected resources for this JID. A resource is\n considered connected after it has completed authentication and resource\n binding.", "Remove the connection from the routing table.", "Send the stanza to the appropriate remote server-to-server stream\n or an external component stream.", "Returns the total number of streams connected to the server.", "Return all pending stanzas to their senders as remote-server-not-found\n errors. Called after a s2s stream has failed to connect.", "Return the client streams to which the from address is allowed to\n contact. Apply the filter block to each stream to narrow the results\n before returning the streams.", "Return the bare JIDs from the list that are allowed to talk to\n the +from+ JID.", "Returns true if the process is running as determined by the numeric\n pid stored in the pid file created by a previous call to start.", "Return true if the domain name matches one of the names in the\n certificate. In other words, is the certificate provided to us really\n for the domain to which we think we're connected?\n\n pem    - The PEM encoded certificate String.\n domain - The domain name String.\n\n Returns true if the certificate was issued for the domain.", "Returns a pair of file names containing the public key certificate\n and matching private key for the given domain. This supports using\n wildcard certificate files to serve several subdomains.\n\n Finding the certificate and private key file for a domain follows these steps:\n\n - Look for <domain>.crt and <domain>.key files in the conf/certs\n   directory. If found, return those file names, otherwise . . .\n\n - Inspect all conf/certs/*.crt files for certificates that contain the\n   domain name either as the subject common name (CN) or as a DNS\n   subjectAltName. The corresponding private key must be in a file of the\n   same name as the certificate's, but with a .key extension.\n\n So in the simplest configuration, the tea.wonderland.lit encryption files\n would be named:\n\n - conf/certs/tea.wonderland.lit.crt\n - conf/certs/tea.wonderland.lit.key\n\n However, in the case of a wildcard certificate for *.wonderland.lit,\n the files would be:\n\n - conf/certs/wonderland.lit.crt\n - conf/certs/wonderland.lit.key\n\n These same two files would be returned for the subdomains of:\n\n - tea.wonderland.lit\n - crumpets.wonderland.lit\n - etc.\n\n domain - The String domain name.\n\n Returns a two element String array for the certificate and private key\n   file names or nil if not found.", "Initialize the stream after its connection to the server has completed.\n EventMachine calls this method when an incoming connection is accepted\n into the event loop.\n\n Returns nothing.", "Read bytes off the stream and feed them into the XML parser. EventMachine\n is responsible for calling this method on its event loop as connections\n become readable.\n\n data - The byte String sent to the server from the client, hopefully XML.\n\n Returns nothing.", "Send the data over the wire to this client.\n\n data - The XML String or XML::Node to write to the socket.\n\n Returns nothing.", "Stream level errors close the stream while stanza and SASL errors are\n written to the client and leave the stream open. All exceptions should\n pass through this method for consistent handling.\n\n e - The StandardError, usually XmppError, that occurred.\n\n Returns nothing.", "Determine the remote and local socket addresses used by this connection.\n\n Returns a two-element Array of String addresses.", "Create a new Member object. Type can be one of 'node', 'way' or\n 'relation'. Ref is the ID of the corresponding Node, Way, or\n Relation. Role is a freeform string and can be empty.\n Return XML for this way. This method uses the Builder library.\n The only parameter ist the builder object.", "Deletes the given element using API write access.\n\n @param [Rosemary::Element] element the element to be created\n @param [Rosemary::Changeset] changeset the changeset to be used to wrap the write access.\n @return [Fixnum] the new version of the deleted element.", "Creates or updates an element depending on the current state of persistance.\n\n @param [Rosemary::Element] element the element to be created\n @param [Rosemary::Changeset] changeset the changeset to be used to wrap the write access.", "Create a new element using API write access.\n\n @param [Rosemary::Element] element the element to be created\n @param [Rosemary::Changeset] changeset the changeset to be used to wrap the write access.\n @return [Fixnum] the id of the newly created element.", "Update an existing element using API write access.\n\n @param [Rosemary::Element] element the element to be created\n @param [Rosemary::Changeset] changeset the changeset to be used to wrap the write access.\n @return [Fixnum] the versiom of the updated element.", "Create a new changeset with an optional comment\n\n @param [String] comment a meaningful comment for this changeset\n @return [Rosemary::Changeset] the changeset which was newly created\n @raise [Rosemary::NotFound] in case the changeset could not be found", "Do a API request without authentication", "Do a API request with authentication, using the given client", "Add one or more tags or nodes to this way.\n\n The argument can be one of the following:\n\n * If the argument is a Hash or an OSM::Tags object, those tags are added.\n * If the argument is an OSM::Node object, its ID is added to the list of node IDs.\n * If the argument is an Integer or String containing an Integer, this ID is added to the list of node IDs.\n * If the argument is an Array the function is called recursively, i.e. all items in the Array are added.\n\n Returns the way to allow chaining.\n\n @return [Rosemary::Way] the way itself", "Return XML for these tags. This method uses the Builder library.\n The only parameter ist the builder object.", "Renders the object as an xml representation compatible to the OSM API\n @return [String] XML", "Return XML for this relation. This method uses the Builder library.\n The only parameter ist the builder object.", "Add one or more tags to this object.\n\n call-seq: add_tags(Hash) -> OsmObject", "Get all relations from the API that have his object as members.\n\n The optional parameter is an Rosemary::API object. If none is specified\n the default OSM API is used.\n\n Returns an array of Relation objects or an empty array.", "Get the history of this object from the API.\n\n The optional parameter is an Rosemary::API object. If none is specified\n the default OSM API is used.\n\n Returns an array of Rosemary::Node, Rosemary::Way, or Rosemary::Relation objects\n with all the versions.", "Extracts the nested value specified by the sequence of idx objects by\n calling dig at each step, returning nil if any intermediate step is nil.\n\n @return CowProxy wrapped value from wrapped object", "Invokes the given block once for each element of self,\n replacing the element with the value returned by the block.\n\n @yield [item] Gives each element in self to the block\n @yieldparam item Wrapped item in self\n @yieldreturn item to replace\n @return [CowProxy::Array] self if block given\n @return [Enumerator] if no block given", "move deltas to on-disk storage, and new_deltas to deltas", "Remove to_delete and then move pending => delta.", "Since the watcher callbacks might invoke EventMachine, we wait until after\n EM startup to start watching for Zk events.", "project to the non-address fields", "Converts strings to UpperCamelCase.\n @param [String] str\n @return [String]", "Calls caller method on object if defined, otherwise yields to block", "lazy-load described_class if it's a string", "Post and create an Authorization.\n Return Boolean.", "Overriding standard method to add new objects", "Calls the PagSeguro web service and register this request for payment.", "Calls the PagSeguro web service and create this request for payment.\n Return boolean.", "Perform a GET request.\n\n # +path+: the path that will be requested. Must be something like <tt>\"transactions/code/739D69-79C052C05280-55542D9FBB33-CAB2B1\"</tt>.\n # +api_version+: the current PagSeguro API version of the requested service\n # +data+: the data that will be sent as query string. Must be a Hash.\n # +headers+: any additional header that will be sent through the request.", "Perform a POST request.\n\n # +path+: the path that will be requested. Must be something like <tt>\"checkout\"</tt>.\n # +api_version+: the current PagSeguro API version of the requested service\n # +data+: the data that will be sent as body data. Must be a Hash.\n # +headers+: any additional header that will be sent through the request.", "Perform a POST request, sending XML data.\n\n # +path+: the path that will be requested. Must be something like <tt>\"checkout\"</tt>.\n # +api_version+: the current PagSeguro API version of the requested service\n # +credentials+: the credentials like ApplicationCredentials or AccountCredentials.\n # +data+: the data that will be sent as body data. Must be a XML.", "Perform a PUT request, sending XML data.\n\n # +path+: the path that will be requested. Must be something like <tt>\"checkout\"</tt>.\n # +credentials+: the credentials like ApplicationCredentials or AccountCredentials.\n # +data+: the data that will be sent as body data. Must be a XML.", "Perform the specified HTTP request. It will include the API credentials,\n api_version, encoding and additional headers.", "Verify if a payment is already included to payment list.\n Returns Boolean.", "The server returns only with a 200 response in case of success.", "Category Tags Endpoint.\n Returns a list of tags for a given category. NOTE `limit` and `offset` must both be set; otherwise they're ignored.\n @param api_key Giphy API Key.\n @param category Filters results by category.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit The maximum number of records to return. (default to 25)\n @option opts [Integer] :offset An optional results offset. Defaults to 0. (default to 0)\n @return [InlineResponse2004]", "Categories Endpoint.\n Returns a list of categories.\n @param api_key Giphy API Key.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit The maximum number of records to return. (default to 25)\n @return [InlineResponse2003]", "Get GIFs by ID Endpoint\n A multiget version of the get GIF by ID endpoint.\n @param api_key Giphy API Key.\n @param ids Filters results by specified GIF IDs, separated by commas.\n @param [Hash] opts the optional parameters\n @return [InlineResponse200]", "Get GIF by ID Endpoint\n Returns a GIF given that GIF's unique ID\n @param api_key Giphy API Key.\n @param gif_id Filters results by specified GIF ID.\n @param [Hash] opts the optional parameters\n @return [InlineResponse2001]", "Random Endpoint\n Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.\n @param api_key Giphy API Key.\n @param [Hash] opts the optional parameters\n @option opts [String] :tag Filters results by specified tag.\n @option opts [String] :rating Filters results by specified rating.\n @option opts [String] :fmt Used to indicate the expected response format. Default is Json. (default to json)\n @return [InlineResponse2002]", "Search Endpoint\n Search all Giphy GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a plus or url encode for phrases. Example paul+rudd, ryan+gosling or american+psycho.\n @param api_key Giphy API Key.\n @param q Search query term or prhase.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit The maximum number of records to return. (default to 25)\n @option opts [Integer] :offset An optional results offset. Defaults to 0. (default to 0)\n @option opts [String] :rating Filters results by specified rating.\n @option opts [String] :lang Specify default country for regional content; use a 2-letter ISO 639-1 country code. See list of supported languages &lt;a href &#x3D; \\&quot;../language-support\\&quot;&gt;here&lt;/a&gt;.\n @option opts [String] :fmt Used to indicate the expected response format. Default is Json. (default to json)\n @return [InlineResponse200]", "Translate Endpoint\n The translate API draws on search, but uses the Giphy `special sauce` to handle translating from one vocabulary to another. In this case, words and phrases to GIFs.\n @param api_key Giphy API Key.\n @param s Search term.\n @param [Hash] opts the optional parameters\n @return [InlineResponse2001]", "Random Sticker Endpoint\n Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.\n @param api_key Giphy API Key.\n @param [Hash] opts the optional parameters\n @option opts [String] :tag Filters results by specified tag.\n @option opts [String] :rating Filters results by specified rating.\n @option opts [String] :fmt Used to indicate the expected response format. Default is Json. (default to json)\n @return [InlineResponse2002]", "Sticker Search Endpoint\n Replicates the functionality and requirements of the classic GIPHY search, but returns animated stickers rather than GIFs.\n @param api_key Giphy API Key.\n @param q Search query term or prhase.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit The maximum number of records to return. (default to 25)\n @option opts [Integer] :offset An optional results offset. Defaults to 0. (default to 0)\n @option opts [String] :rating Filters results by specified rating.\n @option opts [String] :lang Specify default country for regional content; use a 2-letter ISO 639-1 country code. See list of supported languages &lt;a href &#x3D; \\&quot;../language-support\\&quot;&gt;here&lt;/a&gt;.\n @option opts [String] :fmt Used to indicate the expected response format. Default is Json. (default to json)\n @return [InlineResponse200]", "Sticker Translate Endpoint\n The translate API draws on search, but uses the Giphy `special sauce` to handle translating from one vocabulary to another. In this case, words and phrases to GIFs.\n @param api_key Giphy API Key.\n @param s Search term.\n @param [Hash] opts the optional parameters\n @return [InlineResponse2001]", "Outputs the post.date as formatted html, with hooks for CSS styling.\n\n  +date+ is the date object to format as HTML.\n\n Returns string", "Creates an instance of CategoryIndex for each category page, renders it, and\n writes the output to a file.\n\n  +category+ is the category currently being processed.", "Loops through the list of category pages and processes each one.", "Check for an invitation token and process the invite. If an invitation is found, the\n user claims the invite.\n\n Use this only when creating a new user. Invoke manually or from an after_action:\n\n     after_action :process_invite, only: [:create]\n\n Invoke with new_user, or set an instance variable with the standard 'underscore' name of your user model class.\n For example, if your user model is UserProfile, this method will check for @user_profile.", "All resources or organizations should be invitable.\n\n @param [Hash] options - either named_by: <method name> or named: <String>", "Initialize a Command object\n\n @param [Hash] options\n @option options [IO] :output\n   the stream to which printer prints, defaults to stdout\n @option options [Symbol] :printer\n   the printer to use for output logging, defaults to :pretty\n @option options [Symbol] :dry_run\n   the mode for executing command\n\n @api public\n Start external executable in a child process\n\n @example\n   cmd.run(command, [argv1, ..., argvN], [options])\n\n @example\n   cmd.run(command, ...) do |result|\n     ...\n   end\n\n @param [String] command\n   the command to run\n\n @param [Array[String]] argv\n   an array of string arguments\n\n @param [Hash] options\n   hash of operations to perform\n @option options [String] :chdir\n   The current directory.\n @option options [Integer] :timeout\n   Maximum number of seconds to allow the process\n   to run before aborting with a TimeoutExceeded\n   exception.\n @option options [Symbol] :signal\n   Signal used on timeout, SIGKILL by default\n\n @yield [out, err]\n   Yields stdout and stderr output whenever available\n\n @raise [ExitError]\n   raised when command exits with non-zero code\n\n @api public", "Run Ruby interperter with the given arguments\n\n @example\n   ruby %q{-e \"puts 'Hello world'\"}\n\n @api public", "Find printer class or fail\n\n @raise [ArgumentError]\n\n @api private", "pulls out config and makes easy to use hashes\n dirs has the repo paths as keys and the git_repos as values\n repos has repo names as keys and the paths as values", "creates a new heroku app via the API", "Ascending order, oldest is last", "Builds a VTResult object based on the hash and results passed to it\n\n @param hash, Cryptographic hash that was searched\n @param results, Results of the search on Virustotal.com\n\n Outputs the result to STDOUT\n\n @return [String] Pretty text printable representation of the result", "Outputs the result to XML\n\n @return [String] XML representation of the result", "Load all strings of a given file", "Convert csv file to multiple Localizable.strings files for each column", "Process files and create csv\n\n @param [Boolean] write_to_file create or not the csv file\n @return [Hash] the translations formatted if write_to_file", "Basename of given file\n\n @param [String, #read] file_path\n @return [String] basename", "Create the resulting file\n\n @param [Array] keys references of all translations\n @param [Array] strings translations of all languages\n @param [Hash] comments hash containing keys, comments related to each keys, describe the translation", "Utility to call external command\n - pure .popen2 becomes messy with xsel when not reading the output stream\n - xclip doesn't like to have output stream read", "Fetch the +nvim+ version.\n\n @return [String]", "Return all functions defined by the API.", "Set the cursor coodinates\n\n @param coords [Array(Integer, Integer)]\n @return [Array(Integer, Integer)]", "Satisfy the +Enumerable+ interface by yielding each line.\n\n @yieldparam line [String]", "Set a line or line range.\n\n @overload []=(index, string)\n   @param index [Integer]\n   @param string [String]\n\n @overload []=(index, length, strings)\n   @param index [Integer]\n   @param length [Integer]\n   @param strings [Array<String>]\n\n @overload []=(range, strings)\n   @param range [Range]\n   @param strings [Array<String>]\n\n @example Replace the first line using an index\n   line_range[0] = \"first\"\n @example Replace the first two lines using a +Range+\n   line_range[0..1] = [\"first\", \"second\"]\n @example Replace the first two lines using an index and length\n   line_range[0, 2] = [\"first\", \"second\"]", "Make an RPC request and return its response.\n\n If this method is called inside a callback, we are already inside a\n +Fiber+ handler. In that case, we write to the stream and yield the\n +Fiber+. Once the response is received, resume the +Fiber+ and\n return the result.\n\n If this method is called outside a callback, write to the stream and\n run the event loop until a response is received. Messages received\n in the meantime are enqueued to be handled later.", "Need to pass variables in explicity to give the Proc access to them", "Based on solution_constraints, this method tries to find an\n assignment of PackageVersions that is compatible with the\n DependencyGraph. If one cannot be found, the constraints are\n added one at a time until the first unsatisfiable constraint is\n detected. Once the unsatisfiable solution constraint is\n identified, required non-existent packages and the most\n constrained packages are identified and thrown in a\n NoSolutionExists exception.\n\n If a solution constraint refers to a package that doesn't exist\n or the constraint matches no versions, it is considered\n invalid. All invalid solution constraints are collected and\n raised in an InvalidSolutionConstraints exception. If\n valid_packages is non-nil, it is considered the authoritative\n list of extant Packages; otherwise, Package#valid? is used. This\n is useful if the dependency graph represents an already filtered\n set of packages such that a Package actually exists in your\n domain but is added to the dependency graph with no versions, in\n which case Package#valid? would return false even though we\n don't want to report that the package is non-existent.", "This method validates SolutionConstraints and adds their\n corresponding constraints to the workspace.", "Given an assignment of versions to packages, filter down to only\n the required assignments", "Given a workspace and solution constraints, this method returns\n an array that includes only packages that can be induced by the\n solution constraints.", "Validates that each partial upload exists and is marked as one.", "Returns the metadata for this image as PNG chunks.\n\n Chunks will either be of the {ChunkyPNG::Chunk::Text} type for small\n values (in bytes), or of the {ChunkyPNG::Chunk::CompressedText} type\n for values that are larger in size.\n\n @return [Array<ChunkyPNG::Chunk>] An array of metadata chunks.\n @see ChunkyPNG::Image::METADATA_COMPRESSION_TRESHOLD", "Imports an RMagick image as Canvas object.\n @param [Magick::Image] image The image to import\n @return [ChunkyPNG::Canvas] The canvas, constructed from the RMagick image.", "Exports a Canvas as RMagick image instance.\n @param [ChunkyPNG::Canvas] canvas The canvas to export.\n @return [Magick::Image] The RMagick image constructed from the Canvas instance.", "Initializes a vector based on a list of Point instances.\n\n You usually do not want to use this method directly, but call {ChunkyPNG.Vector} instead.\n\n @param [Array<ChunkyPNG::Point>] points\n @see ChunkyPNG.Vector\n Iterates over all the edges in this vector.\n\n An edge is a combination of two subsequent points in the vector. Together, they will form\n a path from the first point to the last point\n\n @param [true, false] close Whether to close the path, i.e. return an edge that connects the last\n   point in the vector back to the first point.\n @return [void]\n @raise [ChunkyPNG::ExpectationFailed] if the vector contains less than two points.\n @see #edges", "Encodes this datastream into a string.\n @return [String] The encoded PNG datastream.", "Checks whether a point is within bounds of this dimension.\n @param [ChunkyPNG::Point, ...] point_like A point-like to bounds-check.\n @return [true, false] True iff the x and y coordinate fall in this dimension.\n @see ChunkyPNG.Point", "CONSTRUCTING COLOR VALUES\n\n Parses a color value given a numeric or string argument.\n\n It supports color numbers, colors in hex notation and named HTML colors.\n\n @param [Integer, String] source The color value.\n @return [Integer] The color value, with the opacity applied if one was\n   given.", "Creates a color by converting it from a string in hex notation.\n\n It supports colors with (#rrggbbaa) or without (#rrggbb) alpha channel\n as well as the 3-digit short format (#rgb) for those without.\n Color strings may include the prefix \"0x\" or \"#\".\n\n @param [String] hex_value The color in hex notation.\n @param [Integer] opacity The opacity value for the color. Overrides any\n    opacity value given in the hex value if given.\n @return [Integer] The color value.\n @raise [ArgumentError] if the value given is not a hex color notation.", "Creates a new color from an HSV triple.\n\n Create a new color using an HSV (sometimes also called HSB) triple. The\n words `value` and `brightness` are used interchangeably and synonymously\n in descriptions of this colorspace. This implementation follows the modern\n convention of 0 degrees hue indicating red.\n\n @param [Fixnum] hue The hue component (0-360)\n @param [Fixnum] saturation The saturation component (0-1)\n @param [Fixnum] value The value (brightness) component (0-1)\n @param [Fixnum] alpha Defaults to opaque (255).\n @return [Integer] The newly constructed color value.\n @raise [ArgumentError] if the hsv triple is invalid.\n @see http://en.wikipedia.org/wiki/HSL_and_HSV", "Creates a new color from an HSL triple.\n\n This implementation follows the modern convention of 0 degrees hue\n indicating red.\n\n @param [Fixnum] hue The hue component (0-360)\n @param [Fixnum] saturation The saturation component (0-1)\n @param [Fixnum] lightness The lightness component (0-1)\n @param [Fixnum] alpha Defaults to opaque (255).\n @return [Integer] The newly constructed color value.\n @raise [ArgumentError] if the hsl triple is invalid.\n @see http://en.wikipedia.org/wiki/HSL_and_HSV", "Convert one HSL or HSV triple and associated chroma to a scaled rgb triple\n\n This method encapsulates the shared mathematical operations needed to\n convert coordinates from a cylindrical colorspace such as HSL or HSV into\n coordinates of the RGB colorspace.\n\n Even though chroma values are derived from the other three coordinates,\n the formula for calculating chroma differs for each colorspace.  Since it\n is calculated differently for each colorspace, it must be passed in as\n a parameter.\n\n @param [Fixnum] hue The hue-component (0-360)\n @param [Fixnum] saturation The saturation-component (0-1)\n @param [Fixnum] y_component The y_component can represent either lightness\n     or brightness/value (0-1) depending on which scheme (HSV/HSL) is being used.\n @param [Fixnum] chroma The associated chroma value.\n @return [Array<Fixnum>] A scaled r,g,b triple. Scheme-dependent\n    adjustments are still needed to reach the true r,g,b values.\n @see http://en.wikipedia.org/wiki/HSL_and_HSV\n @see http://www.tomjewett.com/colors/hsb.html\n @private", "Returns true if this color is fully transparent.\n\n @param [Integer] value The color to test.\n @return [true, false] True if the r, g and b component are equal.", "Composes two colors with an alpha channel using integer math.\n\n This version is faster than the version based on floating point math, so\n this compositing function is used by default.\n\n @param [Integer] fg The foreground color.\n @param [Integer] bg The background color.\n @return [Integer] The composited color.\n @see ChunkyPNG::Color#compose_precise", "Composes two colors with an alpha channel using floating point math.\n\n This method uses more precise floating point math, but this precision is\n lost when the result is converted back to an integer. Because it is\n slower than the version based on integer math, that version is preferred.\n\n @param [Integer] fg The foreground color.\n @param [Integer] bg The background color.\n @return [Integer] The composited color.\n @see ChunkyPNG::Color#compose_quick", "Interpolates the foreground and background colors by the given alpha\n value. This also blends the alpha channels themselves.\n\n A blending factor of 255 will give entirely the foreground,\n while a blending factor of 0 will give the background.\n\n @param [Integer] fg The foreground color.\n @param [Integer] bg The background color.\n @param [Integer] alpha The blending factor (fixed 8bit)\n @return [Integer] The interpolated color.", "Lowers the intensity of a color, by lowering its alpha by a given factor.\n @param [Integer] color The color to adjust.\n @param [Integer] factor Fade factor as an integer between 0 and 255.\n @return [Integer] The faded color.", "Decomposes a color, given a color, a mask color and a background color.\n The returned color will be a variant of the mask color, with the alpha\n channel set to the best fitting value. This basically is the reverse\n operation if alpha composition.\n\n If the color cannot be decomposed, this method will return the fully\n transparent variant of the mask color.\n\n @param [Integer] color The color that was the result of compositing.\n @param [Integer] mask The opaque variant of the color that was being\n   composed\n @param [Integer] bg The background color on which the color was composed.\n @param [Integer] tolerance The decomposition tolerance level, a value\n   between 0 and 255.\n @return [Integer] The decomposed color, a variant of the masked color\n   with the alpha channel set to an appropriate value.", "Checks whether an alpha channel value can successfully be composed\n given the resulting color, the mask color and a background color,\n all of which should be opaque.\n\n @param [Integer] color The color that was the result of compositing.\n @param [Integer] mask The opaque variant of the color that was being\n   composed\n @param [Integer] bg The background color on which the color was composed.\n @param [Integer] tolerance The decomposition tolerance level, a value\n   between 0 and 255.\n @return [Boolean] True if the alpha component can be decomposed\n   successfully.\n @see #decompose_alpha", "Decomposes the alpha channel value given the resulting color, the mask\n color and a background color, all of which should be opaque.\n\n Make sure to call {#alpha_decomposable?} first to see if the alpha\n channel value can successfully decomposed with a given tolerance,\n otherwise the return value of this method is undefined.\n\n @param [Integer] color The color that was the result of compositing.\n @param [Integer] mask The opaque variant of the color that was being\n   composed\n @param [Integer] bg The background color on which the color was composed.\n @return [Integer] The best fitting alpha channel, a value between 0 and\n   255.\n @see #alpha_decomposable?", "Decomposes an alpha channel for either the r, g or b color channel.\n @param [:r, :g, :b] channel The channel to decompose the alpha channel\n   from.\n @param [Integer] color The color that was the result of compositing.\n @param [Integer] mask The opaque variant of the color that was being\n   composed\n @param [Integer] bg The background color on which the color was composed.\n @return [Integer] The decomposed alpha value for the channel.", "Decomposes the alpha channels for the r, g and b color channel.\n @param [Integer] color The color that was the result of compositing.\n @param [Integer] mask The opaque variant of the color that was being\n   composed\n @param [Integer] bg The background color on which the color was composed.\n @return [Array<Integer>] The decomposed alpha values for the r, g and b\n   channels.", "Returns an array with the separate HSV components of a color.\n\n Because ChunkyPNG internally handles colors as Integers for performance\n reasons, some rounding  occurs when importing or exporting HSV colors\n whose coordinates are float-based.  Because of this rounding, #to_hsv and\n #from_hsv may not be perfect inverses.\n\n This implementation follows the modern convention of 0 degrees hue\n indicating red.\n\n @param [Integer] color The ChunkyPNG color to convert.\n @param [Boolean] include_alpha Flag indicates whether a fourth element\n    representing alpha channel should be included in the returned array.\n @return [Array[0]] The hue of the color (0-360)\n @return [Array[1]] The saturation of the color (0-1)\n @return [Array[2]] The value of the color (0-1)\n @return [Array[3]] Optional fourth element for alpha, included if\n    include_alpha=true (0-255)\n @see http://en.wikipedia.org/wiki/HSL_and_HSV", "Returns an array with the separate HSL components of a color.\n\n Because ChunkyPNG internally handles colors as Integers for performance\n reasons, some rounding  occurs when importing or exporting HSL colors\n whose coordinates are float-based.  Because of this rounding, #to_hsl and\n #from_hsl may not be perfect inverses.\n\n This implementation follows the modern convention of 0 degrees hue indicating red.\n\n @param [Integer] color The ChunkyPNG color to convert.\n @param [Boolean] include_alpha Flag indicates whether a fourth element\n     representing alpha channel should be included in the returned array.\n @return [Array<Fixnum>[0]] The hue of the color (0-360)\n @return [Array<Fixnum>[1]] The saturation of the color (0-1)\n @return [Array<Fixnum>[2]] The lightness of the color (0-1)\n @return [Array<Fixnum>[3]] Optional fourth element for alpha, included if\n     include_alpha=true (0-255)\n @see http://en.wikipedia.org/wiki/HSL_and_HSV", "Returns an array with the separate RGBA values for this color.\n\n @param [Integer] color The color to convert.\n @return [Array<Integer>] An array with 4 Integer elements.", "Gets a color value based on a HTML color name.\n\n The color name is flexible. E.g. <tt>'yellowgreen'</tt>, <tt>'Yellow\n green'</tt>, <tt>'YellowGreen'</tt>, <tt>'YELLOW_GREEN'</tt> and\n <tt>:yellow_green</tt> will all return the same color value.\n\n You can include a opacity level in the color name (e.g. <tt>'red @\n 0.5'</tt>) or give an explicit opacity value as second argument. If no\n opacity value is given, the color will be fully opaque.\n\n @param [Symbol, String] color_name The color name. It may include an\n   opacity specifier like <tt>@ 0.8</tt> to set the color's opacity.\n @param [Integer] opacity The opacity value for the color between 0 and\n   255. Overrides any opacity value given in the color name.\n @return [Integer] The color value.\n @raise [ChunkyPNG::Exception] If the color name was not recognized.", "STATIC UTILITY METHODS\n\n Returns the number of sample values per pixel.\n @param [Integer] color_mode The color mode being used.\n @return [Integer] The number of sample values per pixel.", "Returns the number of bytes used for an image pass\n @param [Integer] color_mode The color mode in which the pixels are\n   stored.\n @param [Integer] depth The color depth of the pixels.\n @param [Integer] width The width of the image pass.\n @param [Integer] height The height of the image pass.\n @return [Integer] The number of bytes used per scanline in a datastream.", "Replaces a single pixel in this canvas.\n @param [Integer] x The x-coordinate of the pixel (column)\n @param [Integer] y The y-coordinate of the pixel (row)\n @param [Integer] color The new color for the provided coordinates.\n @return [Integer] The new color value for this pixel, i.e.\n   <tt>color</tt>.\n @raise [ChunkyPNG::OutOfBounds] when the coordinates are outside of the\n   image's dimensions.\n @see #set_pixel", "Replaces a single pixel in this canvas, with bounds checking. It will do\n noting if the provided coordinates are out of bounds.\n\n @param [Integer] x The x-coordinate of the pixel (column)\n @param [Integer] y The y-coordinate of the pixel (row)\n @param [Integer] color The new color value for the provided coordinates.\n @return [Integer] The new color value for this pixel, i.e.\n   <tt>color</tt>, or <tt>nil</tt> if the coordinates are out of bounds.", "Returns an extracted column as vector of pixels.\n @param [Integer] x The 0-based column index.\n @return [Array<Integer>] The vector of pixels in the requested column.", "Replaces a row of pixels on this canvas.\n @param [Integer] y The 0-based row index.\n @param [Array<Integer>] vector The vector of pixels to replace the row\n   with.\n @return [void]", "Replaces a column of pixels on this canvas.\n @param [Integer] x The 0-based column index.\n @param [Array<Integer>] vector The vector of pixels to replace the column\n   with.\n @return [void]", "Alternative implementation of the inspect method.\n @return [String] A nicely formatted string representation of this canvas.\n @private", "Replaces the image, given a new width, new height, and a new pixel array.", "Throws an exception if the x- or y-coordinate is out of bounds.", "Throws an exception if the matrix width and height does not match this canvas' dimensions.", "Creates a tRNS chunk that corresponds with this palette to store the\n alpha channel of all colors.\n\n Note that this chunk can be left out of every color in the palette is\n opaque, and the image is encoded using indexed colors.\n\n @return [ChunkyPNG::Chunk::Transparency] The tRNS chunk.", "Creates a PLTE chunk that corresponds with this palette to store the r,\n g, and b channels of all colors.\n\n @note A PLTE chunk should only be included if the image is encoded using\n   index colors. After this chunk has been built, the palette becomes\n   suitable for encoding an image.\n\n @return [ChunkyPNG::Chunk::Palette] The PLTE chunk.\n @see ChunkyPNG::Palette#can_encode?", "Determines the most suitable colormode for this palette.\n @return [Integer] The colormode which would create the smallest possible\n  file for images that use this exact palette.", "For pretty inspect.\n @return [String] Title with color codes.", "Pretty inspect.\n @return [String] fastbin layouts wrapper with color codes.", "Wrapper the doubly linked list with color codes.\n @param [Array<Integer>] list The list from {#link_list}.\n @return [String] Wrapper with color codes.", "Return the double link list with bin in the center.\n\n The list will like +[..., bk of bk, bk of bin, bin, fd of bin, fd of fd, ...]+.\n @param [Integer] expand_size\n   At most expand size. For +size = 2+, the expand list would be <tt>bk, bk, bin, fd, fd</tt>.\n @return [Array<Integer>] The linked list.", "Show dump results like in gdb's command +x+.\n\n Details are in {HeapInfo::Process#x}.\n @param [Integer] count The number of result need to dump.\n @param [Symbol, String, Integer] address The base address to be dumped.\n @return [void]\n @example\n   x 3, 0x400000\n   # 0x400000:       0x00010102464c457f      0x0000000000000000\n   # 0x400010:       0x00000001003e0002", "Dump data from +address+ until reach null-byte.\n\n @return [String]", "Get the base address and length.\n\n +@info+ will be used for getting the segment base,\n so we can support use symbol as base address.\n @param [Integer, Symbol, String] arg The base address, see examples.\n @param [Integer] len An integer.\n @example\n   base_len_of(123, 321) #=> [123, 321]\n   base_len_of(123) #=> [123, DUMP_BYTES]\n   base_len_of(:heap, 10) #=> [0x603000, 10] # assume heap base @ 0x603000\n   base_len_of('heap+0x30', 10) #=> [0x603030, 10]\n   base_len_of('elf+0x3*2-1') #=> [0x400005, DUMP_BYTES]", "Return segemnts load currently.\n @return [Hash{Symbol => Segment}] The segments in hash format.", "Convert symbol to segment.\n\n @return [HeapInfo::Segment?]\n   The segment object.", "Get the +main_arena+ of libc.\n @return [HeapInfo::Arena]", "Get libc's info.", "Hook all missing methods\n @return [HeapInfo::Nil] return +self+ so that it can be a +nil+ chain.\n @example\n   # h.dump would return Nil when process not found\n   p h.dump(:heap)[8, 8].unpack('Q*')\n   #=> nil", "Start of checkers", "The chunk flags record in low three bits of size\n @return [Array<Symbol>] flags of chunk\n @example\n   c = [0, 0x25].pack(\"Q*\").to_chunk\n   c.flags\n   # [:non_main_arena, :prev_inuse]", "Show the offset in pretty way between the segment.\n Very useful in pwn when leak some address,\n see examples for more details.\n @param [Integer] addr The leaked address.\n @param [Symbol] sym\n   The segement symbol to be calculated offset.\n   If this parameter not given, will loop segments\n   and find the most close one. See examples for more details.\n @return [void] Offset will show to stdout.\n @example\n   h.offset(0x7f11f6ae1670, :libc)\n   #=> 0xf6670 after libc\n   h.offset(0x5559edc057a0, :heap)\n   #=> 0x9637a0 after heap\n   h.offset(0x7f11f6ae1670)\n   #=> 0xf6670 after :libc\n   h.offset(0x5559edc057a0)\n   #=> 0x9637a0 after :heap", "Gdb-like command.\n\n Search a specific value/string/regexp in memory.\n @param [Integer, String, Regexp] pattern\n   The desired search pattern, can be value(+Integer+), string, or regular expression.\n @param [Integer, String, Symbol] from\n   Start address for searching, can be segment(+Symbol+) or segments with offset.\n   See examples for more information.\n @param [Integer] length\n   The search length limit, default is unlimited,\n   which will search until pattern found or reach unreadable memory.\n @param [Boolean] rel\n   To show relative offset of +from+ or absolute address.\n @return [Integer, nil] The first matched address, +nil+ is returned when no such pattern found.\n @example\n   h.find(0xdeadbeef, 'heap+0x10', 0x1000)\n   #=> 6299664 # 0x602010\n   h.find(/E.F/, 0x400000, 4)\n   #=> 4194305 # 0x400001\n   h.find(/E.F/, 0x400000, 3)\n   #=> nil\n   sh_offset = h.find('/bin/sh', :libc) - h.libc\n   #=> 1559771 # 0x17ccdb\n   h.find('/bin/sh', :libc, rel: true) == h.find('/bin/sh', :libc) - h.libc\n   #=> true", "Find pattern in all segments with pretty output.\n\n @param [Integer, String, Regexp] pattern\n   The desired search pattern, can be value(+Integer+), string, or regular expression.\n @param [Symbol, Array<Symbol>] segment\n   Only find pattern in these symbols.\n\n @return [void]", "Show simple information of target process.\n\n Contains program names, pid, and segments' info.\n\n @return [String]\n @example\n   puts h", "Get the value of stack guard.\n\n @return [Integer]\n @example\n   h.canary\n   #=> 11342701118118205184 # 0x9d695e921adc9700", "Read fields extracted from Bash's debugging output\n @return [Hash<Pathname, Array<Integer, nil>>] A hash mapping Bash scripts\n   to Simplecov-style coverage stats", "Updates the stacks that track the history of values for +PWD+ and\n +OLDPWD+\n @param [Pathname] pwd     expanded +PWD+\n @param [Pathname] oldpwd  expanded +OLDPWD+\n @return [void]", "Create an object that can be used for inferring whether a file is or is\n not a shell script.\n @param [String] bash_path path to a Bash interpreter\n Checks whether the provided file refers to a shell script by\n determining whether the first line is a shebang that refers to a shell\n executable, or whether the file has a shellscript extension and contains\n valid shell syntax.\n @param [String,Pathname] filename the name of the file to be checked\n @return [Boolean] whether +filename+ refers to a shell script\n @note returns +false+ when +filename+ is not readable, even if +filename+\n   indeed refers to a shell script.", "Yields fields extracted from a input stream\n @param [String, nil] delimiter   the field separator\n @param [Integer]     field_count the number of fields to extract\n @param [Regexp]      start_match a +Regexp+ that, when matched against the\n   input stream, signifies the beginning of the next series of fields to\n   yield\n @yieldparam [String] field each field extracted from the stream. If\n   +start_match+ is matched with fewer than +field_count+ fields yielded\n   since the last match, yields empty strings until +field_count+ is\n   reached.", "Builds a tarball of the Rust-compiled shared library.", "Logs a debug message to the specified `config.debug_filename`, if set.", "Downloads a Rust binary using a custom URI format, given the target OS and architecture.\n\n Requires the `binary_uri_format` option to be set. The version of the binary is determined by\n the crate version given in `Cargo.toml`.\n\n Returns whether a binary was found and unpacked.", "Defines behaviour on error to emit consistent type.", "Attempts to convert value object to string", "Full path to manual directory\n\n @return [String]\n\n @api private", "Check if manual exists for a command\n\n @param [String] command\n   the command name\n\n @api public", "Read manual page\n\n @api public", "Pages output using configured pager.", "Overrides the processing internals to rescue any exceptions and handle them with the\n registered exception rescue handler.", "Dynamically looks up and then throws the error given by a symbolic name.\n Optionally takes a string message argument and a hash of 'context'.\n @overload error!(name, context = {})\n   @param [Symbol] name the name of the exception, looked up using RocketPants::Errors\n   @param [Hash{Symbol => Object}] context the options passed to the error message translation.\n @overload error!(name, message, context = {})\n   @param [Symbol] name the name of the exception, looked up using RocketPants::Errors\n   @param [String] message an optional message describing the error\n   @param [Hash{Symbol => Object}] context the options passed to the error message translation.\n @raise [RocketPants::Error] the error from the given options", "Returns extra error details for a given object, making it useable\n for hooking in external exceptions.", "Renders an exception as JSON using a nicer version of the error name and\n error message, following the typically error standard as laid out in the JSON\n api design.\n @param [StandardError] exception the error to render a response for.", "Give a response hash from the api, will transform it into\n the correct data type.\n @param [Hash] response the incoming response\n @param [hash] options any options to pass through for transformation\n @return [Object] the transformed response.", "Returns an API response wrapped in a will_paginate collection\n using the pagination key in the response container to set up\n the current number of total entries and page details.\n @param [Array<Object>] objects the actual response contents\n @param [Hash{String => Object}] The response container\n @option container [Hash] \"pagination\" the pagination data to use.", "Finds and uses the transformer for a given incoming object to\n unpack it into a useful data type.\n @param [Hash, Array<Hash>] object the response object to unpack\n @param [Hash] options the unpacking options\n @option options [Hash] :transformer,:as the transformer to use\n @return The transformed data or the data itself when no transformer is specified.", "Lets you add a series of links for the current resource.\n @param [Hash{Symbol => String}] links a hash of links. Those with nil as the value are skipped.", "Given a json object or encoded json, will encode it\n and set it to be the output of the given page.", "Exposes an object to the response - Essentiall, it tells the\n controller that this is what we need to render.", "Extracts the metadata for the current response, merging in options etc.\n Implements a simple hook to allow adding extra metadata to your api.\n\n @param [Object] object the data being exposed\n @param [Hash{Symbol => Object}] options expose options optionally including new metadata.\n @param [Symbol] type the type of the current object\n @param [true,false] singular true iff the current object is a singular resource", "Writes a config file", "There's a potential bug in the creditsafe API where they actually return\n an HTTP 401 if you're unauthorized, hence the sad special case below\n\n rubocop:disable Metrics/MethodLength", "get, post, put and delete methods", "Pull every judgment", "Given a field name-value pair, a data type, and an array of index types, returns a hash of\n mapped names and values. The values in the hash are _arrays_, and may contain multiple values.", "self\n Returns a no_sql_connection which is bound to a mongodb adapter\n or builds a new no_sql_connection if block is given", "Draws the bar", "Initialize RackSessionAccess middleware\n\n @param app a rack application\n @param options\n\n Options:\n * :key - rack session key", "List session data", "Render form for submit new session data", "Update session data", "Dispatch action from request", "Return HTTP method, detect emulated method with _method param", "Returns the minimum entropy for the password's qwerty locality\n adjustments.  If a threshhold is specified we will bail\n early to avoid unnecessary processing.", "Returns the minimum entropy for the passwords dictionary adjustments.\n If a threshhold is specified we will bail early to avoid unnecessary\n processing.\n Note that we only check for the first matching word up to the threshhold if set.\n Subsequent matching words are not deductd.", "Memoize a list of methods\n\n @example\n   memoize :hash\n\n @param [Array<#to_s>] methods\n   a list of methods to memoize\n\n @return [self]\n\n @api public", "Memoize the named method\n\n @param [Symbol] method_name\n   a method name to memoize\n @param [#call] freezer\n   a callable object to freeze the value\n\n @return [undefined]\n\n @api private", "Create a minified one-page version of a timeline by minifying CSS and JS and embedding all assets\n into our ERB template.", "returns true iff the database is in the most recent format", "Project vector onto sphere's surface", "Approximate a curved face with recursively sub-divided triangles.", "Analytically subdivide a face to the required detail level.", "Angle above the XZ plane.", "Texture fixing helper. Spheres have some odd behaviours.", "Fallback filters for non-power-of-2 textures", "synchronize virtual light with the original light", "fit shadow camera's ortho frustum to camera frustum", "For the moment just ignore objects that have multiple materials with different animation methods\n Only the frst material will be taken into account for deciding which depth material to use for shadow maps", "Title for show page of given resource\n @param decorated [Wallaby::ResourceDecorator]\n @return [String]", "Image portrait for given user.\n - if email is present, a gravatar image tag will be returned\n - otherwise, an user icon will be returned\n @param user [Object]\n @return [String] IMG or I element", "Logout path for given user\n @see Wallaby::Configuration::Security#logout_path\n @param user [Object]\n @param app [Object]\n @return [String] URL to log out", "Logout method for given user\n @see Wallaby::Configuration::Security#logout_method\n @param user [Object]\n @return [String, Symbol] http method to log out", "Find controller class\n @param params [Hash]\n @return [Class] controller class", "Find out the model class\n @param params [Hash]\n @return [Class]\n @raise [Wallaby::ModelNotFound] when model class is not found\n @raise [Wallaby::UnprocessableEntity] when there is no corresponding mode found for model class", "Set flash error message\n @param exception [Exception]\n @param env [Hash] @see http://www.rubydoc.info/github/rack/rack/master/file/SPEC", "Validate presence of a type for given field name\n @param type [String, Symbol, nil]\n @return [String, Symbol] type\n @raise [ArgumentError] when type is nil", "Build up tooltip\n @param title [String]\n @param icon_suffix [String]\n @param html_options [Hash]\n @return [String] tooltip HTML", "Build up modal\n @param title [String]\n @param body [String]\n @param html_options [Hash]\n @return [String] modal HTML", "Build up the HTML for displaying error messages\n @param field_name [String/Symbol]\n @return [String] HTML", "Extend label to accept proc type `text` argument\n @see ActionView::Helpers::FormBuilder#label", "Extend select to accept proc type `choices` argument\n @see ActionView::Helpers::FormBuilder#select", "Delegate missing method to `@template`", "To generate remote URL for auto select plugin.\n @see https://github.com/reinteractive/wallaby/blob/master/app/assets/javascripts/wallaby/auto_select.js\n   auto_select.js\n @param url [String, nil]\n   if URL is nil, it will fall back to default remote URL\n @param model_class [Class]\n @param wildcard [String] wildcard that auto_select uses to replace with\n   the typed keyword\n @return [String] URL for autocomplete", "Link for a given model class and filter name\n @param model_class [Class]\n @param filter_name [String, Symbol]\n @param filters [Hash]\n @param url_params [Hash, ActionController::Parameters]\n @return [String] HTML anchor link", "Export link for a given model_class.\n It accepts extra url params\n @param model_class [Class]\n @param url_params [Hash, ActionController::Parameters] extra URL params\n @return [String] HTML anchor link", "Turn a list of classes into tree structure by inheritance.\n @param classes [Array<Class>]\n   a list of all the classes that wallaby supports\n @return [Array<Wallaby::Node>] a tree structure of given classes", "Turn the tree of classes into a nested `ul` list.\n @param array [Array<Wallaby::Node>] root classes\n @return [String] HTML for the whole tree", "Go through provider list and detect which provider is used.\n @param context [ActionController::Base]\n @return [Wallaby::Authorizer]", "Capture exceptions and display the error using error template.\n @param exception [Exception]\n @param symbol [Symbol] http status symbol", "Check if user is allowed to perform action on given subject\n @param action [Symbol, String]\n @param subject [Object, Class]\n @return [true] if allowed\n @return [false] if not allowed\n @since 5.2.0", "Fetch value for given attribute.\n\n If it's used in controller, it will fetch it from class attribute.\n If it's used in view, it will fetch it from controller.\n @param attribute_name [String, Symbol] instance attribute name\n @param class_attribute_name [String, Symbol] class attribute name\n @return [Object] the value", "It overrides the oirgin method to call the origin `find_template` and cache the result during a request.\n @param name [String]\n @param prefixes [Array<String>]\n @param partial [Boolean]\n @param keys [Array<String>] keys of local variables\n @param options [Hash]", "Check user's permission for an action on given subject.\n\n This method will be used in controller.\n @param action [Symbol, String]\n @param subject [Object, Class]\n @raise [Wallaby::Forbidden] when user is not authorized to perform the action.", "Check and see if user is allowed to perform an action on given subject\n @param action [Symbol, String]\n @param subject [Object, Class]\n @return [Boolean]", "Restrict user to assign certain values.\n\n It will do a lookup in policy's methods and pick the first available method:\n\n - attributes\\_for\\_#\\{ action \\}\n - attributes\\_for\n @param action [Symbol, String]\n @param subject [Object]\n @return [Hash] field value paired hash that user's allowed to assign", "Restrict user for mass assignment.\n\n It will do a lookup in policy's methods and pick the first available method:\n\n - permitted\\_attributes\\_for\\_#\\{ action \\}\n - permitted\\_attributes\n @param action [Symbol, String]\n @param subject [Object]\n @return [Array] field list that user's allowed to change.", "Set default options for create action\n @param options [Hash]\n @return [Hash] updated options with default values", "Check user's permission for an action on given subject.\n This method will be used in controller.\n @param action [Symbol, String]\n @param subject [Object, Class]\n @raise [Wallaby::Forbidden] when user is not authorized to perform the action.", "Return link to index page by a given model class\n\n If user's not authorized, nil will be returned\n @param model_class [Class]\n @param url_params [ActionController::Parameters, Hash]\n @param html_options [Hash] (@see ActionView::Helpers::UrlHelper#link_to)\n @return [String, nil] anchor element", "Return link to create page by a given model class\n\n If user's not authorized, nil will be returned\n @param model_class [Class]\n @param html_options [Hash] (@see ActionView::Helpers::UrlHelper#link_to)\n @return [String, nil] anchor element", "Return link to show page by a given model class\n If user's not authorized, resource label will be returned\n @param resource [Object, Wallaby::ResourceDecorator] model class\n @param options [Hash]\n @param html_options [Hash] (@see ActionView::Helpers::UrlHelper#link_to)\n @return [String] anchor element / text", "Return link to edit page by a given model class\n If user's not authorized, resource label will be returned\n @param resource [Object, Wallaby::ResourceDecorator] model class\n @param options [Hash]\n @param html_options [Hash] (@see ActionView::Helpers::UrlHelper#link_to)\n @return [String] anchor element / text", "Return link to delete action by a given model class\n\n If user's not authorized, nil will be returned\n @param resource [Object, Wallaby::ResourceDecorator] model class\n @param html_options [Hash] (@see ActionView::Helpers::UrlHelper#link_to)\n @return [String, nil] anchor element", "Url for index page\n @param model_class [Class]\n @param url_params [ActionController::Parameters, Hash]\n @return [String]", "Url for new resource form page\n @param model_class [Class]\n @return [String]", "Url for edit form page of given resource\n @param resource [Object]\n @param is_resource [Boolean]\n @return [String]", "When a type partial is found, it works as usual.\n\n But when a cell is found, there is an exception {Wallaby::CellHandling} raised. This error will be captured,\n and the cell will be rendered.\n @param context [ActionView::Context]\n @param options [Hash]\n @param block [Proc]\n @return [String] HTML output", "Override origin method to stop rendering when a cell is found.\n @return [ActionView::Template] partial template\n @raise [Wallaby:::CellHandling] when a cell is found", "Returns an array of each scanline's filter type value.", "Re-compress the filtered data.\n\n All arguments are for Zlib. See the document of Zlib::Deflate.new for more detail.", "Process each scanline.\n\n It takes a block with a parameter. The parameter must be an instance of\n PNGlitch::Scanline and it provides ways to edit the filter type and the data\n of the scanlines. Normally it iterates the number of the PNG image height.\n\n Here is some examples:\n\n   pnglitch.each_scanline do |line|\n     line.gsub!(/\\w/, '0') # replace all alphabetical chars in data\n   end\n\n   pnglicth.each_scanline do |line|\n     line.change_filter 3  # change all filter to 3, data will get re-filtering (it won't be a glitch)\n   end\n\n   pnglicth.each_scanline do |line|\n     line.graft 3          # change all filter to 3 and data remains (it will be a glitch)\n   end\n\n See PNGlitch::Scanline for more details.\n\n This method is safer than +glitch+ but will be a little bit slow.\n\n -----\n\n Please note that +each_scanline+ will apply the filters *after* the loop. It means\n a following example doesn't work as expected.\n\n   pnglicth.each_scanline do |line|\n     line.change_filter 3\n     line.gsub! /\\d/, 'x'  # wants to glitch after changing filters.\n   end\n\n To glitch after applying the new filter types, it should be called separately like:\n\n   pnglicth.each_scanline do |line|\n     line.change_filter 3\n   end\n   pnglicth.each_scanline do |line|\n     line.gsub! /\\d/, 'x'\n   end", "Rewrites the width value.", "Rewrites the height value.", "Save to the +file+.", "Rewinds given IOs before and after the block.", "Calculate positions of scanlines", "Registers a custom filter function to encode data.\n\n With this operation, it will be able to change filter encoding behavior despite\n the specified filter type value. It takes a Proc object or a block.", "Registers a custom filter function to decode data.\n\n With this operation, it will be able to change filter decoding behavior despite\n the specified filter type value. It takes a Proc object or a block.", "Save the changes.", "Calculate variance of measurements\n\n @param [Array[Float]] measurements\n\n @return [Float]\n\n @api public", "Run given work and gather time statistics\n\n @param [Float] threshold\n\n @return [Boolean]\n\n @api public", "Assert work is performed within expected iterations per second\n\n @param [Integer] iterations\n\n @return [Boolean]\n\n @api public", "Start the application.", "Convert from a time span in hour or decimal format to a float.\n\n @param [String] time_string either \"M:MM\" or decimal\n @return [#to_f] converted to a floating-point number", "Append a string to the notes for this task.", "Show the network status of the Harvest service.", "Lists shelves for a user", "Get books from a user's shelf", "Add book to a user's shelf\n\n Returns the user's review for the book, which includes all its current shelves", "Perform an API request using API key or OAuth token\n\n path   - Request path\n params - Parameters hash\n\n Will make a request with the configured API key (application\n authentication) or OAuth token (user authentication) if available.", "Perform an API request using API key\n\n path   - Request path\n params - Parameters hash", "Perform an OAuth API request. Goodreads must have been initialized with a valid OAuth access token.\n\n http_method - HTTP verb supported by OAuth gem (one of :get, :post, :delete, etc.)\n path   - Request path\n params - Parameters hash", "Get group details", "Get list of groups a given user is a member of", "Get user details", "Get the specified user's friends\n\n user_id - integer or string", "Recent reviews from all members.\n\n params[:skip_cropped] - Select only non-cropped reviews", "Get review details", "Get list of reviews", "Get a user's review for a given book", "Add review for a book\n\n Params can include :review, :rating, and :shelf\n\n review: text of the review (optional)\n rating: rating (0-5) (optional, default is 0 (no rating))\n shelf: Name of shelf to add book to (optional, must exist, see: shelves.list)\n\n Note that Goodreads API documentation says that this endpoint accepts\n the read_at parameter but it does not appear to work as of 2018-06.", "Edit review for a book\n\n Params can include :review, :rating, :read_at and :shelf, and :finished\n\n review: text of the review (optional)\n rating: rating (0-5) (optional, default is 0 (no rating))\n shelf: Name of shelf to add book to (optional, must exist, see: shelves.list)\n read_at: Time object or String in YYYY-MM-DD format (optional)\n finished: true to mark finished reading (optional)\n shelf: Name of shelf to add book to (optional, must exist, see: shelves.list)", "Search for books\n\n query   - Text to match against book title, author, and ISBN fields.\n options - Optional search parameters\n\n options[:page] - Which page to returns (default: 1)\n options[:field] - Search field. One of: title, author, or genre (default is all)", "Get author details", "Search for an author by name", "Insert a header in packet\n @param [Header] prev header after which insert new one\n @param [String] protocol protocol to insert\n @param [Hash] options protocol specific options\n @return [self]\n @raise [ArgumentError] unknown protocol", "Encapulate another packet in +self+\n @param [Packet] other\n @param [Boolean] parsing set to +true+ to not update last current header field\n    from binding with first other's one. Use only when current header field\n    has its value set accordingly.\n @return [self] +self+ with new headers from +other+\n @since 1.1.0", "Remove headers from +self+\n @param [Array<Header>] hdrs\n @return [self] +self+ with some headers removed\n @raise [FormatError] any headers not in +self+\n @raise [FormatError] removed headers result in an unknown binding\n @since 1.1.0", "Parse a binary string and populate Packet from it.\n @param [String] binary_str\n @param [String,nil] first_header First protocol header. +nil+ means discover it!\n @return [Packet] self\n @raise [ArgumentError] +first_header+ is an unknown header", "Get packet as a pretty formatted string.\n @return [String]", "check if protocol is known\n @param [String] protocol\n @raise [ArgumentError] unknown protocol", "Add a header to packet\n @param [Header::Base] header\n @param [Header::Base] previous_header\n @param [Boolean] parsing\n @return [void]", "Try to guess header from +binary_str+\n @param [String] binary_str\n @return [String] header/protocol name", "Decode packet bottom up\n @return [void]", "Search a upper header for +hdr+\n @param [Header::Base] hdr\n @return [void]\n @yieldparam [Header::Base] found upper header", "here we calculate template operations that depends on\n given process operation status and template id", "Changing custom process or operation classes to default classes.\n If we store error with a custom class and somebody will delete\n or rename this class - we will not be able to load error.", "Provides accessor methods for the members of the MeCab struct.\n @param attr_name [String] attribute name\n @return member values for the MeCab struct\n @raise [NoMethodError] if `attr_name` is not a member of this MeCab struct", "Initializes the wrapped Tagger instance with the given `options`.\n\n Options supported are:\n\n - :rcfile --  resource file\n - :dicdir --  system dicdir\n - :userdic --  user dictionary\n - :lattice_level --  lattice information level (DEPRECATED)\n - :output_format_type --  output format type (wakati, chasen, yomi, etc.)\n - :all_morphs --  output all morphs (default false)\n - :nbest --  output N best results (integer, default 1), requires lattice level >= 1\n - :partial --  partial parsing mode\n - :marginal --  output marginal probability\n - :max_grouping_size --  maximum grouping size for unknown words (default 24)\n - :node_format --  user-defined node format\n - :unk_format --  user-defined unknown node format\n - :bos_format --  user-defined beginning-of-sentence format\n - :eos_format --  user-defined end-of-sentence format\n - :eon_format --  user-defined end-of-NBest format\n - :unk_feature --  feature for unknown word\n - :input_buffer_size -- set input buffer size (default 8192)\n - :allocate_sentence -- allocate new memory for input sentence\n - :theta --  temperature parameter theta (float, default 0.75)\n - :cost_factor --  cost factor (integer, default 700)\n\n <p>MeCab command-line arguments (-F) or long (--node-format) may be used in\n addition to Ruby-style hashs</p>\n <i>Use single-quotes to preserve format options that contain escape chars.</i><br/>\n e.g.<br/>\n\n     nm = Natto::MeCab.new(node_format: '%m\u00a5t%f[7]\u00a5n')\n     => #<Natto::MeCab:0x00000803503ee8                                 \\\n          @model=#<FFI::Pointer address=0x00000802b6d9c0>,              \\\n          @tagger=#<FFI::Pointer address=0x00000802ad3ec0>,             \\\n          @lattice=#<FFI::Pointer address=0x000008035f3980>,            \\\n          @libpath=\"/usr/local/lib/libmecab.so\",                        \\\n          @options={:node_format=>\"%m\u00a5t%f[7]\u00a5n\"},                       \\\n          @dicts=[#<Natto::DictionaryInfo:0x000008035038f8              \\\n                    @filepath=\"/usr/local/lib/mecab/dic/ipadic/sys.dic\" \\\n                    charset=utf8,                                       \\\n                    type=0>]                                            \\\n          @version=0.996>\n\n     puts nm.parse('\u624d\u80fd\u3068\u306f\u6c42\u3081\u308b\u4eba\u9593\u306b\u4e0e\u3048\u3089\u308c\u308b\u3082\u306e\u3067\u306f\u306a\u3044\u3002')\n     \u624d\u80fd    \u30b5\u30a4\u30ce\u30a6\n     \u3068      \u30c8\n     \u306f      \u30cf\n     \u6c42      \u30e2\u30c8\u30e1\u30eb\n     \u4eba\u9593    \u30cb\u30f3\u30b2\u30f3\n     \u306b      \u30cb\n     \u4e0e\u3048    \u30a2\u30bf\u30a8\n     \u3089\u308c\u308b  \u30e9\u30ec\u30eb\n     \u3082\u306e    \u30e2\u30ce\n     \u3067      \u30c7\n     \u306f      \u30cf\n     \u306a\u3044    \u30ca\u30a4\n     \u3002      \u3002\n     EOS\n @param options [Hash, String] the MeCab options\n @raise [MeCabError] if MeCab cannot be initialized with the given `options`\n Parses the given `text`, returning the MeCab output as a single string.\n If a block is passed to this method, then node parsing will be used\n and each node yielded to the given block.\n\n Boundary constraint parsing is available via passing in the\n `boundary_constraints` key in the `options` hash. Boundary constraints\n parsing provides hints to MeCab on where the morpheme boundaries in the\n given `text` are located. `boundary_constraints` value may be either a\n `Regexp` or `String`; please see [String#scan](http://ruby-doc.org/core-2.2.1/String.html#method-i-scan)\n The boundary constraint parsed output will be returned as a single\n string, unless a block is passed to this method for node parsing.\n\n Feature constraint parsing is available by passing in the\n `feature_constraints` key in the `options` hash. Feature constraints\n parsing provides instructions to MeCab to use the feature indicated\n for any morpheme that is an exact match for the given key.\n `feature_constraints` is a hash mapping a specific morpheme (String)\n to a corresponding feature value (String).\n @param text [String] the Japanese text to parse\n @param constraints [Hash] `boundary_constraints` or `feature_constraints`\n @return [String] parsing result from MeCab\n @raise [MeCabError] if the MeCab Tagger cannot parse the given `text`\n @raise [ArgumentError] if the given string `text` argument is `nil`\n @see MeCabNode", "copied from ActiveSupport", "takes an event for which messages should be generated, works out the type of\n notification, updates the notification history in redis, generates the\n notifications", "the global nature of this seems at odds with it calling stop\n within a single coordinator instance. Coordinator is essentially\n a singleton anyway...", "build the object from hash", "return the object in the form of hash", "Instantiate a CLI for an API described by a JSON schema.\n\n @param name [String] The name of the CLI.\n @param schema [Schema] The JSON schema describing the API.\n @param client [Client] A client generated from the JSON schema.\n @param output [IO] The stream to write to.\n Run a command.\n\n @param parameters [Array] The parameters to use when running the\n   command.  The first parameters is the name of the command and the\n   remaining parameters are passed to it.", "Run the command and write the results to the output stream.\n\n @param parameters [Array] The parameters to pass when making a request\n   to run the command.", "Instantiate a link.\n\n @param url [String] The URL to use when making requests.  Include the\n   username and password to use with HTTP basic auth.\n @param link_schema [LinkSchema] The schema for this link.\n @param options [Hash] Configuration for the link.  Possible keys\n   include:\n   - default_headers: Optionally, a set of headers to include in every\n     request made by the client.  Default is no custom headers.\n   - cache: Optionally, a Moneta-compatible cache to store ETags.\n     Default is no caching.\n Make a request to the server.\n\n JSON content received with an ETag is cached.  When the server returns a\n *304 Not Modified* status code content is loaded and returned from the\n cache.  The cache considers headers, in addition to the URL path, when\n creating keys so that requests to the same path, such as for paginated\n results, don't cause cache collisions.\n\n When the server returns a *206 Partial Content* status code the result\n is assumed to be an array and an enumerator is returned.  The enumerator\n yields results from the response until they've been consumed at which\n point, if additional content is available from the server, it blocks and\n makes a request to fetch the subsequent page of data.  This behaviour\n continues until the client stops iterating the enumerator or the dataset\n from the server has been entirely consumed.\n\n @param parameters [Array] The list of parameters to inject into the\n   path.  A request body can be passed as the final parameter and will\n   always be converted to JSON before being transmitted.\n @raise [ArgumentError] Raised if either too many or too few parameters\n   were provided.\n @return [String,Object,Enumerator] A string for text responses, an\n   object for JSON responses, or an enumerator for list responses.", "Unpack the URL and split it into a root URL and a path prefix, if one\n exists.\n\n @param url [String] The complete base URL to use when making requests.\n @return [String,String] A (root URL, path) prefix pair.", "Instantiate an HTTP client.\n\n @param resources [Hash<String,Resource>] A hash that maps method names\n   to resources.\n @param url [String] The URL used by this client.\n Find a resource.\n\n @param name [String] The name of the resource to find.\n @raise [NoMethodError] Raised if the name doesn't match a known resource.\n @return [Resource] The resource matching the name.", "Find a link and invoke it.\n\n @param name [String] The name of the method to invoke.\n @param parameters [Array] The arguments to pass to the method.  This\n   should always be a `Hash` mapping parameter names to values.\n @raise [NoMethodError] Raised if the name doesn't match a known link.\n @return [String,Array,Hash] The response received from the server.  JSON\n   responses are automatically decoded into Ruby objects.", "Get a schema for a named resource.\n\n @param name [String] The name of the resource.\n @raise [SchemaError] Raised if an unknown resource name is provided.", "Get an example request body.\n\n @return [Hash] A sample request body.", "Inject parameters into the link href and return the body, if it exists.\n\n @param parameters [Array] The list of parameters to inject into the\n   path.\n @raise [ArgumentError] Raised if either too many or too few parameters\n   were provided.\n @return [String,Object] A path and request body pair.  The body value is\n   nil if a payload wasn't included in the list of parameters.", "Get the names of the parameters this link expects.\n\n @param parameters [Array] The names of the parameter definitions to\n   convert to parameter names.\n @return [Array<String>] The parameters.", "Get the parameters this link expects.\n\n @param parameters [Array] The names of the parameter definitions to\n   convert to parameter names.\n @return [Array<Parameter|ParameterChoice>] A list of parameter instances\n   that represent parameters to be injected into the link URL.", "Unpack an 'anyOf' or 'oneOf' multi-parameter blob.\n\n @param parameters [Array<Hash>] An array of hashes containing '$ref'\n   keys and definition values.\n @return [Array<Parameter>] An array of parameters extracted from the\n   blob.", "Recursively walk the object hierarchy in the schema to resolve a given\n path.  This is used to find property information related to definitions\n in link hrefs.\n\n @param path [Array<String>] An array of paths to walk, such as\n   ['definitions', 'resource', 'definitions', 'property'].\n @param schema [Hash] The schema to walk.", "Convert a path parameter to a format suitable for use in a path.\n\n @param [Fixnum,String,TrueClass,FalseClass,Time] The parameter to format.\n @return [String] The formatted parameter.", "list of parameters for method signature, body is optional", "Adds a new option to the command. If a block is given, it will be\n executed when the option is successfully parsed.\n\n @param [String, Symbol, nil] short The short option name\n\n @param [String, Symbol, nil] long The long option name\n\n @param [String] desc The option description\n\n @option params [:forbidden, :required, :optional] :argument Whether the\n   argument is forbidden, required or optional\n\n @option params [Boolean] :multiple Whether or not the option should\n   be multi-valued\n\n @option params [Boolean] :hidden Whether or not the option should\n   be printed in the help output\n\n @return [void]", "Defines a new parameter for the command.\n\n @param [Symbol] name The name of the parameter", "Adds a new option with a required argument to the command. If a block is\n given, it will be executed when the option is successfully parsed.\n\n @param [String, Symbol, nil] short The short option name\n\n @param [String, Symbol, nil] long The long option name\n\n @param [String] desc The option description\n\n @option params [Boolean] :multiple Whether or not the option should\n   be multi-valued\n\n @option params [Boolean] :hidden Whether or not the option should\n   be printed in the help output\n\n @return [void]\n\n @deprecated\n\n @see #option", "Parses the command-line arguments into options and arguments.\n\n During parsing, two errors can be raised:\n\n @raise IllegalOptionError if an unrecognised option was encountered,\n   i.e. an option that is not present in the list of option definitions\n\n @raise OptionRequiresAnArgumentError if an option was found that did not\n   have a value, even though this value was required.\n\n @return [Cri::Parser] The option parser self", "Word-wraps and indents the string.\n\n @param [String] str The string to format\n\n @param [Number] width The maximal width of each line. This also includes\n   indentation, i.e. the actual maximal width of the text is\n   `width`-`indentation`.\n\n @param [Number] indentation The number of spaces to indent each line.\n\n @param [Boolean] first_line_already_indented Whether or not the first\n   line is already indented\n\n @return [String] The word-wrapped and indented string", "Creates a new help renderer for the given command.\n\n @param [Cri::Command] cmd The command to generate the help for\n\n @option params [Boolean] :verbose true if the help output should be\n   verbose, false otherwise.\n @return [String] The help text for this command", "Modifies the command using the DSL.\n\n If the block has one parameter, the block will be executed in the same\n context with the command DSL as its parameter. If the block has no\n parameters, the block will be executed in the context of the DSL.\n\n @return [Cri::Command] The command itself", "Defines a new subcommand for the current command using the DSL.\n\n @param [String, nil] name The name of the subcommand, or nil if no name\n   should be set (yet)\n\n @return [Cri::Command] The subcommand", "Returns the commands that could be referred to with the given name. If\n the result contains more than one command, the name is ambiguous.\n\n @param [String] name The full, partial or aliases name of the command\n\n @return [Array<Cri::Command>] A list of commands matching the given name", "Runs the command with the given command-line arguments, possibly invoking\n subcommands and passing on the options and arguments.\n\n @param [Array<String>] opts_and_args A list of unparsed arguments\n\n @param [Hash] parent_opts A hash of options already handled by the\n   supercommand\n\n @return [void]", "Runs the actual command with the given command-line arguments, not\n invoking any subcommands. If the command does not have an execution\n block, an error ir raised.\n\n @param [Array<String>] opts_and_args A list of unparsed arguments\n\n @param [Hash] parent_opts A hash of options already handled by the\n   supercommand\n\n @raise [NotImplementedError] if the command does not have an execution\n   block\n\n @return [void]", "parses the error type into a more useful error message defined in errors.rb\n returns new error object or the original if error cannot be parsed", "this is the lib directory of this gem\n in order to load any puppet functions from this gem we need to add the lib path\n of this gem", "this is required in order to load things only when we need them", "returns a cached list of key words", "looks up the type in the catalog by using the type and title\n and returns the resource in ral format", "returns a formatted array", "this method handles all input and expects a string of text.", "reads input from stdin, since readline requires a tty\n we cannot read from other sources as readline requires a file object\n we parse the string after each input to determine if the input is a multiline_input\n entry.  If it is multiline we run through the loop again and concatenate the\n input", "Given a URI, make an HTTP request\n\n The options Hash recognizes the following keys:\n :timeout:: specifies the timeout (in seconds) for the http request.\n :max_redirects:: the number of times this request will follow 3XX redirects before throwing an error. Default: 4", "this tells ap how to cast our object so we can be specific\n about printing different puppet objects", "Ensure that duplicates have their @hooks object.", "Add a new hook to be executed for the `event_name` event.\n @param [Symbol] event_name The name of the event.\n @param [Symbol] hook_name The name of the hook.\n @param [#call] callable The callable.\n @yield The block to use as the callable (if no `callable` provided).\n @return [PuppetDebugger::Hooks] The receiver.", "Execute the list of hooks for the `event_name` event.\n @param [Symbol] event_name The name of the event.\n @param [Array] args The arguments to pass to each hook function.\n @return [Object] The return value of the last executed hook.", "Get the status of a wip task by id.\n @param [Integer] task_id\n @return [Hash{\"wip_task\" => {\"id\" => Integer, \"status\" => Integer}, \"time\" => timestamp}]", "Find a set of task ids.\n @param [Integer] limit max amount of results to return per request\n @param [Integer] page page of request\n @param [String] group task group\n @param [String] klass task class\n @param [Integer] status Integerish the status of the task\n         see SFRest::Task::STATUS_*\n @return [Array[Integer]]", "Find a set of tasks.\n @param [Hash] datum Hash of filters\n @option datum [Integer] :limit max amount of results to return per request\n @option datum [Integer] :page page of request\n @option datum [String] :group task group\n @option datum [String] :class task class\n @option datum [Integer] :status Integerish the status of the task\n         see SFRest::Task::STATUS_*", "Gets the value of a vairable\n @TODO: this is missnamed becasue it does not check the global paused variable\n @return [Boolean]", "Pauses a specific task identified by its task id.\n This can pause either the task and it's children or just the task\n @param [Integer] task_id\n @param [String] level family|task", "Resumes a specific task identified by its task id.\n This can resume either the task and it's children or just the task\n @param [Integer] task_id\n @param [String] level family|task", "Blocks until a task reaches a specific status\n @param [Integer] task_id\n @param [String] state state to reach\n @param [Integer] max_nap seconds to try before giving up", "Gets the complete list of collections\n Makes multiple requests to the factory to get all the collections on the factory\n @return [Hash{'count' => Integer, 'sites' => Hash}]", "create a site collection\n @param [String] name site collection name\n @param [int|Array] sites nid or array of site nids. First nid is primary\n @param [int|Array] groups gid or array of group ids.\n @param [String] internal_domain_prefix optional the prefix for the internal domain\n                                 defaults to name\n @return [Hash { \"id\" => Integer, \"name\" => String,\n                 \"time\" => \"2016-11-25T13:18:44+00:00\",\n                 \"internal_domain\" => String }]", "sets a site to be a primary site in a site collection\n @param [int] id of the collection where the primary site is being changed\n @param [int] site nid to become the primary site\n @return [Hash{ \"id\" => Integer,\n                \"name\" => String,\n                \"time\" => \"2016-10-28T09:25:26+00:00\",\n                \"primary_site_id\": Integer,\n                \"switched\" => Boolean,\n                \"message\" => String }]", "Modifies the status information.", "Starts an update.", "Gets a list of all site groups.\n @return [Hash] all the groups on the factory plus a count\n                {'count' => count, 'groups' => Hash }\n this will iterate through the group pages", "gets the site ID for the site named sitename\n will page through all the sites available searching for the site\n @param [String] username drupal username (not email)\n @return [Integer] the uid of the drupal user", "Extract the user data for 'key' based on the user result object\n @param [Hash] res result from a request to /users\n @param [String] username\n @param [String] key one of the user data returned (uid, mail, tfa_status...)\n @return [Object] Integer, String, Array, Hash depending on the user data", "Creates a user.\n @param [String] name\n @param [String] email\n @param [Hash] datum hash with elements :pass => string,\n                                        :status => 0|1,\n                                        :roles => Array", "determine what version are available for staging\n @return [Array] Array of available api endpoints", "http request via put\n @param [string] uri\n @return [Object] ruby representation of the json response\n                  if the reponse body  does not parse, raises\n                  a SFRest::InvalidResponse", "http request via delete\n @param [string] uri\n @return [Object] ruby representation of the json response\n                  if the reponse body  does not parse, raises\n                  a SFRest::InvalidResponse", "Confirm that the result looks adequate\n @param [Excon::Response] res\n @param [Boolean] return_status If true returns the integer status\n                  with the reponse\n @return [Array|Object] if return_status then [int, Object]\n                        else Object", "build a get query\n @param [String] current_path the uri like /api/v1/foo\n @param [Hash] datum k,v hash of get query param and value", "Sets the key and value of a variable.", "Gets the complete list of sites\n Makes multiple requests to the factory to get all the sites on the factory\n @param [Boolean] show_incomplete whether to include incomplete sites in\n   the list. The default differs from UI/SF to maintain backward compatibility.\n @return [Hash{'count' => Integer, 'sites' => Hash}]", "Creates a site.\n @param [String] sitename The name of the site to create.\n @param [Integer] group_id  The Id of the group the site is to be a member of.\n @param [String] install_profile The install profile to use when creating the site.\n @param [Integer] codebase The codebase index to use in installs.", "gets the role ID for the role named rolename\n will page through all the roles available searching for the site\n @param [String] rolename the name of the role to find\n @return [Integer] the id of rolename\n this will iterate through the roles pages", "Extract the role data for rolename based on the role result object\n @param [Hash] res result from a request to /roles\n @param [String] rolename\n @return [Object] Integer, String, Array, Hash depending on the user data", "for adding banner_boxes which are closely related to existing ones\n define \"duplicate_extra\" for site-specific actions, eg for additional fields", "Arg manipulation methods", "Add the range selection.\n\n @example Match on results within a single range.\n   selectable.between(field: 1..2)\n\n @example Match on results between multiple ranges.\n   selectable.between(field: 1..2, other: 5..7)\n\n @param [ Hash ] criterion Multiple key/range pairs.\n\n @return [ Selectable ] The cloned selectable.\n\n @since 1.0.0", "Negate the next selection.\n\n @example Negate the selection.\n   selectable.not.in(field: [ 1, 2 ])\n\n @example Add the $not criterion.\n   selectable.not(name: /Bob/)\n\n @example Execute a $not in a where query.\n   selectable.where(:field.not => /Bob/)\n\n @param [ Hash ] criterion The field/value pairs to negate.\n\n @return [ Selectable ] The negated selectable.\n\n @since 1.0.0", "Construct a text search selector.\n\n @example Construct a text search selector.\n   selectable.text_search(\"testing\")\n\n @example Construct a text search selector with options.\n   selectable.text_search(\"testing\", :$language => \"fr\")\n\n @param [ String, Symbol ] terms A string of terms that MongoDB parses\n   and uses to query the text index.\n @param [ Hash ] opts Text search options. See MongoDB documentation\n   for options.\n\n @return [ Selectable ] The cloned selectable.\n\n @since 2.2.0", "Force the values of the criterion to be evolved.\n\n @api private\n\n @example Force values to booleans.\n   selectable.force_typing(criterion) do |val|\n     Boolean.evolve(val)\n   end\n\n @param [ Hash ] criterion The criterion.\n\n @since 1.0.0", "Take the provided criterion and store it as a selection in the query\n selector.\n\n @api private\n\n @example Store the selection.\n   selectable.selection({ field: \"value\" })\n\n @param [ Hash ] criterion The selection to store.\n\n @return [ Selectable ] The cloned selectable.\n\n @since 1.0.0", "Is this queryable equal to another object? Is true if the selector and\n options are equal.\n\n @example Are the objects equal?\n   queryable == criteria\n\n @param [ Object ] other The object to compare against.\n\n @return [ true, false ] If the objects are equal.\n\n @since 1.0.0\n Initialize the new queryable. Will yield itself to the block if a block\n is provided for objects that need additional behaviour.\n\n @example Initialize the queryable.\n   Origin::Queryable.new\n\n @param [ Hash ] aliases The optional field aliases.\n @param [ Hash ] serializers The optional field serializers.\n @param [ Symbol ] driver The driver being used.\n\n @since 1.0.0\n Handle the creation of a copy via #clone or #dup.\n\n @example Handle copy initialization.\n   queryable.initialize_copy(criteria)\n\n @param [ Queryable ] other The original copy.\n\n @since 1.0.0", "Evolve the entry using the aliases.\n\n @api private\n\n @example Evolve the entry.\n   pipeline.evolve(name: 1)\n\n @param [ Hash ] entry The entry to evolve.\n\n @return [ Hash ] The evolved entry.\n\n @since 2.0.0", "Tells origin with method on the class to delegate to when calling an\n original selectable or optional method on the class.\n\n @example Tell origin where to select from.\n   class Band\n     extend Origin::Forwardable\n     select_with :criteria\n\n     def self.criteria\n       Query.new\n     end\n   end\n\n @param [ Symbol ] receiver The name of the receiver method.\n\n @return [ Array<Symbol> ] The names of the forwarded methods.\n\n @since 1.0.0", "Add the aggregation operation.\n\n @api private\n\n @example Aggregate on the operation.\n   aggregation(operation) do |pipeline|\n     pipeline.push(\"$project\" => operation)\n   end\n\n @param [ Hash ] operation The operation for the pipeline.\n\n @return [ Aggregable ] The cloned aggregable.\n\n @since 2.0.0", "Get the pair of objects needed to store the value in a hash by the\n provided key. This is the database field name and the serializer.\n\n @api private\n\n @example Get the name and serializer.\n   smash.storage_pair(\"id\")\n\n @param [ Symbol, String ] key The key provided to the selection.\n\n @return [ Array<String, Object> ] The name of the db field and\n   serializer.\n\n @since 1.0.0", "Add criterion to the selection with the named strategy.\n\n @api private\n\n @example Add criterion with a strategy.\n   mergeable.with_strategy(:__union__, [ 1, 2, 3 ], \"$in\")\n\n @param [ Symbol ] strategy The name of the strategy method.\n @param [ Object ] criterion The criterion to add.\n @param [ String ] operator The MongoDB operator.\n\n @return [ Mergeable ] The cloned query.\n\n @since 1.0.0", "Prepare the value for merging.\n\n @api private\n\n @example Prepare the value.\n   mergeable.prepare(\"field\", \"$gt\", 10)\n\n @param [ String ] field The name of the field.\n @param [ Object ] value The value.\n\n @return [ Object ] The serialized value.\n\n @since 1.0.0", "Merges another selector into this one.\n\n @example Merge in another selector.\n   selector.merge!(name: \"test\")\n\n @param [ Hash, Selector ] other The object to merge in.\n\n @return [ Selector ] The selector.\n\n @since 1.0.0", "Store the value in the selector for the provided key. The selector will\n handle all necessary serialization and localization in this step.\n\n @example Store a value in the selector.\n   selector.store(:key, \"testing\")\n\n @param [ String, Symbol ] key The name of the attribute.\n @param [ Object ] value The value to add.\n\n @return [ Object ] The stored object.\n\n @since 1.0.0", "Evolve a single key selection with various types of values.\n\n @api private\n\n @example Evolve a simple selection.\n   selector.evolve(field, 5)\n\n @param [ Object ] serializer The optional serializer for the field.\n @param [ Object ] value The value to serialize.\n\n @return [ Object ] The serialized object.\n\n @since 1.0.0", "Convert the options to aggregation pipeline friendly options.\n\n @example Convert the options to a pipeline.\n   options.to_pipeline\n\n @return [ Array<Hash> ] The options in pipeline form.\n\n @since 2.0.0", "Adds a method on Symbol for convenience in where queries for the\n provided operators.\n\n @example Add a symbol key.\n   key :all, \"$all\n\n @param [ Symbol ] name The name of the method.\n @param [ Symbol ] strategy The merge strategy.\n @param [ String ] operator The MongoDB operator.\n @param [ String ] additional The additional MongoDB operator.\n\n @since 1.0.0", "Adds sorting criterion to the options.\n\n @example Add sorting options via a hash with integer directions.\n   optional.order_by(name: 1, dob: -1)\n\n @example Add sorting options via a hash with symbol directions.\n   optional.order_by(name: :asc, dob: :desc)\n\n @example Add sorting options via a hash with string directions.\n   optional.order_by(name: \"asc\", dob: \"desc\")\n\n @example Add sorting options via an array with integer directions.\n   optional.order_by([[ name, 1 ], [ dob, -1 ]])\n\n @example Add sorting options via an array with symbol directions.\n   optional.order_by([[ name, :asc ], [ dob, :desc ]])\n\n @example Add sorting options via an array with string directions.\n   optional.order_by([[ name, \"asc\" ], [ dob, \"desc\" ]])\n\n @example Add sorting options with keys.\n   optional.order_by(:name.asc, :dob.desc)\n\n @example Add sorting options via a string.\n   optional.order_by(\"name ASC, dob DESC\")\n\n @param [ Array, Hash, String ] spec The sorting specification.\n\n @return [ Optional ] The cloned optional.\n\n @since 1.0.0", "Add the number of documents to skip.\n\n @example Add the number to skip.\n   optional.skip(100)\n\n @param [ Integer ] value The number to skip.\n\n @return [ Optional ] The cloned optional.\n\n @since 1.0.0", "Limit the returned results via slicing embedded arrays.\n\n @example Slice the returned results.\n   optional.slice(aliases: [ 0, 5 ])\n\n @param [ Hash ] criterion The slice options.\n\n @return [ Optional ] The cloned optional.\n\n @since 1.0.0", "Limits the results to only contain the fields not provided.\n\n @example Limit the results to the fields not provided.\n   optional.without(:name, :dob)\n\n @param [ Array<Symbol> ] args The fields to ignore.\n\n @return [ Optional ] The cloned optional.\n\n @since 1.0.0", "Add a single sort option.\n\n @api private\n\n @example Add a single sort option.\n   optional.add_sort_option({}, :name, 1)\n\n @param [ Hash ] options The options.\n @param [ String ] field The field name.\n @param [ Integer ] direction The sort direction.\n\n @return [ Optional ] The cloned optional.\n\n @since 1.0.0", "Take the provided criterion and store it as an option in the query\n options.\n\n @api private\n\n @example Store the option.\n   optional.option({ skip: 10 })\n\n @param [ Array ] args The options.\n\n @return [ Queryable ] The cloned queryable.\n\n @since 1.0.0", "Add multiple sort options at once.\n\n @api private\n\n @example Add multiple sort options.\n   optional.sort_with_list(:name, :dob, 1)\n\n @param [ Array<String> ] fields The field names.\n @param [ Integer ] direction The sort direction.\n\n @return [ Optional ] The cloned optional.\n\n @since 1.0.0", "Parses and sanitizes a URL.\n\n url     - A String URL.\n options - A Guillotine::Service::Options object.\n\n Returns an Addressable::URI.", "Initializes the adapter.\n\n code_bucket - The Riak::Bucket for all code keys.\n url_bucket  - The Riak::Bucket for all url keys.  If this is not\n               given, the code bucket is used for all keys.\n Public: Stores the shortened version of a URL.\n\n url     - The String URL to shorten and store.\n code    - Optional String code for the URL.\n options - Optional Guillotine::Service::Options\n\n Returns the unique String code for the URL.  If the URL is added\n multiple times, this should return the same code.", "Retrieves a URL riak value from the code.\n\n code - The String code to lookup the URL.\n\n Returns a Riak::RObject, or nil if none is found.", "Retrieves the code riak value for a given URL.\n\n url - The String URL to lookup.\n\n Returns a Riak::RObject, or nil if none is found.", "Create a configuration for this ConfigurationList. This configuration needs\n to have a name.\n\n @note unique names are currently not enforced but likely necessary for the\n   the target to be build successfully.\n\n @param [Types] name Description", "Definiing a property allows the creation of an alias to the actual value.\n This level of indirection allows for the replacement of values which are\n identifiers with a resource representation of it.\n\n @note This is used internally by the resource when it is created to create\n   the getter/setter methods.\n\n @param [String] name of the property\n @param [String] value of the property", "Return the file that matches the specified path. This will traverse\n the project's groups and find the file at the end of the path.\n\n @param [String] name_with_path the path to the file\n @return [FileReference] the file that matches the name, nil if no file\n   matches the path.", "Most Xcode projects have a products group where products are placed. This\n will generate an exception if there is no products group.\n\n @return [Group] the 'Products' group of the project.", "Most Xcode projects have a Frameworks gorup where all the imported\n frameworks are shown. This will generate an exception if there is no\n Frameworks group.\n\n @return [Group] the 'Frameworks' group of the projet.", "Saves the current project at the specified path.\n\n @note currently this does not support saving the workspaces associated\n   with the project to their new location.\n\n @param [String] path the path to save the project", "Return the scheme with the specified name. Raises an error if no schemes\n match the specified name.\n\n @note if two schemes match names, the first matching scheme is returned.\n\n @param [String] name of the specific scheme\n @return [Scheme] the specific scheme that matches the name specified", "Return the target with the specified name. Raises an error if no targets\n match the specified name.\n\n @note if two targets match names, the first matching target is returned.\n\n @param [String] name of the specific target\n @return [Target] the specific target that matches the name specified", "Creates a new target within the Xcode project. This will by default not\n generate all the additional build phases, configurations, and files\n that create a project.\n\n Available targts:\n\n * native\n * aggregate\n\n @param [String] name the name to provide to the target. This will also\n   be the value that other defaults will be based on.\n @param [String,Symbol] type the type of build target to create.\n\n @return [Target] the target created.", "Remove a target from the Xcode project.\n\n @note this will remove the first target that matches the specified name.\n\n @note this will remove only the project entry at the moment and not the\n   the files that may be associated with the target. All build phases,\n   build files, and configurations will automatically be cleaned up when\n   Xcode is opened.\n\n @param [String] name the name of the target to remove from the Xcode\n   project.\n\n @return [Target] the target that has been removed.", "Prints to STDOUT a description of this project's targets, configuration and schemes.", "Using the sytem tool plutil, the specified project file is parsed and\n converted to JSON, which is then converted to a hash object. This content\n contains all the data within the project file and is used to create the\n Registry.\n\n @return [Registry] the representation of the project, this is a Hash with\n   additional methods to provide easier functionality.", "Using the sytem tool plutil, the specified project file is parsed and\n converted to XML, and then converted into a ruby hash object.", "Print an IO input interaction", "Print an IO output interaction", "Create multiple build phases at the same time.\n\n @param [Array<String,Symbol>] base_phase_names are the names of the phases\n   that you want to create for a target.\n\n @return [Array] the phases created.", "Create a product reference file and add it to the product. This is by\n default added to the 'Products' group.\n\n @param [String] name of the product reference to add to the product\n @return [Resource] the product created", "Installs this keychain in the head of teh search path and restores the original on\n completion of the block\n\n @param the block to be invoked with the modified search path", "Import the .p12 certificate file into the keychain using the provided password\n\n @param [String] the path to the .p12 certificate file\n @param [String] the password to open the certificate file", "Returns a list of identities in the keychain.\n\n @return [Array<String>] a list of identity names", "Secure the keychain", "Unlock the keychain using the provided password\n\n @param [String] the password to open the keychain", "Return a specific build configuration.\n\n @note an exception is raised if no configuration matches the specified name.\n\n @param [String] name of a configuration to return\n\n @return [BuildConfiguration] a specific build configuration that\n   matches the specified name.", "Create a configuration for the target or project.\n\n @example creating a new 'App Store Submission' configuration for a project\n\n     project.create_config 'App Store Submission' # => Configuration\n\n @example creating a new 'Ad Hoc' configuration for a target\n\n   target.create_config 'Ad Hoc' do |config|\n     # configuration the new debug config.\n   end\n\n @param [String] name of the configuration to create\n @return [BuildConfiguration] that is created", "Create multiple configurations for a target or project.\n\n @example creating 'Release' and 'Debug for a new target\n\n     new_target = project.create_target 'UniversalBinary'\n     new_target.create_configurations 'Debug', 'Release' do |config|\n       # set up the configurations\n     end\n\n @param [String,Array<String>] configuration_names the names of the\n   configurations to create.", "Return the BuildFile given the file name.\n\n @param [String] name of the FileReference that is being built.\n @return [BuildFile] the BuildFile that links to the file specified with\n   the name.", "Find the first file that has the name or path that matches the specified\n parameter.\n\n @note this is the FileReference, the file being built and not the instance\n   of the BuildFile.\n\n @see #file\n\n @param [String] name the name or the path of the file.\n @return [FileReference] the file referenced that matches the name or path;\n   nil if no file is found.", "Add the specified file to the Build Phase.\n\n First a BuildFile entry is created for the file and then the build file\n entry is added to the particular build phase. A BuildFile identifier must\n exist for each target.\n\n @example adding a source file to the sources build phase\n\n     spec_file = project.group('Specs/Controller').create_file('FirstControllerSpec.m')\n     project.target('Specs').sources_build_phase.add_build_file spec_file\n\n @example adding a source file, that does not use ARC, to the sources build phase\n\n     spec_file = project.group('Specs/Controller').create_file('FirstControllerSpec.m')\n     project.target('Specs').sources_build_phase.add_build_file spec_file, { 'COMPILER_FLAGS' => \"-fno-objc-arc\" }\n\n @param [FileReference] file the FileReference Resource to add to the build\n phase.\n @param [Hash] settings additional build settings that are specifically applied\n   to this individual file.", "Provides a method to generically add objects to the registry. This will\n create a unqiue identifier and add the specified parameters to the\n registry. As all objecst within a the project maintain a reference to this\n registry they can immediately query for newly created items.\n\n @note generally this method should not be called directly and instead\n   resources should provide the ability to assist with generating the\n   correct objects for the registry.\n\n @param [Hash] object_properties a hash that contains all the properties\n   that are known for the particular item.", "Return the names project.  Raises an error if no projects\n match the specified name.\n\n @note if two projects match names, the first matching scheme is returned.\n\n @param [String] name of the specific scheme\n @return [Project] the specific project that matches the name specified", "Establish the Target that this Target Dependency is dependent.\n\n @param [Target] target the target this dependency is based on", "Opens the info plist associated with the configuration and allows you to\n edit the configuration.\n\n @example Editing the configuration\n\n     config = Xcode.project('MyProject.xcodeproj').target('Application').config('Debug')\n     config.info_plist do |plist|\n       puts plist.version  # => 1.0\n       plist.version = 1.1\n       marketing_version = 12.1\n     end\n\n @see InfoPlist", "Retrieve the configuration value for the given name\n\n @param [String] name of the configuration settings to return\n @return [String,Array,Hash] the value stored for the specified configuration", "Set the configuration value for the given name\n\n @param [String] name of the the configuration setting\n @param [String,Array,Hash] value the value to store for the specific setting", "Append a value to the the configuration value for the given name\n\n @param [String] name of the the configuration setting\n @param [String,Array,Hash] value the value to store for the specific setting", "Find all the child groups that have a name that matches the specified name.\n\n @param [String] name of the group that you are looking to return.\n @return [Array<Group>] the groups with the same matching name. This\n   could be no groups, one group, or multiple groups.", "Find all the files that have have a name that matches the specified name.\n\n @param [String] name of the file that you are looking to return.\n @return [Array<FileReference>] the files with the same mathching\n   name. This could be no files, one file, or multiple files.", "Check whether a file or group is contained within this group that has a name\n that matches the one specified\n\n @param [String] name of the group attempting to be found.\n\n @return [Array<Resource>] resource with the name that matches; empty array\n   if no matches were found.", "Adds a group as a child to current group with the given name.\n\n @note A group may be added that has the same name as another group as they\n   are distinguished by a unique identifier and not by name.\n\n @param [String] name of the group that you want to add as a child group of\n   the specified group.\n\n @return [Group] the created group", "Add a file to the specified group. Currently the file creation requires\n the path to the physical file.\n\n @example creating a file with just a path\n\n     project.main_group.create_file 'AppDelegate.m'\n\n @example creating a file with a name and path\n\n     project.main_group.create_file 'name' => 'AppDelegate.m', 'path' => 'Subfolder/AppDelegate.m'\n\n @param [String,Hash] path to the file that is being added or a hash that\n   contains the values would be merged with the default values.\n\n @return [FileReference] the file created.", "Remove the resource from the registry.\n\n @note all children objects of this group are removed as well.", "This method is used internally to find the specified object or add the object\n as a child of this group.\n\n @param [Hash] child_properties the hash of resource to add as a child\n   object of this group if it does not already exist as a child.\n\n @return [Resource] returns the resource that was added a child", "This method is used internally to remove a child object from this and the\n registry.\n\n @param [String] identifier of the child object to be removed.\n @return [Resource] the removed child resource", "Generate all the Builder Tasks for all the matrix of all the Projects and\n Schemes", "Generate all the Builder Tasks for all the matrix of all the Projects,\n Targets, and Configs", "Returns the group specified. If any part of the group does not exist along\n the path the group is created. Also paths can be specified to make the\n traversing of the groups easier.\n\n @note this will attempt to find the paths specified, if it fails to find them\n   it will create one and then continue traversing.\n\n @example Traverse a path through the various sub-groups.\n\n     project.group('Vendor/MyCode/Support Files')\n     # is equivalent to ...\n     project.group('Vendor').first.group('MyCode').first.group('Supporting Files')\n\n @note this path functionality current is only exercised from the project level\n   all groups will treat the path division `/` as simply a character.\n\n @param [String] name the group name to find/create\n\n @return [Group] the group with the specified name.", "!!!! Don't call run twice !!!!", "Derive the maximum number of H3 indexes that could be returned from the input.\n\n @param [String, Array<Array<Array<Float>>>] geo_polygon Either a GeoJSON string\n or a coordinates nested array.\n @param [Integer] resolution Resolution.\n\n @example Derive maximum number of hexagons for given GeoJSON document.\n   geo_json = \"{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\":[[[-1.735839843749998,52.24630137198303],\n     [-1.8923950195312498,52.05249047600099],[-1.56829833984375,51.891749018068246],\n     [-1.27716064453125,51.91208502557545],[-1.19476318359375,52.032218104145294],\n     [-1.24420166015625,52.19413974159753],[-1.5902709960937498,52.24125614966341],\n     [-1.7358398437499998,52.24630137198303]],[[-1.58203125,52.12590076522272],\n     [-1.476287841796875,52.12590076522272],[-1.46392822265625,52.075285904832334],\n     [-1.58203125,52.06937709602395],[-1.58203125,52.12590076522272]],\n     [[-1.4556884765625,52.01531743663362],[-1.483154296875,51.97642166216334],\n     [-1.3677978515625,51.96626938051444],[-1.3568115234375,52.0102459910103],\n     [-1.4556884765625,52.01531743663362]]]}\"\n   H3.max_polyfill_size(geo_json, 9)\n   33391\n\n @example Derive maximum number of hexagons for a nested array of coordinates.\n   coordinates = [\n     [\n       [52.24630137198303, -1.7358398437499998], [52.05249047600099, -1.8923950195312498],\n       [51.891749018068246, -1.56829833984375], [51.91208502557545, -1.27716064453125],\n       [52.032218104145294, -1.19476318359375], [52.19413974159753, -1.24420166015625],\n       [52.24125614966341, -1.5902709960937498], [52.24630137198303, -1.7358398437499998]\n     ],\n     [\n       [52.12590076522272, -1.58203125], [52.12590076522272, -1.476287841796875],\n       [52.075285904832334, -1.46392822265625], [52.06937709602395, -1.58203125],\n       [52.12590076522272, -1.58203125]\n     ],\n     [\n       [52.01531743663362, -1.4556884765625], [51.97642166216334, -1.483154296875],\n       [51.96626938051444, -1.3677978515625], [52.0102459910103, -1.3568115234375],\n       [52.01531743663362, -1.4556884765625]\n     ]\n   ]\n   H3.max_polyfill_size(coordinates, 9)\n   33391\n\n @return [Integer] Maximum number of hexagons needed to polyfill given area.", "Derive a list of H3 indexes that fall within a given geo polygon structure.\n\n @param [String, Array<Array<Array<Float>>>] geo_polygon Either a GeoJSON string or a\n coordinates nested array.\n @param [Integer] resolution Resolution.\n\n @example Derive hexagons for given GeoJSON document.\n   geo_json = \"{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\":[[[-1.735839843799998,52.24630137198303],\n     [-1.8923950195312498,52.05249047600099],[-1.56829833984375,51.891749018068246],\n     [-1.27716064453125,51.91208502557545],[-1.19476318359375,52.032218104145294],\n     [-1.24420166015625,52.19413974159753],[-1.5902709960937498,52.24125614966341],\n     [-1.7358398437499998,52.24630137198303]],[[-1.58203125,52.12590076522272],\n     [-1.476287841796875,52.12590076522272],[-1.46392822265625,52.075285904832334],\n     [-1.58203125,52.06937709602395],[-1.58203125,52.12590076522272]],\n     [[-1.4556884765625,52.01531743663362],[-1.483154296875,51.97642166216334],\n     [-1.3677978515625,51.96626938051444],[-1.3568115234375,52.0102459910103],\n     [-1.4556884765625,52.01531743663362]]]}\"\n   H3.polyfill(geo_json, 5)\n   [\n     599424968551301119, 599424888020664319, 599424970698784767, 599424964256333823,\n     599424969625042943, 599425001837297663, 599425000763555839\n   ]\n\n @example Derive hexagons for a nested array of coordinates.\n   coordinates = [\n     [\n       [52.24630137198303, -1.7358398437499998], [52.05249047600099, -1.8923950195312498],\n       [51.891749018068246, -1.56829833984375], [51.91208502557545, -1.27716064453125],\n       [52.032218104145294, -1.19476318359375], [52.19413974159753, -1.24420166015625],\n       [52.24125614966341, -1.5902709960937498], [52.24630137198303, -1.7358398437499998]\n     ],\n     [\n       [52.12590076522272, -1.58203125], [52.12590076522272, -1.476287841796875],\n       [52.075285904832334, -1.46392822265625], [52.06937709602395, -1.58203125],\n       [52.12590076522272, -1.58203125]\n     ],\n     [\n       [52.01531743663362, -1.4556884765625], [51.97642166216334, -1.483154296875],\n       [51.96626938051444, -1.3677978515625], [52.0102459910103, -1.3568115234375],\n       [52.01531743663362, -1.4556884765625]\n     ]\n   ]\n   H3.polyfill(coordinates, 5)\n   [\n     599424968551301119, 599424888020664319, 599424970698784767, 599424964256333823,\n     599424969625042943, 599425001837297663, 599425000763555839\n   ]\n\n @return [Array<Integer>] Hexagons needed to polyfill given area.", "Derive a nested array of coordinates from a list of H3 indexes.\n\n @param [Array<Integer>] h3_indexes A list of H3 indexes.\n\n @example Get a set of coordinates from a given list of H3 indexes.\n   h3_indexes = [\n     599424968551301119, 599424888020664319, 599424970698784767,\n     599424964256333823, 599424969625042943, 599425001837297663,\n     599425000763555839\n   ]\n   H3.h3_set_to_linked_geo(h3_indexes)\n   [\n     [\n       [52.24425364171531, -1.6470570189756442], [52.19515282473624, -1.7508281227260887],\n       [52.10973325363767, -1.7265910686763437], [52.06042870859474, -1.8301115887419024],\n       [51.97490199314513, -1.8057974545517919], [51.9387204737266, -1.6783497689296265],\n       [51.853128001893175, -1.654344796003053], [51.81682604752331, -1.5274195136674955],\n       [51.866019925789956, -1.424329996292339], [51.829502535462176, -1.2977583914075301],\n       [51.87843896218677, -1.1946402363628545], [51.96394676922824, -1.21787542551618],\n       [52.01267958543637, -1.1145114691876956], [52.09808058649905, -1.1376655003242908],\n       [52.134791926560325, -1.26456988729442], [52.22012854584846, -1.2880298658365215],\n       [52.25672060485973, -1.4154623025177386], [52.20787927927604, -1.5192658757247421]\n     ]\n   ]\n\n @return [Array<Array<Array<Float>>>] Nested array of coordinates.", "Derive H3 index for the given set of coordinates.\n\n @param [Array<Integer>] coords A coordinate pair.\n @param [Integer] resolution The desired resolution of the H3 index.\n\n @example Derive the H3 index for the given coordinates.\n   H3.geo_to_h3([52.24630137198303, -1.7358398437499998], 9)\n   617439284584775679\n\n @raise [ArgumentError] If coordinates are invalid.\n\n @return [Integer] H3 index.", "Derive coordinates for a given H3 index.\n\n The coordinates map to the centre of the hexagon at the given index.\n\n @param [Integer] h3_index A valid H3 index.\n\n @example Derive the central coordinates for the given H3 index.\n   H3.h3_to_geo(617439284584775679)\n   [52.245519061399506, -1.7363137757391423]\n\n @return [Array<Integer>] A coordinate pair.", "Derive the geographical boundary as coordinates for a given H3 index.\n\n This will be a set of 6 coordinate pairs matching the vertexes of the\n hexagon represented by the given H3 index.\n\n If the H3 index is a pentagon, there will be only 5 coordinate pairs returned.\n\n @param [Integer] h3_index A valid H3 index.\n\n @example Derive the geographical boundary for the given H3 index.\n   H3.h3_to_geo_boundary(617439284584775679)\n   [\n     [52.247260929171055, -1.736809158397472], [52.24625850761068, -1.7389279144996015],\n     [52.244516619273476, -1.7384324668792375], [52.243777169245725, -1.7358184256304658],\n     [52.24477956752282, -1.7336997597088104], [52.246521439109415, -1.7341950448552204]\n   ]\n\n @return [Array<Array<Integer>>] An array of six coordinate pairs.", "Derive origin and destination H3 indexes from edge.\n\n Returned in the form\n\n   [origin, destination]\n\n @param [Integer] edge H3 edge index\n\n @example Get origin and destination indexes from edge\n   H3.h3_indexes_from_unidirectional_edge(1266218516299644927)\n   [617700169958293503, 617700169961177087]\n\n @return [Array<Integer>] H3 index array.", "Derive unidirectional edges for a H3 index.\n\n @param [Integer] origin H3 index\n\n @example Get unidirectional indexes from hexagon\n   H3.h3_unidirectional_edges_from_hexagon(612933930963697663)\n   [\n     1261452277305049087, 1333509871342977023, 1405567465380904959,\n     1477625059418832895, 1549682653456760831, 1621740247494688767\n   ]\n\n @return [Array<Integer>] H3 index array.", "Derive coordinates for edge boundary.\n\n @param [Integer] edge H3 edge index\n\n @example\n   H3.h3_unidirectional_edge_boundary(612933930963697663)\n   [\n     [68.92995788193981, 31.831280499087402], [69.39359648991828, 62.345344956509784],\n     [76.163042830191, 94.14309010184775], [87.36469532319619, 145.5581976913368],\n     [81.27137179020497, -34.75841798028461], [73.31022368544393, 0.32561035194326043]\n   ]\n\n @return [Array<Array<Float>>] Edge boundary coordinates for a hexagon", "Derives the hollow hexagonal ring centered at origin with sides of length k.\n\n An error is raised when one of the indexes returned is a pentagon or is\n in the pentagon distortion area.\n\n @param [Integer] origin Origin H3 index.\n @param [Integer] k K distance.\n\n @example Derive the hex ring for the H3 index at k = 1\n   H3.hex_ring(617700169983721471, 1)\n   [\n     617700170044014591, 617700170047946751, 617700169984245759,\n     617700169982672895, 617700169983983615, 617700170044276735\n   ]\n\n @raise [ArgumentError] Raised if the hex ring contains a pentagon.\n\n @return [Array<Integer>] Array of H3 indexes within the hex ring.", "Derives H3 indexes within k distance for each H3 index in the set.\n\n @param [Array<Integer>] h3_set Set of H3 indexes\n @param [Integer] k K distance.\n @param [Boolean] grouped Whether to group the output. Default true.\n\n @example Derive the hex ranges for a given H3 set with k of 0.\n   H3.hex_ranges([617700169983721471, 617700169982672895], 1)\n   {\n     617700169983721471 => [\n       [617700169983721471],\n       [\n         617700170047946751, 617700169984245759, 617700169982672895,\n         617700169983983615, 617700170044276735, 617700170044014591\n       ]\n     ],\n     617700169982672895 = > [\n       [617700169982672895],\n       [\n         617700169984245759, 617700169983197183, 617700169983459327,\n         617700169982935039, 617700169983983615, 617700169983721471\n       ]\n     ]\n   }\n\n @example Derive the hex ranges for a given H3 set with k of 0 ungrouped.\n   H3.hex_ranges([617700169983721471, 617700169982672895], 1, grouped: false)\n   [\n     617700169983721471, 617700170047946751, 617700169984245759,\n     617700169982672895, 617700169983983615, 617700170044276735,\n     617700170044014591, 617700169982672895, 617700169984245759,\n     617700169983197183, 617700169983459327, 617700169982935039,\n     617700169983983615, 617700169983721471\n   ]\n\n @raise [ArgumentError] Raised if any of the ranges contains a pentagon.\n\n @see #hex_range\n\n @return [Hash] Hash of H3 index keys, with array values grouped by k-ring.", "Derives the k-ring for the given origin at k distance, sub-grouped by distance.\n\n @param [Integer] origin Origin H3 index.\n @param [Integer] k K distance.\n\n @example Derive k-ring at distance 2\n   H3.k_ring_distances(617700169983721471, 2)\n   {\n     0 => [617700169983721471],\n     1 = >[\n       617700170047946751, 617700169984245759, 617700169982672895,\n       617700169983983615, 617700170044276735, 617700170044014591\n     ],\n     2 => [\n       617700170048995327, 617700170047684607, 617700170048471039,\n       617700169988177919, 617700169983197183, 617700169983459327,\n       617700169982935039, 617700175096053759, 617700175097102335,\n       617700170043752447, 617700170043490303, 617700170045063167\n     ]\n   }\n\n @return [Hash] Hash of k-ring distances grouped by distance.", "Derives the hexadecimal string representation for a given H3 index.\n\n @param [Integer] h3_index A valid H3 index.\n\n @example Derive the given hexadecimal form for the H3 index\n   H3.h3_to_string(617700169958293503)\n   \"89283470dcbffff\"\n\n @return [String] H3 index in hexadecimal form.", "Convert a GeoJSON document to a nested array of coordinates.\n\n @param [String] input The GeoJSON document. This can be a feature collection, feature,\n   or polygon. If a feature collection is provided, the first feature is used.\n\n @example Convert a GeoJSON document of Banbury to a set of nested coordinates.\n   document = \"{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\":[\n     [\n       [-1.7358398437499998,52.24630137198303], [-1.8923950195312498,52.05249047600099],\n       [-1.56829833984375,51.891749018068246], [-1.27716064453125,51.91208502557545],\n       [-1.19476318359375,52.032218104145294], [-1.24420166015625,52.19413974159753],\n       [-1.5902709960937498,52.24125614966341], [-1.7358398437499998,52.24630137198303]\n     ],\n     [\n       [-1.58203125,52.12590076522272], [-1.476287841796875,52.12590076522272],\n       [-1.46392822265625,52.075285904832334], [-1.58203125,52.06937709602395],\n       [-1.58203125,52.12590076522272]\n     ],\n     [\n       [-1.4556884765625,52.01531743663362], [-1.483154296875,51.97642166216334],\n       [-1.3677978515625,51.96626938051444], [-1.3568115234375,52.0102459910103],\n       [-1.4556884765625,52.01531743663362]\n     ]\n   ]}\"\n   H3.geo_json_to_coordinates(document)\n   [\n     [\n       [52.24630137198303, -1.7358398437499998], [52.05249047600099, -1.8923950195312498],\n       [51.891749018068246, -1.56829833984375], [51.91208502557545, -1.27716064453125],\n       [52.032218104145294, -1.19476318359375], [52.19413974159753, -1.24420166015625],\n       [52.24125614966341, -1.5902709960937498], [52.24630137198303, -1.7358398437499998]\n     ],\n     [\n       [52.12590076522272, -1.58203125], [52.12590076522272, -1.476287841796875],\n       [52.075285904832334, -1.46392822265625], [52.06937709602395, -1.58203125],\n       [52.12590076522272, -1.58203125]\n     ],\n     [\n       [52.01531743663362, -1.4556884765625], [51.97642166216334, -1.483154296875],\n       [51.96626938051444, -1.3677978515625], [52.0102459910103, -1.3568115234375],\n       [52.01531743663362, -1.4556884765625]\n     ]\n   ]\n\n @raise [ArgumentError] Failed to parse the GeoJSON document.\n\n @return [Array<Array<Array>>] Nested array of coordinates.", "Convert a nested array of coordinates to a GeoJSON document\n\n @param [Array<Array<Array>>] coordinates Nested array of coordinates.\n\n @example Convert a set of nested coordinates of Banbury to a GeoJSON document.\n   coordinates = [\n     [\n       [52.24630137198303, -1.7358398437499998], [52.05249047600099, -1.8923950195312498],\n       [51.891749018068246, -1.56829833984375], [51.91208502557545, -1.27716064453125],\n       [52.032218104145294, -1.19476318359375], [52.19413974159753, -1.24420166015625],\n       [52.24125614966341, -1.5902709960937498], [52.24630137198303, -1.7358398437499998]\n     ],\n     [\n       [52.12590076522272, -1.58203125], [52.12590076522272, -1.476287841796875],\n       [52.075285904832334, -1.46392822265625], [52.06937709602395, -1.58203125],\n       [52.12590076522272, -1.58203125]\n     ],\n     [\n       [52.01531743663362, -1.4556884765625], [51.97642166216334, -1.483154296875],\n       [51.96626938051444, -1.3677978515625], [52.0102459910103, -1.3568115234375],\n       [52.01531743663362, -1.4556884765625]\n     ]\n   ]\n   H3.coordinates_to_geo_json(coordinates)\n   \"{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\":[\n     [\n       [-1.7358398437499998,52.24630137198303], [-1.8923950195312498,52.05249047600099],\n       [-1.56829833984375,51.891749018068246], [-1.27716064453125,51.91208502557545],\n       [-1.19476318359375,52.032218104145294], [-1.24420166015625,52.19413974159753],\n       [-1.5902709960937498,52.24125614966341], [-1.7358398437499998,52.24630137198303]\n     ],\n     [\n       [-1.58203125,52.12590076522272], [-1.476287841796875,52.12590076522272],\n       [-1.46392822265625,52.075285904832334], [-1.58203125,52.06937709602395],\n       [-1.58203125,52.12590076522272]\n     ],\n     [\n       [-1.4556884765625,52.01531743663362], [-1.483154296875,51.97642166216334],\n       [-1.3677978515625,51.96626938051444], [-1.3568115234375,52.0102459910103],\n       [-1.4556884765625,52.01531743663362]\n     ]\n   ]}\"\n\n @raise [ArgumentError] Failed to parse the given coordinates.\n\n @return [String] GeoJSON document.", "Derive child hexagons contained within the hexagon at the given H3 index.\n\n @param [Integer] h3_index A valid H3 index.\n @param [Integer] child_resolution The desired resolution of hexagons returned.\n\n @example Find the child hexagons for a H3 index.\n   H3.h3_to_children(613196570357137407, 9)\n   [\n     617700169982672895, 617700169982935039, 617700169983197183, 617700169983459327,\n     617700169983721471, 617700169983983615, 617700169984245759\n   ]\n\n @return [Array<Integer>] H3 indexes of child hexagons.", "Find the maximum uncompacted size of the given set of H3 indexes.\n\n @param [Array<Integer>] compacted_set An array of valid H3 indexes.\n @param [Integer] resolution The desired resolution to uncompact to.\n\n @example Find the maximum uncompacted size of the given set.\n   h3_set = [\n     617700440093229055, 617700440092704767, 617700440100569087, 617700440013012991,\n     617700440013275135, 617700440092180479, 617700440091656191, 617700440092966911,\n     617700440100831231, 617700440100044799, 617700440101617663, 617700440081956863,\n     613196840447246335\n   ]\n   H3.max_uncompact_size(h3_set, 10)\n   133\n\n @raise [ArgumentError] Given resolution is invalid for h3_set.\n\n @return [Integer] Maximum size of uncompacted set.", "Compact a set of H3 indexes as best as possible.\n\n In the case where the set cannot be compacted, the set is returned unchanged.\n\n @param [Array<Integer>] h3_set An array of valid H3 indexes.\n\n @example Compact the given set.\n   h3_set = [\n     617700440073043967, 617700440072781823, 617700440073568255, 617700440093229055,\n     617700440092704767, 617700440100569087, 617700440074092543, 617700440073830399,\n     617700440074354687, 617700440073306111, 617700440013012991, 617700440013275135,\n     617700440092180479, 617700440091656191, 617700440092966911, 617700440100831231,\n     617700440100044799, 617700440101617663, 617700440081956863\n   ]\n   H3.compact(h3_set)\n   [\n     617700440093229055, 617700440092704767, 617700440100569087, 617700440013012991,\n     617700440013275135, 617700440092180479, 617700440091656191, 617700440092966911,\n     617700440100831231, 617700440100044799, 617700440101617663, 617700440081956863,\n     613196840447246335\n   ]\n\n @raise [RuntimeError] Couldn't attempt to compact given H3 indexes.\n\n @return [Array<Integer>] Compacted set of H3 indexes.", "Uncompact a set of H3 indexes to the given resolution.\n\n @param [Array<Integer>] compacted_set An array of valid H3 indexes.\n @param [Integer] resolution The desired resolution to uncompact to.\n\n @example Compact the given set.\n   h3_set = [\n     617700440093229055, 617700440092704767, 617700440100569087, 617700440013012991,\n     617700440013275135, 617700440092180479, 617700440091656191, 617700440092966911,\n     617700440100831231, 617700440100044799, 617700440101617663, 617700440081956863,\n     613196840447246335\n   ]\n   H3.uncompact(h3_set)\n   [\n     617700440093229055, 617700440092704767, 617700440100569087, 617700440013012991,\n     617700440013275135, 617700440092180479, 617700440091656191, 617700440092966911,\n     617700440100831231, 617700440100044799, 617700440101617663, 617700440081956863,\n     617700440072781823, 617700440073043967, 617700440073306111, 617700440073568255,\n     617700440073830399, 617700440074092543, 617700440074354687\n   ]\n\n @raise [RuntimeError] Couldn't attempt to umcompact H3 indexes.\n\n @return [Array<Integer>] Uncompacted set of H3 indexes.", "Runs a given conversion\n\n @example\n   converter.convert('1').to(:numeric)  # => 1\n\n @example\n   converter.convert('1') >> Integer # => 1\n\n @return [Object]\n   the converted target type\n\n @api public", "Detect object type and coerce into known key type\n\n @param [Object] object\n\n @api private", "Creates a new conversions map\n\n @example\n   conversion = Necromancer::Conversions.new\n\n @api public\n Load converters\n\n @api private", "Register a converter\n\n @example with simple object\n   conversions.register NullConverter.new(:array, :array)\n\n @example with block\n   conversions.register do |c|\n     c.source = :array\n     c.target = :array\n     c.convert = -> { |val, options| val }\n   end\n\n @api public", "Inject config into converter\n\n @api private", "Allows access to one column or row.\n\n @overload [](index)\n   Returns one row from a DataTable.\n\n   @param index [Integer] Row number\n   @return [Hash] Row as a hash\n\n @overload [](column_name)\n   Returns one column from a DataTable.\n\n   @param column_name [String] Name of column\n   @return [Array] Column as an array of all values in it", "Slice of a DataTable with only specified columns left.\n\n @param names [Array<String>] What columns to leave in a DataTable\n @return [DataTable]", "Represents DataTable as a `column name => all values in columns`\n hash.\n\n @return [Hash{String => Array}]", "Copies the directory to the given other directory\n\n @param _ [Semverse::Version] The version\n @param directory [Pathname] The pathname\n\n @return nil", "Identifies dependencies from a directory\n\n @param directory [Dir] The directory\n\n @return [Array] The dependencies", "Returns the type from the given arguments.\n\n @param url [String] The base url\n @param branch [Branch] The branch\n\n @return [Type] The type", "Returns the contents of the 'elm-package.json' for the given directory.\n\n @param directory [Dir] The directory\n\n @return [Hash] The contents", "Transform an 'elm' constraint into a proper one.\n\n @param elm_constraint [String] The elm constraint\n\n @return [Array] The transform constraints", "Returns the results of solving\n\n @return [Array] Array of dependencies", "Returns the inital constraints\n\n @return [Array] Array of dependency names and constraints", "Resolves the dependencies of a dependency\n\n @param dependency [Dependency] The dependency\n\n @return nil", "Resolves the dependencies of a dependency and version\n\n @param main [Dependency] The dependency\n @param version [Semverse::Version] The version\n\n @return nil", "Downloads the version into a temporary directory\n\n @param version [Semverse::Version] The version to fetch\n\n @return [Dir] The directory for the source of the version", "Copies the version into the given directory\n\n @param version [Semverse::Version] The version\n @param directory [Pathname] The pathname\n\n @return nil", "Returns the available versions for a repository\n\n @param constraints [Array] The constraints\n @param elm_version [String] The Elm version to match against\n\n @return [Array] The versions", "Returns the matchign versions for a repository for the given constraints\n\n @param constraints [Array] The constraints\n @param elm_version [String] The Elm version to match against\n\n @return [Array] The versions", "Logs the dependency with a dot\n\n @param dependency [Dependency] The dependency\n\n @return nil", "Returns the versions of the repository\n\n @return [Array<Semverse::Version>] The versions", "A helper to build forms with Rails' form builder, built to be used with\n f.select helper.\n\n    f.select :gender, enum_option_pairs(User, :gender), ...\n\n record - The model or Class with the enum\n enum - The Symbol with the name of the enum to create the options for\n encode_as_value - The Boolean which defines if either the key or the value\n                   should be used as value attribute for the option,\n                   defaults to using the key (i.e. false)\n\n FIXME: check if the name `enum_option_pairs` is actually good and clear\n enough...\n\n Returns an Array of pairs, like e.g. `[[\"Translated key\", \"key\"], ...]`", "converts an array of integers into array of ranges", "Only run if the BLAST output does not contain hit alignmment", "Prints the current cluster", "get info about the query", "Since there are two length validations, it is necessary to adjust the\n   scores accordingly", "By default, on page load, the results are automatically sorted by the\n index. However since the whole idea is that users would sort by JSON,\n this is not wanted here.", "make the historgram with the resulted scores", "This method will find all notifications owned by this app and\n push them.", "full replace simplely", "no need transaction", "use by association accessor", "Return the chosen path", "Load the global scheduler config from the YAML file.", "Queue each of the future jobs into Sidekiq from the defined tasks.", "The array of tasks loaded from the config YAML.\n @return [Array<SimpleScheduler::Task]", "Returns an array of existing jobs matching the job class of the task.\n @return [Array<Sidekiq::SortedEntry>]", "Returns an array Time objects for future run times based on\n the current time and the given minutes to look ahead.\n @return [Array<Time>]\n rubocop:disable Metrics/AbcSize", "Perform the future job as defined by the task.\n @param task_params [Hash] The params from the scheduled task\n @param scheduled_time [Integer] The epoch time for when the job was scheduled to be run", "The duration between the scheduled run time and actual run time that\n will cause the job to expire. Expired jobs will not be executed.\n @return [ActiveSupport::Duration]", "Returns whether or not the job has expired based on the time\n between the scheduled run time and the current time.\n @return [Boolean]", "Handle the expired task by passing the task and run time information\n to a block that can be creating in a Rails initializer file.", "Queue the task with the scheduled time if the job allows.", "Returns the very first time a job should be run for the scheduled task.\n @return [Time]", "Explicitly set the name of the exchange", "Build the `queue` for a given method.\n\n If the queue name is not set, the queue name is\n   \"local.remote.resoure.action\"\n\n Example\n   \"bob.alice.user.created\"", "Build the `routing_key` for a given method.\n\n If the routing_key name is not set, the routing_key name is\n   \"remote.resoure.action\"\n\n Example\n   \"amigo.user.created\"", "Returns the point added to itself.\n\n This algorithm is defined in\n [SEC1](http://www.secg.org/collateral/sec1_final.pdf), Section 2.2.1,\n Rule 5.\n\n @return (Point)", "Returns the point multiplied by a non-negative integer.\n\n @param i (Integer)\n @return (Point)", "Finds all possible square roots of the given field element.\n\n @param n (Integer)\n @return (Array) A sorted array of numbers whose square is equal to `n`.", "Internal\n Writes the RIFF chunk header, format chunk, and the header for the data chunk. After this\n method is called the file will be \"queued up\" and ready for writing actual sample data.", "Generate a default spin from the Model name\n This makes it easy to drop obfuscate_id onto any model\n and produce different obfuscated ids for different models", "Should return the Response to send back", "Validates the response\n\n @param [Object] action", "You can define the configuration in different ways\n\n Add a key to the top struct\n define do\n   attribute :added_to_top, String\n end\n\n Add a key to the top struct (that is a struct itself)\n define do\n   attribute :app do\n     attribute :one String\n   end\n end\n Which you could expand too in this way\n define do\n   attribute :app do\n     attribute :two String\n   end\n end\n ...or using this way too (equivalent)\n define(:app) do\n   attribute :two, String\n end\n You can also define a key to be a non-Struct type\n define :app, Attributor::Hash", "Determine an appropriate default content_type for this part given\n the preferred handler_name, if possible.\n\n Considers any pre-defined set of values on the content_type attributge\n of the headers.", "Good optimization to avoid creating lots of strings and comparisons\n on a per-request basis.\n However, this is hacky, as it is rack-specific, and does not really belong here", "Determine the content_type to report for a given example,\n using handler_name if possible.\n\n Considers any pre-defined set of values on the content_type attributge\n of the headers.", "If parameters are empty, return self; otherwise return a new object consisting of this type\n minus parameters.\n\n @return [MediaTypeIdentifier]", "Validates Status code\n\n @raise [Exceptions::Validation]  When response returns an unexpected status.", "Validates 'Location' header\n\n @raise [Exceptions::Validation] When location header does not match to the defined one.", "Validates Content-Type header and response media type\n\n @param [Object] response\n\n @raise [Exceptions::Validation] When there is a missing required header", "Validates response body\n\n @param [Object] response\n\n @raise [Exceptions::Validation]  When there is a missing required header..", "Create new page containing given document.\n\n @param [String] document\n   HTML document. Defaults to an \"about:blank\" window, with the basic\n   structure: `<html><head><title></title></head><body></body></html>`\n\n Load one or more javascript files in page's context\n\n @param [#to_s, #to_s, ...] paths\n   paths to js file\n @return [Page] self", "Read config options from an IO stream and set them on `self`. Defaults\n to reading from the `.s3_sync` file in the MM project root if it exists.\n\n @param io [IO] an IO stream to read from\n @return [void]", "Formats coordinates according to directives in +formatstr+.\n\n Each directive starts with +%+ and can contain some modifiers before\n its name.\n\n Acceptable modifiers:\n - unsigned integers: none;\n - signed integers: <tt>+</tt> for mandatory sign printing;\n - floats: same as integers and number of digits modifier, like\n   <tt>.03</tt>.\n\n List of directives:\n\n %lat :: Full latitude, floating point, signed\n %latds :: Latitude degrees, integer, signed\n %latd :: Latitude degrees, integer, unsigned\n %latm :: Latitude minutes, integer, unsigned\n %lats :: Latitude seconds, floating point, unsigned\n %lath :: Latitude hemisphere, \"N\" or \"S\"\n %lng :: Full longitude, floating point, signed\n %lngds :: Longitude degrees, integer, signed\n %lngd :: Longitude degrees, integer, unsigned\n %lngm :: Longitude minutes, integer, unsigned\n %lngs :: Longitude seconds, floating point, unsigned\n %lngh :: Longitude hemisphere, \"E\" or \"W\"\n\n Examples:\n\n    g = Geo::Coord.new(50.004444, 36.231389)\n    g.strfcoord('%+lat, %+lng')\n    # => \"+50.004444, +36.231389\"\n    g.strfcoord(\"%latd\u00b0%latm'%lath -- %lngd\u00b0%lngm'%lngh\")\n    # => \"50\u00b00'N -- 36\u00b013'E\"\n\n +strfcoord+ handles seconds rounding implicitly:\n\n    pos = Geo::Coord.new(0.033333, 91.333333)\n    pos.lats # => 0.599988e2\n    pos.strfcoord('%latd %latm %.05lats') # => \"0 1 59.99880\"\n    pos.strfcoord('%latd %latm %lats')  # => \"0 2 0\"", "Helper method to read an attribute\n\n @param [#to_sym] attr_name the name of the attribute\n @param [String, Symbol, nil] to_call the name of the method to call on\n the returned value\n @return nil or the value", "Helper method to write a value to an attribute\n\n @param [#to_sym] attr_name the name of the attribute\n @param [#to_s] value the value to set the attribute to", "Attach a namespace to the node\n\n @overload namespace=(ns)\n   Attach an already created XML::Namespace\n   @param [XML::Namespace] ns the namespace object\n @overload namespace=(ns)\n   Create a new namespace and attach it\n   @param [String] ns the namespace uri", "Sets a default value for the property if not currently set.\n\n Example:\n   default_property_value :state, 0\n\n is equivalent to:\n   self.state = state.presence || 0\n\n Example:\n   default_property_value :enabled, false\n\n is equivalent to:\n   self.enabled = false if enabled.nil?", "Converts the type of the property.\n\n Example:\n   format_property_value :weight, :float\n\n is equivalent to:\n   self.weight = weight.to_f if weight.present?", "For each attribute name in nested_attributes extract and return the nested model objects.", "Assigns the given nested child attributes.\n\n Attribute hashes with an +:id+ value matching an existing associated object will update\n that object. Hashes without an +:id+ value will build a new object for the association.\n Hashes with a matching +:id+ value and a +:_destroy+ key set to a truthy value will mark\n the matched object for destruction.\n\n Pushes a key of the association name onto the parent object's +nested_attributes+ attribute.\n The +nested_attributes+ can be used for determining when the parent has associated children.\n\n @param [Symbol] association_name The attribute name of the associated children.\n @param [ActiveSupport::HashWithIndifferentAccess, ActionController::Parameters] attributes\n     The attributes provided by Rails ActionView. Typically new objects will arrive as\n     ActiveSupport::HashWithIndifferentAccess and updates as ActionController::Parameters.\n @param [Hash] options The options to control how nested attributes are applied.\n\n @option options [Proc, Symbol] :reject_if Allows you to specify a Proc or a Symbol pointing\n     to a method that checks whether a record should be built for a certain attribute\n     hash. The hash is passed to the supplied Proc or the method and it should return either\n     +true+ or +false+. Passing +:all_blank+ instead of a Proc will create a proc\n     that will reject a record where all the attributes are blank.\n\n The following example will update the amount of the ingredient with ID 1, build a new\n associated ingredient with the amount of 45, and mark the associated ingredient\n with ID 2 for destruction.\n\n   assign_nested_attributes(:ingredients, {\n     '0' => { id: '1', amount: '123' },\n     '1' => { amount: '45' },\n     '2' => { id: '2', _destroy: true }\n   })", "Updates an object with attributes or marks it for destruction if has_destroy_flag?.", "Retrieves an entity by id or name and by an optional parent.\n\n @param [Integer or String] id_or_name The id or name value of the entity Key.\n @param [Google::Cloud::Datastore::Key] parent The parent Key of the entity.\n\n @return [Entity, nil] a Google::Cloud::Datastore::Entity object or nil.", "Queries entities from Cloud Datastore by named kind and using the provided options.\n When a limit option is provided queries up to the limit and returns results with a cursor.\n\n This method may make several API calls until all query results are retrieved. The `run`\n method returns a QueryResults object, which is a special case Array with additional values.\n QueryResults are returned in batches, and the batch size is determined by the Datastore API.\n Batch size is not guaranteed. It will be affected by the size of the data being returned,\n and by other forces such as how distributed and/or consistent the data in Datastore is.\n Calling `all` on the QueryResults retrieves all results by repeatedly loading #next until\n #next? returns false. The `all` method returns an enumerator which from_entities iterates on.\n\n Be sure to use as narrow a search criteria as possible. Please use with caution.\n\n @param [Hash] options The options to construct the query with.\n\n @option options [Google::Cloud::Datastore::Key] :ancestor Filter for inherited results.\n @option options [String] :cursor Sets the cursor to start the results at.\n @option options [Integer] :limit Sets a limit to the number of results to be returned.\n @option options [String] :order Sort the results by property name.\n @option options [String] :desc_order Sort the results by descending property name.\n @option options [Array] :select Retrieve only select properties from the matched entities.\n @option options [Array] :distinct_on Group results by a list of properties.\n @option options [Array] :where Adds a property filter of arrays in the format\n   [name, operator, value].\n\n @return [Array<Model>, String] An array of ActiveModel results\n\n or if options[:limit] was provided:\n\n @return [Array<Model>, String] An array of ActiveModel results and a cursor that\n   can be used to query for additional results.", "Finds the first entity matching the specified condition.\n\n @param [Hash] args In which the key is the property and the value is the value to look for.\n @option args [Google::Cloud::Datastore::Key] :ancestor filter for inherited results\n\n @return [Model, nil] An ActiveModel object or nil.\n\n @example\n   User.find_by(name: 'Joe')\n   User.find_by(name: 'Bryce', ancestor: parent_key)", "Adds sorting to the results by a property name if included in the options.", "Get the column and row based on the diagonal hash created using diagonalLines.", "Retrieve Sobel value for a given pixel.", "Retrieve the Sobel values for every pixel and set it as @sobel.", "This takes a stack of middlewares and initializes them in a way\n that each middleware properly calls the next middleware.", "Inserts a middleware before each middleware object", "Deletes the given middleware object or index", "Return the response as a hash", "Checks if the target_url is a valid CloudFoundry target.\n\n @return [Boolean] Returns true if target_url is a valid CloudFoundry API URL, false otherwise.", "returns each result items wrapped in their respective objects", "Parse a URL to determine hostname, port number, and whether or not SSL is used.\n @param url [String] URL to parse\n @return [Hash] { ssl: true/false, host: <String>, port: <Integer> }", "This is a compatibility layer for the resources, which are in a different place in Puppet 3.x and Puppet 4.x\n @return [Array] Resource array", "Facts - returned the 'cleansed' facts.\n Clean up facts by setting 'name' to the node if given, and deleting _timestamp and expiration\n which may cause Puppet catalog compilation to fail if the facts are old.\n @param node [String] Node name to override returned facts\n @return [Hash] Facts hash { 'name' => '...', 'values' => { ... } }", "Facts - remove one or more facts from the list.\n @param remove [String|Array<String>] Fact(s) to remove\n @return self", "Turn hash of facts into appropriate YAML for Puppet\n @param node [String] Node name to override returned facts\n @return [String] Puppet-compatible YAML facts", "Returns the value without conversion when it's converted to Java Types.\n When isn't a Rjb class, returns a Java String of it.", "Schedule this \"repeating\" job", "Loop through all of the endpoint instances' public singleton methods to\n add the method to client", "Define the method on the client and send it to the endpoint instance\n with the args passed in", "Creates the configuration\n @param [Hash] hash containing configuration parameters and their values\n @return [Configuration] a new configuration with the values from the\n   config_hash set\n Returns a hash of api keys and their values", "Hook the Podfile.lock file generation to allow us to filter out the links added to the\n Podfile.lock. The logic here is to replace the new Podfile.lock link content with what existed\n before the link was added. Currently, this is called for both Podfile.lock and Manifest.lock\n file so we only want to alter the Podfile.lock\n\n @param path path to write the .lock file to", "Will get the Podfile.lock contents hash after replacing the linked content with its previous\n Podfile.lock information keeping the Podfile and Podfile.lock in sync and clear of any link\n data\n\n @returns hash that is to be dumped to the Podfile.lock file without link content", "Will merge the DEPENDENCIES of the Podfile.lock before a link and after a link\n\n @param links the installed links\n @param before the DEPENDENCIES in the Podfile.lock before the link occurs\n @param after the DEPENDENCIES after the link (includes new link that we want to filter out)\n\n @returns the merged DEPENDENCIES replacing any links that were added with their previous value", "Will merge the hashes of the Podfile.lock before a link and after a link\n\n @param links the installed links\n @param before the hash in the Podfile.lock before the link occurs\n @param after the hash after the link (includes new link that we want to filter out)\n\n @returns the merged hash replacing any links that were added with their previous value", "send to ses", "will remove content blocks text", "send to all list with state passive & subscribed", "Updates option and returns a new object", "Add a sale comment", "Mark tangible sale as shipped", "Provide access to update existing recurring lineitems by allowing to lower the lineitem price\n and push the recurring billing date forward. This call is not currently documented in the\n 2Checkout API documentation.\n\n POST https://www.2checkout.com/api/sales/update_lineitem_recurring\n\n Parameters:\n * (required) lineitem_id: lineitem_id\n * (optional) comment: Optional comment added to sale\n * (optional) shift: days to shift next recurring payment forward\n * (optional) price: new recurring price (must be lower than previous price or else call will fail)\n\n The shift and price parameters are optional, but at least one of them must be provided for the\n call to be valid.\n\n Example Shift Date Next\n curl -X POST https://www.2checkout.com/api/sales/update_lineitem_recurring -u \\\n 'username:password' -d 'lineitem_id=1234567890' -d 'shift=7' -H 'Accept: application/json'\n\n Example Update Price\n curl -X POST https://www.2checkout.com/api/sales/update_lineitem_recurring -u \\\n 'username:password' -d 'lineitem_id=1234567890' -d 'price=1.00' -H 'Accept: application/json'\n\n Please note that this method cannot be used on PayPal sales as 2Checkout cannot alter the\n customer's billing agreement so this call can only update a recurring lineitem on credit card\n sales.", "Updates product and returns a new Product object", "Is this a commonjs module?\n\n Be here as strict as possible, so that non-commonjs files are not\n preprocessed.", "This primarily filters out required files from node modules\n\n @return [<String>] Paths of dependencies to evaluate", "Execute an arbitrary console command that is supplied as text via the\n supplied parameter. Console commands are documented in the\n administrator's guide. If you use a command that is not listed in the\n administrator's guide, the application will return the XMLResponse.", "Obtain system data, such as total RAM, free RAM, total disk space,\n free disk space, CPU speed, number of CPU cores, and other vital\n information.", "Obtain the version information for each scan engine.\n Includes Product, Content, and Java versions.", "Output diagnostic information into log files, zip the files, and encrypt\n the archive with a PGP public key that is provided as a parameter for the\n API call. Then upload the archive using HTTPS to a URL that is specified\n as an API parameter.\n\n @param uri Upload server to send the support log package to.", "Perform an ad hoc scan of a subset of IP addresses for a site at a specific time.\n Only IPs from a single site can be submitted per request,\n and IP addresses must already be included in the site configuration.\n Method is designed for scanning when the targets are coming from an\n external source that does not have access to internal identfiers.\n\n For example:\n   to_scan = ['192.168.2.1', '192.168.2.107']\n   nsc.scan_ips(5, to_scan)\n\n @param [Fixnum] site_id Site ID that the assets belong to.\n @param [Array[String]] ip_addresses Array of IP addresses to scan.\n @return [Status] whether the request was successful", "Perform an ad hoc scan of a subset of IP addresses for a site.\n Only IPs from a single site can be submitted per request,\n and IP addresses must already be included in the site configuration.\n Method is designed for scanning when the targets are coming from an\n external source that does not have access to internal identfiers.\n\n For example:\n   to_scan = ['192.168.2.1', '192.168.2.107']\n   nsc.scan_ips(5, to_scan)\n\n @param [Fixnum] site_id Site ID that the assets belong to.\n @param [Array[String]] ip_addresses Array of IP addresses to scan.\n @return [Scan] Scan launch information.", "Initiate a site scan.\n\n @param [Fixnum] site_id Site ID to scan.\n @param [Boolean] blackout_override Optional. Given suffencent permissions, force bypass blackout and start scan.\n @return [Scan] Scan launch information.", "Initiate an ad-hoc scan on a subset of site assets with\n a specific scan template and scan engine, which may differ\n from the site's defined scan template and scan engine.\n\n @param [Fixnum] site_id Site ID to scan.\n @param [Array[String]] assets Hostnames and/or IP addresses to scan.\n @param [String] scan_template The scan template ID.\n @param [Fixnum] scan_engine The scan engine ID.\n @return [Fixnum] Scan ID.", "Utility method for appending a HostName or IPRange object into an\n XML object, in preparation for ad hoc scanning.\n\n @param [REXML::Document] xml Prepared API call to execute.\n @param [HostName|IPRange] asset Asset to append to XML.", "Utility method for executing prepared XML and extracting Scan launch\n information.\n\n @param [REXML::Document] xml Prepared API call to execute.\n @return [Scan] Scan launch information.", "Stop a running or paused scan.\n\n @param [Fixnum] scan_id ID of the scan to stop.\n @param [Fixnum] wait_sec Number of seconds to wait for status to be\n   updated.", "Retrieve the status of a scan.\n\n @param [Fixnum] scan_id The scan ID.\n @return [String] Current status of the scan. See Nexpose::Scan::Status.", "Resumes a scan.\n\n @param [Fixnum] scan_id The scan ID.", "Pauses a scan.\n\n @param [Fixnum] scan_id The scan ID.", "Retrieve a list of current scan activities across all Scan Engines\n managed by Nexpose. This method returns lighter weight objects than\n scan_activity.\n\n @return [Array[ScanData]] Array of ScanData objects associated with\n   each active scan on the engines.", "Retrieve a list of current scan activities across all Scan Engines\n managed by Nexpose.\n\n @return [Array[ScanSummary]] Array of ScanSummary objects associated with\n   each active scan on the engines.", "Get scan statistics, including node and vulnerability breakdowns.\n\n @param [Fixnum] scan_id Scan ID to retrieve statistics for.\n @return [ScanSummary] ScanSummary object providing statistics for the scan.", "Get a history of past scans for this console, sorted by most recent first.\n\n Please note that for consoles with a deep history of scanning, this method\n could return an excessive amount of data (and take quite a bit of time to\n retrieve). Consider limiting the amount of data with the optional argument.\n\n @param [Fixnum] limit The maximum number of records to return from this call.\n @return [Array[CompletedScan]] List of completed scans, ordered by most\n   recently completed first.", "Get paused scans. Provide a site ID to get paused scans for a site.\n With no site ID, all paused scans are returned.\n\n @param [Fixnum] site_id Site ID to retrieve paused scans for.\n @param [Fixnum] limit The maximum number of records to return from this call.\n @return [Array[ActiveScan]] List of paused scans.", "Export the data associated with a single scan, and optionally store it in\n a zip-compressed file under the provided name.\n\n @param [Fixnum] scan_id Scan ID to remove data for.\n @param [String] zip_file Filename to export scan data to.\n @return [Fixnum] On success, returned the number of bytes written to\n   zip_file, if provided. Otherwise, returns raw ZIP binary data.", "Import scan data into a site.\n\n This method is designed to work with export_scan to migrate scan data\n from one console to another. This method will import the data as if run\n from a local scan engine.\n\n Scan importing is restricted to only importing scans in chronological\n order. It assumes that it is the latest scan for a given site, and will\n abort if attempting to import an older scan.\n\n @param [Fixnum] site_id Site ID of the site to import the scan into.\n @param [String] zip_file Path to a previously exported scan archive.\n @return [Fixnum] The scan ID on success.", "Helper method to get the YUI tables into a consumable Ruby object.\n\n @param [Connection] console API connection to a Nexpose console.\n @param [String] address Controller address relative to https://host:port\n @param [Hash] parameters Parameters that need to be sent to the controller\n    The following attributes may need to be provided:\n      'sort' Column to sort by\n      'table-id' The ID of the table to get from this controller\n @param [Fixnum] page_size Number of records to include per page.\n   Value must conform to supported defaults: -1, 10, 25, 50, 100, 500.\n @param [Fixnum] records number of records to return, gets all if not\n   specified.\n @param [Boolean] post Whether to use form post or get to retrieve data.\n @return [Array[Hash]] An array of hashes representing the requested table.\n\n Example usage:\n   DataTable._get_json_table(@console,\n                             '/data/asset/site',\n                             { 'sort' => 'assetName',\n                               'table-id' => 'site-assets',\n                               'siteID' => site_id })", "Helper method to get a Dyntable into a consumable Ruby object.\n\n @param [Connection] console API connection to a Nexpose console.\n @param [String] address Tag address with parameters relative to\n    https://host:port\n @return [Array[Hash]] array of hashes representing the requested table.\n\n Example usage:\n   DataTable._get_dyn_table(@console, '/data/asset/os/dyntable.xml?tableID=OSSynopsisTable')", "Parse headers out of a dyntable response.", "Parse rows out of a dyntable into an array of values.", "Parse records out of the row of a dyntable.", "Provide a list of all report templates the user can access on the\n Security Console.\n\n @return [Array[ReportTemplateSummary]] List of current report templates.", "Save the configuration for a report template.", "Populate object methods and attributes from a JSON-derived hash.\n\n @param [Nexpose::Connection] nsc Active connection to a console.\n @param [Hash] hash Result of running JSON#parse with the\n   symbolize_names parameter to a 2.0 API response.\n   Pass hash[:resources] if the response is pageable.", "Load a resource from the security console. Once loaded, the value is\n cached so that it need not be loaded again.\n\n @param [Connection] nsc Active connection to the console.\n @param [Symbol] k Original key name, used to identify the class to load.\n @param [String] url Truncated URL to use to retrieve the resource.\n @return [Array[?]] Collection of \"k\" marshalled object.", "Get the class referred to by a field name.\n\n For example, this method will translate a field name like \"malware_kits\"\n into to corresponding MalwareKit class.\n\n @param [String] field Snake-case name of a field.\n @return [Class] Class associated with the provided field.", "Save this dynamic asset group to the Nexpose console.\n Warning, saving this object does not set the id. It must be retrieved\n independently.\n\n @param [Connection] nsc Connection to a security console.\n @return [Boolean] Whether the group was successfully saved.", "Retrieve a list of all Scan Engine Pools managed by the Security Console.\n\n @return [Array[EnginePoolSummary]] Array of EnginePoolSummary objects\n   associated with each engine associated with this security console.", "Save an engine pool to a security console.\n\n @param [Connection] connection Connection to console where site exists.", "Retrieve a list of all sites the user is authorized to view or manage.\n\n @return [Array[SiteSummary]] Array of SiteSummary objects.", "Retrieve a list of all previous scans of the site.\n\n @param [FixNum] site_id Site ID to request scan history for.\n @return [Array[ScanSummary]] Array of ScanSummary objects representing\n   each scan run to date on the site provided.", "Retrieve a history of the completed scans for a given site.\n\n @param [FixNum] site_id Site ID to find scans for.\n @return [CompletedScan] details of the completed scans for the site.", "Remove assets to this site by IP address range.\n\n @param [String] from Beginning IP address of a range.\n @param [String] to Ending IP address of a range.", "Adds assets to this site excluded scan targets by IP address range.\n\n @param [String] from Beginning IP address of a range.\n @param [String] to Ending IP address of a range.", "Adds an asset group ID to this site included scan targets.\n\n @param [Integer] asset_group_id Identifier of an assetGroupID.", "Adds an asset group ID to this site excluded scan targets.\n\n @param [Integer] asset_group_id Identifier of an assetGroupID.", "Scan this site.\n\n @param [Connection] connection Connection to console where scan will be launched.\n @param [String] sync_id Optional synchronization token.\n @param [Boolean] blackout_override Optional. Given suffencent permissions, force bypass blackout and start scan.\n @return [Scan] Scan launch information.", "Updates an existing silo profile on a Nexpose console.\n\n @param [Connection] connection Connection to console where this silo profile will be saved.\n @return [String] Silo Profile ID assigned to this configuration, if successful.", "Provide a listing of all report definitions the user can access on the\n Security Console.\n\n @return [Array[ReportConfigSummary]] List of current report configuration.", "Generate a new report using the specified report definition.", "Get details of the last report generated with the specified report id.", "Generate a report once using a simple configuration.\n\n For XML-based reports, only the textual report is returned and not any images.\n\n @param [Connection] connection Nexpose connection.\n @param [Fixnum] timeout How long, in seconds, to wait for the report to\n   generate. Larger reports can take a significant amount of time.\n @param [Boolean] raw Whether to bypass response parsing an use the raw\n   response. If this option is used, error will only be exposed by\n   examining Connection#response_xml.\n @return Report in text format except for PDF, which returns binary data.", "Save the configuration of this report definition.", "Retrieve summary details of all vulnerabilities.\n\n @param [Boolean] full Whether or not to gather the full summary.\n   Without the flag, only id, title, and severity are returned.\n   It can take twice a long to retrieve full summary information.\n @return [Array[Vulnerability|VulnerabilitySummary]] Collection of all known vulnerabilities.", "Retrieve details for a vulnerability.\n\n @param [String] vuln_id Nexpose vulnerability ID, such as 'windows-duqu-cve-2011-3402'.\n @return [VulnerabilityDetail] Details of the requested vulnerability.", "Search for Vulnerability Checks.\n\n @param [String] search_term Search terms to search for.\n @param [Boolean] partial_words Allow partial word matches.\n @param [Boolean] all_words All words must be present.\n @return [Array[VulnCheck]] List of matching Vulnerability Checks.", "Find vulnerabilities by date available in Nexpose.\n This is not the date the original vulnerability was published, but the\n date the check was made available in Nexpose.\n\n @param [String] from Vulnerability publish date in format YYYY-MM-DD.\n @param [String] to Vulnerability publish date in format YYYY-MM-DD.\n @return [Array[VulnSynopsis]] List of vulnerabilities published in\n   Nexpose between the provided dates.", "Deletes a Nexpose ticket.\n\n @param [Array[Fixnum]] tickets Array of unique IDs of tickets to delete.\n @return [Boolean] Whether or not the ticket deletions succeeded.", "Save this ticket to a Nexpose console.\n\n @param [Connection] connection Connection to console where ticket exists.\n @return [Fixnum] Unique ticket ID assigned to this ticket.", "Save modifications to the Nexpose security console.\n\n @param [Connection] connection Nexpose connection.\n @return [Boolean] true if configuration successfully saved.", "List the scan templates currently configured on the console.\n\n @return [Array[ScanTemplateSummary]] list of scan template summary objects.", "Assign name to this scan template. Required attribute.\n @param [String] name Title to assign.", "Assign a description to this scan template. Require attribute.\n @param [String] description Description of the scan template.", "Adjust the number of threads to use per scan engine for this template\n @param [Integer] threads the number of threads to use per engine", "Adjust the number of threads to use per asset for this template\n @param [Integer] threads the number of threads to use per asset", "Set custom TCP ports to scan for device discovery\n @param [Array] ports Ports to scan for device discovery", "Set custom UDP ports to scan for UDP device discovery\n @param [Array] ports Ports to scan for UDP device discovery", "Set custom TCP ports to scan for TCP service discovery\n @param [Array] ports Ports to scan for TCP service discovery", "Exclude TCP ports during TCP service discovery\n @param [Array] ports TCP ports to exclude from TCP service discovery", "Exclude UDP ports when performing UDP service discovery\n @param [Array] ports UDP ports to exclude from UDP service discovery", "Get a list of the individual vuln checks enabled for this scan template.\n\n @return [Array[String]] List of enabled vulnerability checks.", "Enable individual check for this template.\n\n @param [String] check_id Unique identifier of vuln check.", "Disable individual check for this template.\n\n @param [String] check_id Unique identifier of vuln check.", "Remove individual check for this template. Removes both enabled and\n disabled checks.\n\n @param [String] check_id Unique identifier of vuln check.", "Save this scan template configuration to a Nexpose console.\n\n @param [Connection] nsc API connection to a Nexpose console.", "Enable or disable asset configuration scanning for this template. If\n the level is not \"full\", \"default\" or \"none\", this is a no-op.\n\n @param [String] \"full\" to enable asset configuration logging, and\n   \"default\" or \"none\" to disable it.", "Enable or disable the debug logging.\n @param [Boolean] enable Enable or disable the debug logging.", "Enable or disable windows service editor.\n @param [Boolean] enable Enable or disable windows service editor.", "Returns a summary list of all roles.", "Create or save a Role to the Nexpose console.\n\n @param [Connection] nsc Nexpose connection.", "GET call to a Nexpose controller.\n\n @param [Connection] nsc API connection to a Nexpose console.\n @param [String] uri Controller address relative to https://host:port\n @param [String] content_type Content type to use when issuing the GET.\n @param [Hash] options Parameter options to the call.\n @return [String|REXML::Document|Hash] The response from the call.", "PUT call to a Nexpose controller.\n\n @param [Connection] nsc API connection to a Nexpose console.\n @param [String] uri Controller address relative to https://host:port\n @param [String|REXML::Document] payload XML document required by the call.\n @param [String] content_type Content type to use when issuing the PUT.\n @return [String] The response from the call.", "POST call to a Nexpose controller.\n\n @param [Connection] nsc API connection to a Nexpose console.\n @param [String] uri Controller address relative to https://host:port\n @param [String|REXML::Document] payload XML document required by the call.\n @param [String] content_type Content type to use when issuing the POST.\n @param [Fixnum] timeout Set an explicit timeout for the HTTP request.\n @return [String|REXML::Document|Hash] The response from the call.", "PATCH call to a Nexpose controller.\n\n @param [Connection] nsc API connection to a Nexpose console.\n @param [String] uri Controller address relative to https://host:port\n @param [String|REXML::Document] payload XML document required by the call.\n @param [String] content_type Content type to use when issuing the PATCH.\n @return [String] The response from the call.", "POST call to a Nexpose controller that uses a form-post model.\n This is here to support legacy use of POST in old controllers.\n\n @param [Connection] nsc API connection to a Nexpose console.\n @param [String] uri Controller address relative to https://host:port\n @param [Hash] parameters Hash of attributes that need to be sent\n    to the controller.\n @param [String] content_type Content type to use when issuing the POST.\n @return [Hash] The parsed JSON response from the call.", "DELETE call to a Nexpose controller.\n\n @param [Connection] nsc API connection to a Nexpose console.\n @param [String] uri Controller address relative to https://host:port\n @param [String] content_type Content type to use when issuing the DELETE.", "Get an error message from the response body if the request url api version\n is 2.1 or greater otherwise use the request body", "Code cleanup to allow for cleaner get_error_message method", "Execute a block of code while presenving the preferences for any\n underlying table being accessed. Use this method when accessing data\n tables which are present in the UI to prevent existing row preferences\n from being set to 500.\n\n This is an internal utility method, not subject to backward compatibility\n concerns.\n\n @param [Connection] nsc Live connection to a Nepose console.\n @param [String] pref Preference key value to preserve.", "Perform an asset filter search that will locate assets matching the\n provided conditions.\n\n For example, the following call will return assets with Java installed:\n   nsc.filter(Search::Field::SOFTWARE, Search::Operator::CONTAINS, 'java')\n\n @param [String] field Constant from Search::Field\n @param [String] operator Constant from Search::Operator\n @param [String] value Search term or constant from Search::Value\n @return [Array[FilteredAsset]] List of matching assets.", "Perform a search that will match the criteria provided.\n\n For example, the following call will return assets with Java and .NET:\n   java_criterion = Criterion.new(Search::Field::SOFTWARE,\n                                  Search::Operator::CONTAINS,\n                                  'java')\n   dot_net_criterion = Criterion.new(Search::Field::SOFTWARE,\n                                     Search::Operator::CONTAINS,\n                                     '.net')\n   criteria = Criteria.new([java_criterion, dot_net_criterion])\n   results = nsc.search(criteria)\n\n @param [Criteria] criteria Criteria search object.\n @return [Array[FilteredAsset]] List of matching assets.", "A constructor for Connection\n\n @param [String] ip The IP address or hostname/FQDN of the Nexpose console.\n @param [String] user The username for Nexpose sessions.\n @param [String] pass The password for Nexpose sessions.\n @param [Fixnum] port The port number of the Nexpose console.\n @param [String] silo_id The silo identifier for Nexpose sessions.\n @param [String] token The two-factor authentication (2FA) token for Nexpose sessions.\n @param [String] trust_cert The PEM-formatted web certificate of the Nexpose console. Used for SSL validation.\n Establish a new connection and Session ID", "Logout of the current connection", "Execute an API request", "Download a specific URL, typically a report.\n Include an optional file_name parameter to write the output to a file.\n\n Note: XML and HTML reports have charts not downloaded by this method.\n       Would need to do something more sophisticated to grab\n       all the associated image files.", "Find a Device by its address.\n\n This is a convenience method for finding a single device from a SiteDeviceListing.\n If no site_id is provided, the first matching device will be returned when a device\n occurs across multiple sites.\n\n @param [String] address Address of the device to find. Usually the IP address.\n @param [FixNum] site_id Site ID to restrict search to.\n @return [Device] The first matching Device with the provided address,\n   if found.", "Retrieve a list of all of the assets in a site.\n\n If no site-id is specified, then return all of the assets\n for the Nexpose console, grouped by site-id.\n\n @param [FixNum] site_id Site ID to request device listing for. Optional.\n @return [Array[Device]] Array of devices associated with the site, or\n   all devices on the console if no site is provided.", "Get a list of all assets currently associated with a group.\n\n @param [Fixnum] group_id Unique identifier of an asset group.\n @return [Array[FilteredAsset]] List of group assets.", "List the vulnerability findings for a given device ID.\n\n @param [Fixnum] dev_id Unique identifier of a device (asset).\n @return [Array[VulnFinding]] List of vulnerability findings.", "Retrieve a list of assets which are incomplete in a given scan. If called\n during a scan, this method returns currently incomplete assets which may\n be in progress.\n\n @param [Fixnum] scan_id Unique identifier of a scan.\n @return [Array[IncompleteAsset]] List of incomplete assets.", "delete an alert from the given site", "save an alert for a given site", "Retrieve a list of all users the user is authorized to view or manage.\n\n @return [Array[MultiTenantUserSummary]] Array of MultiTenantUserSummary objects.", "Removes a scan engine from the list of available engines.\n\n @param [Fixnum] engine_id Unique ID of an existing engine to remove.\n @param [String] scope Whether the engine is global or silo scoped.\n @return [Boolean] true if engine successfully deleted.", "Provide a list of current scan activities for a specific Scan Engine.\n\n @return [Array[ScanSummary]] Array of ScanSummary objects associated with\n   each active scan on the engine.", "Retrieve a list of all Scan Engines managed by the Security Console.\n\n @return [Array[EngineSummary]] Array of EngineSummary objects associated\n   with each engine associated with this security console.", "Save this engine configuration to the security console.\n\n @param [Connection] connection Connection to console where site exists.\n @return [Fixnum] ID assigned to the scan engine.", "Retrieve all vulnerability definitions currently in a Nexpose console.\n\n Note, this can easily take 30 seconds to complete and will load over\n 55,000 vulnerability definitions.\n\n @return [Array[VulnerabilityDefinition]] Collection of vulnerability definitions.", "Search for any vulnerability definitions which refer to a given CVE.\n\n @param [String] cve A valid CVE.\n @return [Array[VulnerabilityDefinition]] A list of vuln definitions which check the CVE.", "Search for any vulnerability definitions which refer to a given reference\n ID.\n\n Examples:\n   find_vulns_by_ref('oval', 'OVAL10476')\n   find_vulns_by_ref('bid', 35067)\n   find_vulns_by_ref('secunia', 35188)\n\n @param [String] source External vulnerability reference source.\n @param [String] id Unique vulnerability reference ID.\n @return [Array[VulnerabilityDefinition]] A list of vuln definitions which\n   check the vulnerability.", "Search for any vulnerability definitions which refer to a given title.\n\n Note: This method will return a maximum of 500 results. If the search\n yields a high number of results, consider add more specific words to\n the title.\n\n @param [String] title A (partial) title to search for.\n @param [Boolean] all_words Whether to include all words from the search\n   phrase in the search.\n @return [Array[VulnerabilityDefinition]] A list of vuln definitions with titles matching\n   the provided value.", "Lists all tags\n\n @return [Array[TagSummary]] List of current tags.", "Lists all the tags on an asset\n\n @param [Fixnum] asset_id of the asset to list the applied tags for\n @return [Array[TagSummary]] list of tags on asset", "Lists all the tags on a site\n\n @param [Fixnum] site_id id of the site to get the applied tags\n @return [Array[TagSummary]] list of tags on site", "Lists all the tags on an asset_group\n\n @param [Fixnum] asset_group_id id of the group on which tags are listed\n @return [Array[TagSummary]] list of tags on asset group", "Returns the criticality value which takes precedent for an asset\n\n @param [Fixnum] asset_id id of asset on which criticality tag is selected\n @return [String] selected_criticality string of the relevant criticality; nil if not tagged", "Set the color but validate it", "Creates and saves a tag to Nexpose console\n\n @param [Connection] connection Nexpose connection\n @return [Fixnum] ID of saved tag", "Adds a tag to an asset\n\n @param [Connection] connection Nexpose connection\n @param [Fixnum] asset_id of the asset to be tagged\n @return [Fixnum] ID of applied tag", "Adds a tag to a site\n\n @param [Connection] connection Nexpose connection\n @param [Fixnum] site_id of the site to be tagged\n @return [Fixnum] ID of applied tag", "Adds a tag to an asset group\n\n @param [Connection] connection Nexpose connection\n @param [Fixnum] group_id id of the asset group to be tagged\n @return [Fixnum] ID of applied tag", "Retrieve all active vulnerability exceptions.\n\n @param [String] status Filter exceptions by the current status.\n   @see Nexpose::VulnException::Status\n @return [Array[VulnException]] List of matching vulnerability exceptions.", "Resubmit a vulnerability exception request with a new comment and reason\n after an exception has been rejected.\n\n You can only resubmit a request that has a \"Rejected\" status; if an\n exception is \"Approved\" or \"Under Review\" you will receive an error\n message stating that the exception request cannot be resubmitted.\n\n @param [Fixnum] id Unique identifier of the exception to resubmit.\n @param [String] comment Comment to justify the exception resubmission.\n @param [String] reason The reason for the exception status, if changing.\n   @see Nexpose::VulnException::Reason\n @return [Boolean] Whether or not the resubmission was valid.", "Submit this exception on the security console.\n\n @param [Connection] connection Connection to security console.\n @return [Fixnum] Newly assigned exception ID.", "Approve a vulnerability exception request, update comments and expiration\n dates on vulnerability exceptions that are \"Under Review\".\n\n @param [Connection] connection Connection to security console.\n @param [String] comment Comment to accompany the approval.\n @return [Boolean] Whether or not the approval was accepted by the console.", "Update the expiration date for this exception.\n The expiration time cannot be in the past.\n\n @param [Connection] connection Connection to security console.\n @param [String] new_date Date in the format \"YYYY-MM-DD\".\n @return [Boolean] Whether the update was successfully submitted.", "Validate that this exception meets to requires for the assigned scope.", "Retrieve a list of all backups currently stored on the Console.\n\n @return [Array[Backup]] List of backups.", "Create a backup of this security console's data.\n A restart will be initiated in order to put the product into maintenance\n mode while the backup is made. It will then restart automatically.\n\n @param [Boolean] platform_independent Whether to make a platform\n   independent backup.\n @param [String] description A note about this backup which will be\n   visible through the web interface.\n @return [Boolean] Whether a backup is successfully initiated.", "Initiate database maintenance tasks to improve database performance and\n consistency.\n A restart will be initiated in order to put the product into maintenance\n mode while the tasks are run. It will then restart automatically.\n\n @param [Boolean] clean_up Removes any unnecessary data from the database.\n @param [Boolean] compress Compresses the database tables and reclaims\n   unused, allocated space.\n @param [Boolean] reindex Drops and recreates the database indexes for\n   improved performance.\n @return [Boolean] Whether a maintenance tasks are successfully initiated.", "Restore this backup to the Nexpose console.\n It will restart the console after acknowledging receiving the request.\n\n @param [Connection] nsc An active connection to a Nexpose console.\n @param [String] (Optional) The password to use when restoring the backup.\n @return [Boolean] Whether the request was received.", "Convert a host or IP address to the corresponding HostName or IPRange\n class.\n\n If the String cannot be converted, it will raise an error.\n\n @param [String] asset String representation of an IP or host name.\n @return [IPRange|HostName] Valid class, if it can be converted.", "Convert an array of attributes into a hash consumable by the API.\n\n @param [Array[Hash]] arr Array of attributes to convert.\n @return [Array[Hash]] Array formatted as expected by the API.", "Save any updates to this settings object to the Nexpose console.\n\n @param [Connection] nsc Connection to a Nexpose console.\n @return [Boolean] Whether saving was successful.", "Add an asset exclusion setting.\n\n @param [IPRange|HostName|String] host_or_ip Host or IP (range) to exclude\n   from scanning by the Nexpose console.", "Remove an asset exclusion setting.\n If you need to remove a range of IPs, be sure to explicitly supply an\n IPRange object to the method.\n\n @param [IPRange|HostName|String] host_or_ip Host or IP (range) to remove\n   from the exclusion list.", "Internal method for updating exclusions before saving.", "Internal method for parsing XML for whether control scanning in enabled.", "Internal method for updating control scanning before saving.", "Internal method for parsing XML for whether asset linking in enabled.", "Internal method for updating asset linking before saving.", "sets the DB2 service", "sets the Microsoft SQL Server service.", "sets the MySQL Server service.", "sets the Oracle service.", "sets the PostgreSQL service.", "sets the Remote Execution service.", "sets the Simple Network Management Protocol v3 service.", "sets the Sybase SQL Server service.", "sets the Telnet service.", "sets the Web Site HTTP Authentication service.", "Retrieve a list of all users configured on this console.\n\n @return [Array[UserSummary]] Array of users.", "Retrieve information about all available connections for dynamic\n discovery of assets, including whether or not connections are active.", "Delete an existing connection to a target used for dynamic discovery of assets.\n\n @param [Fixnum] id ID of an existing discovery connection.", "Create a new discovery connection.\n\n @param [String] name Name to assign to this connection.\n @param [String] address IP or fully qualified domain name of the\n    connection server.\n @param [String] user User name for credentials on this connection.\n @param [String] password Password for credentials on this connection.\n\n Save this discovery connection on a given Nexpose console.\n\n @param [Connection] nsc Connection to a console.", "Perform dynamic discover of assets against this connection.\n\n @param [Connection] nsc Connection to a console.\n @param [Criteria] criteria Criteria search object narrowing which assets\n   to filter.\n @return [Array[DiscoveredAsset]] All discovered assets matching the criteria.", "Initiates a connection to a target used for dynamic discovery of assets.\n As long as a connection is active, dynamic discovery is continuous.\n\n @param [Connection] nsc Connection to a console.", "Retrieve an array of all asset groups the user is authorized to view or\n manage.\n\n @return [Array[AssetGroupSummary]] Array of AssetGroupSummary objects.", "Generate an XML representation of this group configuration\n\n @return [String] XML valid for submission as part of other requests.", "Launch ad hoc scans against each group of assets per site.\n\n @param [Connection] connection Connection to console where asset group\n   is configured.\n @return [Hash] Hash of site ID to Scan launch information for each scan.", "get AWS Credentials", "Converts the given local time to the UTC equivalent.\n\n @param time [#to_time] the local time\n @return [Time] the time in UTC\n\n @note The UTC equivalent is a \"best guess\". There are cases where\n   local times do not map to UTC at all (during a time skip forward).\n   There are also cases where local times map to two distinct UTC\n   times (during a fall back). All of these cases are approximated\n   in this method and the first possible result is used instead.\n\n @note A note about the handling of time arguments.\n\n   Because the UTC offset of a `Time` object in Ruby is not\n   equivalent to a single timezone, the `time` argument in this\n   method is first converted to a UTC equivalent before being\n   used as a local time.\n\n   This prevents confusion between historical UTC offsets and the UTC\n   offset that the `Time` object provides. For instance, if I pass\n   a \"local\" time with offset `+8` but the timezone actually had\n   an offset of `+9` at the given historical time, there is an\n   inconsistency that must be resolved.\n\n   Did the user make a mistake; or is the offset intentional?\n\n   One approach to solving this problem would be to raise an error,\n   but this means that the user then needs to calculate the\n   appropriate local offset and append that to a UTC time to satisfy\n   the function. This is impractical because the offset can already\n   be calculated by this library. The user should only need to\n   provide a time without an offset!\n\n   To resolve this inconsistency, the solution I chose was to scrub\n   the offset. In the case where an offset is provided, the time is\n   just converted to the UTC equivalent (without an offset). The\n   resulting time is used as the local reference time.\n\n   For example, if the time `08:00 +2` is passed to this function,\n   the local time is assumed to be `06:00`.", "Converts the given time to the local timezone and includes the UTC\n offset in the result.\n\n @param time [#to_time] the source time\n @return [Time] the time in the local timezone with the UTC offset", "Find the first rule that matches using binary search.", "Get the OpenStruct as encoded BSON.\n\n @example Get the OpenStruct object as encoded BSON.\n   OpenStruct.new({ \"field\" => \"value\" }).to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 4.2.0", "Get the hash as encoded BSON.\n\n @example Get the hash as encoded BSON.\n   { \"field\" => \"value\" }.to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Instantiate the new timestamp.\n\n @example Instantiate the timestamp.\n   BSON::Timestamp.new(5, 30)\n\n @param [ Integer ] seconds The number of seconds.\n @param [ Integer ] increment The increment value.\n\n @since 2.0.0\n Get the timestamp as its encoded raw BSON bytes.\n\n @example Get the timestamp as BSON.\n   timestamp.to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get the array as encoded BSON.\n\n @example Get the array as encoded BSON.\n   [ 1, 2, 3 ].to_bson\n\n @note Arrays are encoded as documents, where the index of the value in\n   the array is the actual key.\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Instantiate the new code.\n\n @example Instantiate the new code.\n   BSON::Code.new(\"this.value = 5\")\n\n @param [ String ] javascript The javascript code.\n\n @since 2.0.0\n Encode the javascript code.\n\n @example Encode the code.\n   code.to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get the date time as encoded BSON.\n\n @example Get the date time as encoded BSON.\n   DateTime.new(2012, 1, 1, 0, 0, 0).to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.1.0", "Instantiate the new code with scope.\n\n @example Instantiate the code with scope.\n   BSON::CodeWithScope.new(\"this.value = name\", name: \"sid\")\n\n @param [ String ] javascript The javascript code.\n @param [ Hash ] scope The variable scope.\n\n @since 2.0.0\n Encode the javascript code with scope.\n\n @example Encode the code with scope.\n   code_with_scope.to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get the integer as encoded BSON.\n\n @example Get the integer as encoded BSON.\n   1024.to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get the object id as it's raw BSON data.\n\n @example Get the raw bson bytes.\n   object_id.to_bson\n\n @note Since Moped's BSON and MongoDB BSON before 2.0.0 have different\n   internal representations, we will attempt to repair the data for cases\n   where the object was instantiated in a non-standard way. (Like a\n   Marshal.load)\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get the true boolean as encoded BSON.\n\n @example Get the true boolean as encoded BSON.\n   true.to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Encode the binary type\n\n @example Encode the binary.\n   binary.to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get the class for the single byte identifier for the type in the BSON\n specification.\n\n @example Get the type for the byte.\n   BSON::Registry.get(\"\\x01\")\n\n @return [ Class ] The corresponding Ruby class for the type.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get the date as encoded BSON.\n\n @example Get the date as encoded BSON.\n   Date.new(2012, 1, 1).to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.1.0", "Get the regular expression as encoded BSON.\n\n @example Get the regular expression as encoded BSON.\n   %r{\\d+}.to_bson\n\n @note From the BSON spec: The first cstring is the regex pattern,\n   the second is the regex options string. Options are identified\n   by characters, which must be stored in alphabetical order.\n   Valid options are 'i' for case insensitive matching,\n   'm' for multiline matching, 'x' for verbose mode,\n   'l' to make \\w, \\W, etc. locale dependent,\n   's' for dotall mode ('.' matches everything),\n   and 'u' to make \\w, \\W, etc. match unicode.\n\n @param [ BSON::ByteBuffer ] buffer The byte buffer to append to.\n @param [ true, false ] validating_keys\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get the time as encoded BSON.\n\n @example Get the time as encoded BSON.\n   Time.new(2012, 1, 1, 0, 0, 0).to_bson\n\n @return [ BSON::ByteBuffer ] The buffer with the encoded object.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Get a value from the document for the provided key. Can use string or\n symbol access, with string access being the faster of the two.\n\n @overload fetch(key)\n   Returns a value from the hash for the given key. If the key does\n   not exist, raises KeyError exception.\n\n @overload fetch(key, default)\n   Returns a value from the hash for the given key. If the key does not\n   exist, returns *default*.\n\n @overload fetch(key, &block)\n   Returns a value from the hash for the given key. If the key does not\n   exist, returns the value of the block called with the key.\n\n @example Get an element for the key.\n   document.fetch(\"field\")\n\n @example Get an element for the key by symbol with a default.\n   document.fetch(:field, 'foo')\n\n @example Get an element for the key by symbol with a block default.\n   document.fetch(:field) { |key| key.upcase }\n\n @param [ String, Symbol ] key The key to look up.\n @param [ Object ] default Returned value if key does not exist.\n @yield [key] Block returning default value for the given key.\n\n @return [ Object ] The found value. Raises KeyError if none found.\n\n @since 4.4.0", "Merge this document with another document, returning the same document in\n the process.\n\n @example Merge with another document.\n   document.merge(name: \"Bob\")\n\n @param [ BSON::Document, Hash ] other The document/hash to merge with.\n\n @return [ BSON::Document ] The result of the merge.\n\n @since 3.0.0", "Get the symbol as a BSON key name encoded C symbol.\n\n @example Get the symbol as a key name.\n   :test.to_bson_key\n\n @return [ String ] The encoded symbol as a BSON key.\n\n @see http://bsonspec.org/#/specification\n\n @since 2.0.0", "Returns an Array containing all method objects sorted by their names.\n\n @return [Array]", "Returns the modules that are included in the constant.\n\n @return [Array]", "Returns the superclass of the current constant or `nil` if there is none.\n\n @return [Mixed]", "Gets the methods of the current constant minus those defined in Object.\n\n @param [Symbol] getter\n @return [Array]", "Converts a String based constant path into an actual constant.\n\n @param [String] constant\n @return [Class]\n @raise [ArgumentError] Raised when one of the segments doesn't exist.", "Executes the specified callback method if it exists.\n\n @param [String|Symbol] name The name of the callback method to execute.\n @param [Array] args Arguments to pass to the callback method.", "Returns an Array containing the segments of a constant path.\n\n @param [RubyLint::AST::Node] node\n @return [Array<Array(Symbol,String)>]", "Bootstraps various core definitions.", "Tries to load the definitions for the given constant.\n Takes into account what modules we are in to resolve the constant name.\n\n @param [String] constant name, possibly unqualified", "Tries to load the definitions for the given constant.\n\n @param [String] constant", "Sets a list of the enabled report levels.\n\n @param [Array] given The report levels specified by the user.\n @return [Array]", "Sets a collection of the analysis constants to use.\n\n @param [Array] names The analysis names as given by the user.\n @return [Array]", "Processes a list of files and writes the output to STDOUT.", "Searches all the files that could potentially define the given constant\n and caches them.\n\n @param [String] constant", "Parses the given file and returns an Array containing all the associated\n AST nodes and comments.\n\n @param [RubyLint::Parser] parser\n @param [String] file\n @return [Array]", "Runs all the registered analysis classes.\n\n @param [RubyLint::AST::Node] ast\n @param [RubyLint::VirtualMachine] vm\n @param [RubyLint::Report] report", "Called after a new instance of the virtual machine has been created.", "Processes the given AST or a collection of AST nodes.\n\n @see #iterate\n @param [Array|RubyLint::AST::Node] ast", "Processes an `or` assignment in the form of `variable ||= value`.", "Processes an `and` assignment in the form of `variable &&= value`.", "Builds an Array.\n\n @param [RubyLint::AST::Node] node", "Builds a Hash.\n\n @param [RubyLint::AST::Node] node", "Pushes the value of `self` onto the current stack.", "Creates the definition for a class.\n\n @param [RubyLint::AST::Node] node", "Builds the definition for a block.\n\n @param [RubyLint::AST::Node] node", "Creates the definition for a method definition.\n\n @param [RubyLint::AST::Node] node", "Exports various variables to the outer scope of the method definition.", "Processes a method call. If a certain method call has its own dedicated\n callback that one will be called as well.\n\n @param [RubyLint::AST::Node] node", "Returns the initial set of definitions to use.\n\n @return [RubyLint::Definition::RubyObject]", "Pushes a new scope on the list of available scopes.\n\n @param [RubyLint::Definition::RubyObject] definition", "Pushes the value of a variable onto the value stack.\n\n @param [RubyLint::AST::Node] node", "Assigns a basic variable.\n\n @param [Symbol] type The type of variable.\n @param [String] name The name of the variable\n @param [RubyLint::Definition::RubyObject] value\n @param [RubyLint::AST::Node] node", "Adds a variable to the current scope of, if a the variable stack is not\n empty, add it to the stack instead.\n\n @param [RubyLint::Definition::RubyObject] variable\n @param [RubyLint::Definition::RubyObject] scope", "Creates a primitive value such as an integer.\n\n @param [RubyLint::AST::Node] node\n @param [Hash] options", "Performs a conditional assignment.\n\n @param [RubyLint::Definition::RubyObject] variable\n @param [RubyLint::Definition::RubyValue] value\n @param [TrueClass|FalseClass] bool When set to `true` existing variables\n  will be overwritten.", "Returns the definition for the given node.\n\n @param [RubyLint::AST::Node] node\n @return [RubyLint::Definition::RubyObject]", "Increments the reference amount of a node's definition unless the\n definition is frozen.\n\n @param [RubyLint::AST::Node] node", "Includes the definition `inherit` in the list of parent definitions of\n `definition`.\n\n @param [RubyLint::Definition::RubyObject] definition\n @param [RubyLint::Definition::RubyObject] inherit", "Extracts all the docstring tags from the documentation of the given\n node, retrieves the corresponding types and stores them for later use.\n\n @param [RubyLint::AST::Node] node", "Creates an \"unknown\" definition with the given method in it.\n\n @param [String] name The name of the method to add.\n @return [RubyLint::Definition::RubyObject]", "Returns a collection of definitions for a set of YARD types.\n\n @param [Array] types\n @return [Array]", "Tracks a method call.\n\n @param [RubyLint::Definition::RubyMethod] definition\n @param [String] name\n @param [RubyLint::AST::Node] node", "Groups constants together based on the top level namespace segment.\n\n @param [Array] constants\n @return [Hash]", "Returns a Hash containing all the instance and class methods and their\n arguments.\n\n @param [Hash] inspected\n @return [Hash]", "defined depending on which selector was used", "If we're operating on something affected by the rvm user mode,\n we need to make sure that the server has the right rvm user mode.\n This returns a shell command to prepend to an existing command\n in order to achieve this.", "Set the properties of the X-axis.\n\n The set_x_axis() method is used to set properties of the X axis.\n\n     chart.set_x_axis(:name => 'Sample length (m)' )\n\n The properties that can be set are:\n\n     :name          (optional)\n     :name_formula  (optional)\n\n     * :name\n\n       Set the name (title or caption) for the axis. The name is displayed\n       below the X axis. This property is optional. The default is to have\n       no axis name.\n\n           chart.set_x_axis( :name => 'Sample length (m)' )\n\n     * :name_formula\n\n       Optional, can be used to link the name to a worksheet cell.\n       See \"Chart names and links\".\n\n           chart.set_x_axis(\n             :name          => 'Sample length (m)',\n             :name_formula  => '=Sheet1!$A$1'\n           )\n\n Additional axis properties such as range, divisions and ticks will be made\n available in later releases.", "Set the properties of the Y-axis.\n\n The set_y_axis() method is used to set properties of the Y axis.\n\n     chart.set_y_axis(:name => 'Sample weight (kg)' )\n\n The properties that can be set are:\n\n     :name          (optional)\n     :name_formula  (optional)\n\n     * :name\n\n       Set the name (title or caption) for the axis. The name is displayed\n       to the left of the Y axis. This property is optional. The default\n       is to have no axis name.\n\n           chart.set_y_axis(:name => 'Sample weight (kg)' )\n\n     * :name_formula\n\n       Optional, can be used to link the name to a worksheet cell.\n       See \"Chart names and links\".\n\n           chart.set_y_axis(\n             :name          => 'Sample weight (kg)',\n             :name_formula  => '=Sheet1!$B$1'\n           )\n\n Additional axis properties such as range, divisions and ticks will be made\n available in later releases.", "Set the properties of the chart plotarea.", "Create and store the Chart data structures.", "Write BIFF record Window2. Note, this overrides the parent Worksheet\n record because the Chart version of the record is smaller and is used\n mainly to indicate if the chart tab is selected or not.", "Convert UTF8 strings used in the chart to UTF16.", "Convert the user specified colour index or string to an colour index and\n RGB colour number.", "Get the Excel chart index for line pattern that corresponds to the user\n defined value.", "Get the Excel chart index for line weight that corresponds to the user\n defined value.", "Store the CHART record and it's substreams.", "Write the SERIES chart substream.", "Write the X-axis TEXT substream.", "Write the AXISPARENT chart substream.", "Write the AI chart BIFF record.", "Write the AREAFORMAT chart BIFF record. Contains the patterns and colours\n of a chart area.", "Write the AXCEXT chart BIFF record.", "Write the AXIS chart BIFF record to define the axis type.", "Write the AXISPARENT chart BIFF record.", "Write the CATSERRANGE chart BIFF record.", "Write the CHARTFORMAT chart BIFF record. The parent record for formatting\n of a chart group.", "Write the DATAFORMAT chart BIFF record. This record specifies the series\n that the subsequent sub stream refers to.", "Write the FBI chart BIFF record. Specifies the font information at the time\n it was applied to the chart.", "Write the FRAME chart BIFF record.", "Write the LEGEND chart BIFF record. The Marcus Horan method.", "Write the LINEFORMAT chart BIFF record.", "Write the MARKERFORMAT chart BIFF record.", "Write the OBJECTLINK chart BIFF record.", "Write the PLOTGROWTH chart BIFF record.", "Write the POS chart BIFF record. Generally not required when using\n automatic positioning.", "Write the SERAUXTREND chart BIFF record.", "Write the SERIES chart BIFF record.", "Write the SERIESTEXT chart BIFF record.", "Write the SHTPROPS chart BIFF record.", "Write the TICK chart BIFF record.", "Write the VALUERANGE chart BIFF record.", "Takes a textual description of a formula and returns a RPN encoded byte\n string.", "Convert each token or token pair to its Excel 'ptg' equivalent.", "Convert a number token to ptgInt or ptgNum", "Convert a string to a ptg Str.", "Convert a function to a ptgFunc or ptgFuncVarV depending on the number of\n args that it takes.", "Convert a symbolic name into a name reference.", "Constructor. Creates a new Worksheet object from a BIFFwriter object\n\n\n Add data to the beginning of the workbook (note the reverse order)\n and to the end of the workbook.", "Hide this worksheet.\n\n The hide() method is used to hide a worksheet:\n\n     worksheet2.hide\n\n You may wish to hide a worksheet in order to avoid confusing a user with\n intermediate data or calculations.\n\n A hidden worksheet can not be activated or selected so this method is\n mutually exclusive with the activate() and select() methods. In addition,\n since the first worksheet will default to being the active worksheet,\n you cannot hide the first worksheet without activating another sheet:\n\n     worksheet2.activate\n     worksheet1.hide", "Set the colour of the worksheet colour.\n\n The set_tab_color() method is used to change the colour of the worksheet\n tab. This feature is only available in Excel 2002 and later. You can\n use one of the standard colour names provided by the Format object or a\n colour index. See \"COLOURS IN EXCEL\" and the set_custom_color() method.\n\n     worksheet1.set_tab_color('red')\n     worksheet2.set_tab_color(0x0C)\n\n See the tab_colors.rb program in the examples directory of the distro.", "Calculate the vertices that define the position of a graphical object within\n the worksheet.\n\n         +------------+------------+\n         |     A      |      B     |\n   +-----+------------+------------+\n   |     |(x1,y1)     |            |\n   |  1  |(A1)._______|______      |\n   |     |    |              |     |\n   |     |    |              |     |\n   +-----+----|    BITMAP    |-----+\n   |     |    |              |     |\n   |  2  |    |______________.     |\n   |     |            |        (B2)|\n   |     |            |     (x2,y2)|\n   +---- +------------+------------+\n\n Example of a bitmap that covers some of the area from cell A1 to cell B2.\n\n Based on the width and height of the bitmap we need to calculate 8 vars:\n     $col_start, $row_start, $col_end, $row_end, $x1, $y1, $x2, $y2.\n The width and height of the cells are also variable and have to be taken into\n account.\n The values of $col_start and $row_start are passed in from the calling\n function. The values of $col_end and $row_end are calculated by subtracting\n the width and height of the bitmap from the width and height of the\n underlying cells.\n The vertices are expressed as a percentage of the underlying cell width as\n follows (rhs values are in pixels):\n\n       x1 = X / W *1024\n       y1 = Y / H *256\n       x2 = (X-1) / W *1024\n       y2 = (Y-1) / H *256\n\n       Where:  X is distance from the left side of the underlying cell\n               Y is distance from the top of the underlying cell\n               W is the width of the cell\n               H is the height of the cell\n\n Note: the SDK incorrectly states that the height should be expressed as a\n percentage of 1024.", "Write the Escher SpContainer record that is part of MSODRAWING.", "Write the Escher Sp record that is part of MSODRAWING.", "Write the Escher ClientData record that is part of MSODRAWING.", "Excel BIFF BOUNDSHEET record.\n\n    sheetname  # Worksheet name\n    offset     # Location of worksheet BOF\n    type       # Worksheet type\n    hidden     # Worksheet hidden flag\n    encoding   # Sheet name encoding", "Converts the tokens of a possibly conditional expression into 1 or 2\n sub expressions for further parsing.\n\n Examples:\n          ('x', '==', 2000) -> exp1\n          ('x', '>',  2000, 'and', 'x', '<', 5000) -> exp1 and exp2", "Returns an index to the XF record in the workbook.\n\n Note: this is a function, not a method.", "Based on the algorithm provided by Daniel Rentz of OpenOffice.", "Pack the string value when a formula evaluates to a string. The value cannot\n be calculated by the module and thus must be supplied by the user.", "Writes Excel DIMENSIONS to define the area in which there is cell data.\n\n Notes:\n   Excel stores the max row/col as row/col +1.\n   Max and min values of 0 are used to indicate that no cell data.\n   We set the undef member data to 0 since it is used by store_table().\n   Inserting images or charts doesn't change the DIMENSION data.", "Write BIFF record Window2.", "Write the Tab Color BIFF record.", "Write BIFF record DEFROWHEIGHT.", "Write BIFF record DEFCOLWIDTH.", "Write BIFF record AUTOFILTERINFO.", "Write BIFF record SELECTION.", "Write BIFF record EXTERNCOUNT to indicate the number of external sheet\n references in a worksheet.\n\n Excel only stores references to external sheets that are used in formulas.\n For simplicity we store references to all the sheets in the workbook\n regardless of whether they are used or not. This reduces the overall\n complexity and eliminates the need for a two way dialogue between the formula\n parser the worksheet objects.", "Store the page setup SETUP BIFF record.", "Write the GRIDSET BIFF record. Must be used in conjunction with the\n PRINTGRIDLINES record.", "Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction\n with the SETUP record.", "Write the worksheet PASSWORD record.", "Note about compatibility mode.\n\n Excel doesn't require every possible Biff record to be present in a file.\n In particular if the indexing records INDEX, ROW and DBCELL aren't present\n it just ignores the fact and reads the cells anyway. This is also true of\n the EXTSST record. Gnumeric and OOo also take this approach. This allows\n WriteExcel to ignore these records in order to minimise the amount of data\n stored in memory. However, other third party applications that read Excel\n files often expect these records to be present. In \"compatibility mode\"\n WriteExcel writes these records and tries to be as close to an Excel\n generated file as possible.\n\n This requires additional data to be stored in memory until the file is\n about to be written. This incurs a memory and speed penalty and may not be\n suitable for very large files.\n\n\n Write cell data stored in the worksheet row/col table.\n\n This is only used when compatibity_mode() is in operation.\n\n This method writes ROW data, then cell data (NUMBER, LABELSST, etc) and then\n DBCELL records in blocks of 32 rows. This is explained in detail (for a\n change) in the Excel SDK and in the OOo Excel file format doc.", "Convert the width of a cell from user's units to pixels. Excel rounds the\n column width to the nearest pixel. If the width hasn't been set by the user\n we use the default value. If the column is hidden we use a value of zero.", "Function to write worksheet AUTOFILTER records. These contain 2 Biff Doper\n structures to represent the 2 possible filter conditions.", "Create a Biff Doper structure that represents a filter expression. Depending\n on the type of the token we pack an Empty, String or Number doper.", "Pack an IEEE double number Doper structure.", "Store the collections of records that make up images.", "Store the collections of records that make up charts.", "Store the collections of records that make up cell comments.\n\n NOTE: We write the comment objects last since that makes it a little easier\n to write the NOTE records directly after the MSODRAWIING records.", "Write the Escher DgContainer record that is part of MSODRAWING.", "Write the Escher Dg record that is part of MSODRAWING.", "Write the Escher SpgrContainer record that is part of MSODRAWING.", "Write the Escher Spgr record that is part of MSODRAWING.", "Generate an Excel BIFF FONT record.", "Set cells borders to the same style\n\n     Also applies to:    set_bottom()\n                         set_top()\n                         set_left()\n                         set_right()\n\n     Default state:      Border is off\n     Default action:     Set border type 1\n     Valid args:         0-13, See below.\n\n A cell border is comprised of a border on the bottom, top, left and right.\n These can be set to the same value using set_border() or individually\n using the relevant method calls shown above.\n\n The following shows the border styles sorted by WriteExcel index number:\n\n     Index   Name            Weight   Style\n     =====   =============   ======   ===========\n     0       None            0\n     1       Continuous      1        -----------\n     2       Continuous      2        -----------\n     3       Dash            1        - - - - - -\n     4       Dot             1        . . . . . .\n     5       Continuous      3        -----------\n     6       Double          3        ===========\n     7       Continuous      0        -----------\n     8       Dash            2        - - - - - -\n     9       Dash Dot        1        - . - . - .\n     10      Dash Dot        2        - . - . - .\n     11      Dash Dot Dot    1        - . . - . .\n     12      Dash Dot Dot    2        - . . - . .\n     13      SlantDash Dot   2        / - . / - .\n\n The following shows the borders sorted by style:\n\n     Name            Weight   Style         Index\n     =============   ======   ===========   =====\n     Continuous      0        -----------   7\n     Continuous      1        -----------   1\n     Continuous      2        -----------   2\n     Continuous      3        -----------   5\n     Dash            1        - - - - - -   3\n     Dash            2        - - - - - -   8\n     Dash Dot        1        - . - . - .   9\n     Dash Dot        2        - . - . - .   10\n     Dash Dot Dot    1        - . . - . .   11\n     Dash Dot Dot    2        - . . - . .   12\n     Dot             1        . . . . . .   4\n     Double          3        ===========   6\n     None            0                      0\n     SlantDash Dot   2        / - . / - .   13\n\n The following shows the borders in the order shown in the Excel Dialog.\n\n     Index   Style             Index   Style\n     =====   =====             =====   =====\n     0       None              12      - . . - . .\n     7       -----------       13      / - . / - .\n     4       . . . . . .       10      - . - . - .\n     11      - . . - . .       8       - - - - - -\n     9       - . - . - .       2       -----------\n     3       - - - - - -       5       -----------\n     1       -----------       6       ===========\n\n Examples of the available border styles are shown in the 'Borders' worksheet\n created by formats.rb.", "Set cells border to the same color\n\n     Also applies to:    set_bottom_color()\n                         set_top_color()\n                         set_left_color()\n                         set_right_color()\n\n     Default state:      Color is off\n     Default action:     Undefined\n     Valid args:         See set_color()\n\n Set the colour of the cell borders. A cell border is comprised of a border\n on the bottom, top, left and right. These can be set to the same colour\n using set_border_color() or individually using the relevant method calls\n shown above. Examples of the border styles and colours are shown in the\n 'Borders' worksheet created by formats.rb.", "Dynamically create set methods that aren't already defined.", "Extract width and height information from a JPEG file.", "When requesting a step tranformer object value, process it, if it hasn't\n alredy been processed, replacing any constants that may be lurking within\n the value.\n\n Processing it means looking for any escaped characters that happen to be\n CONSTANTS that could be matched and then replaced. This is done recursively\n as CONSTANTS can be defined with more CONSTANTS.", "Look through the specified data for the escape pattern and return an array\n of those constants found. This defaults to the @value within step transformer\n as it is used internally, however, it can be called externally if it's\n needed somewhere.", "Looking through all the constants in the registry and returning the value\n with the regex items replaced from the constnat if present", "Each found feature found is creates a new FeatureParser\n\n This logic was copied from the logic found in Cucumber to create the builder\n and then set up the formatter and parser. The difference is really the\n custom Cucumber::Parser::CityBuilder that is being used to parse the elements\n of the feature into YARD::CodeObjects.\n\n @param [<String>] source containing the string conents of the feauture file\n @param [<String>] file the filename that contains the source\n\n\n When parse is called, the gherkin parser is executed and all the feature\n elements that are found are sent to the various methods in the\n Cucumber::Parser::CityBuilder. The result of which is the feature element\n that contains all the scenarios, steps, etc. associated with that feature.\n\n @see Cucumber::Parser::CityBuilder", "Check if given JSON path exists\n @param json_path [String] a valid JSON path expression\n @param json [String] optional JSON from which to check JSON path, default to response body\n @return [true, false] true if JSON path is valid and exists, false otherwise", "Retrieve value of the first JSON element with given JSON path\n @param json_path [String] a valid JSON path expression\n @param json [String] optional JSON from which to apply JSON path, default to response body\n @return [Object] value of first retrieved JSON element in form of Ruby object\n @raise [Exception] if JSON path is invalid or no matching JSON element found", "Retrieve value of the first JSON element with given JSON path as given type\n @param json_path [String] a valid JSON path expression\n @param type [String] required type, possible values are 'numeric', 'array', 'string', 'boolean', 'numeric_string'\n or 'object'\n @param json [String] optional JSON from which to apply JSON path, default to response body\n @return [Object] value of first retrieved JSON element in form of given type\n @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match\n required type", "Retrieve value of the first JSON element with given JSON path as given type, with nil value allowed\n @param json_path [String] a valid JSON path expression\n @param type [String] required type, possible values are 'numeric', 'array', 'string', 'boolean', 'numeric_string'\n or 'object'\n @param json [String] optional JSON from which to apply JSON path, default to response body\n @return [Object] value of first retrieved JSON element in form of given type or nil\n @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match\n required type", "Retrieve value of the first JSON element with given JSON path as given type, and check for a given value\n @param json_path [String] a valid JSON path expression\n @param type [String] required type, possible values are 'numeric', 'string', 'boolean', or 'numeric_string'\n @param value [String] value to check for\n @param json [String] optional JSON from which to apply JSON path, default to response body\n @return [Object] value of first retrieved JSON element in form of given type or nil\n @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match\n required type or value", "Mark a request as externally authorized. Causes ACL checks to be skipped.\n\n @param [Hash] :rack_env Rack environment\n @param [String] :allowed_by what allowed the request", "Mark what authorized the request in the Rack environment\n\n @param [Hash] :rack_env Rack environment\n @param [String] :allowed_by what allowed this request", "Add a credential to the Rack environment\n\n @param [Hash] :rack_env Rack environment\n @param [String] :type credential type to add to the environment\n @param [Object] :credential object to add to the environment", "Public for upgrade-config command only.", "Measure memory usage in report blocks.\n\n @param quiet [Boolean] A flag to toggle benchmark output.\n\n @return [Report]", "Use for_model instead of instatiating a record directly.\n Entry method for building records. Delegates to build_records after remember_depth.", "Saves the records to the database by calling populate on the current database adapter.", "Call populate on any ActiveRecord model to fill it with data.\n Pass the number of records you want to create, and a block to\n set the attributes. You can nest calls to handle associations\n and use ranges or arrays to randomize the values.\n\n   Person.populate(3000) do |person|\n     person.name = \"John Doe\"\n     person.gender = ['male', 'female']\n     Project.populate(10..30, :per_query => 100) do |project|\n       project.person_id = person.id\n       project.due_at = 5.days.from_now..2.years.from_now\n       project.name = Populator.words(1..3).titleize\n       project.description = Populator.sentences(2..10)\n     end\n   end\n\n The following options are supported.\n\n * <tt>:per_query</tt> - limit how many records are inserted per query, defaults to 1000\n\n Populator::Factory is where all the work happens.", "Pick a random value out of a given range.", "Performs a scan.\n\n @param [Hash{Symbol => Object}] options\n   Additional options for nmap.\n\n @param [Hash{Symbol => Object}] exec_options\n   Additional exec-options.\n\n @yield [task]\n   If a block is given, it will be passed a task object\n   used to specify options for nmap.\n\n @yieldparam [Task] task\n   The nmap task object.\n\n @return [Boolean]\n   Specifies whether the command exited normally.\n\n @see http://rubydoc.info/gems/rprogram/0.3.0/RProgram/Program#run-instance_method\n   For additional exec-options.", "Performs a scan and runs `nmap` under `sudo`.\n\n @see #scan\n\n @since 0.8.0", "Parses the scanner information.\n\n @return [Scanner]\n   The scanner that was used and generated the scan file.", "Parses the scan information.\n\n @return [Array<Scan>]\n   The scan information.", "Parses the essential runstats information.\n\n @yield [run_stat]\n   The given block will be passed each runstat.\n\n @yieldparam [RunStat] run_stat\n   A runstat.\n\n @return [Enumerator]\n   If no block is given, an enumerator will be returned.\n\n @since 0.7.0", "Parses the tasks of the scan.\n\n @yield [task]\n   The given block will be passed each scan task.\n\n @yieldparam [ScanTask] task\n   A task from the scan.\n\n @return [Enumerator]\n   If no block is given, an enumerator will be returned.\n\n @since 0.7.0", "Parses the hosts that were found to be up during the scan.\n\n @yield [host]\n   Each host will be passed to a given block.\n\n @yieldparam [Host] host\n   A host in the scan.\n\n @return [XML, Enumerator]\n   The XML parser. If no block was given, an enumerator object will\n   be returned.", "Parses each address of the host.\n\n @yield [addr]\n   Each parsed address will be pass to a given block.\n\n @yieldparam [Address] addr\n   A address of the host.\n\n @return [Host, Enumerator]\n   The host.\n   If no block was given, an enumerator will be returned.", "Parses the hostnames of the host.\n\n @yield [host]\n   Each parsed hostname will be passed to the given block.\n\n @yieldparam [Hostname] host\n   A hostname of the host.\n\n @return [Host, Enumerator]\n   The host.\n   If no block was given, an enumerator will be returned.", "Parses the Uptime analysis of the host.\n\n @yield [uptime]\n   If a block is given, it will be passed the resulting object\n\n @yieldparam [Uptime]\n   Uptime value.\n\n @return [Uptime]\n   The parsed object.\n\n @since 0.7.0", "Parses the TCP ports of the host.\n\n @yield [port]\n   Each TCP port of the host.\n\n @yieldparam [Port] port\n   An TCP scanned port of the host.\n\n @return [Host, Enumerator]\n   The host.\n   If no block was given, an enumerator will be returned.", "The structured output of the NSE scripts.\n\n @return [Hash{String => Hash{String => Array<String>}}]\n   The NSE script names and their structured output.\n\n @since 0.9.0", "Parses the traceroute information for the host.\n\n @yield [hop]\n   Each hop to the host.\n\n @yieldparam [Hop] hop\n   A hop to the host.\n\n @return [Traceroute, Enumerator]\n   The traceroute.\n   If no block was given, an enumerator will be returned.", "Creates a new OS object.\n\n @param [Nokogiri::XML::Node] node\n   The node that contains the OS guessing information.\n\n\n Parses the OS class information.\n\n @yield [class]\n   Passes each OS class to the given block.\n\n @yieldparam [OSClass] class\n   The OS class information.\n\n @return [OS, Enumerator]\n   The OS information. If no block was given, an enumerator object\n   will be returned.", "Parses the OS match information.\n\n @yield [match]\n   Passes each OS match to the given block.\n\n @yieldparam [OSMatch] class\n   The OS match information.\n\n @return [OS, Enumerator]\n   The OS information. If no block was given, an enumerator object\n   will be returned.", "Step down the bbtree a notch because we've reached a closing tag", "Get 'between tag' for tag", "Idempotently up the given services in the project.\n @param [Array] services list of String service names to run\n @param [Boolean] detached if true, to start services in the background;\n   otherwise, monitor logs in the foreground and shutdown on Ctrl+C\n @param [Integer] timeout how long to wait for each service to start\n @param [Boolean] build if true, build images before starting containers\n @param [Boolean] no_build if true, don't build images, even if they're\n   missing\n @param [Boolean] no_deps if true, just run specified services without\n   running the services that they depend on\n @return [true] always returns true\n @raise [Error] if command fails", "Idempotently scales the number of containers for given services in the project.\n @param [Hash] container_count per service, e.g. {web: 2, worker: 3}\n @param [Integer] timeout how long to wait for each service to scale", "Idempotently run an arbitrary command with a service container.\n @param [String] service name to run\n @param [String] cmd command statement to run\n @param [Boolean] detached if true, to start services in the background;\n   otherwise, monitor logs in the foreground and shutdown on Ctrl+C\n @param [Boolean] no_deps if true, just run specified services without\n   running the services that they depend on\n @param [Array] env a list of environment variables (see: -e flag)\n @param [Array] volumes a list of volumes to bind mount (see: -v flag)\n @param [Boolean] rm remove the container when done\n @param [Boolean] no_tty disable pseudo-tty allocation (see: -T flag)\n @param [String] user run as specified username or uid (see: -u flag)\n @raise [Error] if command fails", "Stop running services.\n @param [Array] services list of String service names to stop\n @param [Integer] timeout how long to wait for each service to stop\n @raise [Error] if command fails", "Forcibly stop running services.\n @param [Array] services list of String service names to stop\n @param [String] name of murderous signal to use, default is 'KILL'\n @see Signal.list for a list of acceptable signal names", "Determine the installed version of docker-compose.\n @param [Boolean] short whether to return terse version information\n @return [String, Hash] if short==true, returns a version string;\n   otherwise, returns a Hash of component-name strings to version strings\n @raise [Error] if command fails", "Run a docker-compose command without validating that the CLI parameters\n make sense. Prepend project and file options if suitable.\n\n @see Docker::Compose::Shell#command\n\n @param [Array] args command-line arguments in the format accepted by\n   Backticks::Runner#command\n @return [String] output of the command\n @raise [Error] if command fails", "Parse a string that consists of a sequence of values enclosed within parentheses.\n Ignore any bytes that are outside of parentheses. Values may include nested parentheses.\n\n @param [String] str e.g. \"(foo) ((bar)) ... (baz)\"\n @return [Array] e.g. [\"foo\", \"bar\", \"baz\"]", "Substitute and set environment variables that point to network ports\n published by docker-compose services. Optionally also print bash export\n statements so this information can be made available to a user's shell.", "Transform a Ruby value into a String that can be stored in the\n environment. This accepts nil, String, or Array and returns nil, String\n or JSON-serialized Array.", "Print an export or unset statement suitable for user's shell", "Figure out the likely IP address of the host pointed to by\n self.docker_url.\n\n @return [String] host-reachable IPv4 address of docker host", "Create an instance of Mapper\n\n @param [Docker::Compose::Session] session\n @param [NetInfo] net_info\n Substitute service hostnames and ports that appear in a URL or a\n host:port string. If either component of a host:port string is\n surrounded by square brackets, \"elide\" that component, removing it\n from the result but using it to find the correct service and port.\n\n @example map MySQL on local docker host with 3306 published to 13847\n   map(\"tcp://db:3306\") # => \"tcp://127.0.0.1:13847\"\n\n @example map just the hostname of MySQL on local docker host\n   map(\"db:[3306]\") # => \"127.0.0.1\"\n\n @example map just the port of MySQL on local docker host\n   map(\"[db]:3306\") # => \"13847\"\n\n @example map an array of database hosts\n   map([\"[db1]:3306\", \"[db2]:3306\"])\n\n @param [String,#map] value a URI, host:port pair, or an array of either\n\n @return [String,Array] the mapped value with container-names and ports substituted\n\n @raise [BadSubstitution] if a substitution string can't be parsed\n @raise [NoService] if service is not up or does not publish port", "Map a single string, replacing service names with IPs and container ports\n with the host ports that they have been mapped to.\n @param [String] value\n @return [String]", "Whether `date` is her birthday\n\n @param date [Date]\n\n @return [Boolean]\n\n @example\n   Cure.twinkle.birthday?(Date.parse(\"2015-9-12\"))\n   #=> true", "Get precure all stars\n\n @param [Time,Date,String,Symbol] arg Time, Date or date like String (ex. \"2013-12-16\")\n\n @return [Array<Rubicure::Girl>]\n\n @example precure all stars\n   Precure.all_stars.count\n   Precure.all_stars.map(&:precure_name)\n   # returns current precure count and names\n\n   Precure.all_stars.include?(Cure.echo)\n   #=> false\n\n   Precure.all_stars(\"2013-10-26\").count\n   #=> 33\n\n   Precure.all_stars(:dx).count\n   #=> 14\n\n   Precure.all_stars(:dx2).count\n   #=> 17\n\n   Precure.all_stars(:dx3).count\n   #=> 21\n\n   Precure.all_stars(:new_stage).count\n   #=> 29\n   Precure.all_stars(:new_stage).include?(Cure.echo)\n   #=> true\n\n   Precure.all_stars(:new_stage2).count\n   #=> 32\n\n   Precure.all_stars(:new_stage3).count\n   #=> 37\n   Precure.all_stars(:new_stage3).include?(Cure.echo)\n   #=> true\n\n   Precure.all_stars(:spring_carnival).count\n   #=> 40\n\n   Precure.all_stars(:sing_together_miracle_magic).count\n   #=> 44\n   Precure.all_stars(:sing_together_miracle_magic).include?(Cure.echo)\n   #=> true", "Get all precures\n\n @param [Time,Date] arg Time, Date or date like String (ex. \"2013-12-16\")\n\n @return [Array<Rubicure::Girl>] all precures\n\n @example\n   Precure.all_girls.count\n   Precure.all_girls.map(&:precure_name)\n   # returns current precure count and names\n\n   Precure.all_girls(\"2013-10-26\").count\n   #=> 33\n\n   Precure.all_girls.include?(Cure.echo)\n   #=> true", "Get precure dream stars\n\n @return [Array<Rubicure::Girl>] precure dream stars\n\n @example\n   Precure.dream_stars.count\n   #=> 12\n\n   Precure.dream_stars.map(&:precure_name)\n   #=> [\"\u30ad\u30e5\u30a2\u30d5\u30ed\u30fc\u30e9\", \"\u30ad\u30e5\u30a2\u30de\u30fc\u30e1\u30a4\u30c9\", \"\u30ad\u30e5\u30a2\u30c8\u30a5\u30a4\u30f3\u30af\u30eb\", \"\u30ad\u30e5\u30a2\u30b9\u30ab\u30fc\u30ec\u30c3\u30c8\", \"\u30ad\u30e5\u30a2\u30df\u30e9\u30af\u30eb\", \"\u30ad\u30e5\u30a2\u30de\u30b8\u30ab\u30eb\", \"\u30ad\u30e5\u30a2\u30d5\u30a7\u30ea\u30fc\u30c1\u30a7\", \"\u30ad\u30e5\u30a2\u30db\u30a4\u30c3\u30d7\", \"\u30ad\u30e5\u30a2\u30ab\u30b9\u30bf\u30fc\u30c9\", \"\u30ad\u30e5\u30a2\u30b8\u30a7\u30e9\u30fc\u30c8\", \"\u30ad\u30e5\u30a2\u30de\u30ab\u30ed\u30f3\", \"\u30ad\u30e5\u30a2\u30b7\u30e7\u30b3\u30e9\"]", "Get precure super stars\n\n @return [Array<Rubicure::Girl>] precure super stars\n\n @example\n   Precure.super_stars.count\n   #=> 12\n\n   Precure.super_stars.map(&:precure_name)\n   #=> [\"\u30ad\u30e5\u30a2\u30df\u30e9\u30af\u30eb\", \"\u30ad\u30e5\u30a2\u30de\u30b8\u30ab\u30eb\", \"\u30ad\u30e5\u30a2\u30d5\u30a7\u30ea\u30fc\u30c1\u30a7\", \"\u30ad\u30e5\u30a2\u30db\u30a4\u30c3\u30d7\", \"\u30ad\u30e5\u30a2\u30ab\u30b9\u30bf\u30fc\u30c9\", \"\u30ad\u30e5\u30a2\u30b8\u30a7\u30e9\u30fc\u30c8\", \"\u30ad\u30e5\u30a2\u30de\u30ab\u30ed\u30f3\", \"\u30ad\u30e5\u30a2\u30b7\u30e7\u30b3\u30e9\", \"\u30ad\u30e5\u30a2\u30d1\u30eb\u30d5\u30a7\", \"\u30ad\u30e5\u30a2\u30a8\u30fc\u30eb\", \"\u30ad\u30e5\u30a2\u30a2\u30f3\u30b8\u30e5\", \"\u30ad\u30e5\u30a2\u30a8\u30c8\u30ef\u30fc\u30eb\"]", "Set a comment on a column", "imply date for dt-end if dt-start is defined with a date", "Initializes the generator\n\n @example Create a new generator\n   MarkovChains::Generator.new(text)\n\n @param Text source to generate sentences from\n\n Returns a given number of randonly generated sentences\n\n @example Get 5 sentences\n   get_sentences(5)\n\n @param n [int] number of sentences to generate\n @return Array conataining generated sentences", "Returns the parent entries of the current request, if any.\n These are ActiveRecords or namespace symbols, corresponding\n to the defined nesting attribute.", "The next two methods are the last stop before JSON encoding, so all strings\n in the returned hash must be UTF-8 compatible.", "Try to parse one or more messages from the buffer, and yield them", "Used by filters to initiate upstream connection in response to\n inbound connection", "called with a ProxyMessage", "Protocol is symmetrical.  Each endpoint has its own state.\n This is a bit clunky and maybe should be abstracted into a module?\n Or update parser.rb to differentiate between proto-shared and endpoint-separate state?", "Establish connection to the cluster for administration\n\n @param [String] connstr (\"couchbasae://localhost\") connection string\n @param [Hash] options The connection parameter\n @option options [String] :username The username\n @option options [String] :password The password\n Create data bucket\n\n @param [String] name The name of the bucket\n @param [Hash] options The bucket parameters\n @option options [String] :bucket_type (\"couchbase\") The type of the\n   bucket. Possible values are \"memcached\" and \"couchbase\".\n @option options [Fixnum] :ram_quota (100) The RAM quota in megabytes.\n @option options [Fixnum] :replica_number (1) The number of replicas of\n   each document. Minimum 0, maximum 3.\n @option options [String] :auth_type (\"sasl\") The authentication type.\n   Possible values are \"sasl\" and \"none\". Note you should specify free\n   port for \"none\"\n @option options [Fixnum] :proxy_port The port for moxi\n @option options [true, false] :replica_index (true) Disable or\n   enable indexes for bucket replicas\n @option options [true, false] :flush_enabled (false) Enables the\n   'flush all' functionality on the specified bucket.\n @option options [true, false] :parallel_db_and_view_compaction (false)\n   Indicates whether database and view files on disk can be\n   compacted simultaneously", "Locate bootstrap nodes from a DNS SRV record.\n\n @note This is experimental interface. It might change in future\n       (e.g. service identifiers)\n\n The DNS SRV records need to be configured on a reachable DNS server. An\n example configuration could look like the following:\n\n     _cbmcd._tcp.example.com.  0  IN  SRV  20  0  11210 node2.example.com.\n     _cbmcd._tcp.example.com.  0  IN  SRV  10  0  11210 node1.example.com.\n     _cbmcd._tcp.example.com.  0  IN  SRV  30  0  11210 node3.example.com.\n\n     _cbhttp._tcp.example.com.  0  IN  SRV  20  0  8091 node2.example.com.\n     _cbhttp._tcp.example.com.  0  IN  SRV  10  0  8091 node1.example.com.\n     _cbhttp._tcp.example.com.  0  IN  SRV  30  0  8091 node3.example.com.\n\n Now if \"example.com\" is passed in as the argument, the three\n nodes configured will be parsed and put in the returned URI list. Note that\n the priority is respected (in this example, node1 will be the first one\n in the list, followed by node2 and node3). As of now, weighting is not\n supported.\n\n @param name the DNS name where SRV records configured\n @param bootstrap_protocol (Symbol) the desired protocol for\n        bootstrapping. See +bootstrap_protocols+ option to\n        {Couchbase::Bucket#new}. Allowed values +:http, :cccp+\n @return a list of ordered boostrap URIs by their weight.\n\n @example Initialize connection using DNS SRV records\n\n    nodes = Couchbase::DNS.locate('example.com', :http)\n    if nodes.empty?\n      nodes = [\"example.com:8091\"]\n    end\n    Couchbase.connect(:node_list => nodes)", "Performs query to Couchbase view. This method will stream results if block\n given or return complete result set otherwise. In latter case it defines\n method +total_rows+ returning corresponding entry from\n Couchbase result object.\n\n @note Avoid using +$+ symbol as prefix for properties in your\n   documents, because server marks with it meta fields like flags and\n   expiration, therefore dollar prefix is some kind of reserved. It\n   won't hurt your application. Currently the {ViewRow}\n   class extracts +$flags+, +$cas+ and +$expiration+ properties from\n   the document and store them in {ViewRow#meta} hash.\n\n @param [Hash] params parameters for Couchbase query.\n @option params [true, false] :include_docs (false) Include the\n   full content of the documents in the return. Note that the document\n   is fetched from the in memory cache where it may have been changed\n   or even deleted. See also +:quiet+ parameter below to control error\n   reporting during fetch.\n @option params [true, false] :quiet (true) Do not raise error if\n   associated document not found in the memory. If the parameter +true+\n   will use +nil+ value instead.\n @option params [true, false] :descending (false) Return the documents\n   in descending by key order\n @option params [String, Fixnum, Hash, Array] :key Return only\n   documents that match the specified key. Will be JSON encoded.\n @option params [Array] :keys The same as +:key+, but will work for\n   set of keys. Will be JSON encoded.\n @option params [String, Fixnum, Hash, Array] :startkey Return\n   records starting with the specified key. +:start_key+ option should\n   also work here. Will be JSON encoded.\n @option params [String] :startkey_docid Document id to start with\n   (to allow pagination for duplicate startkeys). +:start_key_doc_id+\n   also should work.\n @option params [String, Fixnum, Hash, Array] :endkey Stop returning\n   records when the specified key is reached. +:end_key+ option should\n   also work here. Will be JSON encoded.\n @option params [String] :endkey_docid Last document id to include\n   in the output (to allow pagination for duplicate startkeys).\n   +:end_key_doc_id+ also should work.\n @option params [true, false] :inclusive_end (true) Specifies whether\n   the specified end key should be included in the result\n @option params [Fixnum] :limit Limit the number of documents in the\n   output.\n @option params [Fixnum] :skip Skip this number of records before\n   starting to return the results.\n @option params [String, Symbol] :on_error (:continue) Sets the\n   response in the event of an error. Supported values:\n   :continue:: Continue to generate view information in the event of an\n               error, including the error information in the view\n               response stream.\n   :stop::     Stop immediately when an error condition occurs. No\n               further view information will be returned.\n @option params [Fixnum] :connection_timeout (75000) Timeout before the\n   view request is dropped (milliseconds)\n @option params [true, false] :reduce (true) Use the reduction function\n @option params [true, false] :group (false) Group the results using\n   the reduce function to a group or single row.\n @option params [Fixnum] :group_level Specify the group level to be\n   used.\n @option params [String, Symbol, false] :stale (:update_after) Allow\n   the results from a stale view to be used. Supported values:\n   false::         Force a view update before returning data\n   :ok::           Allow stale views\n   :update_after:: Allow stale view, update view after it has been\n                   accessed\n @option params [Hash] :body Accepts the same parameters, except\n   +:body+ of course, but sends them in POST body instead of query\n   string. It could be useful for really large and complex parameters.\n\n @yieldparam [Couchbase::ViewRow] document\n\n @return [Array] with documents. There will be +total_entries+\n   method defined on this array if it's possible.\n\n @raise [Couchbase::Error::View] when +on_error+ callback is nil and\n   error object found in the result stream.\n\n @example Query +recent_posts+ view with key filter\n   doc.recent_posts(:body => {:keys => [\"key1\", \"key2\"]})\n\n @example Fetch second page of result set (splitted in 10 items per page)\n   page = 2\n   per_page = 10\n   doc.recent_posts(:skip => (page - 1) * per_page, :limit => per_page)\n\n @example Simple join using Map/Reduce\n   # Given the bucket with Posts(:id, :type, :title, :body) and\n   # Comments(:id, :type, :post_id, :author, :body). The map function\n   # below (in javascript) will build the View index called\n   # \"recent_posts_with_comments\" which will behave like left inner join.\n   \n   #   function(doc) {\n   #     switch (doc.type) {\n   #       case \"Post\":\n   #         emit([doc.id, 0], null);\n   #         break;\n   #       case \"Comment\":\n   #         emit([doc.post_id, 1], null);\n   #         break;\n   #     }\n   #   }\n   \n   post_id = 42\n   doc.recent_posts_with_comments(:start_key => [post_id, 0],\n                                  :end_key => [post_id, 1],\n                                  :include_docs => true)", "Initialize the design doc instance\n\n @since 1.2.1\n\n It takes reference to the bucket, data hash. It will define view\n methods if the data object looks like design document.\n\n @param [Couchbase::Bucket] bucket the reference to connection\n @param [Hash] data the data hash, which was built from JSON document\n   representation", "Compare and swap value.\n\n @since 1.0.0\n\n Reads a key's value from the server and yields it to a block. Replaces\n the key's value with the result of the block as long as the key hasn't\n been updated in the meantime, otherwise raises\n {Couchbase::Error::KeyExists}. CAS stands for \"compare and swap\", and\n avoids the need for manual key mutexing. Read more info here:\n\n @see http://couchbase.com/docs/memcached-api/memcached-api-protocol-text_cas.html\n\n Setting the +:retry+ option to a positive number will cause this method\n to rescue the {Couchbase::Error::KeyExists} error that happens when\n an update collision is detected, and automatically get a fresh copy\n of the value and retry the block. This will repeat as long as there\n continues to be conflicts, up to the maximum number of retries specified.\n\n @param [String, Symbol] key\n\n @param [Hash] options the options for \"swap\" part\n @option options [Fixnum] :ttl (self.default_ttl) the time to live of this key\n @option options [Symbol] :format (self.default_format) format of the value\n @option options [Fixnum] :flags (self.default_flags) flags for this key\n @option options [Fixnum] :retry (0) maximum number of times to autmatically retry upon update collision\n\n @yieldparam [Object] value old value\n @yieldreturn [Object] new value.\n\n @raise [Couchbase::Error::KeyExists] if the key was updated before the the\n   code in block has been completed (the CAS value has been changed).\n\n @example Implement append to JSON encoded value\n\n     c.default_format = :document\n     c.set(\"foo\", {\"bar\" => 1})\n     c.cas(\"foo\") do |val|\n       val[\"baz\"] = 2\n       val\n     end\n     c.get(\"foo\")      #=> {\"bar\" => 1, \"baz\" => 2}\n\n @return [Fixnum] the CAS of new value", "Fetch design docs stored in current bucket\n\n @since 1.2.0\n\n @return [Hash]", "Update or create design doc with supplied views\n\n @since 1.2.0\n\n @param [Hash, IO, String] data The source object containing JSON\n   encoded design document. It must have +_id+ key set, this key\n   should start with +_design/+.\n\n @return [true, false]", "Delete design doc with given id and revision.\n\n @since 1.2.0\n\n @param [String] id Design document id. It might have '_design/'\n   prefix.\n\n @param [String] rev Document revision. It uses latest revision if\n   +rev+ parameter is nil.\n\n @return [true, false]", "Wait for persistence condition\n\n @since 1.2.0.dp6\n\n This operation is useful when some confidence needed regarding the\n state of the keys. With two parameters +:replicated+ and +:persisted+\n it allows to set up the waiting rule.\n\n @param [String, Symbol, Array, Hash] keys The list of the keys to\n   observe. Full form is hash with key-cas value pairs, but there are\n   also shortcuts like just Array of keys or single key. CAS value\n   needed to when you need to ensure that the storage persisted exactly\n   the same version of the key you are asking to observe.\n @param [Hash] options The options for operation\n @option options [Fixnum] :timeout The timeout in microseconds\n @option options [Fixnum] :replicated How many replicas should receive\n   the copy of the key.\n @option options [Fixnum] :persisted How many nodes should store the\n   key on the disk.\n\n @raise [Couchbase::Error::Timeout] if the given time is up\n\n @return [Fixnum, Hash<String, Fixnum>] will return CAS value just like\n   mutators or pairs key-cas in case of multiple keys.", "Returns an ActiveRecord relation based on the computed value of `resource_scope` dsl method", "template method force class macro\n\n concrete class must define *methods.\n if not define '*method', raise NotImplementedError.\n\n sample BaseClass\n   require \"template_methodable\"\n   class BaseDeveloper\n     include TemplateMethodable\n     must_impl :easy_coding, :difficult_coding, :normal_coding\n     module DIFFICILTY\n       EASY = 1\n       NORMAL = 2\n       DIFFICILT = 3\n     end\n     def coding(difficulty)\n       ret = []\n       ret << \"start coding\"\n       case difficulty\n       when DIFFICILTY::EASY\n         ret << easy_coding(\"hoge\", \"hige\")\n       when DIFFICILTY::NORMAL\n         ret << normal_coding(\"hoge\", \"hige\")\n       when DIFFICILTY::DIFFICILT\n         ret << difficult_coding(\"hoge\", \"hige\")\n       else\n         fail 'error'\n       end\n       ret << \"finish coding\"\n       ret.join(\"\\n\")\n     end\n   end\n\n sample Concrete Class. if you don't define xxxx_coding method, it raises NotImplementedError.\n   class StarDeveloper < BaseDeveloper\n     def easy_coding(hoge, hige)\n       \"complete 1 minutes\"\n     end\n     def normal_coding(hoge, hige)\n       \"complete 10 minutes\"\n     end\n     def difficult_coding(hoge, hige)\n       \"complete 59 minutes\"\n     end\n   end", "Iterate over the lines with a depth, and passed the stripped line to the passed block", "Returns the index of the first line where the passed block returns true", "Returns the stripped contents of the last line where the passed block returns true", "Returns an array of stripped lines for each line where the passed block returns true", "The idea here is you can go forward but you can't go back.", "requested -> request, approved -> approve, declined -> decline, pending -> pending", "For the given date range, returns an Array of PDate objects at which\n the supplied event is scheduled to occur.", "Return true or false depend on if the supplied event is scheduled to occur on the\n given date.", "Generate the entry based on the record structure", "Initializes the object. If no users are supplied we look for a config file, if none then create it, and parse it to load users\n @param [String] config_file The path to the file that stores users\n Checks if a user with _nickname_ exists\n @param [String] nickname\n @return [Boolean]", "Returns the user with nickname nil if no such user exists\n @param [String|Symbol] nickname\n @return [User|nil]", "Override to_s to output correct format", "Set a field to be a descending field. This only makes sense in sort\n specifications.", "Create a string representation of the document", "If you create an Index without any options, it'll simply create an index\n in memory. But this class is highly configurable and every option that\n you can supply to IndexWriter and QueryParser, you can also set here.\n Please look at the options for the constructors to these classes.\n\n === Options\n\n See;\n\n * QueryParser\n * IndexWriter\n\n default_input_field::   Default: \"id\". This specifies the default field\n                         that will be used when you add a simple string\n                         to the index using #add_document or <<.\n id_field::              Default: \"id\". This field is as the field to\n                         search when doing searches on a term. For\n                         example, if you do a lookup by term \"cat\", ie\n                         index[\"cat\"], this will be the field that is\n                         searched.\n key::                   Default: nil. Expert: This should only be used\n                         if you really know what you are doing. Basically\n                         you can set a field or an array of fields to be\n                         the key for the index. So if you add a document\n                         with a same key as an existing document, the\n                         existing document will be replaced by the new\n                         object.  Using a multiple field key will slow\n                         down indexing so it should not be done if\n                         performance is a concern. A single field key (or\n                         id) should be find however. Also, you must make\n                         sure that your key/keys are either untokenized\n                         or that they are not broken up by the analyzer.\n auto_flush::            Default: false. Set this option to true if you\n                         want the index automatically flushed every time\n                         you do a write (includes delete) to the index.\n                         This is useful if you have multiple processes\n                         accessing the index and you don't want lock\n                         errors. Setting :auto_flush to true has a huge\n                         performance impact so don't use it if you are\n                         concerned about performance. In that case you\n                         should think about setting up a DRb indexing\n                         service.\n lock_retry_time::       Default: 2 seconds. This parameter specifies how\n                         long to wait before retrying to obtain the\n                         commit lock when detecting if the IndexReader is\n                         at the latest version.\n close_dir::             Default: false.  If you explicitly pass a\n                         Directory object to this class and you want\n                         Index to close it when it is closed itself then\n                         set this to true.\n use_typed_range_query:: Default: true. Use TypedRangeQuery instead of\n                         the standard RangeQuery when parsing\n                         range queries. This is useful if you have number\n                         fields which you want to perform range queries\n                         on. You won't need to pad or normalize the data\n                         in the field in anyway to get correct results.\n                         However, performance will be a lot slower for\n                         large indexes, hence the default.\n\n == Examples\n\n   index = Index::Index.new(:analyzer => WhiteSpaceAnalyzer.new())\n\n   index = Index::Index.new(:path => '/path/to/index',\n                            :create_if_missing => false,\n                            :auto_flush => true)\n\n   index = Index::Index.new(:dir => directory,\n                            :default_slop => 2,\n                            :handle_parse_errors => false)\n\n You can also pass a block if you like. The index will be yielded and\n closed at the index of the box. For example;\n\n   Ferret::I.new() do |index|\n     # do stuff with index. Most of your actions will be cached.\n   end\n Returns an array of strings with the matches highlighted. The +query+ can\n either a query String or a Ferret::Search::Query object. The doc_id is\n the id of the document you want to highlight (usually returned by the\n search methods). There are also a number of options you can pass;\n\n === Options\n\n field::            Default: @options[:default_field]. The default_field\n                    is the field that is usually highlighted but you can\n                    specify which field you want to highlight here. If\n                    you want to highlight multiple fields then you will\n                    need to call this method multiple times.\n excerpt_length::   Default: 150. Length of excerpt to show. Highlighted\n                    terms will be in the centre of the excerpt. Set to\n                    :all to highlight the entire field.\n num_excerpts::     Default: 2. Number of excerpts to return.\n pre_tag::          Default: \"<b>\". Tag to place to the left of the\n                    match.  You'll probably want to change this to a\n                    \"<span>\" tag with a class. Try \"\\033[36m\" for use in\n                    a terminal.\n post_tag::         Default: \"</b>\". This tag should close the\n                    +:pre_tag+. Try tag \"\\033[m\" in the terminal.\n ellipsis::         Default: \"...\". This is the string that is appended\n                    at the beginning and end of excerpts (unless the\n                    excerpt hits the start or end of the field.\n                    Alternatively you may want to use the HTML entity\n                    &#8230; or the UTF-8 string \"\\342\\200\\246\".", "Retrieves the term_vector for a document. The document can be referenced\n by either a string id to match the id field or an integer corresponding\n to Ferret's document number.\n\n See Ferret::Index::IndexReader#term_vector", "Delete all documents returned by the query.\n\n query:: The query to find documents you wish to delete. Can either be a\n         string (in which case it is parsed by the standard query parser)\n         or an actual query object.", "Update the document referenced by the document number +id+ if +id+ is an\n integer or all of the documents which have the term +id+ if +id+ is a\n term..\n For batch update of set of documents, for performance reasons, see batch_update\n\n id::      The number of the document to update. Can also be a string\n           representing the value in the +id+ field. Also consider using\n           the :key attribute.\n new_doc:: The document to replace the old document with", "Batch updates the documents in an index. You can pass either a Hash or\n an Array.\n\n === Array (recommended)\n\n If you pass an Array then each value needs to be a Document or a Hash\n and each of those documents must have an +:id_field+ which will be used\n to delete the old document that this document is replacing.\n\n === Hash\n\n If you pass a Hash then the keys of the Hash will be considered the\n +id+'s and the values will be the new documents to replace the old ones\n with.If the +id+ is an Integer then it is considered a Ferret document\n number and the corresponding document will be deleted.  If the +id+ is a\n String or a Symbol then the +id+ will be considered a term and the\n documents that contain that term in the +:id_field+ will be deleted.\n\n Note: No error will be raised if the document does not currently\n exist. A new document will simply be created.\n\n == Examples\n\n   # will replace the documents with the +id+'s id:133 and id:254\n   @index.batch_update({\n       '133' => {:id => '133', :content => 'yada yada yada'},\n       '253' => {:id => '253', :content => 'bla bla bal'}\n     })\n\n   # will replace the documents with the Ferret Document numbers 2 and 92\n   @index.batch_update({\n       2  => {:id => '133', :content => 'yada yada yada'},\n       92 => {:id => '253', :content => 'bla bla bal'}\n     })\n\n   # will replace the documents with the +id+'s id:133 and id:254\n   # this is recommended as it guarantees no duplicate keys\n   @index.batch_update([\n       {:id => '133', :content => 'yada yada yada'},\n       {:id => '253', :content => 'bla bla bal'}\n     ])\n\n docs:: A Hash of id/document pairs. The set of documents to be updated", "Update all the documents returned by the query.\n\n query::   The query to find documents you wish to update. Can either be\n           a string (in which case it is parsed by the standard query\n           parser) or an actual query object.\n new_val:: The values we are updating. This can be a string in which case\n           the default field is updated, or it can be a hash, in which\n           case, all fields in the hash are merged into the old hash.\n           That is, the old fields are replaced by values in the new hash\n           if they exist.\n\n === Example\n\n   index << {:id => \"26\", :title => \"Babylon\", :artist => \"David Grey\"}\n   index << {:id => \"29\", :title => \"My Oh My\", :artist => \"David Grey\"}\n\n   # correct\n   index.query_update('artist:\"David Grey\"', {:artist => \"David Gray\"})\n\n   index[\"26\"]\n     #=> {:id => \"26\", :title => \"Babylon\", :artist => \"David Gray\"}\n   index[\"28\"]\n     #=> {:id => \"28\", :title => \"My Oh My\", :artist => \"David Gray\"}", "Returns an Explanation that describes how +doc+ scored against\n +query+.\n\n This is intended to be used in developing Similarity implementations,\n and, for good performance, should not be displayed with every hit.\n Computing an explanation is as expensive as executing the query over the\n entire index.", "returns the new reader if one is opened", "truncates the string at the first space after +len+ characters", "takes an optional block to set optional attributes in the links", "Returns the point that is the weighted sum of the specified control points,\n using the specified weights. This method requires that there are four\n weights and four control points.", "Generates mp3 file as a result of\n Text-To-Speech conversion.", "Returns mp3 file bytes as a result of\n Text-To-Speech conversion.", "Returns the flattened array. Each entry in the array is an object; each\n object has attributes corresponding to this flatten operator's keys.\n\n @returns an array of elements from the flattened map.", "Scan the proto chain for an image function.", "Transform value +x+ according to domain and range", "Returns an array of evenly-spaced, suitably-rounded values in the input\n domain. These values are frequently used in conjunction with\n Rule to display tick marks or grid lines.\n\n Subdivisions set the number of division inside each base^x\n By default, is set to base", "Convenience method that takes a list of method calls and tries\n them end-to-end, returning nil if any fail to respond to that\n method name.\n Very similar to ActiveSupport's `.try` method.", "Cache registered classes", "instantiates a view, possibly running a 'layout block' to add child views.", "Blocks passed to `reapply` are only run when `reapply!` is called.", "Just like `get`, but if `get` returns a Layout, this method returns the\n layout's view.", "Just like `last`, but if `last` returns a Layout, this method returns the\n layout's view.", "Just like `all`, but if `all` returns a Layout, this method returns the\n layout's view.", "Just like `nth`, but if `nth` returns a Layout, this method returns the\n layout's view.", "Removes a view from the list of elements this layout is \"tracking\", but\n leaves it in the view hierarchy.  Returns the views that were removed.", "returns the root view that was removed, if any", "This method builds the layout and returns the root view.", "Initializes an instance of a view. This will need to be smarter going\n forward as `new` isn't always the designated initializer.\n\n Accepts a view instance, a class (which is instantiated with 'new') or a\n `ViewLayout`, which returns the root view.", "Calls the `_style` method with the element as the context, and runs the\n optional block in that context.  This is usually done immediately after\n `initialize_element`, except in the case of `add`, which adds the item to\n the tree before styling it.", "Runs a block of code with a new object as the 'context'. Methods from the\n Layout classes are applied to this target object, and missing methods are\n delegated to a new Layout instance that is created based on the new\n context.\n\n This method is part of the public API, you can pass in any object to have\n it become the 'context'.\n\n Example:\n     def table_view_style\n       content = target.contentView\n       if content\n         context(content) do\n           background_color UIColor.clearColor\n         end\n       end\n\n       # usually you use 'context' automatically via method_missing, by\n       # passing a block to a method that returns an object. That object becomes\n       # the new context.\n       layer do\n         # target is now a CALayer, and methods are delegated to CALayerHelpers\n         corner_radius 5\n       end\n     end", "override root to allow a menu title for the top level menu", "override 'add'; menus are just a horse of a different color.", "Equivalent to retryable gem options", "command.on_complete do |success, value, reason|\n   ...\n end", "command.on_success do |value|\n   ...\n end", "command.on_failure do |e|\n   ...\n end", "set future\n set fallback future as an observer\n start dependencies", "timeout_block do\n   retryable_block do\n     breakable_block do\n       block.call\n     end\n   end\n end", "Invoke pry, wrapper with some settings.\n\n @return [void]", "Get the process's text base.\n\n @return [Integer]\n   The base address.\n\n @note\n   This will also set a variable +$text+ in gdb.", "Read current process's memory.\n\n @param [Integer, String] addr\n   Address to start to read.\n   +addr+ can be a string like 'heap+0x10'.\n   Supported variables are names in /proc/$pid/maps such as +heap/libc/stack/ld+.\n\n @param [Integer] num_elements\n   Number of elements to read.\n   If +num_elements+ equals to 1, an object read will be returned.\n   Otherwise, an array with size +num_elements+ will be returned.\n\n @option [Symbol, Class] as\n   Types that supported by [MemoryIO](https://github.com/david942j/memory_io).\n\n @return [Object, Array<Object>]\n   Return types are decided by value of +num_elements+ and option +as+.\n\n @yieldparam [IO] io\n   The +IO+ object that points to +addr+,\n   read from it.\n\n @yieldreturn [Object]\n   Whatever you read from +io+.\n\n @example\n   gdb = GDB::GDB.new('spec/binaries/amd64.elf')\n   gdb.break('main')\n   gdb.run\n   gdb.read_memory('amd64.elf', 4)\n   #=> \"\\x7fELF\"\n\n @example\n   # example of fetching argv\n   gdb = GDB::GDB.new('spec/binaries/amd64.elf')\n   gdb.break('main')\n   gdb.run('pusheen the cat')\n   gdb.read_memory(0x400000, 4)\n   #=> \"\\x7fELF\"\n   argc = gdb.register(:rdi)\n   #=> 4\n   args = gdb.read_memory(gdb.register(:rsi), argc, as: :u64)\n   Array.new(3) do |i|\n     gdb.read_memory(args[i + 1], 1) do |m|\n       str = ''\n       loop do\n         c = m.read(1)\n         break if c == \"\\x00\"\n         str << c\n       end\n       str\n     end\n   end\n   #=> [\"pusheen\", \"the\", \"cat\"]\n\n   # or, use our build-in types of gem +memory_io+.\n   gdb.read_memory(args[1], 3, as: :c_str)\n   #=> [\"pusheen\", \"the\", \"cat\"]", "Write an object to process at specific address.\n\n @param [Integer, String] addr\n   Target address.\n   +addr+ can be a string like 'heap+0x10'.\n   Supported variables are names in +/proc/$pid/maps+ such as +heap/libc/stack/ld+.\n @param [Objects, Array<Objects>] objects\n   Objects to be written.\n\n @option [Symbol, Class] as\n   See {#read_memory}.\n\n @return [void]", "Runs Ruby files through Rubocop. Generates a `markdown` list of warnings.\n\n @param   [String] files\n          A globbed string which should return the files that you want to\n          run through, defaults to nil. If nil, modified and added files\n          from the diff will be used.\n @return  [void]", "Determines the name for a", "clean up all words in  a string, returning an array of clean words", "Initialize a new instance.\n\n Options:\n\n * :randomizer => Random.new # must respond to #rand(limit)\n * :source_parser => SourceParser.new options\n Given a word, return a weighted-randomly selected next-one.", "Check to see if the sentence ends in a PREPOSITION_REGEX word.\n If so, add more words up to max-words until it does.", "return a random sentence\n\n Options:\n\n * :first_word => nil - the start word\n * :words => range or int - number of words in sentence\n * :punctuation => nil - punction to end the sentence with (nil == randomly selected from punctuation_distribution)", "return a random paragraph\n\n Options:\n\n * :first_word => nil - the first word of the paragraph\n * :words => range or int - number of words in sentence\n * :sentences => range or int - number of sentences in paragraph\n * :punctuation => nil - punction to end the paragraph with (nil == randomly selected from punctuation_distribution)", "return random paragraphs\n\n Options:\n\n * :first_word => nil - the first word of the paragraph\n * :words => range or int - number of words in sentence\n * :sentences => range or int - number of sentences in paragraph\n * :paragraphs => range or int - number of paragraphs in paragraph\n * :join => \"\\n\\n\" - join the paragraphs. if :join => false, returns an array of the paragraphs\n * :punctuation => nil - punction to end the paragraph with (nil == randomly selected from punctuation_distribution)", "Re-implementation of the g_array_index and g_ptr_array_index macros", "Create a new Rack Tracer middleware.\n\n @param app The Rack application/middlewares stack.\n @param tracer [OpenTracing::Tracer] A tracer to be used when start_span, and extract\n        is called.\n @param on_start_span [Proc, nil] A callback evaluated after a new span is created.\n @param on_finish_span [Proc, nil] A callback evaluated after a span is finished.\n @param errors [Array<Class>] An array of error classes to be captured by the tracer\n        as errors. Errors are **not** muted by the middleware, they're re-raised afterwards.", "Mirror cookbooks specified in an inventory file.", "Generate a web interface to download any mirrored cookbooks.", "handle the PASS FTP command. This is the second stage of a user logging in", "delete a file", "send a file to the client", "return the size of a file in bytes", "save a file from a client", "return a listing of the current directory, one per line, each line\n separated by the standard FTP EOL sequence. The listing is returned\n to the client over a data socket.", "return a detailed list of files and directories", "delete a directory", "split a client's request into command and parameter components", "handle the HELP FTP command by sending a list of available commands.", "Passive FTP. At the clients request, listen on a port for an incoming\n data connection. The listening socket is opened on a random port, so\n the host and port is sent back to the client on the control socket.", "Active FTP. An alternative to Passive FTP. The client has a listening socket\n open, waiting for us to connect and establish a data socket. Attempt to\n open a connection to the host and port they specify and save the connection,\n ready for either end to send something down it.", "like the MODE and STRU commands, TYPE dates back to a time when the FTP\n protocol was more aware of the content of the files it was transferring, and\n would sometimes be expected to translate things like EOL markers on the fly.\n\n Valid options were A(SCII), I(mage), E(BCDIC) or LN (for local type). Since\n we plan to just accept bytes from the client unchanged, I think Image mode is\n adequate. The RFC requires we accept ASCII mode however, so accept it, but\n ignore it.", "send data to the client across the data socket.\n\n The data socket is NOT guaranteed to be setup by the time this method runs.\n If it isn't ready yet, exit the method and try again on the next reactor\n tick. This is particularly likely with some clients that operate in passive\n mode. They get a message on the control port with the data port details, so\n they start up a new data connection AND send they command that will use it\n in close succession.\n\n The data port setup needs to complete a TCP handshake before it will be\n ready to use, so it may take a few RTTs after the command is received at\n the server before the data socket is ready.", "waits for the data socket to be established", "receive a file data from the client across the data socket.\n\n The data socket is NOT guaranteed to be setup by the time this method runs.\n If this happens, exit the method early and try again later. See the method\n comments to send_outofband_data for further explanation.", "can add more datasets as support becomes available", "allows the adding of a new DNSBL to the set of configured DNSBLs", "converts an ip or a hostname into the DNS query packet requires to lookup the result", "lookup performs the sending of DNS queries for the given items\n returns an array of DNSBLResult", "takes a DNS response and converts it into a DNSBLResult", "decodes the response from Project Honey Pot's service", "Constructor for FlagValues", "Constructor for Flags", "If the argument is close to an integer it rounds it", "mount a folder for browsing", "get the size, in bytes, of the response. used for logging\n @return [Integer] size", "main app loop. called via at_exit block defined in DSL", "check if our script has been updated since the last reload", "reload scripts if needed", "mount a directory for browsing via gopher\n\n @param [Hash] path A hash specifying the path your route will answer to, and the filesystem path to use '/route' => '/home/path/etc'\n @param [Hash] opts a hash of options for the mount. Primarily this is a filter, which will restrict the list files outputted. example: :filter => '*.jpg'\n @param [Class] klass The class that should be used to handle this mount. You could write and use a custom handler if desired\n\n @example mount the directory '/home/user/foo' at the gopher path '/files', and only show JPG files:\n   mount '/files' => '/home/user/foo', :filter => '*.jpg'", "lookup an incoming path\n\n @param [String] selector the selector path of the incoming request", "find and run the first route which matches the incoming request\n @param [Request] req Gopher::Request object", "find a template\n @param [String/Symbol] t name of the template\n @return template block and the class context it should use", "Find the desired template and call it within the proper context\n @param [String/Symbol] template name of the template to render\n @param [Array] arguments optional arguments to be passed to template\n @return result of rendering", "compile a route", "initialize a Logger for tracking hits to the server", "write out an entry to our access log", "zip up two arrays of keys and values from an incoming request", "generate a request object from an incoming selector, and dispatch it to the app\n @param [Request] request Request object to handle\n @return Response object", "send the response back to the client\n @param [Response] response object", "Perform push api validation request and return a descriptive response\n tuple.\n\n @return [Array<String/nil, String>] response tuple.\n   - First value is the response status code.\n   - Second value is a description of the response and the exception error\n     message if an exception occured.", "Maintain backwards compatibility with config files generated by earlier\n versions of the gem\n\n Used by {#load_from_disk}. No compatibility for env variables or initial config currently.", "Returns calculated background queue start time in milliseconds, based on\n environment values.\n\n @return [nil] if no {#environment} is present.\n @return [nil] if there is no `:queue_start` in the {#environment}.\n @return [Integer]", "Returns HTTP queue start time in milliseconds.\n\n @return [nil] if no queue start time is found.\n @return [nil] if begin time is too low to be plausible.\n @return [Integer] queue start in milliseconds.", "Returns sanitized environment for a transaction.\n\n The environment of a transaction can contain a lot of information, not\n all of it useful for debugging.\n\n @return [nil] if no environment is present.\n @return [Hash<String, Object>]", "Returns sanitized session data.\n\n The session data is sanitized by the {Appsignal::Utils::HashSanitizer}.\n\n @return [nil] if `:skip_session_data` config is set to `true`.\n @return [nil] if the {#request} object doesn't respond to `#session`.\n @return [nil] if the {#request} session data is `nil`.\n @return [Hash<String, Object>]", "This class represents one unique visit\n User may have never visited the site\n User may have visited before but his visit is expired\n Everything counted here is unique for a visit\n helpers", "method used in analytics.rb to initialize visit\n called from analytics.rb", "Reset all configuration options to defaults.", "Calling the API method.\n It delegates the network request to `API.call` and result processing to `Result.process`.\n @param [Hash] args Arguments for the API method.", "URL for redirecting the user to VK where he gives the application all the requested access rights.\n @option options [Symbol] :type The type of authorization being used (`:site` and `:client` supported).\n @option options [String] :redirect_uri URL for redirecting the user back to the application (overrides the global configuration value).\n @option options [Array] :scope An array of requested access rights (each represented by a symbol or a string).\n @raise [ArgumentError] raises after receiving an unknown authorization type.\n @return [String] URL to redirect the user to.", "Add a series and it's properties to a chart.", "Set dimensions for scale for the chart.", "Set properties for the chart up-down bars.", "Convert user defined font values into private hash values.", "Switch name and name_formula parameters if required.", "Find the overall type of the data associated with a series.\n\n TODO. Need to handle date type.", "Convert the user specified colour index or string to a rgb colour.", "Get the font style attributes from a font hash.", "Get the font latin attributes from a font hash.", "Write the series name.", "Write the axis font elements.", "Write the X and Y error bars.", "Write the custom error bars type.", "Set the worksheet protection flags to prevent modification of worksheet\n objects.\n\n The protect() method is used to protect a worksheet from modification:\n\n     worksheet.protect\n\n The protect() method also has the effect of enabling a cell's locked\n and hidden properties if they have been set. A locked cell cannot be\n edited and this property is on by default for all cells. A hidden\n cell will display the results of a formula but not the formula itself.\n\n See the protection.rb program in the examples directory of the distro\n for an illustrative example and the +set_locked+ and +set_hidden+ format\n methods in \"CELL FORMATTING\", see Format.\n\n You can optionally add a password to the worksheet protection:\n\n     worksheet.protect('drowssap')\n\n Passing the empty string '' is the same as turning on protection\n without a password.\n\n Note, the worksheet level password in Excel provides very weak\n protection. It does not encrypt your data and is very easy to\n deactivate. Full workbook encryption is not supported by WriteXLSX\n since it requires a completely different file format and would take\n several man months to implement.\n\n You can specify which worksheet elements that you which to protect\n by passing a hash with any or all of the following keys:\n\n     # Default shown.\n     options = {\n         :objects               => false,\n         :scenarios             => false,\n         :format_cells          => false,\n         :format_columns        => false,\n         :format_rows           => false,\n         :insert_columns        => false,\n         :insert_rows           => false,\n         :insert_hyperlinks     => false,\n         :delete_columns        => false,\n         :delete_rows           => false,\n         :select_locked_cells   => true,\n         :sort                  => false,\n         :autofilter            => false,\n         :pivot_tables          => false,\n         :select_unlocked_cells => true\n     }\n\n The default boolean values are shown above. Individual elements\n can be protected as follows:\n\n     worksheet.protect('drowssap', { :insert_rows => true } )", "Set the page header caption and optional margin.\n\n Headers and footers are generated using a string which is a combination\n of plain text and control characters. The margin parameter is optional.\n\n The available control character are:\n\n     Control             Category            Description\n     =======             ========            ===========\n     &L                  Justification       Left\n     &C                                      Center\n     &R                                      Right\n\n     &P                  Information         Page number\n     &N                                      Total number of pages\n     &D                                      Date\n     &T                                      Time\n     &F                                      File name\n     &A                                      Worksheet name\n     &Z                                      Workbook path\n\n     &fontsize           Font                Font size\n     &\"font,style\"                           Font name and style\n     &U                                      Single underline\n     &E                                      Double underline\n     &S                                      Strikethrough\n     &X                                      Superscript\n     &Y                                      Subscript\n\n     &&                  Miscellaneous       Literal ampersand &\n\n Text in headers and footers can be justified (aligned) to the left,\n center and right by prefixing the text with the control characters\n &L, &C and &R.\n\n For example (with ASCII art representation of the results):\n\n     worksheet.set_header('&LHello')\n\n      ---------------------------------------------------------------\n     |                                                               |\n     | Hello                                                         |\n     |                                                               |\n\n\n     worksheet.set_header('&CHello')\n\n      ---------------------------------------------------------------\n     |                                                               |\n     |                          Hello                                |\n     |                                                               |\n\n\n     worksheet.set_header('&RHello')\n\n      ---------------------------------------------------------------\n     |                                                               |\n     |                                                         Hello |\n     |                                                               |\n\n For simple text, if you do not specify any justification the text will\n be centred. However, you must prefix the text with &C if you specify\n a font name or any other formatting:\n\n     worksheet.set_header('Hello')\n\n      ---------------------------------------------------------------\n     |                                                               |\n     |                          Hello                                |\n     |                                                               |\n\n You can have text in each of the justification regions:\n\n     worksheet.set_header('&LCiao&CBello&RCielo')\n\n      ---------------------------------------------------------------\n     |                                                               |\n     | Ciao                     Bello                          Cielo |\n     |                                                               |\n\n The information control characters act as variables that Excel will update\n as the workbook or worksheet changes. Times and dates are in the users\n default format:\n\n     worksheet.set_header('&CPage &P of &N')\n\n      ---------------------------------------------------------------\n     |                                                               |\n     |                        Page 1 of 6                            |\n     |                                                               |\n\n\n     worksheet.set_header('&CUpdated at &T')\n\n      ---------------------------------------------------------------\n     |                                                               |\n     |                    Updated at 12:30 PM                        |\n     |                                                               |\n\n You can specify the font size of a section of the text by prefixing it\n with the control character &n where n is the font size:\n\n     worksheet1.set_header('&C&30Hello Big' )\n     worksheet2.set_header('&C&10Hello Small' )\n\n You can specify the font of a section of the text by prefixing it with\n the control sequence &\"font,style\" where fontname is a font name such\n as \"Courier New\" or \"Times New Roman\" and style is one of the standard\n Windows font descriptions: \"Regular\", \"Italic\", \"Bold\" or \"Bold Italic\":\n\n     worksheet1.set_header('&C&\"Courier New,Italic\"Hello')\n     worksheet2.set_header('&C&\"Courier New,Bold Italic\"Hello')\n     worksheet3.set_header('&C&\"Times New Roman,Regular\"Hello')\n\n It is possible to combine all of these features together to create\n sophisticated headers and footers. As an aid to setting up complicated\n headers and footers you can record a page set-up as a macro in Excel\n and look at the format strings that VBA produces. Remember however\n that VBA uses two double quotes \"\" to indicate a single double quote.\n For the last example above the equivalent VBA code looks like this:\n\n     .LeftHeader   = \"\"\n     .CenterHeader = \"&\"\"Times New Roman,Regular\"\"Hello\"\n     .RightHeader  = \"\"\n\n To include a single literal ampersand & in a header or footer you\n should use a double ampersand &&:\n\n     worksheet1.set_header('&CCuriouser && Curiouser - Attorneys at Law')\n\n As stated above the margin parameter is optional. As with the other\n margins the value should be in inches. The default header and footer\n margin is 0.3 inch. Note, the default margin is different from the\n default used in the binary file format by Spreadsheet::WriteExcel.\n The header and footer margin size can be set as follows:\n\n     worksheet.set_header('&CHello', 0.75)\n\n The header and footer margins are independent of the top and bottom\n margins.\n\n Note, the header or footer string must be less than 255 characters.\n Strings longer than this will not be written and a warning will be\n generated.\n\n See, also the headers.rb program in the examples directory of the\n distribution.", "Set the page footer caption and optional margin.\n\n The syntax of the set_footer() method is the same as set_header()", "Set the number of rows to repeat at the top of each printed page.\n\n For large Excel documents it is often desirable to have the first row\n or rows of the worksheet print out at the top of each page. This can\n be achieved by using the repeat_rows() method. The parameters\n first_row and last_row are zero based. The last_row parameter is\n optional if you only wish to specify one row:\n\n     worksheet1.repeat_rows(0)    # Repeat the first row\n     worksheet2.repeat_rows(0, 1) # Repeat the first two rows", "Set the order in which pages are printed.\n\n The print_across method is used to change the default print direction.\n This is referred to by Excel as the sheet \"page order\".\n\n     worksheet.print_across\n\n The default page order is shown below for a worksheet that extends\n over 4 pages. The order is called \"down then across\":\n\n     [1] [3]\n     [2] [4]\n\n However, by using the print_across method the print order will be\n changed to \"across then down\":\n\n     [1] [2]\n     [3] [4]", "Set the column filter criteria.\n\n The filter_column method can be used to filter columns in a autofilter\n range based on simple conditions.\n\n NOTE: It isn't sufficient to just specify the filter condition.\n You must also hide any rows that don't match the filter condition.\n Rows are hidden using the set_row() +visible+ parameter. WriteXLSX cannot\n do this automatically since it isn't part of the file format.\n See the autofilter.rb program in the examples directory of the distro\n for an example.\n\n The conditions for the filter are specified using simple expressions:\n\n     worksheet.filter_column('A', 'x > 2000')\n     worksheet.filter_column('B', 'x > 2000 and x < 5000')\n\n The +column+ parameter can either be a zero indexed column number or\n a string column name.\n\n The following operators are available:\n\n     Operator        Synonyms\n        ==           =   eq  =~\n        !=           <>  ne  !=\n        >\n        <\n        >=\n        <=\n\n        and          &&\n        or           ||\n\n The operator synonyms are just syntactic sugar to make you more\n comfortable using the expressions. It is important to remember that\n the expressions will be interpreted by Excel and not by ruby.\n\n An expression can comprise a single statement or two statements\n separated by the +and+ and +or+ operators. For example:\n\n     'x <  2000'\n     'x >  2000'\n     'x == 2000'\n     'x >  2000 and x <  5000'\n     'x == 2000 or  x == 5000'\n\n Filtering of blank or non-blank data can be achieved by using a value\n of +Blanks+ or +NonBlanks+ in the expression:\n\n     'x == Blanks'\n     'x == NonBlanks'\n\n Excel also allows some simple string matching operations:\n\n     'x =~ b*'   # begins with b\n     'x !~ b*'   # doesn't begin with b\n     'x =~ *b'   # ends with b\n     'x !~ *b'   # doesn't end with b\n     'x =~ *b*'  # contains b\n     'x !~ *b*'  # doesn't contains b\n\n You can also use * to match any character or number and ? to match any\n single character or number. No other regular expression quantifier is\n supported by Excel's filters. Excel's regular expression characters can\n be escaped using +~+.\n\n The placeholder variable +x+ in the above examples can be replaced by any\n simple string. The actual placeholder name is ignored internally so the\n following are all equivalent:\n\n     'x     < 2000'\n     'col   < 2000'\n     'Price < 2000'\n\n Also, note that a filter condition can only be applied to a column\n in a range specified by the autofilter() Worksheet method.\n\n See the autofilter.rb program in the examples directory of the distro\n for a more detailed example.\n\n Note writeExcel gem supports Top 10 style filters. These aren't\n currently supported by WriteXLSX but may be added later.", "Set the column filter criteria in Excel 2007 list style.\n\n Prior to Excel 2007 it was only possible to have either 1 or 2 filter\n conditions such as the ones shown above in the filter_column method.\n\n Excel 2007 introduced a new list style filter where it is possible\n to specify 1 or more 'or' style criteria. For example if your column\n contained data for the first six months the initial data would be\n displayed as all selected as shown on the left. Then if you selected\n 'March', 'April' and 'May' they would be displayed as shown on the right.\n\n     No criteria selected      Some criteria selected.\n\n     [/] (Select all)          [X] (Select all)\n     [/] January               [ ] January\n     [/] February              [ ] February\n     [/] March                 [/] March\n     [/] April                 [/] April\n     [/] May                   [/] May\n     [/] June                  [ ] June\n\n The filter_column_list() method can be used to represent these types of\n filters:\n\n     worksheet.filter_column_list('A', 'March', 'April', 'May')\n\n The column parameter can either be a zero indexed column number or\n a string column name.\n\n One or more criteria can be selected:\n\n     worksheet.filter_column_list(0, 'March')\n     worksheet.filter_column_list(1, 100, 110, 120, 130)\n\n NOTE: It isn't sufficient to just specify the filter condition. You must\n also hide any rows that don't match the filter condition. Rows are hidden\n using the set_row() visible parameter. WriteXLSX cannot do this\n automatically since it isn't part of the file format.\n See the autofilter.rb program in the examples directory of the distro\n for an example. e conditions for the filter are specified\n using simple expressions:", "Store the horizontal page breaks on a worksheet.\n\n Add horizontal page breaks to a worksheet. A page break causes all\n the data that follows it to be printed on the next page. Horizontal\n page breaks act between rows. To create a page break between rows\n 20 and 21 you must specify the break at row 21. However in zero index\n notation this is actually row 20. So you can pretend for a small\n while that you are using 1 index notation:\n\n     worksheet1.set_h_pagebreaks( 20 )    # Break between row 20 and 21\n\n The set_h_pagebreaks() method will accept a list of page breaks\n and you can call it more than once:\n\n     worksheet2.set_h_pagebreaks( 20,  40,  60,  80,  100 )    # Add breaks\n     worksheet2.set_h_pagebreaks( 120, 140, 160, 180, 200 )    # Add some more\n\n Note: If you specify the \"fit to page\" option via the fit_to_pages()\n method it will override all manual page breaks.\n\n There is a silent limitation of about 1000 horizontal page breaks\n per worksheet in line with an Excel internal limitation.", "Returns a range of data from the worksheet _table to be used in chart\n cached data. Strings are returned as SST ids and decoded in the workbook.\n Return nils for data that doesn't exist since Excel can chart series\n with data missing.", "Calculate the vertices that define the position of a graphical object within\n the worksheet in pixels.\n\n         +------------+------------+\n         |     A      |      B     |\n   +-----+------------+------------+\n   |     |(x1,y1)     |            |\n   |  1  |(A1)._______|______      |\n   |     |    |              |     |\n   |     |    |              |     |\n   +-----+----|    Object    |-----+\n   |     |    |              |     |\n   |  2  |    |______________.     |\n   |     |            |        (B2)|\n   |     |            |     (x2,y2)|\n   +---- +------------+------------+\n\n Example of an object that covers some of the area from cell A1 to cell B2.\n\n Based on the width and height of the object we need to calculate 8 vars:\n\n     col_start, row_start, col_end, row_end, x1, y1, x2, y2.\n\n We also calculate the absolute x and y position of the top left vertex of\n the object. This is required for images.\n\n    x_abs, y_abs\n\n The width and height of the cells that the object occupies can be variable\n and have to be taken into account.\n\n The values of col_start and row_start are passed in from the calling\n function. The values of col_end and row_end are calculated by subtracting\n the width and height of the object from the width and height of the\n underlying cells.\n\n    col_start    # Col containing upper left corner of object.\n    x1           # Distance to left side of object.\n    row_start    # Row containing top left corner of object.\n    y1           # Distance to top of object.\n    col_end      # Col containing lower right corner of object.\n    x2           # Distance to right side of object.\n    row_end      # Row containing bottom right corner of object.\n    y2           # Distance to bottom of object.\n    width        # Width of object frame.\n    height       # Height of object frame.", "Turn the HoH that stores the comments into an array for easier handling\n and set the external links for comments and buttons.", "Set the table ids for the worksheet tables.", "Pad out the rest of the area with formatted blank cells.", "Parse the 3 tokens of a filter expression and return the operator and token.", "Calculate the vertices that define the position of a graphical object within\n the worksheet in EMUs.\n\n The vertices are expressed as English Metric Units (EMUs). There are 12,700\n EMUs per point. Therefore, 12,700 * 3 /4 = 9,525 EMUs per pixel.", "Convert the width of a cell from user's units to pixels. Excel rounds the\n column width to the nearest pixel. If the width hasn't been set by the user\n we use the default value. If the column is hidden it has a value of zero.", "Convert the height of a cell from user's units to pixels. If the height\n hasn't been set by the user we use the default value. If the row is hidden\n it has a value of zero.", "Set up drawing shapes", "This method handles the parameters passed to insert_button as well as\n calculating the comment object position and vertices.", "Write out the worksheet data as a series of rows and cells.", "Convert column width from user units to pane split width.", "Function to iterate through the columns that form part of an autofilter\n range and write the appropriate filters.", "Calculate the vertices that define the position of a shape object within\n the worksheet in EMUs.  Save the vertices with the object.\n\n The vertices are expressed as English Metric Units (EMUs). There are 12,700\n EMUs per point. Therefore, 12,700 * 3 /4 = 9,525 EMUs per pixel.", "Re-size connector shapes if they are connected to other shapes.", "Check shape attributes to ensure they are valid.", "Copy the attributes of another Format object.", "Convert user defined layout properties to the format required internally.", "Convert vertices from pixels to points.", "Helper function for the sparkline color functions below.", "user must not use. it is internal method.", "The +add_format+ method can be used to create new Format objects\n which are used to apply formatting to a cell. You can either define\n the properties at creation time via a hash of property values\n or later via method calls.\n\n     format1 = workbook.add_format(property_hash) # Set properties at creation\n     format2 = workbook.add_format                # Set properties later\n\n See the {Format Class's rdoc}[Format.html] for more details about\n Format properties and how to set them.", "The +add_shape+ method can be used to create new shapes that may be\n inserted into a worksheet.\n\n You can either define the properties at creation time via a hash of\n property values or later via method calls.\n\n     # Set properties at creation.\n     plus  = workbook.add_shape(\n               :type   => 'plus',\n               :id     => 3,\n               :width  => pw,\n               :height => ph\n             )\n\n     # Default rectangle shape. Set properties later.\n     rect  = workbook.add_shape\n\n See also the shape*.rb programs in the examples directory of the distro.\n\n === Shape Properties\n\n Any shape property can be queried or modified by [ ] like hash.\n\n   ellipse = workbook.add_shape(properties)\n   ellipse[:type] = 'cross'    # No longer an ellipse !\n   type = ellipse[:type]       # Find out what it really is.\n\n The properties of a shape object that can be defined via add_shape are\n shown below.\n\n ===:name\n\n Defines the name of the shape. This is an optional property and the shape\n will be given a default name if not supplied. The name is generally only\n used by Excel Macros to refer to the object.\n\n ===:type\n\n Defines the type of the object such as +:rect+, +:ellipse+ OR +:triangle+.\n\n   ellipse = workbook.add_shape(:type => :ellipse)\n\n The default type is +:rect+.\n\n The full list of available shapes is shown below.\n\n See also the shape_all.rb program in the examples directory of the distro.\n It creates an example workbook with all supported shapes labelled with\n their shape names.\n\n === Basic Shapes\n\n    blockArc              can            chevron       cube          decagon\n    diamond               dodecagon      donut         ellipse       funnel\n    gear6                 gear9          heart         heptagon      hexagon\n    homePlate             lightningBolt  line          lineInv       moon\n    nonIsoscelesTrapezoid noSmoking      octagon       parallelogram pentagon\n    pie                   pieWedge       plaque        rect          round1Rect\n    round2DiagRect        round2SameRect roundRect     rtTriangle    smileyFace\n    snip1Rect             snip2DiagRect  snip2SameRect snipRoundRect star10\n    star12                star16         star24        star32        star4\n    star5                 star6          star7         star8         sun\n    teardrop              trapezoid      triangle\n\n === Arrow Shapes\n\n    bentArrow        bentUpArrow       circularArrow     curvedDownArrow\n    curvedLeftArrow  curvedRightArrow  curvedUpArrow     downArrow\n    leftArrow        leftCircularArrow leftRightArrow    leftRightCircularArrow\n    leftRightUpArrow leftUpArrow       notchedRightArrow quadArrow\n    rightArrow       stripedRightArrow swooshArrow       upArrow\n    upDownArrow      uturnArrow\n\n === Connector Shapes\n\n    bentConnector2   bentConnector3   bentConnector4\n    bentConnector5   curvedConnector2 curvedConnector3\n    curvedConnector4 curvedConnector5 straightConnector1\n\n === Callout Shapes\n\n    accentBorderCallout1  accentBorderCallout2  accentBorderCallout3\n    accentCallout1        accentCallout2        accentCallout3\n    borderCallout1        borderCallout2        borderCallout3\n    callout1              callout2              callout3\n    cloudCallout          downArrowCallout      leftArrowCallout\n    leftRightArrowCallout quadArrowCallout      rightArrowCallout\n    upArrowCallout        upDownArrowCallout    wedgeEllipseCallout\n    wedgeRectCallout      wedgeRoundRectCallout\n\n === Flow Chart Shapes\n\n    flowChartAlternateProcess  flowChartCollate        flowChartConnector\n    flowChartDecision          flowChartDelay          flowChartDisplay\n    flowChartDocument          flowChartExtract        flowChartInputOutput\n    flowChartInternalStorage   flowChartMagneticDisk   flowChartMagneticDrum\n    flowChartMagneticTape      flowChartManualInput    flowChartManualOperation\n    flowChartMerge             flowChartMultidocument  flowChartOfflineStorage\n    flowChartOffpageConnector  flowChartOnlineStorage  flowChartOr\n    flowChartPredefinedProcess flowChartPreparation    flowChartProcess\n    flowChartPunchedCard       flowChartPunchedTape    flowChartSort\n    flowChartSummingJunction   flowChartTerminator\n\n === Action Shapes\n\n    actionButtonBackPrevious actionButtonBeginning actionButtonBlank\n    actionButtonDocument     actionButtonEnd       actionButtonForwardNext\n    actionButtonHelp         actionButtonHome      actionButtonInformation\n    actionButtonMovie        actionButtonReturn    actionButtonSound\n\n === Chart Shapes\n\n Not to be confused with Excel Charts.\n\n    chartPlus chartStar chartX\n\n === Math Shapes\n\n    mathDivide mathEqual mathMinus mathMultiply mathNotEqual mathPlus\n\n === Starts and Banners\n\n    arc            bevel          bracePair  bracketPair chord\n    cloud          corner         diagStripe doubleWave  ellipseRibbon\n    ellipseRibbon2 foldedCorner   frame      halfFrame   horizontalScroll\n    irregularSeal1 irregularSeal2 leftBrace  leftBracket leftRightRibbon\n    plus           ribbon         ribbon2    rightBrace  rightBracket\n    verticalScroll wave\n\n === Tab Shapes\n\n    cornerTabs plaqueTabs squareTabs\n\n === :text\n\n This property is used to make the shape act like a text box.\n\n    rect = workbook.add_shape(:type => 'rect', :text => \"Hello \\nWorld\")\n\n The Text is super-imposed over the shape. The text can be wrapped using\n the newline character \\n.\n\n === :id\n\n Identification number for internal identification. This number will be\n auto-assigned, if not assigned, or if it is a duplicate.\n\n === :format\n\n Workbook format for decorating the shape horizontally and/or vertically.\n\n === :rotation\n\n Shape rotation, in degrees, from 0 to 360\n\n === :line, :fill\n\n Shape color for the outline and fill.\n Colors may be specified  as a color index, or in RGB format, i.e. AA00FF.\n\n See COULOURS IN EXCEL in the main documentation for more information.\n\n === :link_type\n\n Line type for shape outline. The default is solid.\n The list of possible values is:\n\n    dash, sysDot, dashDot, lgDash, lgDashDot, lgDashDotDot, solid\n\n === :valign, :align\n\n Text alignment within the shape.\n\n Vertical alignment can be:\n\n    Setting     Meaning\n    =======     =======\n    t           Top\n    ctr         Centre\n    b           Bottom\n\n Horizontal alignment can be:\n\n    Setting     Meaning\n    =======     =======\n    l           Left\n    r           Right\n    ctr         Centre\n    just        Justified\n\n The default is to center both horizontally and vertically.\n\n === :scale_x, :scale_y\n\n Scale factor in x and y dimension, for scaling the shape width and\n height. The default value is 1.\n\n Scaling may be set on the shape object or via insert_shape.\n\n === :adjustments\n\n Adjustment of shape vertices. Most shapes do not use this. For some\n shapes, there is a single adjustment to modify the geometry.\n For instance, the plus shape has one adjustment to control the width\n of the spokes.\n\n Connectors can have a number of adjustments to control the shape\n routing. Typically, a connector will have 3 to 5 handles for routing\n the shape. The adjustment is in percent of the distance from the\n starting shape to the ending shape, alternating between the x and y\n dimension. Adjustments may be negative, to route the shape away\n from the endpoint.\n\n === :stencil\n\n Shapes work in stencil mode by default. That is, once a shape is\n inserted, its connection is separated from its master.\n The master shape may be modified after an instance is inserted,\n and only subsequent insertions will show the modifications.\n\n This is helpful for Org charts, where an employee shape may be\n created once, and then the text of the shape is modified for each\n employee.\n\n The insert_shape method returns a reference to the inserted\n shape (the child).\n\n Stencil mode can be turned off, allowing for shape(s) to be\n modified after insertion. In this case the insert_shape() method\n returns a reference to the inserted shape (the master).\n This is not very useful for inserting multiple shapes,\n since the x/y coordinates also gets modified.", "The set_properties method can be used to set the document properties\n of the Excel file created by WriteXLSX. These properties are visible\n when you use the Office Button -> Prepare -> Properties option in Excel\n and are also available to external applications that read or index windows\n files.\n\n The properties should be passed in hash format as follows:\n\n     workbook.set_properties(\n       :title    => 'This is an example spreadsheet',\n       :author   => 'Hideo NAKAMURA',\n       :comments => 'Created with Ruby and WriteXLSX'\n     )\n\n The properties that can be set are:\n\n     :title\n     :subject\n     :author\n     :manager\n     :company\n     :category\n     :keywords\n     :comments\n     :status\n\n See also the properties.rb program in the examples directory\n of the distro.", "Change the RGB components of the elements in the colour palette.\n\n The set_custom_color method can be used to override one of the built-in\n palette values with a more suitable colour.\n\n The value for +index+ should be in the range 8..63,\n see \"COLOURS IN EXCEL\".\n\n The default named colours use the following indices:\n\n      8   =>   black\n      9   =>   white\n     10   =>   red\n     11   =>   lime\n     12   =>   blue\n     13   =>   yellow\n     14   =>   magenta\n     15   =>   cyan\n     16   =>   brown\n     17   =>   green\n     18   =>   navy\n     20   =>   purple\n     22   =>   silver\n     23   =>   gray\n     33   =>   pink\n     53   =>   orange\n\n A new colour is set using its RGB (red green blue) components. The +red+,\n +green+ and +blue+ values must be in the range 0..255. You can determine\n the required values in Excel using the Tools->Options->Colors->Modify\n dialog.\n\n The set_custom_color workbook method can also be used with a HTML style\n +#rrggbb+ hex value:\n\n     workbook.set_custom_color(40, 255,  102,  0   ) # Orange\n     workbook.set_custom_color(40, 0xFF, 0x66, 0x00) # Same thing\n     workbook.set_custom_color(40, '#FF6600'       ) # Same thing\n\n     font = workbook.add_format(:color => 40)   # Use the modified colour\n\n The return value from set_custom_color() is the index of the colour that\n was changed:\n\n     ferrari = workbook.set_custom_color(40, 216, 12, 12)\n\n     format  = workbook.add_format(\n                                 :bg_color => ferrari,\n                                 :pattern  => 1,\n                                 :border   => 1\n                            )\n\n Note, In the XLSX format the color palette isn't actually confined to 53\n unique colors. The WriteXLSX gem will be extended at a later stage to\n support the newer, semi-infinite, palette.", "Assemble worksheets into a workbook.", "Iterate through the XF Format objects and separate them into XF and DXF\n formats.", "Iterate through the XF Format objects and give them an index to non-default\n font elements.", "Iterate through the XF Format objects and give them an index to non-default\n number format elements.\n\n User defined records start from index 0xA4.", "Iterate through the XF Format objects and give them an index to non-default\n border elements.", "Iterate through the XF Format objects and give them an index to non-default\n fill elements.\n\n The user defined fill properties start from 2 since there are 2 default\n fills: patternType=\"none\" and patternType=\"gray125\".", "Iterate through the worksheets and store any defined names in addition to\n any user defined names. Stores the defined names for the Workbook.xml and\n the named ranges for App.xml.", "Iterate through the worksheets and set up the VML objects.", "Extract the named ranges from the sorted list of defined names. These are\n used in the App.xml file.", "Iterate through the worksheets and set up any chart or image drawings.", "Extract information from the image file such as dimension, type, filename,\n and extension. Also keep track of previously seen images to optimise out\n any duplicates.", "Extract width and height information from a PNG file.", "Extract width and height information from a BMP file.", "setting daemon address for components communicate with X-Ray daemon.", "Returns the number of its direct and indirect children.\n This is useful when we remove the reference to a subsegment\n and need to keep remaining subsegment size accurate.", "Return True if the sampler decide to sample based on input\n information and sampling rules. It will first check if any\n custom rule should be applied, if not it falls back to the\n default sampling rule.\n All arugments are extracted from incoming requests by\n X-Ray middleware to perform path based sampling.", "Begin a segment for the current context. The recorder\n only keeps one segment at a time. Create a second one without\n closing existing one will overwrite the existing one.\n @return [Segment] thew newly created segment.", "End the current segment and send it to X-Ray daemon if it is ready.", "Begin a new subsegment and add it to be the child of the current active\n subsegment or segment. Also tie the new created subsegment to the current context.\n Its sampling decision will follow its parent.\n @return [Subsegment] the newly created subsegment. It could be `nil` if no active entity\n   can be found and `context_missing` is set to `LOG_ERROR`.", "End the current active subsegment. It also send the entire segment if\n this subsegment is the last one open or stream out subsegments of its\n parent segment if the stream threshold is breached.", "Record the passed block as a subsegment.\n If `context_missing` is set to `LOG_ERROR` and no active entity can be found,\n the passed block will be executed as normal but it will not be recorded.", "A proxy method to get the metadata under provided namespace\n from the current active entity.", "Decide whether to borrow or take one quota from\n the reservoir. Return `false` if it can neither\n borrow nor take. This method is thread-safe.", "Return the rule name if it decides to sample based on\n a service sampling rule matching. If there is no match\n it will fallback to local defined sampling rules.", "This takes the @uri and inserts the keys to form a path.\n To start we make sure that for nil/numeric values, we wrap those into an\n array. We then scan the string for %d and %s to find the number of times\n we possibly need to insert keys into the URI. Next, we check the size of\n the keys array, if the keys size is less than the number of possible keys\n in the URI, we will remove the trailing %d or %s, then remove the\n trailing /. We then pass the keys into the uri to form the path.\n ex. foo/%d/bar/%d => foo/1/bar/2", "Generate a token that can be used to log the customer into the storefront.\n This requires your app to have the store_v2_customers_login scope and to\n be installed in the store.", "For Rails 3.2 support", "Saves the rendered as a fixture file.", "Writes to the IO after first truncating the output to fit the console\n width. If the underlying IO is not a TTY, ANSI colors are removed from\n the output. A newline is always added. Color output can be forced by\n setting the SSHKIT_COLOR environment variable.", "Initializes the runner with a parsed feature\n\n @param [Array<String>] filenames\n   A list of feature filenames to run\n\n @param [Hash] options\n\n @option options [String] :step_definitions_path\n   The path in which step definitions are found.\n\n @option options [String] :support_path\n   The path with the support ruby files.\n\n @api public\n Inits the reporter with a default one.\n\n @api public", "Runs this runner and outputs the results in a colorful manner.\n\n @return [true, false]\n   Whether the run was succesful.\n\n @api public", "The orderer for this run.\n\n @api public", "Parse options from the config file\n\n @return [Boolean]\n   If the config was parsed from the file", "Runs before running a scenario with a particular tag\n\n @param [String] tag\n   the tag to match\n\n @example\n   Spinach.hooks.on_tag('javascript') do\n     # change capybara driver\n   end", "Get the feature and its definitions from the appropriate files", "Process a step from the feature file using the given step_defs.\n If it is missing, return true. Otherwise, add it to the used_steps for\n the report at the end and return false.", "Store any unused step names for the report at the end of the audit", "Get the step names for all steps in the given class, including those in\n common modules", "Produce a report of unused steps that were not found anywhere in the audit", "Print a report of the missing step objects provided", "Hooks the reporter to the runner endpoints", "Uses given args to list the feature files to run. It will find a single\n feature, features in a folder and subfolders or every feature file in the\n feature path.\n\n @return [Array]\n   An array with the feature file names.\n\n @api public", "Parses the arguments into options.\n\n @return [Hash]\n   A hash of options separated by its type.\n\n @api private", "Runs commands from the specified array until successful.\n Returns the result of the successful command or an ExecResult with\n exit_code 1 if all fail.", "Runs the given block in a new transaction.\n @param [Boolean] run_in_tx if true a new transaction will not be created, instead if will simply yield to the given block\n @@yield [Neo4j::Transaction::Instance]", "To support old syntax of providing run_in_tx first\n But session first is ideal", "Add or update an entry in the set\n\n If the entry to add isn't part of the set already,\n it will be added. If an entry with the same cache\n key as the entry to add is part of the set already,\n it will be replaced with the given entry.\n\n @param [Object] entry\n   the entry to be added\n\n @return [OrderedSet] self\n\n @api private", "Make sure that entry is part of this PropertySet\n\n @param [#to_s] name\n @param [#name] entry\n\n @return [#name]\n   the entry that is now part of this PropertySet\n\n @api semipublic", "Updates the Query with another Query or conditions\n\n Pretty unrealistic example:\n\n @example\n\n   Journal.all(:limit => 2).query.limit                     # => 2\n   Journal.all(:limit => 2).query.update(:limit => 3).limit # => 3\n\n @param [Query, Hash] other\n   other Query or conditions\n\n @return [Query]\n   self\n\n @api semipublic", "Takes an Enumerable of records, and destructively filters it.\n First finds all matching conditions, then sorts it,\n then does offset & limit\n\n @param [Enumerable] records\n   The set of records to be filtered\n\n @return [Enumerable]\n   Whats left of the given array after the filtering\n\n @api semipublic", "Filter a set of records by the conditions\n\n @param [Enumerable] records\n   The set of records to be filtered\n\n @return [Enumerable]\n   Whats left of the given array after the matching\n\n @api semipublic", "Sorts a list of Records by the order\n\n @param [Enumerable] records\n   A list of Resources to sort\n\n @return [Enumerable]\n   The sorted records\n\n @api semipublic", "Slices collection by adding limit and offset to the\n query, so a single query is executed\n\n @example\n\n   Journal.all(:limit => 10).slice!(3, 5)\n\n will execute query with the following limit\n (when repository uses DataObjects adapter, and thus\n queries use SQL):\n\n   LIMIT 10\n\n and then takes a slice of collection in the Ruby space\n\n @api semipublic", "Returns detailed human readable\n string representation of the query\n\n @return [String]  detailed string representation of the query\n\n @api semipublic", "Get the properties used in the conditions\n\n @return [Set<Property>]\n  Set of properties used in the conditions\n\n @api private", "Transform Query into subquery conditions\n\n @return [AndOperation]\n   a subquery for the Query\n\n @api private", "Hash representation of a Query\n\n @return [Hash]\n   Hash representation of a Query\n\n @api private", "Validate the options\n\n @param [#each] options\n   the options to validate\n\n @raise [ArgumentError]\n   if any pairs in +options+ are invalid options\n\n @api private", "Verifies that query offset is non-negative and only used together with limit\n @api private", "Verifies that associations given in conditions belong\n to the same repository as query's model\n\n @api private", "Handle all the conditions options provided\n\n @param [Array<Conditions::AbstractOperation, Conditions::AbstractComparison, Hash, Array>]\n   a list of conditions\n\n @return [undefined]\n\n @api private", "Append conditions to this Query\n\n   TODO: needs example\n\n @param [Property, Symbol, String, Operator, Associations::Relationship, Path] subject\n   the subject to match\n @param [Object] bind_value\n   the value to match on\n @param [Symbol] operator\n   the operator to match with\n\n @return [Query::Conditions::AbstractOperation]\n   the Query conditions\n\n @api private", "Apply a set operation on self and another query\n\n @param [Symbol] operation\n   the set operation to apply\n @param [Query] other\n   the other query to apply the set operation on\n\n @return [Query]\n   the query that was created for the set operation\n\n @api private", "Return the union with another query's conditions\n\n @param [Query] other\n   the query conditions to union with\n\n @return [OrOperation]\n   the union of the query conditions and other conditions\n\n @api private", "Extract conditions from a Query\n\n @param [Query] query\n   the query with conditions\n\n @return [AbstractOperation]\n   the operation\n\n @api private", "Return a self referrential relationship\n\n @return [Associations::OneToMany::Relationship]\n   the 1:m association to the same model\n\n @api private", "Return options for the self referrential relationship\n\n @return [Hash]\n   the options to use with the self referrential relationship\n\n @api private", "Grab a single record by its key. Supports natural and composite key\n lookups as well.\n\n   Zoo.get(1)                # get the zoo with primary key of 1.\n   Zoo.get!(1)               # Or get! if you want an ObjectNotFoundError on failure\n   Zoo.get('DFW')            # wow, support for natural primary keys\n   Zoo.get('Metro', 'DFW')   # more wow, composite key look-up\n\n @param [Object] *key\n   The primary key or keys to use for lookup\n\n @return [Resource, nil]\n   A single model that was found\n   If no instance was found matching +key+\n\n @api public", "Return the first Resource or the first N Resources for the Model with an optional query\n\n When there are no arguments, return the first Resource in the\n Model.  When the first argument is an Integer, return a\n Collection containing the first N Resources.  When the last\n (optional) argument is a Hash scope the results to the query.\n\n @param [Integer] limit (optional)\n   limit the returned Collection to a specific number of entries\n @param [Hash] query (optional)\n   scope the returned Resource or Collection to the supplied query\n\n @return [Resource, Collection]\n   The first resource in the entries of this collection,\n   or a new collection whose query has been merged\n\n @api public", "Copy a set of records from one repository to another.\n\n @param [String] source_repository_name\n   The name of the Repository the resources should be copied _from_\n @param [String] target_repository_name\n   The name of the Repository the resources should be copied _to_\n @param [Hash] query\n   The conditions with which to find the records to copy. These\n   conditions are merged with Model.query\n\n @return [Collection]\n   A Collection of the Resource instances created in the operation\n\n @api public", "Get the current +repository_name+ for this Model.\n\n If there are any Repository contexts, the name of the last one will\n be returned, else the +default_repository_name+ of this model will be\n\n @return [String]\n   the current repository name to use for this Model\n\n @api private", "Initialize the list of allowed writer methods\n\n @return [undefined]\n\n @api private", "Test if the model has properties\n\n A model may also be valid if it has at least one m:1 relationships which\n will add inferred foreign key properties.\n\n @return [undefined]\n\n @raise [IncompleteModelError]\n   raised if the model has no properties\n\n @api private", "Lookup an entry in the SubjectSet based on a given name\n\n @param [#to_s] name\n   the name of the entry\n\n @return [Object, nil]\n   the entry having the given name, or nil if not found\n\n @api private", "Reloads the Collection from the repository\n\n If +query+ is provided, updates this Collection's query with its conditions\n\n   cars_from_91 = Cars.all(:year_manufactured => 1991)\n   cars_from_91.first.year_manufactured = 2001   # note: not saved\n   cars_from_91.reload\n   cars_from_91.first.year                       #=> 1991\n\n @param [Query, Hash] query (optional)\n   further restrict results with query\n\n @return [self]\n\n @api public", "Lookup a Resource in the Collection by key\n\n This looksup a Resource by key, typecasting the key to the\n proper object if necessary.\n\n   toyotas = Cars.all(:manufacturer => 'Toyota')\n   toyo = Cars.first(:manufacturer => 'Toyota')\n   toyotas.get(toyo.id) == toyo                  #=> true\n\n @param [Enumerable] *key\n   keys which uniquely identify a resource in the Collection\n\n @return [Resource]\n   Resource which matches the supplied key\n @return [nil]\n   No Resource matches the supplied key\n\n @api public", "Returns a new Collection optionally scoped by +query+\n\n This returns a new Collection scoped relative to the current\n Collection.\n\n   cars_from_91 = Cars.all(:year_manufactured => 1991)\n   toyotas_91 = cars_from_91.all(:manufacturer => 'Toyota')\n   toyotas_91.all? { |car| car.year_manufactured == 1991 }       #=> true\n   toyotas_91.all? { |car| car.manufacturer == 'Toyota' }        #=> true\n\n If +query+ is a Hash, results will be found by merging +query+ with this Collection's query.\n If +query+ is a Query, results will be found using +query+ as an absolute query.\n\n @param [Hash, Query] query\n   optional parameters to scope results with\n\n @return [Collection]\n   Collection scoped by +query+\n\n @api public", "Return the first Resource or the first N Resources in the Collection with an optional query\n\n When there are no arguments, return the first Resource in the\n Collection.  When the first argument is an Integer, return a\n Collection containing the first N Resources.  When the last\n (optional) argument is a Hash scope the results to the query.\n\n @param [Integer] limit (optional)\n   limit the returned Collection to a specific number of entries\n @param [Hash] query (optional)\n   scope the returned Resource or Collection to the supplied query\n\n @return [Resource, Collection]\n   The first resource in the entries of this collection,\n   or a new collection whose query has been merged\n\n @api public", "Lookup a Resource from the Collection by offset\n\n @param [Integer] offset\n   offset of the Resource in the Collection\n\n @return [Resource]\n   Resource which matches the supplied offset\n @return [nil]\n   No Resource matches the supplied offset\n\n @api public", "Deletes and Returns the Resources given by an offset or a Range\n\n @param [Integer, Array(Integer), Range] *args\n   the offset, offset and limit, or range indicating first and last position\n\n @return [Resource, Collection]\n   The entry which resides at that offset and limit, or\n   a new Collection object with the set limits and offset\n @return [Resource, Collection, nil]\n   The offset is out of range\n\n @api public", "Splice a list of Resources at a given offset or range\n\n When nil is provided instead of a Resource or a list of Resources\n this will remove all of the Resources at the specified position.\n\n @param [Integer, Array(Integer), Range] *args\n   The offset, offset and limit, or range indicating first and last position.\n   The last argument may be a Resource, a list of Resources or nil.\n\n @return [Resource, Enumerable]\n   the Resource or list of Resources that was spliced into the Collection\n @return [nil]\n   If nil was used to delete the entries\n\n @api public", "Iterate over each Resource\n\n @yield [Resource] Each resource in the collection\n\n @return [self]\n\n @api public", "Initializes a Resource and appends it to the Collection\n\n @param [Hash] attributes\n   Attributes with which to initialize the new resource\n\n @return [Resource]\n   a new Resource initialized with +attributes+\n\n @api public", "Update every Resource in the Collection\n\n   Person.all(:age.gte => 21).update(:allow_beer => true)\n\n @param [Hash] attributes\n   attributes to update with\n\n @return [Boolean]\n   true if the resources were successfully updated\n\n @api public", "Update every Resource in the Collection bypassing validation\n\n   Person.all(:age.gte => 21).update!(:allow_beer => true)\n\n @param [Hash] attributes\n   attributes to update\n\n @return [Boolean]\n   true if the resources were successfully updated\n\n @api public", "Remove all Resources from the repository, bypassing validation\n\n This performs a deletion of each Resource in the Collection from\n the repository and clears the Collection while skipping\n validation.\n\n @return [Boolean]\n   true if the resources were successfully destroyed\n\n @api public", "Check to see if collection can respond to the method\n\n @param [Symbol] method\n   method to check in the object\n @param [Boolean] include_private\n   if set to true, collection will check private methods\n\n @return [Boolean]\n   true if method can be responded to\n\n @api public", "Test if the collection is loaded between the offset and limit\n\n @param [Integer] offset\n   the offset of the collection to test\n @param [Integer] limit\n   optional limit for how many entries to be loaded\n\n @return [Boolean]\n   true if the collection is loaded from the offset to the limit\n\n @api private", "Lazy loads a Collection\n\n @return [self]\n\n @api private", "Initializes a new Collection\n\n @return [Collection]\n   A new Collection object\n\n @api private", "Apply a set operation on self and another collection\n\n @param [Symbol] operation\n   the set operation to apply\n @param [Collection] other\n   the other collection to apply the set operation on\n\n @return [Collection]\n   the collection that was created for the set operation\n\n @api private", "Creates a resource in the collection\n\n @param [Boolean] execute_hooks\n   Whether to execute hooks or not\n @param [Hash] attributes\n   Attributes with which to create the new resource\n\n @return [Resource]\n   a saved Resource\n\n @api private", "Saves a collection\n\n @param [Boolean] execute_hooks\n   Whether to execute hooks or not\n\n @return [Boolean]\n   Returns true if collection was updated\n\n @api private", "Returns default values to initialize new Resources in the Collection\n\n @return [Hash] The default attributes for new instances in this Collection\n\n @api private", "Track the added resource\n\n @param [Resource] resource\n   the resource that was added\n\n @return [Resource]\n   the resource that was added\n\n @api private", "Track the added resources\n\n @param [Array<Resource>] resources\n   the resources that were added\n\n @return [Array<Resource>]\n   the resources that were added\n\n @api private", "Track the removed resources\n\n @param [Array<Resource>] resources\n   the resources that were removed\n\n @return [Array<Resource>]\n   the resources that were removed\n\n @api private", "Filter resources in the collection based on a Query\n\n @param [Query] query\n   the query to match each resource in the collection\n\n @return [Array]\n   the resources that match the Query\n @return [nil]\n   nil if no resources match the Query\n\n @api private", "Return the absolute or relative scoped query\n\n @param [Query, Hash] query\n   the query to scope the collection with\n\n @return [Query]\n   the absolute or relative scoped query\n\n @api private", "Delegate the method to the Model\n\n @param [Symbol] method\n   the name of the method in the model to execute\n @param [Array] *args\n   the arguments for the method\n\n @return [Object]\n   the return value of the model method\n\n @api private", "Retrieve a collection of results of a query\n\n   TODO: create example\n\n @param [Query] query\n   composition of the query to perform\n\n @return [Array]\n   result set of the query\n\n @api semipublic", "Update the attributes of one or more resource instances\n\n   TODO: create example\n\n @param [Hash(Property => Object)] attributes\n   hash of attribute values to set, keyed by Property\n @param [Collection] collection\n   collection of records to be updated\n\n @return [Integer]\n   the number of records updated\n\n @api semipublic", "Remove a descendant\n\n Also removes from all descendants\n\n @param [Module] descendant\n\n @return [DescendantSet]\n   self\n\n @api private", "Test the value to see if it is a valid value for this Property\n\n @param [Object] loaded_value\n   the value to be tested\n\n @return [Boolean]\n   true if the value is valid\n\n @api semipulic", "Asserts value is valid\n\n @param [Object] loaded_value\n   the value to be tested\n\n @return [Boolean]\n   true if the value is valid\n\n @raise [Property::InvalidValueError]\n   if value is not valid", "Sets the value of the attribute and marks the attribute as dirty\n if it has been changed so that it may be saved. Do not set from\n instance variables directly, but use this method. This method\n handles the lazy loading the property and returning of defaults\n if nessesary.\n\n @example\n   class Foo\n     include DataMapper::Resource\n\n     property :first_name, String\n     property :last_name,  String\n\n     def full_name(name)\n       name = name.split(' ')\n       attribute_set(:first_name, name[0])\n       attribute_set(:last_name, name[1])\n     end\n\n     # using the shorter syntax\n     def name_from_address_book(name)\n       name = name.split(', ')\n       self.first_name = name[1]\n       self.last_name = name[0]\n     end\n   end\n\n @param [Symbol] name\n   name of attribute to set\n @param [Object] value\n   value to store\n\n @return [undefined]\n\n @api public", "Gets all the attributes of the Resource instance\n\n @param [Symbol] key_on\n   Use this attribute of the Property as keys.\n   defaults to :name. :field is useful for adapters\n   :property or nil use the actual Property object.\n\n @return [Hash]\n   All the attributes\n\n @api public", "Compares another Resource for equality\n\n Resource is equal to +other+ if they are the same object\n (identical object_id) or if they are both of the *same model* and\n all of their attributes are equivalent\n\n @param [Resource] other\n   the other Resource to compare with\n\n @return [Boolean]\n   true if they are equal, false if not\n\n @api public\n Compares another Resource for equivalency\n\n Resource is equivalent to +other+ if they are the same object\n (identical object_id) or all of their attribute are equivalent\n\n @param [Resource] other\n   the other Resource to compare with\n\n @return [Boolean]\n   true if they are equivalent, false if not\n\n @api public\n Compares two Resources to allow them to be sorted\n\n @param [Resource] other\n   The other Resource to compare with\n\n @return [Integer]\n   Return 0 if Resources should be sorted as the same, -1 if the\n   other Resource should be after self, and 1 if the other Resource\n   should be before self\n\n @api public\n Returns hash value of the object.\n Two objects with the same hash value assumed equal (using eql? method)\n\n DataMapper resources are equal when their models have the same hash\n and they have the same set of properties\n\n When used as key in a Hash or Hash subclass, objects are compared\n by eql? and thus hash value has direct effect on lookup\n\n @api private\n Get a Human-readable representation of this Resource instance\n\n   Foo.new   #=> #<Foo name=nil updated_at=nil created_at=nil id=nil>\n\n @return [String]\n   Human-readable representation of this Resource instance\n\n @api public", "Hash of attributes that have unsaved changes\n\n @return [Hash]\n   attributes that have unsaved changes\n\n @api semipublic", "Initialize a new instance of this Resource using the provided values\n\n @param [Hash] attributes\n   attribute values to use for the new instance\n\n @return [Hash]\n   attribute values used in the new instance\n\n @api public\n @api private", "Reset the key to the original value\n\n @return [undefined]\n\n @api private", "Remove all the ivars for properties and relationships\n\n @return [undefined]\n\n @api private", "Reloads specified attributes\n\n @param [Array<Property>] properties\n   the properties to reload\n\n @return [Resource]\n   the receiver, the current Resource instance\n\n @api private", "Return conditions to match the Resource\n\n @return [Hash]\n   query conditions\n\n @api private", "Returns loaded child relationships\n\n @return [Array<Associations::OneToMany::Relationship>]\n   array of child relationships for which this resource is parent and is loaded\n\n @api private", "Saves the resource\n\n @return [Boolean]\n   true if the resource was successfully saved\n\n @api semipublic", "Saves the parent resources\n\n @return [Boolean]\n   true if the parents were successfully saved\n\n @api private", "Checks if the resource has unsaved changes\n\n @return [Boolean]\n  true if the resource has unsaved changes\n\n @api semipublic", "Checks if the parents have unsaved changes\n\n @return [Boolean]\n  true if the parents have unsaved changes\n\n @api private", "Return true if +other+'s is equivalent or equal to +self+'s\n\n @param [Resource] other\n   The Resource whose attributes are to be compared with +self+'s\n @param [Symbol] operator\n   The comparison operator to use to compare the attributes\n\n @return [Boolean]\n   The result of the comparison of +other+'s attributes with +self+'s\n\n @api private", "Execute all the queued up hooks for a given type and name\n\n @param [Symbol] type\n   the type of hook to execute (before or after)\n @param [Symbol] name\n   the name of the hook to execute\n\n @return [undefined]\n\n @api private", "Prevent a method from being in the stack more than once\n\n The purpose of this method is to prevent SystemStackError from\n being thrown from methods from encountering infinite recursion\n when called on resources having circular dependencies.\n\n @param [Object] default\n   default return value\n\n @yield The block of code to run once\n\n @return [Object]\n   block return value\n\n @api private", "Returns the plural form of the word in the string.\n\n Examples:\n   \"post\".pluralize             # => \"posts\"\n   \"octopus\".pluralize          # => \"octopi\"\n   \"sheep\".pluralize            # => \"sheep\"\n   \"words\".pluralize            # => \"words\"\n   \"CamelOctopus\".pluralize     # => \"CamelOctopi\"", "Prints out exception_message based on specified e", "Given a word with dashes, returns a camel cased version of it.\n\n @example\n   classify('job-name') # => 'JobName'", "Given a class, dasherizes the name, used for getting tube names\n\n @example\n   dasherize('JobName') # => \"job-name\"", "Resolves job priority based on the value given. Can be integer, a class or nothing\n\n @example\n  resolve_priority(1000) => 1000\n  resolve_priority(FooBar) => <queue priority>\n  resolve_priority(nil) => <default priority>", "Resolves job respond timeout based on the value given. Can be integer, a class or nothing\n\n @example\n  resolve_respond_timeout(1000) => 1000\n  resolve_respond_timeout(FooBar) => <queue respond_timeout>\n  resolve_respond_timeout(nil) => <default respond_timeout>", "Performs a job by reserving a job from beanstalk and processing it\n\n @example\n   @worker.work_one_job\n @raise [Beaneater::NotConnected] If beanstalk fails to connect multiple times.", "Return a new connection instance", "Reserve a job from the watched queues", "Handles an error according to custom definition\n Used when processing a job that errors out", "Normalizes tube names given array of tube_names\n Compacts nil items, flattens arrays, sets tubes to nil if no valid names\n Loads default tubes when no tubes given.", "Print out when a job completed\n If message is nil, job is considered complete", "Processes a job and handles any failure, deleting the job once complete\n\n @example\n   @task.process", "Timeout job within specified block after given time.\n\n @example\n   timeout_job_after(3) { do_something! }", "Yield to a block that will be retried several times if the connection to\n beanstalk goes down and is able to be re-established.\n\n @param options Hash Options. Valid options are:\n   :max_retries       Integer The maximum number of times the block will be yielded to.\n                              Defaults to 4\n   :on_retry          Proc    An optional proc that will be called for each retry. Will be\n                              called after the connection is re-established and :retry_delay\n                              has passed but before the block is yielded to again\n   :retry_delay       Float   The amount to sleep before retrying. Defaults to 1.0\n @raise Beaneater::NotConnected If a connection is unable to be re-established", "Attempts to ensure a connection to beanstalk is established but only if\n we're not connected already\n @param max_retries Integer The maximum number of times to attempt connecting. Defaults to 4\n @param retry_delay Float   The time to wait between retrying to connect. Defaults to 1.0\n @raise [Beaneater::NotConnected] If beanstalk fails to connect after multiple attempts.\n @return Connection This Connection is returned if the connection to beanstalk is open or was able to be reconnected", "Returns the beanstalk queue addresses\n\n @example\n   beanstalk_addresses => [\"127.0.0.1:11300\"]", "Returns a host and port based on the uri_string given\n\n @example\n   beanstalk_host_and_port(\"beanstalk://127.0.0.1\") => \"127.0.0.1:11300\"", "Sent it to state_id and  country id it will return cities of that states", "Wrapper for file_field helper. It can accept `custom_control` option.\n\n   file_field :photo, bootstrap: {custom_control: true}", "Bootstrap wrapper for readonly text field that is shown as plain text.\n\n   plaintext(:value)", "Same as submit button, only with btn-primary class added", "form group wrapper for input fields", "Renders control for a given field", "Wrapping in control in column wrapper", "Wrapper for collections of radio buttons and checkboxes", "Wrapper for `form_with`. Passing in Bootstrap form builder.", "By default, Rails will wrap form fields with extra html to indicate\n inputs with errors. We need to handle this in the builder to render\n Bootstrap specific markup. So we need to bypass this.", "Perform an HTTP request for the given uri and method\n with common basic response handling. Will raise a\n ParseProtocolError if the response has an error status code,\n and will return the parsed JSON body on success, if there is one.", "Write the current state of the local object to the API.\n If the object has never been saved before, this will create\n a new object, otherwise it will update the existing stored object.", "representation of object to send on saves", "Increment the given field by an amount, which defaults to 1.\n Saves immediately to reflect incremented", "Merge a hash parsed from the JSON representation into\n this instance. This will extract the reserved fields,\n merge the hash keys, and then ensure that the reserved\n fields do not occur in the underlying hash storage.", "Draw all children at the same level, for having multiple top-level\n peer leaves.", "Uploads the file to s3 and verifies the checksum.\n\n @param file [String] File to be uploaded to s3.\n @param key [String] Name of the object to be created on s3.\n @raise [RuntimeError] If the file fails to upload correctly after 3\n                       attempts.", "Downloads the release build from github and verifies the checksum.\n\n @param version [String] Version to be downloaded\n @param [String] Build file downloaded.\n @raise [RuntimeError] If the file fails to download correctly after 3\n                       attempts.", "Verifies the checksum for a file downloaded from github.\n\n @param build_file [String] Build file to verify.\n @param checksum_file [String] Checksum file to verify the build.\n @param attempt [Integer] The attempt for this verification.", "Backs up the failed file from a github verification.\n\n @param build_file [String] The build file to backup.\n @param attempt [Integer] Which attempt to verify the file failed.", "Verifies the checksum for a file uploaded to s3.\n\n Uses a HEAD request and uses the etag, which is an MD5 hash.\n\n @param s3_name [String] The object's name on s3.\n @param checksum_file [String] Checksum file to verify the build.\n @param attempt [Integer] The attempt for this verification.", "Backs up the failed file from an s3 verification.\n\n @param s3_name [String] The object's name on s3.\n @param attempt [Integer] Which attempt to verify the file failed.", "Get additional information about instances not returned by the ASG API.", "Looks for the travis build and attempts to retry if the build does not\n exist yet.\n\n @param verison [String] Build version to look for.\n\n @return [String] Job number for the travis build.", "Waits for a job to complete, within the defined timeout.\n\n @param job_number [String] The job number to wait for.", "Return a Hash of the default values defined in the stack template.", "Determines if a valid git tag already exists.\n\n @param tag [String] Tag to check existence for.\n @param sha [String] SHA to verify the tag against.\n\n @return [Boolean] Whether or not the tag exists.\n\n @raise [RuntimeError] if the SHAs do not match.", "Determines if a github release already exists.\n\n @param semver [String] Semantic version string for the release.\n\n @return [Boolean]", "Checks for the commit's CI job status. If its not finished yet,\n wait till timeout.\n\n @param sha [String] Commit sha.\n\n @return [String] Status and links to the CI jobs", "Convert hash to array,offset notation", "Convert array,offset notation to hash", "return a hash of basic options to merge", "if no filters, we use results to add profile", "Move this from it's current queue into another", "Fail a job", "Start a thread listening", "Pop a work item off the queue", "Peek at a work item", "How many items in the queue?", "If we're updating, don't consider historic slugs for the same record\n to be conflicts. This will allow a record to revert to a previously\n used slug.", "Establish connection to configured target.", "Retrieve the contents of a remote file. Returns nil\n if the file didn't exist or couldn't be read.", "Returns the list of targets as an array of TargetHost instances,\n them to account for ranges embedded in the target name.", "Given a cookbook path or name, try to load that cookbook. Either return\n a cookbook object or raise an error.", "Find the specified recipe or default recipe if none is specified.\n Raise an error if recipe cannot be found.", "Accepts a target_host and establishes the connection to that host\n while providing visual feedback via the Terminal API.", "Runs the GenerateLocalPolicy action and renders UI updates\n as the action reports back", "Runs the Converge action and renders UI updates as\n the action reports back", "A handler for common action messages", "Rudimentary routing support for channels to controllers.\n\n @param opts\n   a Hash of mappings either string keys (channel globs)\n   mapping to controller constants eg:\n\n     '/widgets/**' => WidgetsController\n\n   or you can set the behaviour for unknown channels:\n\n     :default => :block\n\n   :default can be set to :allow, :drop or :block.\n   if :drop is chosen then messages to unknown channels\n   will be silently dropped, whereas if you choose\n   :block then the message will be returned with the\n   error \"Permission denied.\"", "Image tag wrapper for forwarding Image API options", "Given a field and an array of child fields, we need to recurse through them to get the last one\n\n @param field [Symbol] the field we need to search for\n @param children [Array] an array of field values to match against\n @return an entity matching this class, which is the last in the tree", "Return HTML which is passed through the Redcarpet markdown processor, using a custom renderer\n so that we can manipulate images using contentful's URL-based API.\n NOTE that this is super-permissive out of the box. Set options to suit when you call the method.\n\n @param renderer_options [Hash] of options from https://github.com/vmg/redcarpet#darling-i-packed-you-a-couple-renderers-for-lunch\n @param markdown_options [Hash] of options from https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use\n @param image_options [Hash] of options to pass to the Image API. https://github.com/contentful/contentful_rails#manipulating-images", "this is where we receive a webhook, via a POST", "FIXME this has english in it so will cause problems if the locale is not en", "Open TCP socket\n\n @param [String] ipaddr IP address of remote server\n @param [Integer] port connection port\n @param [Hash] opts options of connection\n @option opts [Float, Integer] :connect_timeout seconds timeout for open socket\n @return [Socket] socket\n\n @raise [ModBusTimeout] timed out attempting to create connection", "Convert string of byte to string for log\n @example\n   logging_bytes(\"\\x1\\xa\\x8\") => \"[01][0a][08]\"\n @param [String] msg input string\n @return [String] readable string of bytes", "Write a single coil\n\n @example\n  write_single_coil(1, 0) => self\n\n @param [Integer] addr address coil\n @param [Integer] val value coil (0 or other)\n @return self", "Write multiple coils\n\n @example\n  write_multiple_coils(1, [0,1,0,1]) => self\n\n @param [Integer] addr address first coil\n @param [Array] vals written coils", "Read discrete inputs\n\n @example\n  read_discrete_inputs(addr, ninputs) => [1, 0, ..]\n\n @param [Integer] addr address first input\n @param[Integer] ninputs number inputs\n @return [Array] inputs", "Write multiple holding registers\n\n @example\n  write_multiple_registers(1, [0xaa, 0]) => self\n\n @param [Integer] addr address first registers\n @param [Array] val written registers\n @return self", "Mask a holding register\n\n @example\n   mask_write_register(1, 0xAAAA, 0x00FF) => self\n @param [Integer] addr address registers\n @param [Integer] and_mask mask for AND operation\n @param [Integer] or_mask mask for OR operation", "Request pdu to slave device\n\n @param [String] pdu request to slave\n @return [String] received data\n\n @raise [ResponseMismatch] the received echo response differs from the request\n @raise [ModBusTimeout] timed out during read attempt\n @raise [ModBusException] unknown error\n @raise [IllegalFunction] function code received in the query is not an allowable action for the server\n @raise [IllegalDataAddress] data address received in the query is not an allowable address for the server\n @raise [IllegalDataValue] value contained in the query data field is not an allowable value for server\n @raise [SlaveDeviceFailure] unrecoverable error occurred while the server was attempting to perform the requested action\n @raise [Acknowledge] server has accepted the request and is processing it, but a long duration of time will be required to do so\n @raise [SlaveDeviceBus] server is engaged in processing a long duration program command\n @raise [MemoryParityError] extended file area failed to pass a consistency check", "Initialize a proxy for a slave and a type of operation\n Read single or multiple values from a modbus slave depending on whether a Fixnum or a Range was given.\n Note that in the case of multiples, a pluralized version of the method is sent to the slave", "Write single or multiple values to a modbus slave depending on whether a Fixnum or a Range was given.\n Note that in the case of multiples, a pluralized version of the method is sent to the slave. Also when\n writing multiple values, the number of elements must match the number of registers in the range or an exception is raised", "We have to read specific amounts of numbers of bytes from the network depending on the function code and content", "Calc CRC16 for massage", "Iterates over the expressions of this expression as an array, passing\n the expression and its index within its parent to the given block.", "Returns a new array with the results of calling the given block once\n for every expression. If a block is not given, returns an array with\n each expression and its level index as an array.", "Run the given commands via a system call.\n The executable must be one of the permitted ClamAV executables.\n The arguments will be combined with default arguments if needed.\n The arguments are sorted alphabetically before being passed to the system.\n\n Examples:\n   run('clamscan', file, '--verbose')\n   run('clamscan', '-V')", "Dispatches to any named view in a specific database", "saves an attachment directly to couchdb", "returns an attachment's data", "deletes an attachment directly from couchdb", "Returns the CouchDB uri for the document", "Duplicate and remove excess baggage from the provided URI", "Take a look at the options povided and try to apply them to the HTTP conneciton.", "Prepare the http connection options for HTTPClient.\n We try to maintain RestClient compatability in option names as this is what we used before.", "Send request, and leave a reference to the response for debugging purposes", "Check if the provided doc is nil or special IO device or temp file. If not,\n encode it into a string.\n\n The options supported are:\n * :raw TrueClass, if true the payload will not be altered.", "Provide JSON data hash that can be stored in the database.\n Will go through each attribute value and request the `as_couch_json` method\n on each if available, or return the value as-is.", "Creates the database if it doesn't exist", "Retrive an unused UUID from CouchDB. Server instances manage caching a list of unused UUIDs.", "Send a GET request.", "Send a PUT request.", "Send a DELETE request.", "Replicates via \"pulling\" from another database to this database. Makes no attempt to deal with conflicts.", "Replicates via \"pushing\" to another database. Makes no attempt to deal with conflicts.", "== Retrieving and saving single documents\n GET a document from CouchDB, by id. Returns a Document, Design, or raises an exception\n if the document does not exist.", "POST an array of documents to CouchDB. If any of the documents are\n missing ids, supply one from the uuid cache.\n\n If called with no arguments, bulk saves the cache of documents to be bulk saved.", "Updates the given doc by yielding the current state of the doc\n and trying to update update_limit times. Returns the doc\n if successfully updated without hitting the limit.\n If the limit is reached, the last execption will be raised.", "PUT an attachment directly to CouchDB, expects an IO object, or a string\n that will be converted to a StringIO in the 'file' parameter.", "DELETE an attachment directly from CouchDB", "Cast an individual value", "Initialize a new instance of a property's type ready to be\n used. If a proc is defined for the init method, it will be used instead of\n a normal call to the class.", "Create a front end in your rails router.", "Restores a previously soft-deleted document. Handles this by removing the\n deleted_at flag.\n\n @example Restore the document from deleted state.\n   document.restore\n\n For resoring associated documents use :recursive => true\n @example Restore the associated documents from deleted state.\n   document.restore(:recursive => true)\n\n TODO: @return [ Time ] The time the document had been deleted.\n\n @since 1.0.0", "Replace non-white-listed addresses with these sanitized addresses.\n Allow good listed email addresses, and then remove the bad listed addresses", "display colorset on IRuby notebook as a html table\n @return [String] generated html", "generate static html file\n @return [String] generated html", "export static html file", "Add diagram with Array\n @param [Symbol] type the type of diagram to add\n @param [Array<Array>] *data array from which diagram is created\n @example\n    plot.add(:surface, [0,1,2], [0,1,2], [0,1,2])", "Add diagram with DataFrame\n @param [DataFrame] DataFrame from which diagram is created\n @param [Symbol] type the type of diagram to add\n @param [Array<Symbol>] *labels column labels for x, y or some other dimension\n @example\n    df = Nyaplot::DataFrame.new({x: [0,1,2], y: [0,1,2], z: [0,1,2]})\n    plot.add(df, :surface, :x, :y, :z)", "export html file", "Returns an array of those manifests from the previous spec which should be kept,\n   based on inspecting the new spec against the locked resolution from the previous spec.", "Straightforward breadth-first graph traversal algorithm.", "finds templatable page that works for path", "Entity should respond to \"slug\"", "Create a new level instance.\n\n @example Enable all severities\n   Yell::Level.new\n\n @example Pass the minimum possible severity\n   Yell::Level.new :warn\n\n @example Pass an array to exactly set the level at the given severities\n   Yell::Level.new [:info, :error]\n\n @example Pass a range to set the level within the severities\n   Yell::Level.new (:info..:error)\n\n @param [Integer,String,Symbol,Array,Range,nil] severity The severity for the level.\n Set the severity to the given format", "Creates a div around the object and yields a builder.\n\n Example:\n\n   show_for @user do |f|\n     f.attribute :name\n     f.attribute :email\n   end", "Get plain response body and parse the XML doc", "Execute the call - returns response body or redirect url", "Get the URL for the call", "Create an exception with code & message", "Loads the StoryFormat with the specified name\n Given a story file, injects it into the StoryFormat and returns the HTML results", "Runs HAML, Coffeescript etc. preprocessors across each applicable passage", "This method simply checks that either id or name is supplied\n\n Some examples:\n\n # checks for a --id or --name option\n validate_id_or_name\n # checks for --content-view-id or --content-view-name\n validate_id_or_name :content_view", "Call an event's callbacks with provided arguments.", "Remove an specific callback on an event,\n or all an event's callbacks.", "Set the paths from which Bowline will automatically load source files, and\n the load_once paths.", "Create a new Configuration instance, initialized with the default values.\n Set the root_path to APP_ROOT and canonicalize it.", "Loop though all targets in the pod\n generate a collection of hashes", "Collect assets based on manifest", "Convert an asset with a given converter class", "Compress assets if compressor is defined", "Create Gzip versions of assets", "Save assets to file", "Create a new QueueCollection at +path+\n\n Puts +data+ onto the queue named +key+", "Retrieves data from the queue named +key+", "Returns all active queues.", "Retrieves data from the queue.", "Initialize a new Starling server, but do not accept connections or\n process requests.\n\n +opts+ is as for +start+\n\n Start listening and processing requests.", "Creates a new handler for the MemCache protocol that communicates with a\n given client.\n\n Process incoming commands from the attached client.", "Return a child process", "Add a child attachment", "Retrieve the IPv6 sub-net mask assigned to the interface\n\n @return [String] IPv6 netmask\n @raise [ArgumentError] if the given scope is not `:global` or `:link`", "Applies the given static network configuration to the interface\n\n @param ip [String] IPv4 address\n @param mask [String] subnet mask\n @param gw [String] gateway address\n @param dns [Array<String>] list of dns servers\n @param search [Array<String>] list of search domains\n @return [Boolean] true on success, false otherwise\n @raise ArgumentError if an IP is not formatted properly", "Applies the given static IPv6 network configuration to the interface\n\n @param ip [String] IPv6 address\n @param prefix [Number] prefix length for IPv6 address\n @param gw [String] gateway address\n @param dns [Array<String>] list of dns servers\n @param search [Array<String>] list of search domains\n @return [Boolean] true on success, false otherwise\n @raise ArgumentError if an IP is not formatted properly or interface does not start", "Returns the class enhanced by the custom fields.\n Be careful, call this method only if the source class\n has been saved with success.\n\n @param [ String, Symbol ] name The name of the relation.\n\n @return [ Class ] The modified class.", "Collects all the modifications of the custom fields\n\n @param [ String, Symbol ] name The name of the relation.\n\n @return [ Array ] An array of hashes storing the modifications", "Apply the modifications collected from the custom fields by\n updating all the documents of the relation.\n The update uses the power of mongodb to make it fully optimized.\n\n @param [ String, Symbol ] name The name of the relation.", "If the localized attribute has been changed in at least one of the custom fields,\n we have to upgrade all the records enhanced by custom_fields in order to make\n the values consistent with the mongoid localize option.\n\n Ex: post.attributes[:name] = 'Hello world' => post.attributes[:name] = { en: 'Hello world' }\n\n @param [ String, Symbol ] name The name of the relation.", "Return the list of the getters dynamically based on the\n custom_fields recipe in order to get the formatted values\n of the custom fields.\n If a block is passed, then the list will be filtered accordingly with\n the following logic. If the block is evaluated as true, then the method\n will be kept in the list, otherwise it will be removed.\n\n @example\n   # keep all the methods except for the field named 'foo'\n   project.custom_fields_methods do |rule|\n     rule['name] != 'foo'\n   end\n\n @return [ List ] a list of method names (string)", "List all the setters that are used by the custom_fields\n in order to get updated thru a html form for instance.\n\n @return [ List ] a list of method names (string)", "Build a hash for all the non-relationship fields\n meaning string, text, date, boolean, select, file types.\n This hash stores their name and their value.\n\n @return [ Hash ] Field name / formatted value", "Check if the rule defined by the name is a \"many\" relationship kind.\n A \"many\" relationship includes \"has_many\" and \"many_to_many\"\n\n @param [ String ] name The name of the rule\n\n @return [ Boolean ] True if the rule is a \"many\" relationship kind.", "Sets up a connection to the collector.\n\n  Instrumental::Agent.new(API_KEY)\n  Instrumental::Agent.new(API_KEY, :collector => 'hostname:port')\n Store a gauge for a metric, optionally at a specific time.\n\n  agent.gauge('load', 1.23)", "Store the duration of a block in a metric. multiplier can be used\n to scale the duration to desired unit or change the duration in\n some meaningful way.\n\n  agent.time('response_time') do\n    # potentially slow stuff\n  end\n\n  agent.time('response_time_in_ms', 1000) do\n    # potentially slow stuff\n  end\n\n  ids = [1, 2, 3]\n  agent.time('find_time_per_post', 1 / ids.size.to_f) do\n    Post.find(ids)\n  end", "Called when a process is exiting to give it some extra time to\n push events to the service. An at_exit handler is automatically\n registered for this method, but can be called manually in cases\n where at_exit is bypassed like Resque workers.", "Check and optionally convert a signature to a normalized lower-S form. If\n check_only is `true` then the normalized signature is not returned.\n\n This function always return a tuple containing a boolean (`true` if not\n previously normalized or `false` if signature was already normalized),\n and the normalized signature. When check_only is `true`, the normalized\n signature returned is always `nil`.", "Add a number of public keys together.", "Retrieve data for this room", "Update a room", "Delete a room", "Invite user to this room", "Add member to this room", "Get a list of members in this room\n This is all people who have been added a to a private room", "Get a list of participants in this room\n This is all people currently in the room", "Send a message to this room.\n\n Usage:\n\n   # Default\n   send 'some message'", "Send a notification message to this room.\n\n Usage:\n\n   # Default\n   send 'nickname', 'some message'\n\n   # Notify users and color the message red\n   send 'nickname', 'some message', :notify => true, :color => 'red'\n\n   # Notify users (deprecated)\n   send 'nickname', 'some message', true\n\n Options:\n\n +color+::  \"yellow\", \"red\", \"green\", \"purple\", or \"random\"\n            (default \"yellow\")\n +notify+:: true or false\n            (default false)", "Send a file to this room.\n\n Usage:\n\n   # Default\n   send_file 'nickname', 'some message', File.open(\"/path/to/file\")", "Change this room's topic\n\n Usage:\n\n   # Default\n   topic 'my awesome topic'\n\n Options:\n\n +from+::  the name of the person changing the topic\n            (default \"API\")", "Pull this room's history\n\n Usage\n\n   # Default\n\n\n Options\n\n +date+::     Whether to return a specific day (YYYY-MM-DD format) or recent\n                (default \"recent\")\n +timezone+:: Your timezone.  Supported timezones are at: https://www.hipchat.com/docs/api/timezones\n                (default \"UTC\")\n +format+::   Format to retrieve the history in.  Valid options are JSON and XML\n                (default \"JSON\")", "Pull this room's statistics", "Create a webhook for this room\n\n Usage:\n\n   # Default\n   create_webhook 'http://example.org/path/to/my/webhook', 'room_event'\n\n Options:\n\n +pattern+::  The regular expression pattern to match against messages. Only applicable for message events.\n                (default \"\")\n +name+::     The label for this webhook\n                (default \"\")", "Delete a webhook for this room\n\n Usage:\n\n   # Default\n   delete_webhook 'webhook_id'", "Gets all webhooks for this room\n\n Usage:\n\n   # Default\n   get_all_webhooks\n\n Options:\n\n +start-index+::  The regular expression pattern to match against messages. Only applicable for message events.\n                (default \"\")\n +max-results+::     The label for this webhook\n                (default \"\")", "Get a webhook for this room\n\n Usage:\n\n   # Default\n   get_webhook 'webhook_id'", "\"id\", \"term\", \"score\", \"aliases\", \"data\"", "remove only cares about an item's id, but for consistency takes an object", "Send a private message to user.", "Send a private file to user.", "Get a user's details.", "Getting all rooms details in which user is present", "Builds a multipart file body for the api.\n\n message - a message to attach\n file - a File instance", "Returns the scopes for the Auth token\n\n Calls the endpoint:\n\n   https://api.hipchat.com/v2/oauth/token/#{token}\n\n   The response is a JSON object containing a client key. The client\n   object contains a list of allowed scopes.\n\n   There are two possible response types, for a global API token, the\n   room object will be nil. For a room API token, the room object will\n   be populated:\n\n Optional room parameter can be passed in. The method will return the\n following:\n\n   - if it's a global API token and room param is nil: scopes\n   - if it's a global API token and room param is not nil: scopes\n   - if it's a room API token and room param is nil: nil\n   - if it's a room API token and room param is not nil\n       - if room param's room_id matches token room_id: scopes\n       - if room param's room_id doesn't match token room_id: nil\n\n Raises errors if response is unrecognizable", "Adds a backtrace to this span\n\n @param limit [Integer] Limit the backtrace to the top <limit> frames", "Log an error into the span\n\n @param e [Exception] The exception to be logged", "Helper method to add multiple tags to this span\n\n @params tags [Hash]\n @return [Span]", "Retrieve the hash of tags for this span", "Should we reduce this image with KDU?", "The data we get back from kdu_expand is a bmp and we need to change it\n to the requested format by calling Imagemagick.", "Create a clone of the Transformation, without the crop\n @return [IIIF::Image::Transformation] a new transformation", "Create a clone of this Transformation, scaled by the factor\n @param [IIIF::Image::Transformation] transformation the transformation to clone\n @param [Integer] factor the scale for the new transformation\n @return [Transformation] a new transformation, scaled by factor", "Sets up periodic timers and starts the agent in a background thread.", "Starts the timer loop for the timers that were initialized\n in the setup method.  This is blocking and should only be\n called from an already initialized background thread.", "Collect process ID, name and arguments to notify\n the host agent.", "Method to report metrics data to the host agent.\n\n @param paylod [Hash] The collection of metrics to report.\n\n @return [Boolean] true on success, false otherwise", "Accept and report spans to the host agent.\n\n @param traces [Array] An array of [Span]\n @return [Boolean]", "Check that the host agent is available and can be contacted.  This will\n first check localhost and if not, then attempt on the default gateway\n for docker in bridged mode.", "Tracing blocks API methods\n\n Will start a new trace or continue an on-going one (such as\n from incoming remote requests with context headers).\n\n @param name [String] the name of the span to start\n @param kvs [Hash] list of key values to be reported in the span\n @param incoming_context [Hash] specifies the incoming context.  At a\n   minimum, it should specify :trace_id and :span_id from the following:\n     @:trace_id the trace ID (must be an unsigned hex-string)\n     :span_id the ID of the parent span (must be an unsigned hex-string)\n     :level specifies data collection level (optional)", "Trace a block of code within the context of the exiting trace\n\n Example usage:\n\n ::Instana.tracer.trace(:dbwork, { :db_name => @db.name }) do\n   @db.select(1)\n end\n\n @param name [String] the name of the span to start\n @param kvs [Hash] list of key values to be reported in this new span", "Lower level tracing API methods\n\n Will start a new trace or continue an on-going one (such as\n from incoming remote requests with context headers).\n\n @param name [String] the name of the span to start\n @param kvs [Hash] list of key values to be reported in the span\n @param incoming_context [Hash] specifies the incoming context.  At a\n   minimum, it should specify :trace_id and :span_id from the following:\n     :trace_id the trace ID (must be an unsigned hex-string)\n     :span_id the ID of the parent span (must be an unsigned hex-string)\n     :level specifies data collection level (optional)", "Closes out the current span\n\n @note `name` isn't really required but helps keep sanity that\n we're closing out the span that we really want to close out.\n\n @param name [String] the name of the span to exit (close out)\n @param kvs [Hash] list of key values to be reported in the span", "Closes out the current span in the current trace\n and queues the trace for reporting\n\n @note `name` isn't really required but helps keep sanity that\n we're ending the span that we really want to close out.\n\n @param name [String] the name of the span to end\n @param kvs [Hash] list of key values to be reported in the span", "Add info to an asynchronous span\n\n @param kvs [Hash] list of key values to be reported in the span\n @param span [Span] the span for this Async op (previously returned\n   from `log_async_entry`)", "Add an error to an asynchronous span\n\n @param e [Exception] Add exception to the current span\n @param span [Span] the span for this Async op (previously returned\n   from `log_async_entry`)", "Closes out an asynchronous span\n\n @param name [String] the name of the async span to exit (close out)\n @param kvs [Hash] list of key values to be reported in the span\n @param span [Span] the span for this Async op (previously returned\n   from `log_async_entry`)", "Inject a span into the given carrier\n\n @param span_context [SpanContext]\n @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]\n @param carrier [Carrier]", "Extract a span from a carrier\n\n @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]\n @param carrier [Carrier]\n\n @return [SpanContext]", "Adds a trace to the queue to be processed and\n sent to the host agent\n\n @param [Trace] the trace to be added to the queue", "Retrieves a single staged trace from the staging queue.  Staged traces\n are traces that have completed but may have outstanding\n asynchronous spans.\n\n @param trace_id [Integer] the Trace ID to be searched for", "Initializes a new instance of Trace\n\n @param name [String] the name of the span to start\n @param kvs [Hash] list of key values to be reported in the span\n @param incoming_context [Hash] specifies the incoming context.  At a\n   minimum, it should specify :trace_id and :span_id from the following:\n     :trace_id the trace ID (must be an unsigned hex-string)\n     :span_id the ID of the parent span (must be an unsigned hex-string)\n     :level specifies data collection level (optional)\n\n Start a new span as a child of @current_span\n\n @param name [String] the name of the span to start\n @param kvs [Hash] list of key values to be reported in the span", "Log an error into the current span\n\n @param e [Exception] Add exception to the current span", "Close out the current span and set the parent as\n the current span\n\n @param kvs [Hash] list of key values to be reported in the span", "End an asynchronous span\n\n @param name [Symbol] the name of the span\n @param kvs [Hash] list of key values to be reported in the span\n @param span [Span] the span of this Async op (previously returned\n   from `log_async_entry`)", "Adds the passed in backtrace to the specified span.  Backtrace can be one\n generated from Kernel.caller or one attached to an exception\n\n @param bt [Array] the backtrace\n @param limit [Integer] Limit the backtrace to the top <limit> frames\n @param span [Span] the span to add the backtrace to or if unspecified\n   the current span", "Return value of param if it exists, nil otherwise.", "Returns the controller's model", "Used to proxy all method and attribute requests not implemented on the controller\n to the model.\n\n On first call of a missing method a method is generated to avoid the missing lookup\n next time, this should be faster for repeated lookups of the same method, e.g. reg", "Check if the current IP has a spec", "Return a hash based on the filter provided", "Tests that the block format for defining registers works", "Add a register.\n When adding a register you must supply a name, an address, size in bits, and bit definitions,\n any bits that are not declared will be filled with dummy bit objects that are\n not writable and will read back as 0.\n\n @example\n             Name    Address  Size   Bit Definitions\n   add_reg :control,  0x00,    16    :mode    => { :pos => 8, :bits => 8 },\n                                     # Leaving out bits does 1 by default\n                                     :launch  => { :pos => 6 },\n                                     # The default reset state is 0, specify an alternative..\n                                     :status  => { :pos => 4, :bits => 2, :res => 0b11 },\n                                     :fail    => { :pos => 2 },\n                                     :done    => { :pos => 0 }\n\n Can be called on any object to add a register to it", "Called within an add_reg block to define bits", "Can be called to add app specific meta data that is isolated to all registers\n defined within a given class", "Returns true if the object contains a register matching the given name", "Returns\n  -the register object matching the given name\n  -or a hash of all registes matching a given regular expression\n  -or a hash of all registers, associated with a feature, if no name is specified.\n\n Can also be used to define a new register if a block is supplied in which case\n it is equivalent to calling add_reg with a block.", "Cycle through all targets in the upcoming run to ensure\n that all output directories exist", "Returns a full path to the regression command file within the local application", "Adds a new item to the componentable container.\n @note All options added will be passed to the subclasses instantiation.\n @note The options is only valid for the stock :add method.\n @note Any extra options provided are still passed to the subclasses instantiation.\n @param name [Symbol] Name to reference the new component object.\n @param options [Hash] Customizations for both the add method and for the class's instantiation.\n @option options [Class, String] class_name The class to instaniate the component at :name as.\n @return [ComponentableObject] The instantiated class at :name\n @raise [Origen::Componentable::NameInUseError] Raised if :name already points to a component.", "Moves a component object from one name to another.\n @param to_move [Symbol] Component name to move elsewhere.\n @param new_name [Symbol] New name to give to the component from :to_move.\n @return [Symbol] The component moved.\n @raise [Origen::Componentable::NameInUseError] Raised if :new_name is already in use and the :override option is not specified.\n @raise [Origen::Componentable::NameDoesNotExistsError] Raised if :to_move name does not exists.", "Deletes a component from the componentable container\n @param name [Symbol] Name of component to delete\n @return [Hash(Symbol, <ComponentableItem>)]  containing the name of the component deleted and its component.\n @raise [Origen::Componentable::NameDoesNotExistsError] Raised if :to_copy name does not exists.", "Deletes all of the components in the container.\n @return [Hash(Symbol, <ComponentableItem>)] Hash containing all of the deleted items.", "This will be called whenever an object that includes this module\n is instantiated\n\n @api private", "Returns true if the given sub block owns at least one register", "Used to create attribute accessors on the fly.\n\n On first call of a missing method a method is generated to avoid the missing lookup\n next time, this should be faster for repeated lookups of the same method, e.g. reg", "Adds a new documentation notion to the block", "Adds a new feature to the block", "Returns a Note object from the notes hash", "Method to print a spec table to the console", "Parses maillist file and returns an array of email address", "Returns the server data packet available for the given application,\n returns nil if none is found", "Returns the release date for the current or given application version", "Enable for debugging to see what the currently tracked objects are\n def object_store\n  [@load_event, @static_resources, @transient_resources]\n end", "This will be called by the Origen release process to post\n the latest app version information to the server", "Set the current mode configuration of the current model", "Returns an array containing the IDs of all known modes if no ID is supplied,\n otherwise returns an object representing the given mode ID", "Executes the given block of code for each known chip mode, inside the block\n the current mode of the top level block will be set to the given mode.\n\n At the end of the block the current mode will be restored to whatever it\n was before entering the block.", "Returns all specs found for the model.  if none found it returns an empty array", "Delete all specs and notes for self recursively", "Used to proxy all method and attribute requests not implemented on the model\n to the controller.\n\n On first call of a missing method a method is generated to avoid the missing lookup\n next time, this should be faster for repeated lookups of the same method, e.g. reg", "Returns a user object representing the current user, will return a default\n user object if the current user is not known to the generator", "Returns a numeric representation of the version, this can be used\n for chronological comparison with other versions", "Returns the version as a time, only applicable for timestamps,\n otherwise an error will be raised", "Validates the given condition and the extracted tag, returns the\n tag wrapped in a VersionString if valid, will raise an error if\n not", "Manually handle symlink deletion to support windows\n @api private", "Process each remote", "Returns true if the given import is currently setup as a path", "Makes all dirty remotes clean", "If the supplied tag looks like a semantic version number, then make sure it has the\n 'v' prefix", "Use this to specify the current package option for the given SoC.\n\n This allows different pin configurations to be specified by package.", "Returns an array containing the IDs of all known configurations if no ID is supplied,\n otherwise returns an object representing the given package ID", "Define and instantiate an erratum object", "Returns an erratum or list of erratum that meet a specific criteria", "Define and instantiate a sw_workaround object", "Returns a sw_workaround object with a specific id", "Dynamically add a new site variable at the highest priority.", "Dynamically add a new site variable at the lowest priority.\n Essentially, this sets a new default value.", "Gets all config variables as a hash, but the hash's values are the Config instances which defines the highest\n priority of each var, instead of the var's value itself.", "Forces a reparse of the site configs.\n This will set the configs along the current path first,\n then, using those values, will add a site config at the home directory.", "Returns the contents of the given list file in an array, if it\n can be found, if not will raise an error", "Returns a full path to the given file or directory, raises an error if it\n can't be resolved", "Returns an absolute path for the given", "If the current path looks like it is a reference to an import, the\n path will be replaced with the absolute path to the local import directory", "Insert _ in file name if not present", "Returns the sub directory of the current base directory that the\n given file is in", "Convenience method to use when you want to write to a file, this takes\n care of ensuring that the directory exists prior to attempting to open\n the file", "Returns true if the version of the IP represented by the object has the bug of the\n given name", "Set the logger level, for valid values see LEVELS", "Sends the given method and arguments to all file logger instances", "Specify the order that pins will appear in the output pattern, unspecified\n pins will appear in an arbitrary order at the end\n\n API v2, deprecated", "Equivalent to the all_pins method but considers power pins rather than regular pins", "Equivalent to the all_pins method but considers other pins rather than regular pins", "Equivalent to the pins method but considers power pins rather than regular pins", "Equivalent to the pins method but considers ground pins rather than regular pins", "Equivalent to the pins method but considers other pins rather than regular pins", "Equivalent to the pins method but considers virtual pins rather than regular pins", "Delete any pin or pin group.  If arg is a pin then delete the pin and any instances\n of it in any pin groups", "Render an ERB template", "Returns an array of the names of all associated features", "allows us to override ratings in cases where they make the robot look stupid", "Starts a new span.\n\n @param operation_name [String] The operation name for the Span\n @param child_of [SpanContext] SpanContext that acts as a parent to\n        the newly-started Span. If a Span instance is provided, its\n        .span_context is automatically substituted.\n @param references [Array<SpanContext>] An array of SpanContexts that\n         identify any parent SpanContexts of newly-started Span. If Spans\n         are provided, their .span_context is automatically substituted.\n @param start_time [Time] When the Span started, if not now\n @param tags [Hash] Tags to assign to the Span at start time\n @param ignore_active_scope [Boolean] whether to create an implicit\n   References#CHILD_OF reference to the ScopeManager#active.\n @return [Span]", "Extract a SpanContext from a carrier\n @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]\n @param carrier [Carrier] A carrier object of the type dictated by the specified `format`\n @return [SpanContext] the extracted SpanContext or nil if none could be found", "Set all baggage at once. This will reset the baggage to the given param.\n @param baggage [Hash] new baggage for the span", "Hash representation of a span", "Make a span instance active.\n\n @param span [Span] the Span that should become active\n @param finish_on_close [Boolean] whether the Span should automatically be\n   finished when Scope#close is called\n @return [Scope] instance to control the end of the active period for the\n  Span. It is a programming error to neglect to call Scope#close on the\n  returned instance.", "Configure the Instagram class in preparation requests.\n\n @options opts [String] :client_id (Lentil::Engine::APP_CONFIG[\"instagram_client_id\"]) The Instagram client ID\n @options opts [String] :client_secret (Lentil::Engine::APP_CONFIG[\"instagram_client_secret\"]) The Instagram client secret\n @options opts [String] :access_token (nil) The optional Instagram client ID", "Configure the Instagram class in preparation for leaving comments\n\n @param  access_token = nil [String] Instagram access token for the writing account", "Queries the Instagram API for recent images with a given tag.\n\n @param [String] tag The tag to query by\n\n @return [Hashie::Mash] The data returned by Instagram API", "Produce processed image metadata from Instagram metadata.\n This metadata is accepted by the save_image method.\n\n @param [Hashie::Mash] instagram_metadata The single image metadata returned by Instagram API\n\n @return [Hash] processed image metadata", "Takes return from Instagram API gem and adds image,\n users, and tags to the database.\n\n @raise [DuplicateImageError] This method does not accept duplicate external image IDs\n\n @param [Hash] image_data processed Instagram image metadata\n\n @return [Image] new Image object", "Takes return from Instagram API gem and adds all new images,\n users, and tags to the database.\n\n @param [Hashie::Mash] instagram_load The content returned by the Instagram gem\n @param [Boolean] raise_dupes Whether to raise exceptions for duplicate images\n\n @raise [DuplicateImageError] If there are duplicate images and raise_dupes is true\n\n @return [Array] New image objects", "Retrieve the binary image data for a given Image object\n\n @param [Image] image An Image model object from the Instagram service\n\n @raise [Exception] If there are request problems\n\n @return [String] Binary image data", "Retrieve the binary video data for a given Image object\n\n @param [Image] image An Image model object from the Instagram service\n\n @raise [Exception] If there are request problems\n\n @return [String] Binary video data", "Leave a comment containing the donor agreement on an Instagram image\n\n @param  image [type] An Image model object from the Instagram service\n\n @raise [Exception] If a comment submission fails\n @authenticated true\n\n @return [Hashie::Mash] Instagram response", "Takes image object and returns a popularity score\n\n @param [object] image object with image data\n\n @return [integer] popularity score of image", "Takes an image id and updates its popularity score\n\n @param [integer] id of image to update defaults to :all\n\n @return [boolean] success/failure of update", "Given a list of zip codes, looks up what city and state they are associated with.\n\n The USPS api is only capable of handling at most 5 zip codes per request.", "Create a DSL method to set a certain config property. The\n generated method will take either a plain value, or a block,\n which will be captured and stored instead.", "Forward a method to the config object. This assumes the method\n will return an updated config instance.\n\n Either takes a list of methods to forward, or a mapping (hash)\n of source to destination method name.", "Generate a DSL method that creates a certain type of domain\n object, and adds it to a list on the config.\n\n     def_add :fieldset, create: Fieldset, append_to: :fields\n\n This will generate a `fieldset` method, which will call\n `Fieldset.create`, and append the result to `config.fields`", "Derives a mapper from the given collection.\n\n @param collection [Object]\n @return [Class] A mapper, typically a subclass of Yaks::Mapper", "Derives a mapper from the given item. This item should not\n be a collection.\n\n @param item [Object]\n @return [Class] A mapper, typically a subclass of Yaks::Mapper\n\n @raise [RuntimeError] only occurs when no mapper is found for the given item.", "Returns this document's root node. Returns `self` if the\n current document is a root node\n\n @example\n   node = Node.find(...)\n   node.root\n\n @return [Mongoid::Document] The documents root node", "Nullifies all children's parent_id\n\n @return [undefined]", "Updates the parent_ids and marks the children for\n rearrangement when the parent_ids changed\n\n @private\n @return [undefined]", "Does the mangling xcconfig need to be updated?\n @return  [Truthy] Does the xcconfig need to be updated?", "Update all pod xcconfigs to use the mangling defines", "Update a mangling config to use the mangling defines\n @param    [String] pod_xcconfig_path\n           Path to the pod xcconfig to update", "Adds the Pods project to the RubyMotion config as a vendored project and", "Performs a CocoaPods Installation.\n\n For now we only support one Pods target, this will have to be expanded\n once we work on more spec support.\n\n Let RubyMotion re-generate the BridgeSupport file whenever the list of\n installed pods changes.", "Do not copy `.framework` bundles, these should be handled through RM's\n `embedded_frameworks` config attribute.", "Mixes in struct behavior to the current class.", "Returns an array of all minimum cycles in a graph\n\n This is not an efficient implementation O(n^4) and could\n be done using Minimum Spanning Trees. Hint. Hint.", "Parses the given text.\n\n @param [String] body (self.body) The text to parse\n @return [Sexp, NilClass] the sexp representing the input text.", "Finds all sexps of the given type in the given Sexp tree.\n\n @param [Symbol] type the type of sexp to search for\n @param [Sexp] tree (self.parse(self.body)) The tree to search in. Leave\n   blank to search the entire body.\n @return [Array<Sexp>] all sexps in the input tree (or whole body) that\n   are of the given type.", "class TarjanSccVisitor\n This is Tarjan's algorithm for strongly connected components, from his\n paper \"Depth first search and linear graph algorithms\".  It calculates\n the components in a single application of DFS.  We implement the\n algorithm with the help of the DFSVisitor TarjanSccVisitor.\n\n === Definition\n\n A _strongly connected component_ of a directed graph G=(V,E) is a\n maximal set of vertices U which is in V, such that for every pair of\n vertices u and  v in U, we have both a path from u to v and a path\n from v to u. That is to say, u and v are reachable from each other.\n\n @Article{Tarjan:1972:DFS,\n   author =       \"R. E. Tarjan\",\n   key =          \"Tarjan\",\n   title =        \"Depth First Search and Linear Graph Algorithms\",\n   journal =      \"SIAM Journal on Computing\",\n   volume =       \"1\",\n   number =       \"2\",\n   pages =        \"146--160\",\n   month =        jun,\n   year =         \"1972\",\n   CODEN =        \"SMJCAT\",\n   ISSN =         \"0097-5397 (print), 1095-7111 (electronic)\",\n   bibdate =      \"Thu Jan 23 09:56:44 1997\",\n   bibsource =    \"Parallel/Multi.bib, Misc/Reverse.eng.bib\",\n }\n\n The output of the algorithm is recorded in a TarjanSccVisitor _vis_.\n vis.comp_map will contain numbers giving the component ID assigned to\n each vertex. The number of components is vis.num_comp.", "The each_edge iterator should provide efficient access to all edges of the\n graph. Its defines the EdgeListGraph concept.\n\n This method must _not_ be defined by concrete graph classes, because it\n can be implemented using each_vertex and each_adjacent. However for\n undirected graph the function is inefficient because we must not yield\n (v,u) if we already visited edge (u,v).", "Processes the global options, which includes picking which warnings to\n run against the source code. The settings provided determine what\n modifies the runner's settings.\n\n @param [Hash] settings the settings from the command-line to process.\n @option settings :only (String) a list of warning names or short names\n   that will be the only warnings run. The names should be whitespace-delimited.\n @option settings :\"line-length\" (Integer) a maximum line length to\n   generate a warning for. A common choice is 80/83.", "Parses the command-line options using Trollop\n\n @return [Hash{Symbol => Object}] the settings entered by the user", "Gets all the options from the warning plugins and collects them\n with overriding rules. The later the declaration is run, the higher the\n priority the option has.", "Prints the known modules after analysis.", "Converts a list of warnings and symbol shortcuts for warnings to just a\n list of warnings.", "Collects warnings from all the provided files by running them through\n the scanner.\n\n @param [Array<String>] files the files to scan. If (stdin) is in the\n   array, then data will be read from STDIN until EOF is reached.\n @param [Scanner] scanner the scanner that will look for warnings\n   in the source text.\n @return [Array<Warning>] a set of warnings, ordered by file.", "Displays warnings using user-provided settings.\n\n @param [Array<Warning>] warnings the warnings generated by the input\n   files, ordered by file\n @param [Hash{Symbol => Object}] settings the user-set display settings", "Attach a map to the visitor which records the distance of a visited\n vertex to the start vertex.\n\n This is similar to BGLs\n distance_recorder[http://www.boost.org/libs/graph/doc/distance_recorder.html].\n\n After the distance_map is attached, the visitor has a new method\n distance_to_root, which answers the distance to the start vertex.", "Returns a DirectedAdjacencyGraph, which represents a BFS search tree\n starting at _v_.  This method uses the tree_edge_event of BFSIterator\n to record all tree edges of the search tree in the result.", "Do a recursive DFS search on the whole graph.  If a block is passed,\n it is called on each _finish_vertex_ event.  See\n strongly_connected_components for an example usage.", "Start a depth first search at vertex _u_.  The block _b_ is called on\n each finish_vertex event.", "Scans the text for warnings.\n\n @param [String] text the input ruby file to scan\n @return [Array[Laser::Warnings]] the warnings generated by the code.\n   If the code is clean, an empty array is returned.", "Finds all matching warnings, and if the user wishes, fix a subset of them.", "Tries to fix the given line with a set of matching warnings for that line.\n May recurse if there are multiple warnings on the same line.", "Returns all warnings that match the line", "Checks for new warnings based on indentation.", "Goes through all line warning subclasses and checks if we got some new\n warnings for a given line", "Lexes the given text.\n\n @param [String] body (self.body) The text to lex\n @return [Array<Array<Integer, Integer>, Symbol, String>] A set of tokens\n   in Ripper's result format. Each token is an array of the form:\n   [[1, token_position], token_type, token_text]. I'm not exactly clear on\n   why the 1 is always there. At any rate - the result is an array of those\n   tokens.", "Finds the first instance of a set of tokens in the body. If no text is\n given to scan, then the full content is scanned.\n\n @param [String] body (self.body) The first parameter is optional: the text\n   to search. This defaults to the full text.\n @param [Symbol] token The rest of the arguments are tokens to search\n   for. Any number of tokens may be specified.\n @return [Array] the token in the form returned by Ripper. See #lex.", "Splits the body into two halfs based on the first appearance of a keyword.\n\n @example\n   split_on_keyword('x = 5 unless y == 2', :unless)\n   # => ['x = 5 ', 'unless y == 2']\n @param [String] body (self.body) The first parameter is optional: the text\n   to search. This defaults to the full text.\n @param [Symbol] token The rest of the arguments are keywords to search\n   for. Any number of keywords may be specified.\n @return [Array<String, String>] The body split by the keyword.", "Splits the body into two halfs based on the first appearance of a token.\n\n @example\n   split_on_token('x = 5 unless y == 2', :on_kw)\n   # => ['x = 5 ', 'unless y == 2']\n @param [String] body (self.body) The first parameter is optional: the text\n   to search. This defaults to the full text.\n @param [Symbol] token The rest of the arguments are tokens to search\n   for. Any number of tokens may be specified.\n @return [Array<String, String>] The body split by the token.", "Convert a general graph to an AdjacencyGraph.  If the graph is directed,\n returns a DirectedAdjacencyGraph; otherwise, returns an AdjacencyGraph.", "Returns a new empty DirectedAdjacencyGraph which has as its edgelist\n class the given class.  The default edgelist class is Set, to ensure\n set semantics for edges and vertices.\n\n If other graphs are passed as parameters their vertices and edges are\n added to the new graph.\n Copy internal vertice_dict", "Converts the adjacency list of each vertex to be of type _klass_. The\n class is expected to have a new contructor which accepts an enumerable as\n parameter.", "Creates a new method that returns the boolean negation of the\n specified method.", "Creates an attr_accessor that defaults to a certain value.", "Creates a DSL-friendly set-and-getter method. The method, when called with\n no arguments, acts as a getter. When called with arguments, it acts as a\n setter. Uses class instance variables - this is not for generating\n instance methods.\n\n @example\n   class A\n     cattr_get_and_setter :type\n   end\n   class B < A\n     type :silly\n   end\n   p B.type  # => :silly", "Returns the dominance frontier of the graph.\n\n If the start node is not provided, it is assumed the receiver is a\n ControlFlowGraph and has an #enter method.\n\n return: Node => Set<Node>", "performs a set intersection of the dominator tree.", "The batch connect template configuration used for this cluster\n @param template [#to_sym, nil] the template type\n @return [Hash] the batch connect configuration", "Build a batch connect template from the respective configuration\n @param context [#to_h] the context used for rendering the template\n @return [BatchConnect::Template] the batch connect template", "Whether the custom feature is allowed based on the ACLs\n @return [Boolean] is this custom feature allowed", "Convert object to hash\n @return [Hash] the hash describing this object", "submits bulk job described by JobTemplate 't'\n and returns an array of job id strings", "run block with JobInfo to finish for each waited session job\n or return JobInfo array if no block was passed", "Very occasionally, we need to get a visitor for another relation, so it makes sense to factor\n these out into a public method despite only being two lines long.", "Schedule a mass mail blast from template", "Schedule a mass mail blast from previous blast", "params\n   blast_id, Fixnum | String\n   name, String\n   list, String\n   schedule_time, String\n   from_name, String\n   from_email, String\n   subject, String\n   content_html, String\n   content_text, String\n   options, hash\n\n updates existing blast", "params\n   list, String\n   date, String\n\n returns:\n   hash, response from server\n Retrieve information about your subscriber counts on a particular list, on a particular day.", "params\n   blast_id, String\n   start_date, String\n   end_date, String\n   options, Hash\n\n returns:\n   hash, response from server\n Retrieve information about a particular blast or aggregated information from all of blasts over a specified date range", "params\n   template, String\n   start_date, String\n   end_date, String\n   options, Hash\n\n returns:\n   hash, response from server\n Retrieve information about a particular blast or aggregated information from all of blasts over a specified date range", "params\n   email, String\n   type, String\n   template, String\n   _when, String\n   options, hash\n\n Add a new alert to a user. You can add either a realtime or a summary alert (daily/weekly).\n _when is only required when alert type is weekly or daily", "params\n   job, String\n   options, hash\n   report_email, String\n   postback_url, String\n   binary_key, String\n\n interface for making request to job call", "params\n   emails, String | Array\n implementation for import_job", "implementation for import job using file upload", "implementation for update job using file upload", "implementation for purchase import job using file upload", "implementation for snapshot job", "implementation for export list job", "Get user by specified key", "params\n   template, String\n   trigger_id, String\n Get an existing trigger", "params\n   template, String\n   time, String\n   time_unit, String\n   event, String\n   zephyr, String\n Create or update a trigger", "params\n   template, String\n   time, String\n   time_unit, String\n   zephyr, String\n Create or update a trigger", "set up our post request", "Create a task\n\n post '/tasks'\n\n Creates a new task\n You can create either a **floating** task or create a **related** task and associate it with one of the resource types below:\n * [Leads](/docs/rest/reference/leads)\n * [Contacts](/docs/rest/reference/contacts)\n * [Deals](/docs/rest/reference/deals)\n\n @param task [Task, Hash] Either object of the Task type or Hash. This object's attributes describe the object to be created.\n @return [Task] The resulting object represting created resource.", "Update a task\n\n put '/tasks/{id}'\n\n Updates task information\n If the specified task does not exist, this query will return an error\n\n @param task [Task, Hash] Either object of the Task type or Hash. This object's attributes describe the object to be updated.\n @return [Task] The resulting object represting updated resource.", "Create a contact\n\n post '/contacts'\n\n Create a new contact\n A contact may represent a single individual or an organization\n\n @param contact [Contact, Hash] Either object of the Contact type or Hash. This object's attributes describe the object to be created.\n @return [Contact] The resulting object represting created resource.", "Update a contact\n\n put '/contacts/{id}'\n\n Updates contact information\n If the specified contact does not exist, the request will return an error\n **Notice** When updating contact tags, you need to provide all tags\n Any missing tag will be removed from a contact's tags\n\n @param contact [Contact, Hash] Either object of the Contact type or Hash. This object's attributes describe the object to be updated.\n @return [Contact] The resulting object represting updated resource.", "Create a call\n\n post '/calls'\n\n Create a new call\n\n @param call [Call, Hash] Either object of the Call type or Hash. This object's attributes describe the object to be created.\n @return [Call] The resulting object represting created resource.", "Update a call\n\n put '/calls/{id}'\n\n Allows to attach a Contact or Lead to an existing Call, or change it\u2019s current association\n\n @param call [Call, Hash] Either object of the Call type or Hash. This object's attributes describe the object to be updated.\n @return [Call] The resulting object represting updated resource.", "Retrieve deal's associated contacts\n\n get '/deals/{deal_id}/associated_contacts'\n\n Returns all deal associated contacts\n\n @param deal_id [Integer] Unique identifier of a Deal\n @param options [Hash] Search options\n @option options [Integer] :page (1) Page number to start from. Page numbering starts at 1, and omitting the `page` parameter will return the first page.\n @option options [Integer] :per_page (25) Number of records to return per page. Default limit is *25* and the maximum number that can be returned is *100*.\n @return [Array<AssociatedContact>] The list of AssociatedContacts for the first page, unless otherwise specified.", "Create an associated contact\n\n post '/deals/{deal_id}/associated_contacts'\n\n Creates a deal's associated contact and its role\n If the specified deal or contact does not exist, the request will return an error\n\n @param deal_id [Integer] Unique identifier of a Deal\n @param associated_contact [AssociatedContact, Hash] Either object of the AssociatedContact type or Hash. This object's attributes describe the object to be created.\n @return [AssociatedContact] The resulting object represting created resource.", "Intantiate a new BaseCRM Sync API V2 high-level wrapper\n\n @param options[Hash] Wrapper options\n @option options [String] :device_uuid Device's UUID.\n @option options [BaseCRM::Client] :client BaseCRM API v2 client instance.\n\n @raise [ConfigurationError] if no device's uuid provided\n @raise [ConfigurationError] if no client instance provided\n\n @return [Sync] New wrapper instance\n\n @see Client\n @see SyncService\n Perform a full synchronization flow.\n See the following example:\n\n   client = BaseCRM::Client.new(access_token: \"<YOUR_ACCESS_TOKEN>\")\n   sync = BaseCRM::Sync.new(client: client, device_uuid: \"<YOUR_DEVICES_UUID>\")\n   sync.fetch do |meta, resource|\n     DB.send(meta.sync.event_type, entity) ? meta.sync.ack : meta.sync.nack\n   end\n\n @param block [Proc] Procedure that will be called for every item in the queue. Takes two input arguments: SyncMeta instance\n   associated with the resource, and the resource. You should use either `SyncQueue#ack` or `SyncQueue#nack` to return value from the block.\n\n @return nil", "Start synchronization flow\n\n post '/sync/start'\n\n Starts a new synchronization session.\n This is the first endpoint to call, in order to start a new synchronization session.\n\n @param device_uuid [String] Device's UUID for which to perform synchronization.\n @return [SyncSession] The resulting object is the synchronization session object or nil if there is nothing to synchronize.", "Get data from queue\n\n get '/sync/{session_id}/queues/main'\n\n Fetch fresh data from the main queue.\n Using session identifier you call continously the `#fetch` method to drain the main queue.\n\n @param device_uuid [String] Device's UUID for which to perform synchronization\n @param session_id [String] Unique identifier of a synchronization session.\n @param queue [String|Symbol] Queue name.\n @return [Array<Array<Meta, Model>>] The list of sync's metadata associated with data and data, or nil if nothing more to synchronize.", "Acknowledge received data\n\n post '/sync/ack'\n\n Send acknowledgement keys to let know the Sync service which data you have.\n As you fetch new data, you need to send acknowledgement keys.\n\n @param device_uuid [String] Device's UUID for which to perform synchronization.\n @param ack_keys [Array<String>] The list of acknowledgement keys.\n @return [Boolean] Status of the operation.", "Create a tag\n\n post '/tags'\n\n Creates a new tag\n **Notice** the tag's name **must** be unique within the scope of the resource_type\n\n @param tag [Tag, Hash] Either object of the Tag type or Hash. This object's attributes describe the object to be created.\n @return [Tag] The resulting object represting created resource.", "Update a tag\n\n put '/tags/{id}'\n\n Updates a tag's information\n If the specified tag does not exist, this query will return an error\n **Notice** if you want to update a tag, you **must** make sure the tag's name is unique within the scope of the specified resource\n\n @param tag [Tag, Hash] Either object of the Tag type or Hash. This object's attributes describe the object to be updated.\n @return [Tag] The resulting object represting updated resource.", "Create a loss reason\n\n post '/loss_reasons'\n\n Create a new loss reason\n <figure class=\"notice\">\n Loss reason's name **must** be unique\n </figure>\n\n @param loss_reason [LossReason, Hash] Either object of the LossReason type or Hash. This object's attributes describe the object to be created.\n @return [LossReason] The resulting object represting created resource.", "Update a loss reason\n\n put '/loss_reasons/{id}'\n\n Updates a loss reason information\n If the specified loss reason does not exist, the request will return an error\n <figure class=\"notice\">\n If you want to update loss reason you **must** make sure name of the reason is unique\n </figure>\n\n @param loss_reason [LossReason, Hash] Either object of the LossReason type or Hash. This object's attributes describe the object to be updated.\n @return [LossReason] The resulting object represting updated resource.", "Create a note\n\n post '/notes'\n\n Create a new note and associate it with one of the resources listed below:\n * [Leads](/docs/rest/reference/leads)\n * [Contacts](/docs/rest/reference/contacts)\n * [Deals](/docs/rest/reference/deals)\n\n @param note [Note, Hash] Either object of the Note type or Hash. This object's attributes describe the object to be created.\n @return [Note] The resulting object represting created resource.", "Update a note\n\n put '/notes/{id}'\n\n Updates note information\n If the note ID does not exist, this request will return an error\n\n @param note [Note, Hash] Either object of the Note type or Hash. This object's attributes describe the object to be updated.\n @return [Note] The resulting object represting updated resource.", "Create a source\n\n post '/sources'\n\n Creates a new source\n <figure class=\"notice\">\n Source's name **must** be unique\n </figure>\n\n @param source [Source, Hash] Either object of the Source type or Hash. This object's attributes describe the object to be created.\n @return [Source] The resulting object represting created resource.", "Create an order\n\n post '/orders'\n\n Create a new order for a deal\n User needs to have access to the deal to create an order\n Each deal can have at most one order and error is returned when attempting to create more\n\n @param order [Order, Hash] Either object of the Order type or Hash. This object's attributes describe the object to be created.\n @return [Order] The resulting object represting created resource.", "Update an order\n\n put '/orders/{id}'\n\n Updates order information\n If the specified order does not exist, the request will return an error\n\n @param order [Order, Hash] Either object of the Order type or Hash. This object's attributes describe the object to be updated.\n @return [Order] The resulting object represting updated resource.", "Create a lead\n\n post '/leads'\n\n Creates a new lead\n A lead may represent a single individual or an organization\n\n @param lead [Lead, Hash] Either object of the Lead type or Hash. This object's attributes describe the object to be created.\n @return [Lead] The resulting object represting created resource.", "Update a lead\n\n put '/leads/{id}'\n\n Updates lead information\n If the specified lead does not exist, this query returns an error\n <figure class=\"notice\">\n In order to modify tags, you need to supply the entire set of tags\n `tags` are replaced every time they are used in a request\n </figure>\n\n @param lead [Lead, Hash] Either object of the Lead type or Hash. This object's attributes describe the object to be updated.\n @return [Lead] The resulting object represting updated resource.", "Create a deal\n\n post '/deals'\n\n Create a new deal\n\n @param deal [Deal, Hash] Either object of the Deal type or Hash. This object's attributes describe the object to be created.\n @return [Deal] The resulting object represting created resource.", "Update a deal\n\n put '/deals/{id}'\n\n Updates deal information\n If the specified deal does not exist, the request will return an error\n <figure class=\"notice\">\n In order to modify tags used on a record, you need to supply the entire set\n `tags` are replaced every time they are used in a request\n </figure>\n\n @param deal [Deal, Hash] Either object of the Deal type or Hash. This object's attributes describe the object to be updated.\n @return [Deal] The resulting object represting updated resource.", "Retrieve order's line items\n\n get '/orders/{order_id}/line_items'\n\n Returns all line items associated to order\n\n @param order_id [Integer] Unique identifier of a Order\n @param options [Hash] Search options\n @option options [String] :ids Comma-separated list of line item IDs to be returned in a request.\n @option options [Integer] :quantity Quantity of line item.\n @option options [Integer] :value Value of line item.\n @option options [Integer] :page (1) Page number to start from. Page numbering starts at 1, and omitting the `page` parameter will return the first page.\n @option options [Integer] :per_page (25) Number of records to return per page. Default limit is *25* and the maximum number that can be returned is *100*.\n @option options [String] :sort_by (id:asc) A field to sort by. **Default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=value:desc`.\n @return [Array<LineItem>] The list of LineItems for the first page, unless otherwise specified.", "Create a line item\n\n post '/orders/{order_id}/line_items'\n\n Adds a new line item to an existing order\n Line items correspond to products in the catalog, so first you must create products\n Because products allow defining different prices in different currencies, when creating a line item, the parameter currency is required\n\n @param order_id [Integer] Unique identifier of a Order\n @param line_item [LineItem, Hash] Either object of the LineItem type or Hash. This object's attributes describe the object to be created.\n @return [LineItem] The resulting object represting created resource.", "Retrieve a single line item\n\n get '/orders/{order_id}/line_items/{id}'\n\n Returns a single line item of an order, according to the unique line item ID provided\n\n @param order_id [Integer] Unique identifier of a Order\n @param id [Integer] Unique identifier of a LineItem\n @return [LineItem] Searched resource object.", "Create a product\n\n post '/products'\n\n Create a new product\n\n @param product [Product, Hash] Either object of the Product type or Hash. This object's attributes describe the object to be created.\n @return [Product] The resulting object represting created resource.", "Update a product\n\n put '/products/{id}'\n\n Updates product information\n If the specified product does not exist, the request will return an error\n <figure class=\"notice\"><p>In order to modify prices used on a record, you need to supply the entire set\n <code>prices</code> are replaced every time they are used in a request\n </p></figure>\n\n @param product [Product, Hash] Either object of the Product type or Hash. This object's attributes describe the object to be updated.\n @return [Product] The resulting object represting updated resource.", "Retrieve all deal unqualified reasons\n\n get '/deal_unqualified_reasons'\n\n Returns all deal unqualified reasons available to the user according to the parameters provided\n\n @param options [Hash] Search options\n @option options [String] :ids Comma separated list of deal unqualified reasons unique identifiers to be returned in a request.\n @option options [String] :name Name of the deal unqualified reason to search for. This parameter is used in a strict sense.\n @option options [Integer] :page (1) Page number to start from. Page numbering is 1-based and omitting `page` parameter will return the first page.\n @option options [Integer] :per_page (25) Number of records to return per page. Default limit is *25* and maximum number that can be returned is *100*.\n @option options [String] :sort_by (id:asc) A field to sort by. **Default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=name:desc`.\n @return [Array<DealUnqualifiedReason>] The list of DealUnqualifiedReasons for the first page, unless otherwise specified.", "Create a deal unqualified reason\n\n post '/deal_unqualified_reasons'\n\n Create a new deal unqualified reason\n <figure class=\"notice\">\n Deal unqualified reason's name **must** be unique\n </figure>\n\n @param deal_unqualified_reason [DealUnqualifiedReason, Hash] Either object of the DealUnqualifiedReason type or Hash. This object's attributes describe the object to be created.\n @return [DealUnqualifiedReason] The resulting object represting created resource.", "Update a deal unqualified reason\n\n put '/deal_unqualified_reasons/{id}'\n\n Updates a deal unqualified reason information\n If the specified deal unqualified reason does not exist, the request will return an error\n <figure class=\"notice\">\n If you want to update deal unqualified reason you **must** make sure name of the reason is unique\n </figure>\n\n @param deal_unqualified_reason [DealUnqualifiedReason, Hash] Either object of the DealUnqualifiedReason type or Hash. This object's attributes describe the object to be updated.\n @return [DealUnqualifiedReason] The resulting object represting updated resource.", "Forwards the date the given amount of days.\n\n @param [Numeric] other The days to add\n\n @return [ISO8601::Date] New date resulting of the addition", "Splits the date component into valid atoms.\n\n Acceptable patterns:\n\n * YYYY\n * YYYY-MM but not YYYYMM\n * YYYY-MM-DD, YYYYMMDD\n * YYYY-Www, YYYYWdd\n * YYYY-Www-D, YYYYWddD\n * YYYY-DDD, YYYYDDD\n\n @param [String] input\n\n @return [Array<Integer>]\n rubocop:disable Metrics/AbcSize", "Changes the base to compute the months for the right base year", "Splits a duration pattern into valid atoms.\n\n Acceptable patterns:\n\n * PnYnMnD\n * PTnHnMnS\n * PnYnMnDTnHnMnS\n * PnW\n\n Where `n` is any number. If it contains a decimal fraction, a dot (`.`) or\n comma (`,`) can be used.\n\n @param [String] input\n\n @return [Hash<Float>]", "Fetch the number of seconds of another element.\n\n @param [ISO8601::Duration, Numeric] other Instance of a class to fetch\n   seconds.\n\n @raise [ISO8601::Errors::TypeError] If other param is not an instance of\n   ISO8601::Duration or Numeric classes\n\n @return [Float] Number of seconds of other param Object", "The amount of seconds\n\n TODO: Fractions of year will fail\n\n @param [ISO8601::DateTime, nil] base (nil) The base datetime to compute\n   the year length.\n\n @return [Numeric]\n rubocop:disable Metrics/AbcSize", "Check if a given time is inside the current TimeInterval.\n\n @param [#to_time] other DateTime to check if it's\n   inside the current interval.\n\n @raise [ISO8601::Errors::TypeError] if time param is not a compatible\n   Object.\n\n @return [Boolean]", "Returns true if the interval is a subset of the given interval.\n\n @param [ISO8601::TimeInterval] other a time interval.\n\n @raise [ISO8601::Errors::TypeError] if time param is not a compatible\n   Object.\n\n @return [Boolean]", "Return the intersection between two intervals.\n\n @param [ISO8601::TimeInterval] other time interval\n\n @raise [ISO8601::Errors::TypeError] if the param is not a TimeInterval.\n\n @return [Boolean]", "Parses a subpattern to a correct type.\n\n @param [String] pattern\n\n @return [ISO8601::Duration, ISO8601::DateTime]", "Parses an ISO date time, where the date and the time components are\n optional.\n\n It enhances the parsing capabilities of the native DateTime.\n\n @param [String] date_time The ISO representation\n rubocop:disable Metrics/AbcSize", "Validates the date has the right pattern.\n\n Acceptable patterns: YYYY, YYYY-MM-DD, YYYYMMDD or YYYY-MM but not YYYYMM\n\n @param [String] input A date component\n\n @return [Array<String, nil>]", "If time is provided date must use a complete representation", "Makes a repo with the given name.", "Returns the local git branches; current branch is always first", "Retrieve the decoded value of the contents of a bitmap\n described either by the bitmap number or name.\n\n ===Example\n\n    mes = BlaBlaMessage.parse someMessageBytes\n    mes[2] # bmp 2 is generally the PAN\n    mes[\"Primary Account Number\"] # if thats what you called the field in Message.bmp.", "Returns a nicely formatted representation of this\n message.", "Set the bit to the indicated value. Only `true` sets the\n bit, any other value unsets it.", "Generate the bytes representing this bitmap.", "must send nonblock proc", "Create a form menu.\n\n @param title [String] Text to display on line 0. If nil title won't be\n   displayed and Display.clear won't be called on before the option show.\n @param selection [Hash] Hash (display text => value that will return)\n   containing the list options.\n @param options [Hash] Hash containing options to change the menu behaviour.\n\n @example\n   options = {\n     # default value to return if enter, you can work with complex data.\n     :default => 10,\n     # Add number to label or not\n     :number => true,\n     # Input Timeout in miliseconds\n     :timeout => 30_000\n   }\n\n   selection = {\n     \"option X\" => 10,\n     \"option Y\" => 11\n   }\n\n   menu(\"Option menu\", selection, options)", "Run the editor command for the +method_name+ of +object+.", "Return the editor command for the given file and line.\n\n This is an array of the command with its arguments.", "Open an editor at the named method's definition.\n\n Uses Looksee.editor to determine the editor command to run.\n\n Only works for methods for which file and line numbers are\n accessible.", "Defines region accessor.\n\n @param [Symbol] region_name\n @param [Hash|Proc] in, optional, alias: within\n @param [Class] class, optional, alias: region_class\n @param [Block] block", "Defines multiple regions accessor.\n\n @param [Symbol] region_name\n @param [Hash|Proc] in, optional, alias: within\n @param [Hash] each, required\n @param [Class] class, optional, alias: region_class\n @param [Class] through, optional, alias collection_class\n @param [Block] block, optional", "Authorize client by fetching a new access_token via refresh token\n\n @example\n   client.authorize_from_refresh_token(\"DEF\")\n\n @param [String] refresh_token\n\n @return [OAuth2::AccessToken]\n\n @api public", "Returns the hqmf-parser's ruby implementation of an HQMF document.\n Rebuild from population_criteria, data_criteria, and measure_period JSON", "Returns all of the codes on this datatype in a way that is typical\n to the CQL execution engine.", "Shift all fields that deal with dates by the given value.\n Given value should be in seconds. Positive values shift forward, negative\n values shift backwards.", "Shift dates by the given value.\n Given value should be in seconds. Positive values shift forward, negative\n values shift backwards.\n\n NOTE: This will only shift if @high and @low are DateTimes.", "Shift all data element fields that deal with dates by the given value.\n Given value should be in seconds. Positive values shift forward, negative\n values shift backwards.\n\n Note: This will shift dates of the birthdate and\n dates on the data elements that exist on the patient.", "Ensure fields_for yields a GovukElementsFormBuilder.", "Given an attributes hash that could include any number of arbitrary keys, this method\n ensure we merge one or more 'default' attributes into the hash, creating the keys if\n don't exist, or merging the defaults if the keys already exists.\n It supports strings or arrays as values.", "Update a box\n\n @param [Hash] args\n @param [String] org - organization of the box to read\n @param [String] box_name - name of the box to read\n @return [Hash] @data", "Requests a search based on the given parameters\n\n @param [String] query\n @param [String] provider\n @param [String] sort\n @param [String] order\n @param [String] limit\n @param [String] page\n @return [Hash]", "Create a filter using +block+. In the block you specify\n selectors and actions to be performed on selected nodes. In the\n example below, the selector is \"Image\", which selects all image\n nodes. The action is to prepend the contents of the image's caption\n by the string \"Figure. \".\n\n @param block [Proc] the filter specification\n\n @return [JSON] a JSON string with the filtered pandoc AST\n\n @example Add 'Figure' to each image's caption\n   input = IOString.new(File.read(\"my_report.md\")\n   output = IOString.new\n\n   Paru::Filter.new(input, output).filter do\n       with \"Image\" do |image|\n           image.inner_markdown = \"Figure. #{image.inner_markdown}\"\n       end\n   end", "Specify what nodes to filter with a +selector+. If the +current_node+\n matches that selector, it is passed to the block to this +with+ method.\n\n @param selector [String] a selector string\n @yield [Node] the current node if it matches the selector", "Create a new Selector based on the selector string\n\n @param selector [String] the selector string\n Does node get selected by this Selector in the context of the already filtered\n nodes?\n\n @param node [Node] the node to check against this Selector\n @param filtered_nodes [Array<Node>] the context of filtered nodes to take\n   into account as well\n\n @return [Boolean] True if the node in the context of the\n   filtered_nodes is selected by this Selector", "Look up attributes", "Issues an immediate update of the state with tag \"once\"\n set, but does not update the local state. Useful for transient errors.\n Opts are merged with the state.", "Set the \"slimmer headers\" to configure the page\n\n @param hash [Hash] the options\n @option hash [String] application_name\n @option hash [String] format\n @option hash [String] organisations\n @option hash [String] page_owner\n @option hash [String] remove_search\n @option hash [String] result_count\n @option hash [String] search_parameters\n @option hash [String] section\n @option hash [String] skip\n @option hash [String] template\n @option hash [String] world_locations", "Add a new breakpoint.", "Change the conditional expression for a breakpoint.", "Delete an existing breakpoint with the given ID.", "Delete all breakpoints.", "Cleanup when debugging is stopped and execution continues.", "Adds a task to the current scope", "Delegate to the current object scope", "Generates a command line with command and any tty_option", "Initalizes the blank Fudgefile", "Runs the parsed builds\n @param [String] build_name the given build to run (default 'default')", "Sets builds to an initial empty array\n Adds a build to the current description", "Adds a task group to the current description or includes a task group", "Gets a task group of the given name", "Run the specified build\n\n @param [String] which_build Defaults to 'default'", "times the execution of a block and adds a field containing the duration in milliseconds\n\n @param name [String] the name of the field to add to the event\n @return [self] this event.\n @example\n   event.with_timer \"task_ms\" do\n     # something time consuming\n   end", "Loops through the list of required configurations and raises an error\n if a it can't find all the configuration values set\n @return [nil]", "Loops through the list of required configurations and raises an error\n if a it can't find at least one configuration value set\n @return [nil]", "Raises an error if the setting receives an invalid value\n @param config [String] the value to be assigned\n @param allowed_values [Array] an array of allowed values for the variable\n @return [nil]", "Prints an event", "Enqueue an event to send.  Sampling happens here, and we will create\n new threads to handle work as long as we haven't gone over max_concurrent_batches and\n there are still events in the queue.\n\n @param event [Event] the event to send to honeycomb\n @api private", "Makes a HTTP request after signing the headers\n @return [Hash] the body from the HTTP request", "Build a Response after a completed request.\n\n @param client [BookingSync::API::Client] The client that is\n   managing the API connection.\n @param res [Faraday::Response] Faraday response object\n Turn parsed contents from an API response into a Resource or\n collection of Resources.\n\n @param hash [Hash] A Hash of resources parsed from JSON.\n @return [Array] An Array of Resources.", "Make a HTTP request to a path and returns an Array of Resources\n\n @param method [Symbol] HTTP verb to use.\n @param path [String] The path, relative to {#api_endpoint}.\n @param data [Hash] Data to be send in the request's body\n   it can include query: key with requests params for GET requests\n @param options [Hash] A customizable set of request options.\n @return [Array<BookingSync::API::Resource>] Array of resources.", "Make a HTTP GET or POST request to a path with pagination support.\n\n @param options [Hash]\n @option options [Integer] per_page: Number of resources per page\n @option options [Integer] page: Number of page to return\n @option options [Boolean] auto_paginate: If true, all resources will\n   be returned. It makes multiple requestes underneath and joins the results.\n\n @yieldreturn [Array<BookingSync::API::Resource>] Batch of resources\n @return [Array<BookingSync::API::Resource>] Batch of resources", "Make a HTTP request to given path and returns Response object.\n\n @param method [Symbol] HTTP verb to use.\n @param path [String] The path, relative to {#api_endpoint}.\n @param data [Hash] Data to be send in the request's body\n   it can include query: key with requests params for GET requests\n @param options [Hash] A customizable set of request options.\n @return [BookingSync::API::Response] A Response object.", "Yields client with temporarily modified headers.\n\n @param extra_headers [Hash] Additional headers added to next request.\n @yieldreturn [BookingSync::API::Client] Client with modified default headers.\n @return [Array<BookingSync::API::Resource>|BookingSync::API::Resource|String|Object] Client response", "Process faraday response.\n\n @param faraday_response [Faraday::Response] - A response to process\n @raise [BookingSync::API::Unauthorized] - On unauthorized user\n @raise [BookingSync::API::UnprocessableEntity] - On validations error\n @return [BookingSync::API::Response|NilClass]", "Make an API request with the curent Relation.\n\n @param data [Hash|String] The Optional Hash or Resource body to be sent.\n   :get or :head requests can have no body, so this can be the options Hash\n   instead.\n @param options [Hash] A Hash of option to configure the API request.\n @option options [Hash] headers: A Hash of API headers to set.\n @option options [Hash] query: Hash of URL query params to set.\n @option options [Symbol] method: Symbol HTTP method.\n @return [BookingSync::API::Response]", "Return a Ruby hash that contains models requested by the user's params and allowed\n by the +name+ presenter's configuration.\n\n Pass the returned hash to the render method to convert it into a useful format.\n For example:\n    render :json => brainstem_present(\"post\"){ Post.where(:draft => false) }\n @param (see PresenterCollection#presenting)\n @option options [String] :namespace (\"none\") the namespace to be presented from\n @yield (see PresenterCollection#presenting)\n @return (see PresenterCollection#presenting)", "Returns a proc that takes two arguments, +models+ and +association_names+,\n which, when called, preloads those.\n\n @return [Proc] A callable proc", "Given user params, apply a validated sort order to the given scope.", "Clean and validate a sort order and direction from user params.", "Creates a new instance of the Cli to respond to user input.\n\n Input is expected to be the name of the subcommand, followed by any\n additional arguments.\n\n\n Routes to an application endpoint depending on given options.\n\n @return [Brainstem::Cli] the instance", "assign hash to properties", "assign hash to selectors", "handle class or module\n\n return enclosure", "Recognize speech and yield hypotheses in infinite loop\n\n @param [Fixnum] max_samples Number of samples to process at a time", "Yields as soon as any hypothesis is available", "Decode a raw audio stream as a single utterance, opening a file if path given\n\n See #decode_raw\n\n @param [IO] audio_path_or_file The raw audio stream or file path to decode as a single utterance\n @param [Fixnum] max_samples The maximum samples to process from the stream on each iteration", "Decode a raw audio stream as a single utterance.\n\n No headers are recognized in this files.  The configuration parameters samprate\n and input_endian are used to determine the sampling rate and endianness of the stream,\n respectively.  Audio is always assumed to be 16-bit signed PCM.\n\n @param [IO] audio_file The raw audio stream to decode as a single utterance\n @param [Fixnum] max_samples The maximum samples to process from the stream on each iteration", "Decode raw audio data.\n\n @param [Boolean] no_search If non-zero, perform feature extraction but don't do any\n   recognition yet.  This may be necessary if your processor has trouble doing recognition in\n   real-time.\n @param [Boolean] full_utt If non-zero, this block of data is a full utterance\n   worth of data.  This may allow the recognizer to produce more accurate results.\n @return Number of frames of data searched", "Convert logarithmic probability to linear floating point", "Read next block of audio samples while recording; read upto max samples into buf.\n\n @param [FFI::Pointer] buffer 16bit buffer of at least max_samples in size\n @params [Fixnum] max_samples The maximum number of samples to read from the audio device\n @return [Fixnum] Samples actually read (could be 0 since non-blocking); nil if not\n   recording and no more samples remaining to be read from most recent recording.", "Read next block of audio samples from file; up to max samples into buffer.\n\n @param [FFI::Pointer] buffer 16bit buffer of at least max_samples in size\n @params [Fixnum] max_samples The maximum number of samples to read from the audio file\n @return [Fixnum] Samples actually read; nil if EOF", "returns true if the current thread is one of the threadpool threads", "called from the Client registered callback when an event fires\n\n @note this is *ONLY* dealing with asynchronous callbacks! watchers\n   and session events go through here, NOT anything else!!\n\n @private", "returns true if there's a pending watch of type for path\n @private", "you barely ever need to actually use this method but lets you remove a\n message from the queue by specifying its title\n\n @param [String] message_title the title of the message to remove", "highly destructive method!\n WARNING! Will delete the queue and all messages in it", "how long to wait on thread shutdown before we return", "this is for testing, allows us to wait until this object has gone into\n blocking state.\n\n avoids the race where if we have already been blocked and released\n this will not block the caller\n\n pass optional timeout to return after that amount of time or nil to block\n forever\n\n @return [true] if we have been blocked previously or are currently blocked,\n @return [nil] if we timeout", "this method must be synchronized on @mutex, obviously", "ensures that threshold + 1 nodes are being watched", "This method should be removed once all providers are extracted.\n Bundler will correctly require all dependencies automatically and thus\n fog-core wont need to know any specifics providers. Each provider will\n have to load its dependencies.", "Create a new instance, optionally providing CLI `args` to\n parse immediately.\n Apply these flags to `config`. Returns `config`.", "Construct hash from mutated parameters", "Creates a notification subscription\n\n @note You must check the HTTP response code to check the status of the request to add a subscription.  See {https://wiki.fitbit.com/display/API/Fitbit+Subscriptions+API} for information about what the codes mean.\n\n @param [Hash] opts The notification subscription data\n @option opts [Symbol] :type The type of subscription (valid\n   values are :activities, :foods, :sleep, :body, and :all). REQUIRED\n @option opts [Integer, String] :subscriptionId The subscription id\n\n @return [Integer, Hash] An array containing the HTTP response code and\n   a hash containing confirmation information for the subscription.\n @since v0.4.0", "Removes a notification subscription\n\n @note You must check the HTTP response code to check the status of the request to remove a subscription.  See {https://wiki.fitbit.com/display/API/Fitbit+Subscriptions+API} for information about what the codes mean.\n\n @param [Hash] opts The notification subscription data\n @option opts [Symbol] :type The type of subscription to remove;\n   valid values are :activities, :foods, :sleep, :body, and :all).\n   REQUIRED\n @option opts [Integer, String] :subscription_id The id of the\n   subscription to remove.\n @option opts [Inteter, Stri)g] :subscriber_id The subscriber id of the client\n   application, created via {http://dev.fitbit.com}\n\n @return [Integer, Hash] An array containing the HTTP response code and\n   a hash containing confirmation information for the subscription.\n @since v0.4.0", "Ensures that the type supplied is valid\n\n @param [Symbol] subscription_type The type of subscription;\n   valid values are (:sleep, :body, :activities, :foods, and\n   :all)\n @raise [Fitgem::InvalidArgumentError] Raised if the supplied type\n   is not valid\n @return [Boolean]", "Create the subscription management API url\n\n @param [Hash] opts The options on how to construct the\n   subscription API url\n @option opts [Symbol] :type The type of subscription;\n   valid values are (:sleep, :body, :activities, :foods, and\n   :all)\n @option opts [Symbol] :use_subscription_id If true, then\n   opts[:subscription_id] will be used in url construction\n @option opts [String] :subscription_id The id of the subscription\n   that the URL is for\n @return [String] The url to use for subscription management", "Log weight to fitbit for the current user\n\n @param [Integer, String] weight The weight to log, as either\n   an integer or a string in \"X.XX'\" format\n @param [DateTime, String] date The date the weight should be\n   logged, as either a DateTime or a String in 'yyyy-MM-dd' format\n\n @options opts [DateTime, String] :time The time the weight should be logged\n   as either a DateTime or a String in 'HH:mm:ss' format\n\n @return [Hash]\n\n @since v0.9.0", "Log body fat percentage\n\n @param [Decimal, Integer, String] fatPercentage Body fat percentage to log,\n   in format \"X.XX\" if a string\n @param [DateTime, Date, String] date The date to log body fat percentage on,\n   in format \"yyyy-MM-dd\" if a string\n @param [Hash] opts\n @option opts [DateTime, Time, String] :time The time to log body fat percentage\n   at, in \" HH:mm:ss\" format if a String\n\n @since v0.9.0", "Create or update a user's weight goal\n\n @param [DateTime, Date, String] startDate Weight goal start date;\n   in the format \"yyyy-MM-dd\" if a string\n @param [Decimal, Integer, String] startWeight Weight goal start weight;\n   in the format \"X.XX\" if a string\n @param [Decimal, Integer, String] goalWeight Weight goal target weight;\n   in the format \"X.XX\" if a string\n\n @since v0.9.0", "Determine the URI for the body_weight or body_fat method\n\n @params [String] base_uri the base URI for the body weight or body fat method\n @params [Hash] opts body weight/fat options\n @option opts [Date] date The date in the format YYYY-mm-dd.\n @option opts [Date] base-date The end date when period is provided, in the\n   format yyyy-MM-dd or today; range start date when a date range is provided.\n @option opts [String] period The date range period. One of 1d, 7d, 30d, 1w, 1m\n @option opts [Date] end-date Range end date when date range is provided.\n   Note that period should not be longer than 31 day\n\n @return [String] an URI based on the base URI and provided options", "Create or update a user's weekly goal\n\n @param [Hash] :opts\n\n @option opts [Symbol] :type The type of goal to create or update; must be one of\n   :steps, :distance, or :floors. REQUIRED\n @option opts [Decimal, Integer, String] :value The goal value; in the format 'X.XX'\n   if a string. REQUIRED\n\n @since v0.9.0", "Update an existing alarm\n\n @param [Integer, String] alarm_id The id of the alarm\n @param [Integer, String] device_id The id of the device you would like to\n   manage the alarm on\n @param [Hash] opts Alarm settings\n @option opts [DateTime, Time, String] :time Time of the alarm\n @option opts [TrueClass, FalseClass] :enabled\n @option opts [TrueClass, FalseClass] :recurring One time or recurring alarm\n @option opts [String] :weekDays The days the alarm is active on as a list of\n   comma separated values: MONDAY, WEDNESDAY, SATURDAY. For recurring only\n @option opts [Integer] :snoozeLength Minutes between the alarms\n @option opts [Integer] :snoozeCount Maximum snooze count\n @option opts [String] :label Label for the alarm\n\n @return [Hash] Hash containing updated alarm settings", "Format any of a variety of time-related types into the formatted string\n required when using the fitbit API.\n\n The time parameter can take several different kind of objects: a DateTime object,\n a Time object, or a String Object.  Furthermore, the string object may be either\n the date in a preformatted string (\"HH:mm\"), or it may be the string value \"now\" to\n indicate that the time value used is the current localtime.\n\n @param [DateTime, Time, String] time The object to format into a time string\n @param [Hash] opts format time options\n @option opts [TrueClass, FalseClass] :include_timezone Include timezone in the output or not\n @raise [Fitgem::InvalidTimeArgument] Raised when the parameter object is not a\n   DateTime, Time, or a valid (\"HH:mm\" or \"now\") string object\n @return [String] Date in \"HH:mm\" string format", "Fetch the correct label for the desired measurement unit.\n\n The general use case for this method is that you are using the client for\n a specific user, and wish to get the correct labels for the unit measurements\n returned for that user.\n\n A secondary use case is that you wish to get the label for a measurement given a unit\n system that you supply (by setting the Fitgem::Client.api_unit_system attribute).\n\n In order for this method to get the correct value for the current user's preferences,\n the client must have the ability to make API calls.  If you respect_user_unit_preferences\n is passed as 'true' (or left as the default value) and the client cannot make API calls\n then an error will be raised by the method.\n\n @param [Symbol] measurement_type The measurement type to fetch the label for\n @param [Boolean] respect_user_unit_preferences Should the method fetch the current user's\n   specific measurement preferences and use those (true), or use the value set on Fitgem::Client.api_unit_system (false)\n @raise [Fitgem::ConnectionRequiredError] Raised when respect_user_unit_preferences is true but the\n   client is not capable of making API calls.\n @raise [Fitgem::InvalidUnitSystem] Raised when the current value of Fitgem::Client.api_unit_system\n   is not one of [ApiUnitSystem.US, ApiUnitSystem.UK, ApiUnitSystem.METRIC]\n @raise [Fitgem::InvalidMeasurementType] Raised when the supplied measurement_type is not one of\n   [:duration, :distance, :elevation, :height, :weight, :measurements, :liquids, :blood_glucose]\n @return [String] The string label corresponding to the measurement type and\n   current api_unit_system.", "Tries to find the model class corresponding to specified table name.\n Takes into account that the model can be defined in a namespace.\n Searches only up to one level deep - won't find models nested in two\n or more modules.\n\n Note that if we allow namespaces, the conversion can be ambiguous, i.e.\n if the table is named \"aa_bb_cc\" and AaBbCc, Aa::BbCc and AaBb::Cc are\n all defined there's no absolute rule that tells us which one to use.\n This method prefers the less nested one and, if there are two at\n the same level, the one with shorter module name.", "Checks if there is a class of specified name and if so, returns\n the class object. Otherwise returns nil.", "Displays all warnings and errors.", "Builds the rules table of the parser. Each row is built in reverse order.\n\n @param [LL::CompiledGrammar] grammar\n @return [Array]", "Adds warnings for any unused rules. The first defined rule is skipped\n since it's the root rule.\n\n @param [LL::CompiledGrammar] compiled_grammar", "Adds warnings for any unused terminals.\n\n @param [LL::CompiledGrammar] compiled_grammar", "Processes the root node of a grammar.\n\n @param [LL::AST::Node] node\n @param [LL::CompiledGrammar] compiled_grammar", "Sets the name of the parser.\n\n @param [LL::AST::Node] node\n @param [LL::CompiledGrammar] compiled_grammar", "Processes the assignment of terminals.\n\n @see [#process]", "Processes the assignment of a rule.\n\n @see [#process]", "Creates a basic prototype for a rule.\n\n @see [#process]", "Processes a single rule branch.\n\n @see [#process]\n @return [LL::Branch]", "Returns the value of the mandatory sysUpTime varbind for this trap.\n\n Throws InvalidTrapVarbind if the sysUpTime varbind is not present.", "Returns the value of the mandatory snmpTrapOID varbind for this trap.\n\n Throws InvalidTrapVarbind if the snmpTrapOID varbind is not present.", "Returns true if this ObjectId is a subtree of the provided parent tree\n ObjectId.  For example, \"1.3.6.1.5\" is a subtree of \"1.3.6.1\".", "Returns an index based on the difference between this ObjectId\n and the provided parent ObjectId.\n\n For example, ObjectId.new(\"1.3.6.1.5\").index(\"1.3.6.1\") returns an\n ObjectId of \"5\".", "Returns a VarBindList for the provided list of objects.  If a\n string is provided it is interpretted as a symbolic OID.\n\n This method accepts many different kinds of objects:\n - single string object IDs e.g. \"1.3.6.1\" or \"IF-MIB::ifTable.1.1\"\n - single ObjectId\n - list of string object IDs\n - list of ObjectIds\n - list of VarBinds", "Returns the symbolic name of the given OID.\n\n e.g. OID \"1.3.6.1.2.1.1.0\" returns symbol \"SNMPv2-MIB::system.0\"", "Sends a get-next request for the supplied list of ObjectId or VarBind\n objects.\n\n Returns a Response PDU with the results of the request.", "Sends a get-bulk request.  The non_repeaters parameter specifies\n the number of objects in the object_list to be retrieved once.  The\n remaining objects in the list will be retrieved up to the number of\n times specified by max_repetitions.", "Sends a set request using the supplied list of VarBind objects.\n\n Returns a Response PDU with the results of the request.", "Sends an SNMPv1 style trap.\n\n enterprise: The enterprise OID from the IANA assigned numbers\n (http://www.iana.org/assignments/enterprise-numbers) as a String or\n an ObjectId.\n\n agent_addr: The IP address of the SNMP agent as a String or IpAddress.\n\n generic_trap: The generic trap identifier.  One of :coldStart,\n :warmStart, :linkDown, :linkUp, :authenticationFailure,\n :egpNeighborLoss, or :enterpriseSpecific\n\n specific_trap: An integer representing the specific trap type for\n an enterprise-specific trap.\n\n timestamp: An integer respresenting the number of hundredths of\n a second that this system has been up.\n\n object_list: A list of additional varbinds to send with the trap.\n\n For example:\n\n   Manager.open(:Version => :SNMPv1) do |snmp|\n     snmp.trap_v1(\n       \"enterprises.9\",\n       \"10.1.2.3\",\n       :enterpriseSpecific,\n        42,\n       12345,\n       [VarBind.new(\"1.3.6.1.2.3.4\", Integer.new(1))])\n  end", "Sends an SNMPv2c style trap.\n\n sys_up_time: An integer respresenting the number of hundredths of\n a second that this system has been up.\n\n trap_oid: An ObjectId or String with the OID identifier for this\n trap.\n\n object_list: A list of additional varbinds to send with the trap.", "Sends an inform request using the supplied varbind list.\n\n sys_up_time: An integer respresenting the number of hundredths of\n a second that this system has been up.\n\n trap_oid: An ObjectId or String with the OID identifier for this\n inform request.\n\n object_list: A list of additional varbinds to send with the inform.", "Helper method for building VarBindList for trap and inform requests.", "Walks a list of ObjectId or VarBind objects using get_next until\n the response to the first OID in the list reaches the end of its\n MIB subtree.\n\n The varbinds from each get_next are yielded to the given block as\n they are retrieved.  The result is yielded as a VarBind when walking\n a single object or as a VarBindList when walking a list of objects.\n\n Normally this method is used for walking tables by providing an\n ObjectId for each column of the table.\n\n For example:\n\n   SNMP::Manager.open(:host => \"localhost\") do |manager|\n     manager.walk(\"ifTable\") { |vb| puts vb }\n   end\n\n   SNMP::Manager.open(:host => \"localhost\") do |manager|\n     manager.walk([\"ifIndex\", \"ifDescr\"]) do |index, descr|\n       puts \"#{index.value} #{descr.value}\"\n     end\n   end\n\n The index_column identifies the column that will provide the index\n for each row.  This information is used to deal with \"holes\" in a\n table (when a row is missing a varbind for one column).  A missing\n varbind is replaced with a varbind with the value NoSuchInstance.\n\n Note: If you are getting back rows where all columns have a value of\n NoSuchInstance then your index column is probably missing one of the\n rows.  Choose an index column that includes all indexes for the table.", "Helper method for walk.  Checks all of the VarBinds in vb_list to\n make sure that the row indices match.  If the row index does not\n match the index column, then that varbind is replaced with a varbind\n with a value of NoSuchInstance.", "Wait until response arrives.  Ignore responses with mismatched IDs;\n these responses are typically from previous requests that timed out\n or almost timed out.", "Only here to be stubbed for testing.  Gross.", "Sets all internal variables from a hash", "Generate non-digest assets by making a copy of the digest asset,\n with digests stripped from js and css. The new files are also gzipped.\n Other assets are copied verbatim.", "Initialize asset from serialized hash", "Serialize custom attributes.", "extract options from the options hash with highest priority over Sauce.config\n but fall back on Sauce.config otherwise", "for neg feedback loop protection", "Gets the url for zenaton api\n @param resource [String] the endpoint for the api\n @param params [Hash|String] query params to be url encoded\n @return [String] the api url with parameters", "Start a single task\n @param task [Zenaton::Interfaces::Task]", "Start the specified workflow\n @param flow [Zenaton::Interfaces::Workflow]", "Finds a workflow\n @param workflow_name [String] the class name of the workflow\n @param custom_id [String] the custom ID of the workflow\n @return [Zenaton::Interfaces::Workflow, nil]", "Sends an event to a workflow\n @param workflow_name [String] the class name of the workflow\n @param custom_id [String] the custom ID of the workflow (if any)\n @param event [Zenaton::Interfaces::Event] the event to send\n @return [NilClass]", "Executes jobs asynchronously\n @param jobs [Array<Zenaton::Interfaces::Job>]\n @return nil", "Uh oh! This will allow the class including this module to \"build a path\"\n by chaining calls to resources, terminated with a method linked to an\n action that will execute the api call.\n\n For example:\n\n `foo.stories(story_id).comments.update(id: comment_id, text: \"comment text\")`\n\n This example will execute a call to:\n\n `https://api.clubhouse.io/api/v2/stories/{story-id}/comments/{comment-id}`\n\n with arguments:\n\n   `{ text: \"comment text\" }`", "We'd better not lie when asked.", "Prepares a fancy request object and ensures the inputs make as much sense\n as possible. It's still totally possible to just provide a path that\n doesn't match a real url though.\n\n Executes the http(s) request and provides the response with some\n additional decoration in a Hash.", "override this in your own helper for greater control", "calculate the height of each row\n by default, it will be the height option minus the day names height,\n divided by the total number of calendar rows\n this gets tricky, however, if there are too many event rows to fit into the row's height\n then we need to add additional height", "For the given month, find the start and end dates\n Find all the events within this range, and create event strips for them", "Expand start and end dates to show the previous month and next month's days,\n that overlap with the shown months display", "Get the events overlapping the given start and end dates", "Create the various strips that show events.", "start_d - start of the month, or start of the week\n end_d - end of the month, or end of the week", "executes a view and return the results. you pass in a view spec\n which is usually a result of a SomePersistentClass.some_view call.\n\n Example:\n\n   class User\n     include CouchPotato::Persistence\n     property :age\n     view :all, key: :age\n   end\n   db = CouchPotato.database\n\n   db.view(User.all) # => [user1, user2]\n\n You can pass the usual parameters you can pass to a couchdb view to the view:\n\n   db.view(User.all(limit: 5, startkey: 2, reduce: false))\n\n For your convenience when passing a hash with only a key parameter you can just pass in the value\n\n   db.view(User.all(key: 1)) == db.view(User.all(1))\n\n Instead of passing a startkey and endkey you can pass in a key with a range:\n\n   db.view(User.all(key: 1..20)) == db.view(startkey: 1, endkey: 20) == db.view(User.all(1..20))\n\n You can also pass in multiple keys:\n\n   db.view(User.all(keys: [1, 2, 3]))", "Instantiates a new object.\n Should never be called directly.\n Sets the urls to be indexed.\n\n The +host+, or any other global option can be set here:\n\n   Sitemap::Generator.instance.load :host => \"mywebsite.com\" do\n     ...\n   end\n\n Literal paths can be added as follows:\n\n   Sitemap::Generator.instance.load :host => \"mywebsite.com\" do\n     literal \"/some_fancy_url\"\n   end\n\n Simple paths can be added as follows:\n\n   Sitemap::Generator.instance.load :host => \"mywebsite.com\" do\n     path :faq\n   end\n\n Object collections are supported too:\n\n   Sitemap::Generator.instance.load :host => \"mywebsite.com\" do\n     resources :activities\n   end\n\n Search options such as frequency and priority can be declared as an options hash:\n\n   Sitemap::Generator.instance.load :host => \"mywebsite.com\" do\n     path :root, :priority => 1\n     path :faq, :priority => 0.8, :change_frequency => \"daily\"\n     resources :activities, :change_frequency => \"weekly\"\n   end", "Adds the associated object types.\n\n The following will map all Activity entries, as well as the index (<tt>/activities</tt>) page:\n\n   resources :activities\n\n You can also specify which entries are being mapped:\n\n   resources :articles, :objects => proc { Article.published }\n\n To skip the index action and map only the records:\n\n   resources :articles, :skip_index => true\n\n As with the path, you can specify params through the +params+ options hash.\n The params can also be build conditionally by using a +proc+:\n\n   resources :activities, :params => { :host => proc { |activity| [activity.location, host].join(\".\") } }, :skip_index => true\n\n In this case the host will change based the each of the objects associated +location+ attribute.\n Because the index page doesn't have this attribute it's best to skip it.", "Parses the loaded data and returns the xml entries.", "Creates a temporary file from the existing entries.", "URL to the sitemap file.\n\n Defaults to <tt>sitemap.xml</tt>.", "Build the scenario steps provided\n\n @param [Array<String>] steps A collection of steps to build the scenario", "Send a REGISTER message with the specified credentials\n\n @param [String] user the user to register as. May be given as a full SIP URI (sip:user@domain.com), in email-address format (user@domain.com) or as a simple username ('user'). If no domain is supplied, the source IP from SIPp will be used.\n @param [optional, String, nil] password the password to authenticate with.\n @param [Hash] opts A set of options to modify the message\n\n @example Register with authentication\n   s.register 'frank@there.com', 'abc123'\n\n @example Register without authentication or a domain\n   s.register 'frank'", "Expect to receive a SIP INVITE\n\n @param [Hash] opts A set of options containing SIPp <recv> element attributes", "Sets an expectation for a SIP 200 message from the remote party\n as well as storing the record set and the response time duration\n\n @param [Hash] opts A set of options to modify the expectation\n @option opts [true, false] :optional Whether or not receipt of the message is optional. Defaults to false.", "Convenience method to wait for an answer from the called party\n\n This sets expectations for optional SIP 100, 180 and 183,\n followed by a required 200 and sending the acknowledgement.\n\n @param [Hash] opts A set of options to modify the expectations", "Expect to receive a MESSAGE message\n\n @param [String] regexp A regular expression (as a String) to match the message body against", "Create partition table for Call Length\n\n @param [Integer] min An value specifying the minimum time in milliseconds for the table\n @param [Integer] max An value specifying the maximum time in milliseconds for the table\n @param [Integer] interval An value specifying the interval in milliseconds for the table", "Create partition table for Response Time\n\n @param [Integer] min An value specifying the minimum time in milliseconds for the table\n @param [Integer] max An value specifying the maximum time in milliseconds for the table\n @param [Integer] interval An value specifying the interval in milliseconds for the table", "Dump the scenario to a SIPp XML string\n\n @return [String] the SIPp XML scenario", "Compile the scenario and its media to disk\n\n Writes the SIPp scenario file to disk at {filename}.xml, and the PCAP media to {filename}.pcap if applicable.\n {filename} is taken from the :filename option when creating the scenario, or falls back to a down-snake-cased version of the scenario name.\n\n @return [String] the path to the resulting scenario file\n\n @example Export a scenario to a specified filename\n   scenario = Scenario.new 'Test Scenario', filename: 'my_scenario'\n   scenario.compile! # Leaves files at my_scenario.xml and my_scenario.pcap\n\n @example Export a scenario to a calculated filename\n   scenario = Scenario.new 'Test Scenario'\n   scenario.compile! # Leaves files at test_scenario.xml and test_scenario.pcap", "Create a scenario instance\n\n @param [String] name The scenario's name\n @param [String] xml The XML document representing the scenario\n @param [String] media The media to be invoked by the scenario in PCAP format\n @param [Hash] args options to customise the scenario. @see Scenario#initialize.\n\n\n Write compiled Scenario XML and PCAP media to tempfiles.\n\n These will automatically be closed and deleted once they have gone out of scope, and can be used to execute the scenario without leaving stuff behind.\n\n @return [Hash<Symbol => Tempfile>] handles to created Tempfiles at :scenario and :media\n\n @see http://www.ruby-doc.org/stdlib-1.9.3/libdoc/tempfile/rdoc/Tempfile.html", "Waits for the runner to finish execution\n\n @raises Errno::ENOENT when the SIPp executable cannot be found\n @raises SippyCup::ExitOnInternalCommand when SIPp exits on an internal command. Calls may have been processed\n @raises SippyCup::NoCallsProcessed when SIPp exit normally, but has processed no calls\n @raises SippyCup::FatalError when SIPp encounters a fatal failure\n @raises SippyCup::FatalSocketBindingError when SIPp fails to bind to the specified socket\n @raises SippyCup::SippGenericError when SIPp encounters another type of error\n\n @return Boolean true if execution succeeded without any failed calls, false otherwise", "Define a blueprint with the given name for this class.\n\n e.g.\n   Post.blueprint do\n     title { \"A Post\" }\n     body  { \"Lorem ipsum...\" }\n   end\n\n If you provide the +name+ argument, a named blueprint will be created.\n See the +blueprint_name+ argument to the make method.", "Construct and save an object from a blueprint, if the class allows saving.\n\n :call-seq:\n   make!([count], [blueprint_name], [attributes = {}])\n\n Arguments are the same as for make.", "Parses the arguments to make.\n\n Yields a blueprint and an attributes hash to the block, which should\n construct an object from them. The block may be called multiple times to\n construct multiple objects.", "Generate an object from this blueprint.\n\n Pass in attributes to override values defined in the blueprint.", "Return the watcher hash associated with the req_id. If the req_id\n is the ZKRB_GLOBAL_CB_REQ, then does not clear the req from the internal\n store, otherwise the req_id is removed.", "this implementation is gross, but i don't really see another way of doing it\n without more grossness\n\n returns true if we're connected, false if we're not\n\n if timeout is nil, we never time out, and wait forever for CONNECTED state", "submits a job for processing\n blocks the caller until result has returned", "receive the response from the server, set @rval, notify caller", "close the connection normally, stops the dispatch thread and closes the\n underlying connection cleanly", "the C lib doesn't strip the chroot path off of returned path values, which\n is pretty damn annoying. this is used to clean things up.", "if we're chrooted, this method will strip the chroot prefix from +path+", "this is not as safe as the one in ZK, just to be used to clean up\n when we're the only one adjusting a particular path", "Return node route params which can be used in Rails route options\n\n @param method_or_path [String] string with action and controller for route (Ex. home#index)\n @param options [Hash] options to merge with internally built params. Passed params overrides route params.\n @return [Hash] route options. Will return at least node \"node_id\" and \"locale\" keys.", "Maintain unique name within parent_id scope.\n If name is not unique add numeric postfix.", "Maintain unique slug within parent_id scope.\n If slug is not unique add numeric postfix.", "There are no configuration options yet.", "Verifies that the passed in ordered Double is being called\n in the correct position.", "Resets the registered Doubles and ordered Doubles", "Reconstruct the source index from the specifications in +spec_dirs+.", "The signature for the source index.  Changes in the signature indicate a\n change in the index.", "The signature for the given gem specification.", "Find a gem by an exact match on the short name.", "Updates this SourceIndex from +source_uri+.  If +all+ is false, only the\n latest gems are fetched.", "Get the quick index needed for incremental updates.", "Make a list of full names for all the missing gemspecs.", "Tries to fetch Marshal representation first, then YAML", "Update the cached source index with the missing names.", "Execute the provided ssh command\n @param [String] command The command to be executed\n @return [Hash] Returns a hash containing :exit_status, :stdout and :stderr", "Run a windows style command using serverspec.  Defaults to running on the 'default_node'\n test node, otherwise uses the node specified in @example.metadata[:node]\n @param [String] cmd The serverspec command to executed\n @param [Hash] opt No currently supported options\n @return [Hash] Returns a hash containing :exit_status, :stdout and :stderr", "Run a unix style command using serverspec.  Defaults to running on the 'default_node'\n test node, otherwise uses the node specified in @example.metadata[:node]\n @param [String] cmd The serverspec command to executed\n @param [Hash] opt No currently supported options\n @return [Hash] Returns a hash containing :exit_status, :stdout and :stderr", "Setup the testing environment\n @param [Array<String>] args The argument array of options for configuring Beaker\n See 'beaker --help' for full list of supported command line options", "Finds all test suites in this test file, with test methods included.", "URL to redirect to in order for the user to approve the payment\n\n options:\n * country: default country code for the user\n * type: mini / light", "Create a new scraper instance.\n\n The argument +source+ is a URL, string containing HTML, or HTML::Node.\n The optional argument +options+ are options passed to the scraper.\n See Base#scrape for more details.\n\n For example:\n   # The page we want to scrape\n   url = URI.parse(\"http://example.com\")\n   # Skip the header\n   scraper = MyScraper.new(url, :root_element=>\"body\")\n   result = scraper.scrape\n Scrapes the document and returns the result.\n\n If the scraper was created with a URL, retrieve the page and parse it.\n If the scraper was created with a string, parse the page.\n\n The result is returned by calling the #result method. The default\n implementation returns +self+ if any extractor returned true,\n +nil+ otherwise.\n\n The method may raise any number of exceptions. HTTPError indicates\n it failed to retrieve the HTML page, and HTMLParseError that it failed\n to parse the page. Other exceptions come from extractors and the\n #result method.\n\n See also Base#scrape.", "Returns the document being processed.\n\n If the scraper was created with a URL, this method will attempt to\n retrieve the page and parse it.\n\n If the scraper was created with a string, this method will attempt\n to parse the page.\n\n Be advised that calling this method may raise an exception\n (HTTPError or HTMLParseError).\n\n The document is parsed only the first time this method is called.", "Returns the next sibling node.", "Returns the previous sibling node.", "Return the previous element before this one. Skips sibling text\n nodes.\n\n Using the +name+ argument, returns the previous element with\n that name, skipping other sibling elements.", "Process each node beginning with the current node.", "Treat the text at the current position as a tag, and scan it. Supports\n comments, doctype tags, and regular tags, and ignores less-than and\n greater-than characters within quoted strings.", "Return the next element after this one. Skips sibling text nodes.\n\n With the +name+ argument, returns the next element with that name,\n skipping other sibling elements.", "Creates a only child lambda. Pass +of-type+ to only look at\n elements of its type.", "Search for all nodes that match the given conditions, and return them\n as an array.", "Returns a textual representation of the node", "Match the given value to the given condition.", "Create a client instance. This is used as a factory for endpoint\n instances which communicate with Resource implementations.\n\n == Overview\n\n Suppose you have Resources with only +public_actions+ so that no\n sessions are needed, with resource implementations running at host\n \"test.com\" on paths which follow downcase/pluralisation conventions.\n In this case, creating a Client instance can be as simple as:\n\n     client = Hoodoo::Client.new(\n       base_uri:     'http://test.com/',\n       auto_session: false\n     )\n\n Ask this client for an endpoint of Resource \"Member\" implementing\n version 2 of its interface:\n\n     members = client.resource( :Member, 2 )\n\n Perform operations on the endpoints according to the methods in the\n base class - see these for details:\n\n * Hoodoo::Client::Endpoint#list\n * Hoodoo::Client::Endpoint#show\n * Hoodoo::Client::Endpoint#create\n * Hoodoo::Client::Endpoint#update\n * Hoodoo::Client::Endpoint#delete\n\n The above reference describes the basic approach for each call, with\n common parameters such as the query hash or body hash data described\n in the base class constructor, Hoodoo::Client::Endpoint#new.\n\n As an example, we could list records 50-79 inclusive of \"Member\"\n sorted by +created_at+ ascending, embedding an \"account\" for each,\n where field 'surname' matches 'Smith' - assuming there's an\n implementation of such a Resource interface available! - as follows:\n\n     results = members.list(\n       offset:    50,\n       limit:     25,\n       sort:      'created_at',\n       direction: 'asc',\n       search:    { 'surname' => 'Smith' },\n       _embed:    'account'\n     )\n\n This will return a Hoodoo::Client::AugmentedArray. This is an Array\n subclass which will contain the (up to) 25 results from the above\n call and supports Hoodoo::Client::AugmentedArray#dataset_size which\n (if the called Resource endpoint implementation provides the\n information) gives the total size of the data set at the time of\n calling. Hoodoo::Client::AugmentedArray#estimated_dataset_size\n likewise gives access to the estimated count, if available.\n\n The other 4 methods return a Hoodoo::Client::AugmentedHash. This is a\n Hash subclass. Both the Array and Hash subclasses provide a common\n standard way to handle errors. See the documentation of these classes\n for details; in brief, you _must_ _always_ check for errors before\n examining the Hash or Array data with a pattern such as this:\n\n     if results.platform_errors.has_errors?\n       # Examine results.platform_errors, which is a\n       # Hoodoo::Errors instance, and deal with the contents.\n     else\n       # Treat 'results' as a Hash containing the Resource\n       # data (String keys) or Array of Hashes of such data.\n     end\n\n == Session management\n\n By default, the Hoodoo::Client constructor assumes you want automatic\n session management.\n\n If you want to use automatic sessions, a Resource endpoint which\n implements the Session Resource interface is required. This must\n accept a POST (+create+) action with a payload of two JSON fields:\n +caller_id+ and +authentication_secret+. It must return a Resource\n with an \"id\" value that contains the session ID to quote in future\n requests via the X-Session-ID HTTP header; or it should return an\n error if the Caller ID and/or authentication secret are incorrect.\n\n The Resource is assumed to live at the same base URI and/or be\n discovered by the same mechanism (e.g. by convention) as everything\n else you'll use the client instance for. For more about discovery\n related paramters, see later.\n\n You will need to provide the +caller_id+ and +authentication_secret+\n (as named parameter +caller_secret+) to the constructor. If the name\n of the Resource implementing the Session interface is not 'Session',\n or not at version 1, then you can also provide alternatives. For\n example, suppose we want to use automatic session management for\n Caller ID \"0123\" and secret \"ABCD\" via version 2 of \"CustomSession\":\n\n     client = Hoodoo::Client.new(\n       base_uri:              'http://test.com/',\n       auto_session_resource: 'CustomSession',\n       auto_session_version:  2,\n       caller_id:             '0123',\n       caller_secret:         'ABCD'\n     )\n\n Finally, you can manually supply a session ID externally for the\n X-Session-ID header through the +session_id+ parameter. This may be\n used in conjunction with auto-session management; in that case, the\n given session is used until it expires (a \"platform.invalid_session\"\n error is encountered), after which a new one will be obtained.\n\n == Discovery parameters\n\n The Client instance needs to be able to find the place where the\n requested Resource implementations are located, which it does using\n the Hoodoo::Services::Discovery framework. You should read the\n description of this framework to get a feel for how that works first.\n\n One of the following *named* parameters must be supplied in order to\n choose a discovery engine for finding Resource endpoints:\n\n +discoverer+:: The Client needs a *Discoverer* to map from resource\n                names and versions to locations on the Internet of the\n                actual resource endpoint implementation. Via the\n                +discoverer+ parameter, you can explicitly pass a\n                Hoodoo::Services::Discovery subclass instance\n                customised to your own requirements. There are also\n                convenience parameters available - see below - that\n                create discoverer instances for you, covering common\n                use cases. If provided, the +discoverer+ parameter\n                takes precedence over any other parameters below.\n\n +base_uri+::   When given, Resource discovery is done by\n                Hoodoo::Services::Discovery::ByConvention. The path\n                that the by-convention discoverer creates is appended\n                to the base URI to build the full URI at which a server\n                implementing each requested Resource endpoint must be\n                listening (else a 404 / 'platform.not_found' response\n                arises). Specify as a String. If provided, the\n                +base_uri+ parameter takes precedence over any other\n                parameters below.\n\n +drb_uri+::    When given, Resource discovery is done by\n                Hoodoo::Services::Discovery::ByDRb. A DRb service\n                providing discovery data must be running at the given\n                URI. Specify as a String. See\n                Hoodoo::Services::Discovery::ByDRb::DRbServer and file\n                +drb_server_start.rb+ for more.\n\n +drb_port+::   Instead of +drb_uri+, you can provide the port number\n                of a DRb server on localhost. See\n                Hoodoo::Services::Discovery::ByDRb for which of\n                +drb_uri+ or +drb_port+ take precedence, if both are\n                provided.\n\n As an example of using a custom Discoverer, consider a simple HTTP\n case with the +base_uri+ parameter. The default \"by convention\"\n discoverer pluralises all paths, but let's say you have exceptions\n for Version and Health singleton resources which you've elected to\n place on singular, not plural, paths. You will need to construct a\n custom discoverer with these exceptions. See the documentation for\n Hoodoo::Services::Discovery::ByConvention to understand the options\n passed in for the custom routing information.\n\n     base_uri = 'https://api.test.com/'\n\n     discoverer = Hoodoo::Services::Discovery::ByConvention.new(\n       :base_uri => base_uri,\n       :routing  => {\n         :Version => { 1 => '/v1/version' },\n         :Health  => { 1 => '/v1/health'  }\n       }\n     )\n\n     client = Hoodoo::Client.new(\n       :discoverer => discoverer,\n       # ...other options...\n     )\n\n == Other parameters\n\n The following additional *named* parameters are all optional:\n\n +locale+::                The String given in Content-Language _and_\n                           Accept-Language HTTP headers for requests;\n                           default is \"en-nz\".\n\n +session_id+::            An optional session ID to be used for the\n                           initial X-Session-ID request header value.\n\n +auto_session+::          If +false+, automatic session management is\n                           disabled. Default is +true+.\n\n +auto_session_resource+:: Name of the Resource to use for automatic\n                           session management as a String or Symbol.\n                           Default is +\"Session\"+.\n\n +auto_session_version+::  Version of the Resource to use for\n                           automatic session management as an Integer.\n                           Default is 1.\n\n +caller_id+::             If using automatic session management, a\n                           Caller UUID must be provided. It is used\n                           as the +caller_id+ field's value in the\n                           POST (+create+) call to the session\n                           Resource endpoint.\n\n +caller_secret+::         If using automatic session management, a\n                           Caller authentication secret must be\n                           provide. It is used as the\n                           +authentication_secret+ field's value in\n                           the POST (+create+) call to the session\n                           Resource endpoint.\n\n If curious about the implementation details of automatic session\n management, see the Hoodoo::Client::Endpoints::AutoSession class's\n code.\n\n Get an endpoint instance which you can use for talking to a Resource.\n See the constructor for full information.\n\n You'll always get an endpoint instance back from this call. If an\n implementation of the given version of the given Resource cannot be\n contacted, you will only get a 404 ('platform.not_found') or 408\n ('platform.timeout') response when you try to make a call to it.\n\n +resource+:: Resource name as a Symbol or String (e.g. +:Purchase+).\n\n +version+::  Endpoint version as an Integer; optional; default is 1.\n\n +options+::  Optional options Hash (see below).\n\n The options Hash key/values are as follows:\n\n +locale+:: Locale string for request/response, e.g. \"en-gb\". Optional.\n            If omitted, defaults to the locale set in this Client\n            instance's constructor.\n\n OTHERS::   See Hoodoo::Client::Headers' +HEADER_TO_PROPERTY+. All\n            such option keys _MUST_ be Symbols.", "Remove a writer instance from this logger. If the instance has not been\n previously added, no error is raised.\n\n Slow writers may take a while to finish processing and shut down in\n the background. As a result, this method might take a while to return.\n Internal default timeouts may even mean that the writer is still running\n (possibly entirely hung).\n\n +writer_instances+:: One or more _instances_ of a subclass of\n                      Hoodoo::Logger::FastWriter or\n                      Hoodoo::Logger::SlowWriter, passed as one or\n                      more comma-separated parameters.", "Does this log instance's collection of writers include any writer\n instances which are of the given writer _class_? Returns +true+ if so,\n else +false+.\n\n This is slower than #include? so try to work with writer instance\n queries rather than writer class queries if you can.\n\n +writer_class+:: A _subclass_ (class reference, not instance) of\n                  Hoodoo::Logger::FastWriter or\n                  Hoodoo::Logger::SlowWriter.", "Create an instance.\n\n +descriptions+:: (Optional) Hoodoo::ErrorDescriptions instance with\n                  service-domain-specific error descriptions added, or\n                  omit for a default instance describing +platform+ and\n                  +generic+ error domains only.\n\n Add an error instance to this collection.\n\n +code+::      Error code in full, e.g. +generic.invalid_state'.\n\n +options+::   An options Hash, optional.\n\n The options hash contains symbol keys named as follows, with values as\n described:\n\n +reference+:: Reference data Hash, optionality depending upon the error\n               code and the reference data its error description mandates.\n               Provide key/value pairs where (symbol) keys are names from\n               the array of description requirements and values are\n               strings. All values are concatenated into a single string,\n               comma-separated. Commas within values are escaped with a\n               backslash; backslash is itself escaped with a backslash.\n\n               You must provide that data at a minimum, but can provide\n               additional keys too if you so wish. Required keys are\n               always included first, in order of appearance in the\n               requirements array of the error declaration, followed by\n               any extra values in undefined order.\n\n               See also Hoodoo::ErrorDescriptions::DomainDescriptions#error\n\n +message+::   Optional human-readable for-developer message, +en-nz+\n               locale. Default messages are provided for all errors, but\n               if you think you can provide something more informative,\n               you can do so through this parameter.\n\n Example:\n\n     errors.add_error(\n       'platform.not_found',\n       :message => 'Optional custom message',\n       :reference => { :entity_name => 'mandatory reference data' }\n     )\n\n In the above example, the mandatory reference data +entity_name+ comes\n from the description for the 'platform.not_found' message - see the\n Hoodoo::ErrorDescriptions#initialize _implementation_ and Platform API.", "Add a precompiled error to the error collection. Pass error code,\n error message and reference data directly.\n\n In most cases you should be calling #add_error instead, *NOT* here.\n\n *No* *validation* is performed. You should only really call here if\n storing an error / errors from another, trusted source with assumed\n validity (e.g. another service called remotely with errors in the JSON\n response). It's possible to store invalid error data using this call,\n which means counter-to-documentation results could be returned to API\n clients. That is Very Bad.\n\n Pass optionally the HTTP status code to use if this happens to be the\n first stored error. If this is omitted, 500 is kept as the default.", "Run the +hoodoo+ command implementation. Command line options are\n taken from the Ruby ARGV constant.", "Instantiate a new Transient storage object through which temporary data\n can be stored or retrieved.\n\n The TransientStore abstraction is a high level and simple abstraction over\n heterogenous data storage engines. It does not expose the many subtle\n configuration settings usually available in such. If you need to take\n advantage of those at an item storage level, you'll need to use a lower\n level interface and thus lock your code to the engine of choice.\n\n Engine plug-ins are recommended to attempt to gain and test a connection\n to the storage engine when this object is constructed, so if building a\n TransientStore instance, ensure your chosen storage engine is running\n first. Exceptions may be raised by storage engines, so you will probably\n want to catch those with more civilised error handling code.\n\n _Named_ parameters are:\n\n +storage_engine+::           An entry from ::supported_storage_engines.\n\n +storage_host_uri+::         The engine-dependent connection URI. Consult\n                              documentation for your chosen engine to find\n                              out its connection URI requirements, along\n                              with the documentation for the constructor\n                              method of the plug-in in use, since in some\n                              cases requirements may be unusual (e.g. in\n                              Hoodoo::TransientStore::MemcachedRedisMirror).\n\n +default_maximum_lifespan+:: The default time-to-live for data items, in,\n                              seconds; can be overridden per item; default\n                              is 604800 seconds or 7 days.\n\n +default_namespace+::        Storage engine keys are namespaced with\n                              +nz_co_loyalty_hoodoo_transient_store_+ by\n                              default, though this can be overridden here.\n                              Pass a String or Symbol.\n\n Set (write) a given payload into the storage engine with the given\n payload and maximum lifespan.\n\n Payloads must only contain simple types such as Hash, Array, String and\n Integer. Complex types like Symbol, Date, Float, BigDecimal or custom\n objects are unlikely to serialise properly but since this depends upon\n the storage engine in use, errors may or may not be raised for misuse.\n\n Storage engines usually have a maximum payload size limit; consult your\n engine administrator for information. For example, the default - but\n reconfigurable - maximum payload size for Memcached is 1MB.\n\n For maximum possible compatibility:\n\n * Use only Hash payloads with String key/value paids and no nesting. You\n   may choose to marshal the data into a String manually for unusual data\n   requirements, manually converting back when reading stored data.\n\n * Keep the payload size as small as possible - large objects belong in\n   bulk storage engines such as Amazon S3.\n\n These are only guidelines though - heterogenous storage engine support\n and the ability of system administrators to arbitrarily configure those\n storage engines makes it impossible to be more precise.\n\n Returns:\n\n * +true+ if storage was successful\n * +false+ if storage failed but the reason is unknown\n * An +Exception+ instance if storage failed and the storage engine\n   raised an exception describing the problem.\n\n _Named_ parameters are:\n\n +key+::              Storage key to use in the engine, which is then used\n                      in subsequent calls to #get and possibly eventually\n                      to #delete. Only non-empty Strings or Symbols are\n                      permitted, else an exception will be raised.\n\n +payload+::          Payload data to store under the given +key+. A flat\n                      Hash is recommended rather than simple types such as\n                      String (unless marshalling a complex type into such)\n                      in order to make potential additions to stored data\n                      easier to implement. Note that +nil+ is prohibited.\n\n +maximum_lifespan+:: Optional maximum lifespan, seconds. Storage engines\n                      may chooset to evict payloads sooner than this; it\n                      is a maximum time, not a guarantee. Omit to use this\n                      TransientStore instance's default value - see ::new.\n                      If you know you no longer need a piece of data at a\n                      particular point in the execution flow of your code,\n                      explicitly delete it via #delete rather than leaving\n                      it to expire. This maximises the storage engine's\n                      pool free space and so minimises the chance of early\n                      item eviction.", "Given a storage key, make sure it's a String or Symbol, coerce to a\n String and ensure it isn't empty. Returns the non-empty String version.\n Raises exceptions for bad input classes or empty keys.\n\n +key+::                 Key to normalise.\n\n +calling_method_name+:: Name of calling method to declare in exception\n                         messages, to aid callers in debugging.", "Uploading a gem file", "List versions for a gem", "Delete a gem version", "Add a collaborator to the account", "Remove a collaborator to the account", "List Git repos for this account", "Update repository name and settings", "Reset repository to initial state", "Rebuild Git repository package", "Set the status", "Read a request object from the connection", "Read from the client", "Log the given event", "Read a number of bytes, looping until they are available or until\n readpartial returns nil, indicating there are no more bytes to read", "Read a string up to the given number of bytes, blocking until some\n data is available but returning immediately if some data is available", "return the original model stored by create_model or find_model", "return a newly selected model", "if the factory name != the model name, store under both names", "given args of pickle model name, and an optional extra action, or segment, will attempt to find\n a matching named route\n\n   path_to_pickle 'the user', :action => 'edit'       # => /users/3/edit\n   path_to_pickle 'the user', 'the comment'           # => /users/3/comments/1\n   path_to_pickle 'the user', :segment => 'comments'  # => /users/3/comments\n\n If you don;t know if the 'extra' part of the path is an action or a segment, then just\n pass it as 'extra' and this method will run through the possibilities\n\n   path_to_pickle 'the user', :extra => 'new comment' # => /users/3/comments/new", "return the deliveries array, optionally selected by the passed fields", "add an error for a server", "Detects if an object is 'streamable' - can we read from it, and can we know the size?", "Start a fresh connection. The object closes any existing connection and\n opens a new one.", "=begin rdoc\n    Send HTTP request to server\n\n     request_params hash:\n     :server   => 'www.HostName.com'   # Hostname or IP address of HTTP server\n     :port     => '80'                 # Port of HTTP server\n     :protocol => 'https'              # http and https are supported on any port\n     :request  => 'requeststring'      # Fully-formed HTTP request to make\n     :proxy_host => 'hostname'         # hostname of HTTP proxy host to use, default none.\n     :proxy_port => port               # port of HTTP proxy host to use, default none.\n     :proxy_username => 'username'     # username to use for proxy authentication, default none.\n     :proxy_password => 'password'     # password to use for proxy authentication, default none.\n\n     :raise_on_timeout                 # do not perform a retry if timeout is received (false by default)\n     :http_connection_retry_count\n     :http_connection_open_timeout\n     :http_connection_read_timeout\n     :http_connection_retry_delay\n     :user_agent\n     :exception\n\n    Raises RuntimeError, Interrupt, and params[:exception] (if specified in new).\n\n=end", "Makes a pdf from a passed in string.\n\n Returns PDF as a stream, so we can use send_data to shoot\n it down the pipe using Rails.", "Given a flow expression id, locates the corresponding ruote\n expression and attaches a subprocess to it.\n\n Accepts the fei as a Hash or as a FlowExpressionId instance.\n\n By default, the workitem of the expression you attach to provides\n the initial workitem for the attached branch. By using the\n :fields/:workitem or :merge_fields options, one can change that.\n\n Returns the fei of the attached [root] expression\n (as a FlowExpressionId instance).", "Computes mutation and immediately applies it...\n\n See #compute_mutation\n\n Return the mutation instance (forensic?)", "Returns an array of ProcessStatus instances.\n\n WARNING : this is an expensive operation, but it understands :skip\n and :limit, so pagination is our friend.\n\n Please note, if you're interested only in processes that have errors,\n Engine#errors is a more efficient means.\n\n To simply list the wfids of the currently running, Engine#process_wfids\n is way cheaper to call.", "This method expects there to be a logger with a wait_for method in the\n context, else it will raise an exception.\n\n *WARNING*: #wait_for() is meant for environments where there is a unique\n worker and that worker is nested in this engine. In a multiple worker\n environment wait_for doesn't see events handled by 'other' workers.\n\n This method is only useful for test/quickstart/examples environments.\n\n   dashboard.wait_for(:alpha)\n     # will make the current thread block until a workitem is delivered\n     # to the participant named 'alpha'\n\n   engine.wait_for('123432123-9043')\n     # will make the current thread block until the processed whose\n     # wfid is given (String) terminates or produces an error.\n\n   engine.wait_for(5)\n     # will make the current thread block until 5 messages have been\n     # processed on the workqueue...\n\n   engine.wait_for(:empty)\n     # will return as soon as the engine/storage is empty, ie as soon\n     # as there are no more processes running in the engine (no more\n     # expressions placed in the storage)\n\n   engine.wait_for('terminated')\n     # will return as soon as any process has a 'terminated' event.\n\n It's OK to wait for multiple wfids:\n\n   engine.wait_for('20100612-bezerijozo', '20100612-yakisoba')\n\n If one needs to wait for something else than a wfid but needs to break\n in case of error:\n\n   engine.wait_for(:alpha, :or_error)\n\n\n == ruote 2.3.0 and wait_for(event)\n\n Ruote 2.3.0 introduced the ability to wait for an event given its name.\n Here is a quick list of event names and a their description:\n\n * 'launch' - [sub]process launch\n * 'terminated' - process terminated\n * 'ceased' - orphan process terminated\n * 'apply' - expression application\n * 'reply' - expression reply\n * 'dispatched' - emitted workitem towards participant\n * 'receive' - received workitem from participant\n * 'pause' - pause order\n * 'resume' - pause order\n * 'dispatch_cancel' - emitting a cancel order to a participant\n * 'dispatch_pause' - emitting a pause order to a participant\n * 'dispatch_resume' - emitting a resume order to a participant\n\n Names that are past participles are for notification events, while\n plain verbs are for action events. Most of the time, a notitication\n is emitted has the result of an action event, workers don't take any\n action on them, but services that are listening to the ruote activity\n might want to do something about them.\n\n\n == ruote 2.3.0 and wait_for(hash)\n\n For more precise testing, wait_for accepts hashes, for example:\n\n   r = dashboard.wait_for('action' => 'apply', 'exp_name' => 'wait')\n\n will block until a wait expression is applied.\n\n If you know ruote msgs, you can pinpoint at will:\n\n   r = dashboard.wait_for(\n     'action' => 'apply',\n     'exp_name' => 'wait',\n     'fei.wfid' => wfid)\n\n == what wait_for returns\n\n #wait_for returns the intercepted event. It's useful when testing/\n spec'ing, as in:\n\n   it 'completes successfully' do\n\n     definition = Ruote.define :on_error => 'charly' do\n       alpha\n       bravo\n     end\n\n     wfid = @board.launch(definition)\n\n     r = @board.wait_for(wfid)\n       # wait until process terminates or hits an error\n\n     r['workitem'].should_not == nil\n     r['workitem']['fields']['alpha'].should == 'was here'\n     r['workitem']['fields']['bravo'].should == 'was here'\n     r['workitem']['fields']['charly'].should == nil\n   end\n\n == :timeout option\n\n One can pass a timeout value in seconds for the #wait_for call, as in:\n\n   dashboard.wait_for(wfid, :timeout => 5 * 60)\n\n The default timeout is 60 (seconds). A nil or negative timeout disables\n the timeout.", "Registers a participant in the engine.\n\n Takes the form\n\n   dashboard.register_participant name_or_regex, klass, opts={}\n\n With the form\n\n   dashboard.register_participant name_or_regex do |workitem|\n     # ...\n   end\n\n A BlockParticipant is automatically created.\n\n\n == name or regex\n\n When registering participants, strings or regexes are accepted. Behind\n the scenes, a regex is kept.\n\n Passing a string like \"alain\" will get ruote to automatically turn it\n into the following regex : /^alain$/.\n\n For finer control over this, pass a regex directly\n\n   dashboard.register_participant /^user-/, MyParticipant\n     # will match all workitems whose participant name starts with \"user-\"\n\n\n == some examples\n\n   dashboard.register_participant 'compute_sum' do |wi|\n     wi.fields['sum'] = wi.fields['articles'].inject(0) do |s, (c, v)|\n       s + c * v # sum + count * value\n     end\n     # a block participant implicitely replies to the engine immediately\n   end\n\n   class MyParticipant\n     def initialize(opts)\n       @name = opts['name']\n     end\n     def on_workitem\n       workitem.fields['rocket_name'] = @name\n       send_to_the_moon(workitem)\n     end\n     def on_cancel\n       # do nothing\n     end\n   end\n\n   dashboard.register_participant(\n     /^moon-.+/, MyParticipant, 'name' => 'Saturn-V')\n\n   # computing the total for a invoice being passed in the workitem.\n   \n   class TotalParticipant\n     include Ruote::LocalParticipant\n\n     def on_workitem\n       workitem['total'] = workitem.fields['items'].inject(0.0) { |t, item|\n         t + item['count'] * PricingService.lookup(item['id'])\n       }\n       reply\n     end\n\n     def on_cancel\n     end\n   end\n   dashboard.register_participant 'total', TotalParticipant\n\n Remember that the options (the hash that follows the class name), must be\n serializable via JSON.\n\n\n == require_path and load_path\n\n It's OK to register a participant by passing its full classname as a\n String.\n\n   dashboard.register_participant(\n     'auditor', 'AuditParticipant', 'require_path' => 'part/audit.rb')\n   dashboard.register_participant(\n     'auto_decision', 'DecParticipant', 'load_path' => 'part/dec.rb')\n\n Note the option load_path / require_path that point to the ruby file\n containing the participant implementation. 'require' will load and eval\n the ruby code only once, 'load' each time.\n\n\n == :override => false\n\n By default, when registering a participant, if this results in a regex\n that is already used, the previously registered participant gets\n unregistered.\n\n   dashboard.register_participant 'alpha', AaParticipant\n   dashboard.register_participant 'alpha', BbParticipant, :override => false\n\n This can be useful when the #accept? method of participants are in use.\n\n Note that using the #register(&block) method, :override => false is\n automatically enforced.\n\n   dashboard.register do\n     alpha AaParticipant\n     alpha BbParticipant\n   end\n\n\n == :position / :pos => 'last' / 'first' / 'before' / 'after' / 'over'\n\n One can specify the position where the participant should be inserted\n in the participant list.\n\n   dashboard.register_participant 'auditor', AuditParticipant, :pos => 'last'\n\n * last : it's the default, places the participant at the end of the list\n * first : top of the list\n * before : implies :override => false, places before the existing\n   participant with the same regex\n * after : implies :override => false, places after the last existing\n   participant with the same regex\n * over : overrides in the same position (while the regular, default\n   overide removes and then places the new participant at the end of\n   the list)", "Given a list of attribute names, returns the first attribute name for\n which there is a value.", "Looks up the value for attribute n.", "Returns the value for attribute 'key', this value should be present\n in the array list 'values'. If not, the default value is returned.\n By default, the default value is the first element of 'values'.", "prefix = 'on' => will lookup on, on_val, on_value, on_v, on_var,\n on_variable, on_f, on_fld, on_field...", "Returns a Hash containing all attributes set for an expression with\n their values resolved.", "Given something like\n\n   sequence do\n     participant 'alpha'\n   end\n\n in the context of the participant expression\n\n   attribute_text()\n\n will yield 'alpha'.\n\n Note : an empty text returns '', not the nil value.", "'tos' meaning 'many \"to\"'", "Called by the worker when it has just created this FlowExpression and\n wants to apply it.", "The essence of the reply_to_parent job...", "Expression received a \"pause\" message. Will put the expression in the\n \"paused\" state and then pass the message to the children.\n\n If the expression is in a non-nil state (failed, timed_out, ...), the\n message will be ignored.", "Returns true if the given fei points to an expression in the parent\n chain of this expression.", "Used locally but also by ConcurrenceExpression, when preparing children\n before they get applied.", "Used by expressions when, well, applying a child expression of theirs.", "Called when the expression is about to reply to its parent and wants\n to get rid of its tags.", "Used by both _merge_to and _merge_from", "Returns a hash tagname => fei of tags set at the root of the process\n instance.\n\n Returns nil if there is no defined root expression.", "Returns a hash tagname => array of feis of all the tags set in the process\n instance.", "Returns the unique identifier for this process instance.", "Returns the 'position' of the process.\n\n   pdef = Ruote.process_definition do\n     alpha :task => 'clean car'\n   end\n   wfid = engine.launch(pdef)\n\n   sleep 0.500\n\n   engine.process(wfid) # => [[\"0_0\", \"alpha\", {\"task\"=>\"clean car\"}]]\n\n A process with concurrent branches will yield multiple 'positions'.\n\n It uses #workitems underneath.\n\n If you want to list all the expressions where the \"flow currently is\"\n regardless they are participant expressions or errors, look at the\n #leaves method.", "Returns the expressions where the flow is currently, ak the leaves\n of the execution tree.\n\n Whereas #position only looks at participant expressions (and errors),\n #leaves looks at any expressions that is a leave (which has no\n child at this point).\n\n Returns an array of FlowExpression instances. (Note that they may\n have their attribute #error set).", "Returns a list of the workitems currently 'out' to participants\n\n For example, with an instance of\n\n   Ruote.process_definition do\n     concurrence do\n       alpha :task => 'clean car'\n       bravo :task => 'sell car'\n     end\n   end\n\n calling engine.process(wfid).workitems will yield two workitems\n (alpha and bravo).\n\n Warning : do not confuse the workitems here with the workitems held\n in a storage participant or equivalent. The workitem returned here\n are the workitems as they were right before being sent out to the\n participant.\n\n Note: the workitems handed out here are not \"workitem documents\",\n they are extracted from the 'participant' expressions in the\n expression trees not from the stored workitems lot, they cannot\n be updated/proceeded via a storage participant. Consider them\n \"read only\".", "Returns a 'dot' representation of the process. A graph describing\n the tree of flow expressions that compose the process.", "Do the rendering.", "Simply returns a pretty-printed view of the workitem", "Determines and schedules timeout if any.\n\n Note that process definition timeout has priority over participant\n specified timeout.", "Use this method to re_dispatch the workitem.\n\n It takes two options :in and :at for \"later re_dispatch\".\n\n Look at the unschedule_re_dispatch method for an example of\n participant implementation that uses re_dispatch.\n\n Without one of those options, the method is a \"reject\".", "As used by the dispatch pool and the worker.", "Packages the error in a 'raise' msg and places it in the storage,\n for a worker to pick it up.\n\n TODO: investigate: is it still used, relevant? (probably yes, ruote-swf)", "Called by msg_handle or action_handle.", "Returns a serializable hash with all the details of the error.", "How many branch replies are expected before the concurrence is over ?", "Given a list of workitems and a merge_type, will merge according to\n the merge type.\n\n The return value is the merged workitem.\n\n (Still used when dealing with highest/lowest merge_type and legacy\n concurrence/citerator expressions)", "Encodes this workitem as JSON. If pretty is set to true, will output\n prettified JSON.", "Used by FlowExpression when leaving a tag.", "Dispatching the msg.", "The raw dispatch work, wrapped in error handling.", "Wraps the call to do_dispatch in a thread.", "Instantiates the participant and calls its cancel method.", "This method pipes back a workitem into the engine, letting it resume\n in its flow, hopefully.", "Can be used to raise an error in the workflow instance.\n\n Can be called either with an error class and arguments, either with\n an error instance (and no arguments), or a string message and no\n arguments.\n\n The workitem can be either an instance of Ruote::Workitem or a workitem\n in its Hash representation.\n\n   receiver.flunk(workitem, ArgumentError, \"not enough info\")\n   receiver.flunk(workitem, \"ArgumentError\", \"not enough info\")\n   receiver.flunk(workitem, ArgumentError, \"not enough info\", backtrace)\n   receiver.flunk(workitem, \"ArgumentError\", \"not enough info\", backtrace)\n   receiver.flunk(workitem, \"not enough info\")\n\n   rescue => e\n     receiver.flunk(workitem, e)\n   end", "Given a process definitions and optional initial fields and variables,\n launches a new process instance.\n\n This method is mostly used from the Ruote::Dashboard class (which\n includes this mixin).\n\n process_definition must be a result of Ruote.process_definition call\n or XML or JSON serialized process definition, as accepted by\n Ruote::Reader#read.\n\n fields are workflow parameters that will be placed in workitem.fields.\n\n Calls to this method returns the newly launched \"workflow instance id\"\n (\"wfid\" for short), the [hopefully] unique identifier for the\n process instance.\n\n == custom :wfid\n\n When calling this method, it's OK to pass a field named :wfid (Symbol,\n not String) that will be used as the identifier for the process instance.", "Convenience method, given a workitem or a fei, returns the\n corresponding flow expession.", "Fetches back a stashed value.\n\n   get(fei, 'colour')\n     # => 'blue'\n\n To return the whole stash\n\n   get(fei)\n     # => { 'colour' => 'blue' }\n\n put & get are useful for a participant that needs to communicate\n between its consume and its cancel.", "Returns true if the engine system is inactive, ie if all the process\n instances are terminated or are stuck in an error.\n\n NOTE : for now, if a branch of a process is in error while another is\n still running, this method will consider the process instance inactive\n (and it will return true if all the processes are considered inactive).", "Given a schedule, attempts to trigger it.\n\n It first tries to reserve the schedule. If the reservation fails\n (another worker was successful probably), false is returned.\n The schedule is triggered if the reservation was successful, true\n is returned.", "Processes one msg.\n\n Will return false immediately if the msg reservation failed (another\n worker grabbed the message.\n\n Else will execute the action ordered in the msg, and return true.\n\n Exceptions in execution are intercepted here and passed to the\n engine's (context's) error_handler.", "Works for both the 'launch' and the 'apply' msgs.\n\n Creates a new expression, gives and applies it with the\n workitem contained in the msg.", "Handles 'pause_process' and 'resume_process'.", "Reputs a doc or a msg.\n\n Used by certain storage implementations to pass documents around workers\n or to reschedule msgs (see ruote-swf).", "Filter is passed in a block (which is not evaluted as a ruote branch\n but immediately translated into a filter.\n\n   pdef = Ruote.process_definition do\n     filter do\n       field 'x', :type => 'string'\n       field 'y', :type => 'number'\n     end\n   end\n\n Note : 'or' is OK\n\n   pdef = Ruote.process_definition do\n     filter do\n       field 'x', :type => 'string'\n       _or\n       field 'y', :type => 'number'\n     end\n   end", "Filter thanks to the attributes of the expression.\n\n   pdef = Ruote.process_definition do\n     filter 'x', :type => 'string', :record => true\n     filter 'y', :type => 'number', :record => true\n   end", "Returns a fresh hash of all the variables visible from this expression.\n\n This is used mainly when forgetting an expression.", "Unbinds a variables.", "Used by lookup_variable and set_variable to extract the\n prefix in a variable name", "Look for mutation points in an expression and its children.", "Look for mutation points in any non-concurrent expression.", "Determines which child expression of the cursor is to be applied next.", "Jumps to an integer position, or the name of an expression\n or a tag name of a ref name.", "Used when doing integration tests, removes all\n msgs, schedules, errors, expressions and workitems.\n\n NOTE that it doesn't remove engine variables (danger)", "Removes a process by removing all its schedules, expressions, errors,\n workitems and trackers.\n\n Warning: will not trigger any cancel behaviours at all, just removes\n the process.", "Used by put_msg", "Used by put_schedule", "Looks up parent with on_error attribute and triggers it", "Given an error, returns the on_error registered for it, or nil if none.", "Removes a set of tracker ids and updated the tracker document.", "The method behind on_pre_msg and on_msg. Filters msgs against trackers.\n Triggers trackers if there is a match.", "Alters the msg, only called in \"pre\" mode.", "Prepares the message that gets placed on the ruote msg queue.", "Given a msg and a hash of conditions, returns true if the msg\n matches the conditions.", "The context will call this method for each msg sucessfully processed\n by the worker.", "Blocks until one or more interests are satisfied.\n\n interests must be an array of interests. Please refer to\n Dashboard#wait_for documentation for allowed values of each interest.\n\n If multiple interests are given, wait_for blocks until\n all of the interests are satisfied.\n\n wait_for may only be used by one thread at a time. If one\n thread calls wait_for and later another thread calls wait_for\n while the first thread is waiting, the first thread's\n interests are lost and the first thread will never wake up.", "Checks whether message msg matches any of interests being waited for.\n\n Some interests look for actions on particular workflows (e.g.,\n waiting for some workflow to finish). Other interests are not\n attached to any particular workflow (e.g., :inactive waits until\n the engine finishes processing all active and pending workflows)\n but are still satisfied when actions happen on workflows (e.g.,\n the last workflow being run finishes).\n\n Returns true if all interests being waited for have been satisfied,\n false otherwise.", "Returns true if this context has a given service registered.", "Does persist or unpersist, if successful then returns true. If the\n expression is gone, returns false.\n If there is a 'fresher' version of the expression, re-attempt and returns\n false.", "This is the method called by ruote when passing a workitem to\n this participant.", "Removes the workitem from the storage and replies to the engine.", "Removes the workitem and hands it back to the flow with an error to\n raise for the participant expression that emitted the workitem.", "Returns all the workitems stored in here.", "Return all workitems for the specified wfid", "Returns all workitems for the specified participant name", "Queries the store participant for workitems.\n\n Some examples :\n\n   part.query(:wfid => @wfid).size\n   part.query('place' => 'nara').size\n   part.query('place' => 'heiankyou').size\n   part.query(:wfid => @wfid, :place => 'heiankyou').size\n\n There are two 'reserved' criterion : 'wfid' and 'participant'\n ('participant_name' as well). The rest of the criteria are considered\n constraints for fields.\n\n 'offset' and 'limit' are reserved as well. They should prove useful\n for pagination. 'skip' can be used instead of 'offset'.\n\n Note : the criteria is AND only, you'll have to do ORs (aggregation)\n by yourself.", "Mostly a test method. Returns a Hash were keys are participant names\n and values are integers, the count of workitems for a given participant\n name.", "Delegates a currently owned workitem to a new owner.\n\n Fails if the workitem can't be found, belongs to noone, or if the\n workitem passed as argument is out of date (got modified in the mean\n time).\n\n It's OK to delegate to nil, thus freeing the workitem.\n\n See #reserve for an an explanation of the reserve/delegate/proceed flow.", "Given a few options and a block, returns all the workitems that match\n the block", "Computes the id for the document representing the document in the storage.", "Walks up the expression tree (process instance and returns the first\n expression that includes the CommandMixin\n\n (CommandExpression includes CommandMixin, but since it doesn't have\n children, no need to 'evince' it)", "Maybe \"lookup_real_participant_code\" would be a better name...", "called by 'else', 'then' or perhaps 'equals'", "Removes a participant, given via its name or directly from this\n participant list.\n\n Called usually by Engine#unregister_participant.", "Returns a participant instance, or nil if there is no participant\n for the given participant name.\n\n Mostly a combination of #lookup_info and #instantiate.", "Given a participant name, returns participant details.\n\n Returns nil if there is no participant registered that covers the given\n participant name.", "Returns an instance of a participant.", "Create a playlist for a Spotify user. The playlist will be empty until you add tracks.\n\n Requires playlist-modify-public for a public playlist.\n Requires playlist-modify-private for a private playlist.", "Add an Array of track uris to an existing playlist.\n\n Adding tracks to a user's public playlist requires authorization of the playlist-modify-public scope;\n adding tracks to a private playlist requires the playlist-modify-private scope.\n\n client.add_user_tracks_to_playlist('1181346016', '7i3thJWDtmX04dJhFwYb0x', %w(spotify:track:4iV5W9uYEdYUVa79Axb7Rh spotify:track:2lzEz3A3XIFyhMDqzMdcss))", "Follow artists or users\n\n client.follow('artist', ['0BvkDsjIUla7X0k6CSWh1I'])", "Create a new instance of the status class with the given options\n\n <b>Options:</b>\n * +host+ - the host for monit, defaults to +localhost+\n * +port+ - the Monit port, defaults to +2812+\n * +ssl+ - should we use SSL for the connection to Monit (default: false)\n * +auth+ - should authentication be used, defaults to false\n * +username+ - username for authentication\n * +password+ - password for authentication\n Construct the URL", "Get the status from Monit.", "Parse the XML from Monit into a hash and into a Ruby representation.", "Add an artifact to the graph\n\n @param [String] name\n @Param [String] version", "Return all the artifacts from the collection of artifacts\n with the given name.\n\n @param [String] name\n\n @return [Array<Solve::Artifact>]", "Returns true or false if the given version would be satisfied by\n the version constraint.\n\n @param [Semverse::Version, #to_s] target\n\n @return [Boolean]", "Runs the solver with the set of demands given. If any DepSelector\n exceptions are raised, they are rescued and re-raised", "Callback required by Molinillo\n Determines whether the given `requirement` is satisfied by the given\n `spec`, in the context of the current `activated` dependency graph.\n\n @param [Object] requirement\n @param [DependencyGraph] activated the current dependency graph in the\n   resolution process.\n @param [Object] spec\n @return [Boolean] whether `requirement` is satisfied by `spec` in the\n   context of the current `activated` dependency graph.", "Searches the current dependency graph to find previously activated\n requirements for the current artifact.\n\n @param [Object] requirement\n @param [DependencyGraph] activated the current dependency graph in the\n   resolution process.\n @return [Array<Semverse::Version> the list of currently activated versions\n of this requirement", "Sets the SPI clock frequency", "Activate a specific chip so that communication can begin\n\n When a block is provided, the chip is automatically deactivated after the block completes.\n When a block is not provided, the user is responsible for calling chip_select(CHIP_SELECT_NONE)\n\n @example With block (preferred)\n   spi.chip_select do\n     spi.write(0xFF)\n   end\n\n @example Without block\n   spi.chip_select(CHIP_SELECT_0)\n   spi.write(0xFF)\n   spi.write(0x22)\n   spi.chip_select(CHIP_SELECT_NONE)\n\n @yield\n @param [optional, CHIP_SELECT_*] chip the chip select line options", "Configure the active state of the chip select line\n\n The default state for most chips is active low.\n\n \"active low\" means the clock line is kept high during idle, and goes low when communicating.\n\n \"active high\" means the clock line is kept low during idle, and goes high when communicating.\n\n @param [Boolean] active_low true for active low, false for active high\n @param [optional, CHIP_SELECT_*] chip one of CHIP_SELECT_*", "Write to the bus\n\n @example Write a single byte\n   spi.write(0x22)\n\n @example Write multiple bytes\n   spi.write(0x22, 0x33, 0x44)\n\n @return [Number|Array] data that came out of MISO during write", "This is used by build, create, and append. You really shouldn't use it\n directly. Although it's totally fine if you do\n\n @return [RMQ]", "Same as append, but will look for a view with the same name and reapply styles\n to it if it finds one. If it doesn't, it'll append as normal.\n\n @example\n   @my_button = rmq.find_or_append(UIButton, :my_button)\n   @my_button = rmq.find_or_append(UIButton, :my_button) # Only one created", "Same as append!, but will look for a view with the same name and reapply styles\n to it if it finds one. If it doesn't, it'll append! as normal.\n\n @example\n   @my_button = rmq.find_or_append!(UIButton, :my_button)\n   @my_button = rmq.find_or_append!(UIButton, :my_button) # Only one created", "Just like append, but inserts the view at index 0 of the subview array\n\n @return [RMQ]", "Build a view, similar to create and append, but only inits an existing view. Usefull\n in collectionview cells for example\n\n @example\n # In your collectionview\n rmq.build(cell) unless cell.reused\n\n # Then in your cell\n\n def rmq_build\n   rmq.append(UIView, :foo)\n end", "this method shortcuts specific validation rules.  As such it should only be\n added to for universal validation needs.  It must be kept as efficient as possible.", "Warning, this is very slow", "Warning, this is very slow to output log, checking truthy however is\n basically as performant as an if statement\n\n @example\n\n # foo and bar are objects we want to inspect\n rmq.debug.assert(1==2, 'Bad stuff happened', {\n   foo: foo,\n   bar: bar\n })", "Calculates the bottom right of a view using its subviews\n\n @return [Hash]", "This is mostly used internally\n\n If rmq was called in a view, context will be that view. If it was called\n in a UIViewController, it will be that controller. If it is called in another\n object, it will be current controller's rmq instance and thus context will be\n that controller", "The UIViews currently selected\n\n Use {#get} instead to get the actual UIView objects\n\n @return [Array]", "Wraps 1 or more views in an rmq instance.\n\n Normally you select a view or views using rmq(my_view). Which doesn't\n work if you have an instance of a RMQ, in which case it isn't a method.\n In some cases you want to save an instance of rmq and use it like the rmq\n method, for this you'd use #wrap\n\n @example\n   q = RubyMotionQuery::RMQ.new\n\n   # Bad\n   q(my_view).view_controller\n\n   # Good\n   q.wrap(my_view).view_controller", "Super useful in the console. log outputs to the console a table of the selected views\n\n @param :wide outputs wide format (really wide, but awesome: rmq.all.log :wide). :tree outputs the\n log in a tree form\n\n @return [String]\n\n @example\n    (main)> rmq(UIImageView).log\n\n    object_id   | class                 | style_name              | frame                           |\n    sv id       | superview             | subviews count          | tags                            |\n    - - - - - - | - - - - - - - - - - - | - - - - - - - - - - - - | - - - - - - - - - - - - - - - - |\n    168150976   | UIImageView           | logo                    | {l: 60, t: 10, w: 200, h: 95.5} |\n    168128784   | UIView                | 0                       |                                 |\n    - - - - - - | - - - - - - - - - - - | - - - - - - - - - - - - | - - - - - - - - - - - - - - - - |\n    168180640   | UIImageView           |                         | {l: 1, t: 1, w: 148, h: 19}     |\n    168173616   | UIRoundedRectButton   | 0                       |                                 |\n    - - - - - - | - - - - - - - - - - - | - - - - - - - - - - - - | - - - - - - - - - - - - - - - - |\n    168204336   | UIImageView           |                         | {l: 1, t: 0, w: 77, h: 27}      |\n    168201952   | _UISwitchInternalView | 0                       |                                 |\n    - - - - - - | - - - - - - - - - - - | - - - - - - - - - - - - | - - - - - - - - - - - - - - - - |\n    172600352   | UIImageView           |                         | {l: -2, t: 0, w: 79, h: 27}     |\n    168204512   | UIView                | 0                       |                                 |\n    - - - - - - | - - - - - - - - - - - | - - - - - - - - - - - - | - - - - - - - - - - - - - - - - |\n    168205504   | UIImageView           |                         | {l: -2, t: 0, w: 131, h: 27}    |\n    168204512   | UIView                | 0                       |                                 |\n    - - - - - - | - - - - - - - - - - - | - - - - - - - - - - - - | - - - - - - - - - - - - - - - - |\n    168205600   | UIImageView           |                         | {l: 49, t: 0, w: 29, h: 27}     |\n    168204512   | UIView                | 0                       |                                 |\n    - - - - - - | - - - - - - - - - - - | - - - - - - - - - - - - | - - - - - - - - - - - - - - - - |\n    RMQ 278442176. 6 selected. selectors: [UIImageView]\n\n @example\n   rmq.log :tree\n\n @example\n   rmq.all.log :wide", "Applies advices to a given method\n @note This method is public only because we use it from define_method on a module\n @note If will figure out the method scope (private/public/protected) on its own\n @param method [Symbol] method to which we want to apply this interception", "Defines on a target element new methods that will contain advices logic\n as long as their blocks. Then we can invoke advices logic as a normal methods\n In a way it just casts a block to methods for peformance reasons\n If we have advices that just execute already existing methods, this won't create\n anything\n @note All methods like this are set to private - they should stay as an internal\n   implementation detail", "Will apply all the advices to all methods that match", "Invokes deferred logics blocks on a target element and stores deferred logic\n invokations results", "Redefines singleton_method_added and method_added methods so they are monitored\n If new method is added we will apply to it appropriate advices", "Recreates a given method applying all the advices one by one\n @param method [String] method name of a method that we want to recreate\n @param advices [Array<Aspector::Advice>] all the advices that\n   should be applied (after filtering)\n @param scope [Symbol] method visibility (private, protected, public)", "Creates a full messages that we want to log\n @param args any arguments that we want to log based on\n @return [String] message string for logging - provides additional context information\n @example Create a message based on a single argument\n   message('action taken') #=> 'Aspector::Base | ExampleClass | action taken'", "Draws the graph legend with the given labels.\n @param [Array<LegendItem>] The labels to write as part of the legend.", "Draws a horizontal line.", "Draws a single item of the legend, which includes the label and the\n symbol with the matching color. Labels are written from right to left.\n @param", "Convenience method to wrap a block by setting and unsetting a Prawn\n property such as line_width.", "Try to find the primary group name for a given user.\n\n @param user [String, Integer] User to check, if given as an integer this\n   is used as a UID, otherwise it is the username.\n @return [String]\n @example\n   attribute(:group, kind_of: [String, Integer], default: lazy { PoiseApplication::Utils.primary_group_for(user) })", "Loop through all records and sent them to Splunk", "Find the cookbook name for a given filename. The can used to find the\n cookbook that corresponds to a caller of a file.\n\n @param run_context [Chef::RunContext] Context to check.\n @param filename [String] Absolute filename to check for.\n @return [String]\n @example\n   def my_thing\n     caller_filename = caller.first.split(':').first\n     cookbook = Poise::Utils.find_cookbook_name(run_context, caller_filename)\n     # ...\n   end", "Try to find an ancestor to call a method on.\n\n @since 2.2.3\n @since 2.3.0\n   Added ignore parameter.\n @param obj [Object] Self from the caller.\n @param msg [Symbol] Method to try to call.\n @param args [Array<Object>] Method arguments.\n @param default [Object] Default return value if no valid ancestor exists.\n @param ignore [Array<Object>] Return value to ignore when scanning ancesors.\n @return [Object]\n @example\n   val = @val || Poise::Utils.ancestor_send(self, :val)", "Create a helper to invoke a module with some parameters.\n\n @since 2.3.0\n @param mod [Module] The module to wrap.\n @param block [Proc] The module to implement to parameterization.\n @return [void]\n @example\n   module MyMixin\n     def self.my_mixin_name(name)\n       # ...\n     end\n   end\n\n   Poise::Utils.parameterized_module(MyMixin) do |name|\n     my_mixin_name(name)\n   end", "Check that the given arguments match the given block. This is needed\n because Ruby will nil-pad mismatched argspecs on blocks rather than error.\n\n @since 2.3.0\n @param block [Proc] Block to check.\n @param args [Array<Object>] Arguments to check.\n @return [void]", "List OAuth applications\n\n @return [Array<Kong::OAuthApp>]", "For all of the following dampening getters, half_time, reuse_time,\n suppress_time, and max_suppress_time, return nil if dampening\n is not configured, but also return nil if a dampening routemap\n is configured because they are mutually exclusive.", "Universal Getter, Default Getter, and Setter", "Is the given name available in the YAML?", "common ace getter", "icmp ace getter", "hsrp delay minimum and reload are in the same CLI\n but both can be set independent of each other", "bridge-domain and vlans are mutually exclusive\n so when there are vlans, we need to remove them\n from the bd range while restting", "Call this for setting hot_standby and weight together because\n the CLI is pretty weird and it accepts these params in a very\n particular way and they cannot even be reset unless proper\n order is followed", "Example clis;\n system bridge-domain 101-200\n bridge-domain 101-200\n bridge-domain 101-110,120,141-145,180\n   member vni 6001-6011,5041-5044,8000,9000\n\n config_get('bridge_domain_vni', 'member_vni')\n will get the current member vni in this case\n 6001-6011,5041-5044,8000,9000\n\n config_get('bridge_domain_vni', 'member_vni_bd')\n will get the current bd's mapped to member vni in this case\n 101-110,120,141-145,180\n\n The @bd_ids_list which is created when the BridgeDomainVNI object is\n initialized which could be 101-110 bd range.\n hash_map will have 101=>6001,102=>6002...120=>6011,141=>5041...180=>9000\n And the final_bd_vni hash will be based of the initialized list\n 101=>6001,102=>6002,103=>6003....110=>6010 only.", "The yaml file may specifiy an Array as the get_value to drill down into\n nxapi_structured table output.  The table may contain multiple rows but\n only one of the rows has the interesting data.", "Attempt to massage the given value into the format specified by the\n given CmdRef object.", "Get the command reference", "Validate the YAML node tree before converting it into Ruby\n data structures.\n\n @raise RuntimeError if the node tree is not valid by our constraints.\n\n @param node Node to be validated, then recurse to its children.\n @param filename File that YAML was parsed from, for messages\n @param depth Depth into the node tree\n @param parents String describing parents of this node, for messages", "Read in yaml file.\n The expectation is that a file corresponds to a feature", "interface %s\n   %s ip ospf message-digest-key %d %s %d %s", "CLI can be either of the following or none\n ip ospf bfd\n ip ospf bfd disable", "interface %s\n   %s ip ospf bfd %s", "interface %s\n   %s ip ospf network %s", "interface %s\n   %s ip ospf passive-interface", "interface %s\n   ip ospf priority %d", "interface %s\n   ip ospf transmit-delay %d", "Reset everything back to default", "Set vtp domain name", "Get vtp password", "Set vtp password", "Set vtp filename", "Graceful Restart Setters", "BGP Timers Setters", "match community public private exact-match", "match metric 1 8 224 +- 9 23 5 +- 8 6", "match ospf-area 10 7", "match mac-list m1 m2", "match evpn route-type 1\n match evpn route-type 2 all\n match evpn route-type 2 mac-ip\n match evpn route-type 2 mac-only\n match evpn route-type 3 etc.", "set metric 44 55 66 77 88\n set metric +33", "set dampening 6 22 44 55", "set as-path prepend 55.77 44 33.5\n set as-path prepend last-as 1", "set ip default next-hop 1.1.1.1 2.2.2.2 3.3.3.3", "set ip next-hop 1.1.1.1 2.2.2.2 3.3.3.3", "set ip next-hop 1.1.1.1 2.2.2.2 3.3.3.3 load-share\n set ip next-hop load-share", "set ipv6 default next-hop 1.1.1.1 2.2.2.2 3.3.3.3", "set ipv6 next-hop 1.1.1.1 2.2.2.2 3.3.3.3", "set ipv6 default next-hop 1.1.1.1 2.2.2.2 3.3.3.3 load-share\n set ipv6 default next-hop load-share", "set extcommunity cost igp 0 22 igp 3 23\n set extcommunity cost pre-bestpath 1 222 pre-bestpath 2 54\n set extcommunity cost pre-bestpath 1 222 pre-bestpath 2 54 igp 0 22", "anycast-gateway-mac", "Set encryption type and password", "only one next-hop is allowed per interface but\n due to nxos issues, it allows more than one;\n so the workaround is to clean up the current ingress\n intf and configure all of them again", "Fail if the key was already defined with a ValueOverwriteError", "Represents stitched together screenshot and writes to file.\n\n @example\n   opts = {:page_height_limit => 5000}\n   browser.screenshot.save_stitch(\"path/abc.png\", browser, opts)\n\n @param [String] path\n @deprecated\n   @param [Watir::Browser] browser\n @param [Hash] opts", "Employs html2canvas to produce a Base64 encoded string\n of a full page screenshot.\n\n @example\n   browser.screenshot.base64_canvas(browser)\n   #=> '7HWJ43tZDscPleeUuPW6HhN3x+z7vU/lufmH0qNTtTum94IBWMT46evImci1vnFGT'\n\n @deprecated\n   @param [Watir::Browser] browser\n\n @return [String]", "Sets up the underlying ZooKeeper connection.", "Handles a ZK event.\n\n @param [ZK::Event] event the ZK event to handle", "Dispatches a redis operation to a master or slave.\n\n @param [Symbol] method the method to dispatch\n @param [Array] args the arguments to pass to the method\n @param [Proc] block an optional block to pass to the method\n @return [Object] the result of dispatching the command", "Fetches the known redis nodes from ZooKeeper.\n\n @return [Hash] the known master/slave redis servers", "Builds new Redis clients for the specified nodes.\n\n @param [Array<String>] nodes the array of redis host:port pairs\n @return [Array<Redis>] the array of corresponding Redis clients", "Verifies the actual role for a redis node.\n\n @param [Redis] node the redis node to check\n @param [Symbol] role the role to verify\n @return [Symbol] the verified role\n @raise [InvalidNodeRoleError] if the role is invalid", "Determines if the currently known redis servers is different\n from the nodes returned by ZooKeeper.\n\n @param [Array<String>] new_nodes the new redis nodes\n @return [Boolean] true if nodes are different, false otherwise", "Acquires a client to use for the specified operation.\n\n @param [Symbol] method the method for which to retrieve a client\n @return [Redis] a redis client to use\n @note\n   This method stores a stack of clients used to handle the case\n   where the same RedisFailover::Client instance is referenced by\n   nested blocks (e.g., block passed to multi).", "Parses the configuration operations.\n\n @param [Hash] options the configuration options", "Makes this node a slave of the given node.\n\n @param [Node] node the node of which to become a slave", "Safely performs a redis operation within a given timeout window.\n\n @yield [Redis] the redis client to use for the operation\n @raise [NodeUnavailableError] if node is currently unreachable", "Configures the ZooKeeper client.", "Handles an unavailable node.\n\n @param [Node] node the unavailable node\n @param [Hash<Node, NodeSnapshot>] snapshots the current set of snapshots", "Handles an available node.\n\n @param [Node] node the available node\n @param [Hash<Node, NodeSnapshot>] snapshots the current set of snapshots", "Handles a node that is currently syncing.\n\n @param [Node] node the syncing node\n @param [Hash<Node, NodeSnapshot>] snapshots the current set of snapshots", "Handles a manual failover request to the given node.\n\n @param [Node] node the candidate node for failover\n @param [Hash<Node, NodeSnapshot>] snapshots the current set of snapshots", "Promotes a new master.\n\n @param [Hash<Node, NodeSnapshot>] snapshots the current set of snapshots\n @param [Node] node the optional node to promote", "Seeds the initial node master from an existing znode config.", "Creates a Node instance from a string.\n\n @param [String] node_string a string representation of a node (e.g., host:port)\n @return [Node] the Node representation", "Searches for the master node.\n\n @param [Array<Node>] nodes the nodes to search\n @return [Node] the found master node, nil if not found", "Redirects all slaves to the specified node.\n\n @param [Node] node the node to which slaves are redirected", "It's possible that a newly available node may have been restarted\n and completely lost its dynamically set run-time role by the node\n manager. This method ensures that the node resumes its role as\n determined by the manager.\n\n @param [Node] node the node to reconcile", "Deletes the znode path containing the redis nodes.\n\n @param [String] path the znode path to delete", "Creates a znode path.\n\n @param [String] path the znode path to create\n @param [Hash] options the options used to create the path\n @option options [String] :initial_value an initial value for the znode\n @option options [Boolean] :ephemeral true if node is ephemeral, false otherwise", "Writes state to a particular znode path.\n\n @param [String] path the znode path that should be written to\n @param [String] value the value to write to the znode\n @param [Hash] options the default options to be used when creating the node\n @note the path will be created if it doesn't exist", "Handles a manual failover znode update.\n\n @param [ZK::Event] event the ZK event to handle", "Used to update the master node manager state. These states are only handled if\n this node manager instance is serving as the master manager.\n\n @param [Node] node the node to handle\n @param [Hash<Node, NodeSnapshot>] snapshots the current set of snapshots", "Updates the current view of the world for this particular node\n manager instance. All node managers write this state regardless\n of whether they are the master manager or not.\n\n @param [Node] node the node to handle\n @param [Symbol] state the node state\n @param [Integer] latency an optional latency", "Builds current snapshots of nodes across all running node managers.\n\n @return [Hash<Node, NodeSnapshot>] the snapshots for all nodes", "Waits until this node manager becomes the master.", "Manages the redis nodes by periodically processing snapshots.", "Executes a block wrapped in a ZK exclusive lock.", "Perform a manual failover to a redis node.", "Determines if each snapshot has a sufficient number of node managers.\n\n @param [Hash<Node, Snapshot>] snapshots the current snapshots\n @return [Boolean] true if sufficient, false otherwise", "Invokes the configured failover strategy.\n\n @param [Hash<Node, NodeSnapshot>] snapshots the node snapshots\n @return [Node] a failover candidate", "Initialize a pkcs11 dynamic library.\n\n @param [Hash, CK_C_INITIALIZE_ARGS] args  A Hash or CK_C_INITIALIZE_ARGS instance with load params.", "Obtain an array of Slot objects in the system.\n\n @param [true, false] tokenPresent  indicates whether the list\n    obtained includes only those slots with a token present (true), or\n    all slots (false);\n @return [Array<Slot>]", "Continues a search for token and session objects that match a template,\n obtaining additional object handles.\n\n See {Session#find_objects} for convenience\n @return [Array<PKCS11::Object>] Returns an array of Object instances.", "Generates a secret key Object or set of domain parameters, creating a new\n Object.\n\n @param [Hash, Symbol, Integer, PKCS11::CK_MECHANISM] mechanism  used mechanism\n @param [Hash] template  Attributes of the key to create.\n @return [PKCS11::Object]  key Object of the new created key.\n @example generate 112 bit DES key\n     key = session.generate_key(:DES2_KEY_GEN,\n       {:ENCRYPT=>true, :WRAP=>true, :DECRYPT=>true, :UNWRAP=>true})", "Derives a key from a base key, creating a new key object.\n\n @param [Hash, Symbol, Integer, PKCS11::CK_MECHANISM] mechanism  used mechanism\n @param [PKCS11::Object] base_key  key to derive\n @param [Hash] template  Attributes of the object to create.\n @return [PKCS11::Object]  key object of the new created key.\n @example Derive a AES key by XORing with some derivation data\n     deriv_data = \"\\0\"*16\n     new_key = session.derive_key( {CKM_XOR_BASE_AND_DATA => {:pData => deriv_data}}, secret_key,\n       :CLASS=>CKO_SECRET_KEY, :KEY_TYPE=>CKK_AES, :VALUE_LEN=>16, :ENCRYPT=>true )", "Opens a Session between an application and a token in a particular slot.\n\n @param [Integer] flags  indicates the type of session. Default is read-only,\n         use <tt>CKF_SERIAL_SESSION | CKF_RW_SESSION</tt> for read-write session.\n\n * If called with block, yields the block with the session and closes the session\n   when the is finished.\n * If called without block, returns the session object.\n @return [PKCS11::Session]", "Get the value of one or several attributes of the object.\n\n @param [String, Symbol, Integer, Array] attribute can be String or Symbol\n             of the attribute(s) constant or the attribute(s) number as Integer.\n\n @return [String, Integer, Boolean, Array, nil] the attribute value as String,\n   Integer or true/false depending on the attribute type.\n   If called with more than one parameter or with an Array, a Array\n   of attribute values is returned.\n Unknown attributes (out of PKCS#11 v2.2) are not converted to adequate\n ruby objects but returned as String.\n That is true/false will be returned as \"\\\\001\" respectively \"\\\\000\".\n\n @example\n     object[:VALUE] # => \"\\000\\000\\000\\000\\000\\000\\000\\000\"\n     object[:MODULUS_BITS] # => 768\n     object[:MODULUS_BITS, :LABEL] # => [1024, \"MyKey\"]\n\n See PKCS#11 for attribute definitions.", "Modifies the value of one or several attributes of the object.\n\n @param [String, Symbol, Integer] attribute  can be String or Symbol of the attribute constant\n             or the attribute value as Integer.\n @param [String, Integer, Boolean, Array, nil] value  value(s) the attribute(s) will be set to.\n\n Following value conversations are done from Ruby to C:\n   true   -> 0x01\n   false  -> 0x00\n   nil    -> NULL pointer\n   Integer-> binary encoded unsigned long\n\n @example\n     object[:VALUE] = \"\\000\\000\\000\\000\\000\\000\\000\\000\"\n     object[:MODULUS_BITS] = 768\n     object[:MODULUS_BITS, :LABEL] = 1024, 'MyKey'\n\n See PKCS#11 for attribute definitions.\n @return value", "Obtains the value of one or more attributes of the object in a single call.\n\n @param [Array<String, Symbol, Integer>, Hash, String, Integer] attribute attribute names\n    whose values should be returned\n\n Without params all known attributes are tried to read from the Object.\n This is significant slower then naming the needed attributes and should\n be used for debug purposes only.\n\n @return [Array<PKCS11::CK_ATTRIBUTE>] Requested attributes with values.\n\n @example\n   certificate.attributes :VALUE, :CLASS\n    => [#<PKCS11::CK_ATTRIBUTE CKA_VALUE (17) value=\"0\\x82...\">, #<PKCS11::CK_ATTRIBUTE CKA_CLASS (0) value=1>]", "Get all campaigns detail.\n @param {Array} data contains php array with key value pair.\n @options data {String} type: Type of campaign. Possible values \u2013 classic, trigger, sms, template ( case sensitive ) [Optional]\n @options data {String} status: Status of campaign. Possible values \u2013 draft, sent, archive, queued, suspended, in_process, temp_active, temp_inactive ( case sensitive ) [Optional]\n @options data {Integer} page: Maximum number of records per request is 500, if there are more than 500 campaigns then you can use this parameter to get next 500 results [Optional]\n @options data {Integer} page_limit: This should be a valid number between 1-500 [Optional]", "sign in as a user using the server side flow", "Sign in as a user using credentials", "Sign in as an app", "Sign in with an transfer token, only available for Podio", "Sign in with SSO", "Sign in with an OpenID, only available for Podio", "Sign in with an activation code, only available for Podio", "reconfigure the client with a different access token", "Give the distance in meters between ordered\n location points using the 'Haversine' formula", "Creates a new integration from the supplied hash.\n\n @param params [Hash] A hash with symbolic keys representing the instance\n                      attributes of this integration. The key +:name+ is\n                      required.\n Updates the integration from the supplied hash.\n\n @param params [Hash] A hash with symbolic keys representing the instance\n                      attributes of this integration.", "Adds the specified channels to this integration.\n\n @note This method is not thread-safe and should only be called from an\n       active transaction.\n @param channels [Hash] the channel data to add\n @param conf [Hash] the previously deserialized configuration\n @raise [CommandError] if one of the channel identifiers already exists", "Deletes the specified channels from this integration.\n\n @note This method is not thread-safe and should only be called from an\n       active transaction.\n @param identifiers [Array<String>] the channel identifiers to remove\n @raise [CommandError] if one of the channel identifiers does not exist", "Sets the list of channels.\n\n @param channels [Array<Channel>] the list of channels\n @param conf [Hash] the previously deserialized configuration", "Serializes this integration.\n\n @param conf [Hash] the deserialized configuration\n @return [Array, Hash] the serialized object", "Sends a command to the named pipe.\n\n @param cmd [String] the command\n @param explicit [Boolean] whether this command was invoked explicitly\n @return [Boolean] whether the command was sent successfully", "Constructs a new integration manager for a specified configuration.\n\n @param config [Config] the configuration to manage\n Creates a new integration from the given parameters.\n\n @param params [Hash] the parameters to initialize the integration with", "Updates an integration with the given parameters.\n\n @param name [String] the current name of the integration to update\n @param params [Hash] the parameters to update the integration with", "Destroys an integration.\n\n @param name [String] the name of the integration to destroy\n @param params [Hash] the command-line options", "Lists all integrations, or integrations with names containing the given\n search term.\n\n @param search [String, nil] an optional search term", "Finds an integration given its name.\n\n @param name [String] the name to search for\n @raise [CommandError] if no integration with the given name exists\n @return [Integration] the integration", "Checks that the specified name and endpoint are available for use.\n\n @param name [String] the name to check for\n @param endpoint [String] the endpoint to check for\n @raise [CommandError] if name or endpoint are already taken", "Checks that the specified name and endpoint are available for use by the\n specified integration.\n\n @param name [String] the name to check for\n @param endpoint [String] the endpoint to check for\n @param intg [Integration] the integration to ignore\n @raise [CommandError] if name or endpoint are already taken", "Updates the channels associated with an integration from the specified\n parameters.\n\n @param integration [Integration] the integration\n @param params [Hash] the parameters to update the integration with. Valid\n                      keys are +:clear_channels+ to clear the channel list\n                      before proceeding, +:add_channel+ to add the given\n                      channels, and +:delete_channel+ to delete the given\n                      channels from the integration. All keys are optional.\n                      The value of +:clear_channels+ should be a boolean.\n                      The value of +:add_channel+ should be a hash of the\n                      form +identifier => params+, and +:remove_channel+\n                      should be an array of channel identifiers to remove.", "Prints information about an integration.\n\n @param integration [Integration] the integration", "Prints information about the channels associated with an integration.\n\n @param integration [Integration] the integration", "Constructs a new network manager for a specified configuration.\n\n @param config [Config] the configuration to manage\n Creates a new network from the given parameters.\n\n @param params [Hash] the parameters to initialize the network with", "Updates a network with the given parameters.\n\n @param name [String] the current name of the network to update\n @param params [Hash] the parameters to update the network with", "Destroys a network.\n\n @param name [String] the name of the network to destroy\n @param params [Hash] the command-line options", "Lists all networks, or networks with names containing the given search\n term.\n\n @param search [String, nil] an optional search term", "Finds a network given its name.\n\n @param name [String] the name to search for\n @raise [CommandError] if no network with the given name exists\n @return [Network] the network", "Checks that all channels associated with an integration belong to a valid\n network.\n\n @param integration [Integration] the integration to check", "Checks that the specified name is available for use by the specified\n network.\n\n @param name [String] the name to check for\n @param network [Network] the network to ignore\n @raise [CommandError] if the name is already taken", "Prints information about a network.\n\n @param network [Network] the network", "Waits for this bot to stop. If any of the managed threads finish early,\n the bot is shut down immediately.", "Sets traps for SIGINT and SIGTERM so Codebot can shut down gracefully.", "Creates a new Sinatra server for handling incoming requests.\n\n @return [Class] the created server", "Handles a POST request.\n\n @param core [Core] the bot to dispatch requests to\n @param request [Sinatra::Request] the request to handle\n @param params [Hash] the request parameters", "Dispatches a received payload to the IRC client.\n\n @param core [Core] the bot to dispatch this request to\n @param request [Sinatra::Request] the request received by the web server\n @param endpoint [String] the endpoint at which the request was received\n @param payload [String] the payload that was sent to the endpoint\n @return [Array<Integer, String>] HTTP status code and response", "Creates a new request for the webhook.\n\n @param integration [Integration] the integration for which the request\n                                  was made\n @param request [Sinatra::Request] the request received by the web server\n @param payload [String] the payload that was sent to the endpoint\n @return [Request, Array<Integer, String>] the created request, or an\n                                           array containing HTTP status\n                                           code and response if the\n                                           request was invalid", "Verifies a webhook signature.\n\n @param request [Sinatra::Request] the request received by the web server\n @param integration [Integration] the integration for which the request\n                                  was made\n @param payload [String] the payload that was sent to the endpoint\n @return [Boolean] whether the signature is valid", "Creates a new IRC client.\n\n @param core [Core] the bot this client belongs to\n Dispatches a new request.\n\n @param request [Request] the request to dispatch", "Connects to and disconnects from networks as necessary in order for the\n list of connections to reflect changes to the configuration.", "Disconnects from a given network if the network is currently connected.\n\n @param network [Network] the network to disconnected from", "Formats a number.\n\n @param num [Integer] the number\n @param singular [String, nil] the singular noun to append to the number\n @param plural [String, nil] the plural noun to append to the number\n @return [String] the formatted number", "Constructs a sentence from array elements, connecting them with commas\n and conjunctions.\n\n @param ary [Array<String>] the array\n @param empty_sentence [String, nil] the sentence to return if the array\n                                     is empty\n @return [String] the constructed sentence", "Truncates the given text, appending a suffix if it was above the allowed\n length.\n\n @param text [String] the text to truncate\n @param suffix [String] the suffix to append if the text is truncated\n @param length [Integer] the maximum length including the suffix\n @yield [String] the truncated string before the ellipsis is appended\n @return short [String] the abbreviated text", "Abbreviates the given text, removes any trailing punctuation except for\n the ellipsis appended if the text was truncated, and sanitizes the text\n for delivery to IRC.\n\n @param text [String] the text to process\n @return [String] the processed text", "Safely extracts a value from a JSON object.\n\n @param path [Array<#to_s>] the path to traverse\n @return [Object, nil] the extracted object or +nil+ if no object was\n                       found at the given path", "Starts this IPC server.", "Handles an incoming IPC command.\n\n @param command [String] the command", "Sanitizes a network name.\n\n @param name [String] the name of the network\n @param conf [Hash] the configuration containing all networks\n @return [Network, nil] the corresponding network or +nil+ on error", "Creates a new channel from the supplied hash.\n\n @param params [Hash] A hash with symbolic keys representing the instance\n                      attributes of this channel. The keys +:name+ and\n                      +:network+ are required. Alternatively, the key\n                      +:identifier+, which should use the format\n                      +network/name+, can be specified.\n Updates the channel from the supplied hash.\n\n @param params [Hash] A hash with symbolic keys representing the instance\n                      attributes of this channel.", "Sets the network for this channel.\n\n @param network [String] the name of the network\n @param conf [Hash] the configuration containing all networks", "Sets network and channel name based on the given identifier.\n\n @param identifier [String] the identifier\n @param conf [Hash] the configuration containing all networks", "Loads the configuration from the specified file.\n\n @param file [String] the path to the configuration file\n @return [Hash] the loaded configuration, or the default configuration if\n                the file did not exist", "Saves the configuration to the specified file.\n\n @param file [String] the path to the configuration file", "Creates a new network from the supplied hash.\n\n @param params [Hash] A hash with symbolic keys representing the instance\n                      attributes of this network. The keys +:name+ and\n                      +:host+ are required.\n Updates the network from the supplied hash.\n\n @param params [Hash] A hash with symbolic keys representing the instance\n                      attributes of this network.", "Updates the connection details of this network.\n\n @param host [String] the new hostname, or +nil+ to keep the current value\n @param port [Integer] the new port, or +nil+ to keep the current value\n @param secure [Boolean] whether to connect over TLS, or +nil+ to keep the\n                         current value", "Updates the SASL authentication details of this network.\n\n @param disable [Boolean] whether to disable SASL, or +nil+ to keep the\n                          current value.\n @param user [String] the SASL username, or +nil+ to keep the current value\n @param pass [String] the SASL password, or +nil+ to keep the current value", "Updates the NickServ authentication details of this network.\n\n @param disable [Boolean] whether to disable NickServ, or +nil+ to keep the\n                          current value.\n @param user [String] the NickServ username, or +nil+ to keep the\n                          current value\n @param pass [String] the NickServ password, or +nil+ to keep the\n                          current value", "Serializes this network.\n\n @param _conf [Hash] the deserialized configuration\n @return [Array, Hash] the serialized object", "Starts a new managed thread if no thread is currently running.\n The thread invokes the +run+ method of the class that manages it.\n\n @param arg the argument to pass to the +#run+ method\n @return [Thread, nil] the newly created thread, or +nil+ if\n                       there was already a running thread", "Starts this IRC thread.\n\n @param connection [IRCConnection] the connection the thread controls", "Delivers a message to an IRC channel.\n\n @param bot [Cinch::Bot] the IRC bot\n @param message [Message] the message to deliver", "Gets the list of channels associated with this network.\n\n @param config [Config] the configuration to search\n @param network [Network] the network to search for\n @return [Array<Channel>] the list of channels", "Constructs a new bot for the given IRC network.\n\n @param con [IRCConnection] the connection the thread controls", "return the user with the given id; if it isn't in our room cache,\n do a request to get it", "Perform a request for the user with the given ID", "Initialize a new CLI instance to handle option parsing from arguments\n   into configuration to start the coordinator running on all mailboxes\n\n @param args [Array] `ARGV` passed from `bin/mail_room`\n Start the coordinator running, sets up signal traps", "run the mailbox watcher", "Kicks off a thread to watch the sketch, reloading JRubyArt\n and restarting the sketch whenever it changes.", "Convenience function to report errors when loading and running a sketch,\n instead of having them eaten by the thread they are loaded in.", "Close and shutter a running sketch. But don't exit.\n @HACK seems to work with watch until we find a better\n way of disposing of sketch window...", "Nice block method to draw to a buffer.\n You can optionally pass it a width, a height, and a renderer.\n Takes care of starting and ending the draw for you.", "hue, sat, brightness in range 0..1.0 returns RGB color int", "explicitly provide 'processing.org' dist instance method", "Uses PImage class method under hood", "There's just so many functions in Processing,\n Here's a convenient way to look for them.", "Proxy over a list of Java declared fields that have the same name as\n some methods. Add to this list as needed.", "Dispatch central.", "Parse the command-line options.", "For extra security, this method must be overloaded by the extending class.", "Can be overloaded for custom titles", "Export Filter Data", "deprecated for Rails 3.0 and up", "Make HTTP request to Catapult API\n @param method [Symbol] http method to make\n @param path [String] path of url (exclude api verion and endpoint) to make call\n @param data [Hash] data  which will be sent with request (for :get and :delete request they will be sent with query in url)\n @return [Array] array with 2 elements: parsed json data of response and response headers", "Check response object and raise error if status code >= 400\n @param response response object", "Convert all keys of a hash to camel cased strings", "Convert all keys of hash to underscored symbols", "Serialize asset to fileupload JSON format", "Request the transcription process to be started for the given recording id.\n @return [Hash] created transcription\n @example\n   transcription = recording.create_transcription()", "Returns the class to be used as the authorization adapter", "many? for Mongoid and collection? for AR", "Add a member to a conference.\n @param data [Hash] data to add member to a conference\n @return [ConferenceMember] created member\n @example\n   member = conference.create_member(:call_id=>\"id\")", "Retrieve information about a particular conference member\n @param member_id [String] id of member\n @return [ConferenceMember] member information\n @example\n   member = conference.get_member(\"id\")", "List all members from a conference\n @return [Array] array of ConferenceMember instances\n @example\n   members = conference.get_members()", "Prints a QR Code to the PDF document. The QR Code creation happens on the fly.\n\n content::  The string to render as content of the QR Code\n\n *options:: Named optional parameters\n\n   +:level+:: Error correction level to use. One of: (:l,:m,:h,:q), Defaults to :m\n   +:extent+:: Size of QR Code given in pt (1 pt == 1/72 in)\n   +:pos+:: Two-element array containing the position at which the QR-Code should be rendered. Defaults to [0,cursor]\n   +:dot+:: Size of QR Code module/dot. Calculated from extent or defaulting to 1pt\n   +:stroke+:: boolean value whether to draw bounds around the QR Code.\n             Defaults to true.\n   +:margin+:: Size of margin around code in QR-Code modules/dots, Default to 4\n   +:align+:: Optional alignment within the current bounding box. Valid values are :left, :right, and :center. If set\n             This option overrides the horizontal positioning specified in :pos. Defaults to nil.\n   +:debug+:: Optional boolean, renders a coordinate grid around the QRCode if true (uses Prawn#stroke_axis)", "Add a endpoint to a domain.\n @param data [Hash] data to add endpoint to a domain\n @return [EndPoint] created endpoint\n @example\n   endpoint = domain.create_endpoint(:name=>\"name\", :application_id => \"id\")", "Retrieve information about an endpoint\n @param endpoint_id [String] id of endpoint\n @return [EndPoint] endpoint information\n @example\n   endpoint = domain.get_endpoint(\"id\")", "List all endpoints from a domain\n @return [Array] array of EndPoint instances\n @example\n   endpoints = domain.get_endpoints()", "Delete an endpoint\n @example\n   domain.delete_endpoint(\"id\")", "Gather the DTMF digits pressed\n @param data [String|Hash] sentence to speak on creating cather if string, otherwise it is hash with gather options\n @return [Hash] created gather\n @example\n   gather = call.create_gather(\"Press a digit\")\n   gather = call.create_gather(:max_digits => 1, :prompt => {:sentence => \"Press a digit\",  :bargeable => true })", "Speak a sentence\n @param sentence [String[ sentence to speak\n @param tag [String] optional tag value\n @param gender [String] optional gender of voice\n @param voice [String] optional voice name", "Extracts data criteria from the HQMF document.", "This method is needed for situations when there is a only\n a negated version of a data criteria.  Bonnie will only\n show the affirmative version of data criteria.  This method\n will create an affirmative version of a data criteria when there\n is only the negative one in the HQMF.", "Returns an array of measures, will contain a single measure if it is a non-composite measure", "Creates and returns a measure", "Extract the code system from the xml taht the document should use", "Handles parsing the attributes of the document", "Extracts the mappings between actual HQMF populations and their\n corresponding CQL define statements.", "Extracts the name of the main cql library from the Population Criteria Section.", "Get the title of the criteria, provides a human readable description\n @return [String] the title of this data criteria", "render weixin server authorize results", "music = generate_music", "Takes a node and a filename as arguments", "Takes an arbitrary number of child nodes, adds them to the list of children,\n and make this node their parent.", "Renders text nodes with all markings.", "Returns a rendered RichText document", "Renders asset nodes", "Renders all nodes in the document.", "Parse all found storyboards and build a dictionary of constant => locations\n\n A constant key can potentially exist in many files so locations is a collection", "Convert a Textile string into HTML output.\n\n input - The Textile String to convert.\n\n Returns the HTML formatted String.", "Data structure for holdings information of bib records.\n A hash with mms ids as keys, with values of an array of\n one or more hashes of holdings info", "Access the top level JSON attributes as object methods", "Persist the user in it's current state back to Alma", "Handle form data, JSON body, or a blank value", "Execute an action on a resource\n\n @param action [Symbol]\n @param params [Hash]\n @param headers [Hash]\n @param options [Hash]\n @return [Hash]", "Makes a request to the remote service.", "Pull certain fields out of the controller and add to the data hash.", "Simple description of the change.\n @return [String]", "Evaluate a block, just like it was a constructor block.", "Merge in a hash containing constant values. Arrays will be resolved as colors in RGBA or RGB format.\n\n @param [Hash<Symbol => Object>] constants_hash", "Merge in a hash containing default values for each element.\n\n @param [Hash<Symbol => Hash>] elements_hash", "Returns the range of the selection.\n\n @return [Range]", "Sets the text within the selection. The caret will be placed at the end of the inserted text.\n\n @param [String] str Text to insert.\n @return [String] The new selection text.", "Position of the caret.\n\n @param [Integer] pos Position of caret in the text.\n @return [Integer] New position of caret.", "Draw the text area.\n\n @return [nil]", "Index of character in reference to the displayable text.", "Cut the selection and copy it to the clipboard.", "Create a button within the container.", "Create an icon.", "Returns the element within this container that was hit,\n @return [Element, nil] The element hit, otherwise nil.", "Set the position of the icon, respective to the text.", "Recalculate the size of the container.\n Should be overridden by any descendant that manages the positions of its children.", "Draw a filled rectangle.", "Draw an unfilled rectangle.", "Turn notifications on.\n\n @param [Hash] options the turn_on options\n @option options [Boolean] silent disable any logging", "Turn notifications off.", "Show a system notification with all configured notifiers.\n\n @param [String] message the message to show\n @option opts [Symbol, String] image the image symbol or path to an image\n @option opts [String] title the notification title", "Insatance of Runner, selected based on format and runmode.", "Invoked when a test passes.", "After all tests are run, this is the last observable action.", "Creates an optionally-colorized string describing the number of occurances an event occurred.\n\n @param [String] str A printf-style string that expects an integer argument (i.e. the count)\n @param [Integer] count The number of occurances of the event being described.\n @param [nil, Symbol] colorize_method The method on Colorize to call in order to apply color to the result, or nil\n   to not apply any coloring at all.", "Cleanups and prints test payload\n\n Example:\n         fail is not 1\n       @ test/test_runners.rb:46:in `test_autorun_with_trace'\n         bin/turn:4:in `<main>'", "Run command.", "Test files.", "Load reporter based on output mode and return its class.", "Turn calls this method to start the test run.", "Pass in params from Rails routing", "return changes hash, currently exists to keep compatibility with importer html", "Return the first error we get", "adds attributes like virtual", "Validation\n We want to validate an attribute if its\n uncoerced value is not nil", "Set the context of tags so that draft and archived tags are not displayed publicly", "Checks if the User has a given role\n\n @param role_sym [Symbol] role(s) to check - Can be array of symbols or one symbol\n\n @return [Boolean] whether or not user has role(s)", "Renders the provided list\n\n @return [String] the rendered list item", "Signs a user in\n @param user [Integral::User] user to sign in", "Creates array of related posts. If enough related posts do not exist uses popular posts", "Override full_filename to set version name at the end", "Override full_original_filename to set version name at the end", "Renders a thumbnail gallery", "Forward the enquiry on and send an auto reply. Create newsletter signup if necessary", "Loop over all list item children calling render on each\n\n @return [String] compiled string of all the rendered list item children", "Works out what the provided attr evaluates to.\n\n @param attr [Symbol] attribute to evaluate\n\n @return [String] value of attribute", "Tags to be used within the header of an article to describe the subject", "Preview image for the post if present. Otherwise returns featured image", "Image for the post if present. Otherwise returns default image", "Creates an anchor link\n\n @param body [String] body of the link\n @param location [String] location of the anchor\n\n @return [String] anchor to a particular location of the current page", "Override method_missing to check for main app routes before throwing exception", "Attempts to signup an email to newsletter", "Send supplied enquiry to contact email\n\n @param enquiry [Enquiry] enquiry which the visitor has created", "Send an auto reply to the visitor of the supplied enquiry\n\n @param enquiry [Enquiry] enquiry which the visitor has created", "BASE METHODS\n Public methods", "I think we shouldn't to have my_deleted_comments cache counter", "Hobo Fields field declaration", "The problem in RubyZip 1.1.0 is that we only call `seek`\n when `io` is a File. We need to move the cursor to the\n right position when `io` is a StringIO as well.", "List existing direct debit authorities for a given bank account\n\n @see https://reference.promisepay.com/#list-direct-debit-authorities\n\n @param account_id [String] account id to retrieve direct debit authorities from.\n @param options [Hash] Optional options.\n @option options [Integer] :limit Can ask for up to 200 users. default: 10\n @option options [Integer] :offset Pagination help. default: 0\n\n @return [Array<Promisepay::DirectDebitAuthority>] List of direct debit authorities.", "Validate a US bank routing number before creating an account.\n This can be used to provide on-demand verification,\n and further information of the bank information a User is providing.\n\n @see https://reference.promisepay.com/#validate-routing-number\n\n @param routing_number [String] Bank account Routing Number\n\n @return [Hash]", "List all companies for a marketplace\n\n @see https://reference.promisepay.com/#list-companies\n\n @param options [Hash] Optional options.\n @option options [Integer] :limit Can ask for up to 200 users. default: 10\n @option options [Integer] :offset Pagination help. default: 0\n\n @return [Array<Promisepay::Company>] List all companies for a marketplace.", "Update a company for a user\n\n @see https://reference.promisepay.com/#update-company\n\n @param attributes [Hash] Company's attributes.\n\n @return [Promisepay::Company]", "Catch calls for resources", "Show the buyer detail for a single item for a marketplace.\n\n @see https://reference.promisepay.com/#show-item-buyer\n\n @return [Promisepay::User]", "Get fees associated to the item.\n\n @see https://reference.promisepay.com/#show-item-fees\n\n @param options [Hash] Optional options.\n @option options [Integer] :limit Can ask for up to 200 fees. default: 10\n @option options [Integer] :offset Pagination help. default: 0\n\n @return [Array<Promisepay::Fee>]", "Get historical transactions for the item.\n\n @see https://reference.promisepay.com/#list-item-transactions\n\n @param options [Hash] Optional options.\n @option options [Integer] :limit Can ask for up to 200 transactions. default: 10\n @option options [Integer] :offset Pagination help. default: 0\n\n @return [Array<Promisepay::Transaction>]", "Get historical batch_transactions for the item.\n\n @see https://reference.promisepay.com/#list-item-batch-transactions\n\n @param options [Hash] Optional options.\n @option options [Integer] :limit Can ask for up to 200 transactions. default: 10\n @option options [Integer] :offset Pagination help. default: 0\n\n @return [Array<Promisepay::BatchTransaction>]", "Make a payment for an Item.\n\n @see https://reference.promisepay.com/#make-payment\n\n @return [Boolean]", "Request payment for an Item.\n\n @see https://reference.promisepay.com/#request-payment\n\n @return [Boolean]", "Release funds held in escrow from an Item with an Escrow or Escrow Partial Release\n payment type.\n\n @see https://reference.promisepay.com/#release-payment\n\n @return [Boolean]", "Request release of funds held in escrow, from an Item with an Escrow or Escrow Partial\n Release payment type.\n\n @see https://reference.promisepay.com/#request-release\n\n @return [Boolean]", "Acknowledge that funds are being wired for payment.\n\n @see https://reference.promisepay.com/#acknowledge-wire-transfer\n\n @return [Boolean]", "Revert an acknowledge wire Item Action.\n\n @see https://reference.promisepay.com/#revert-wire-transfer\n\n @return [Boolean]", "Request a refund for an Item.\n\n @see https://reference.promisepay.com/#request-refund\n\n @return [Boolean]", "Raise a dispute for the Item.\n\n @see https://reference.promisepay.com/#raise-dispute\n\n @return [Boolean]", "List all items for a marketplace\n\n @see https://reference.promisepay.com/#list-items\n\n @param options [Hash] Optional options.\n @option options [Integer] :limit Can ask for up to 200 items. default: 10\n @option options [Integer] :offset Pagination help. default: 0\n\n @return [Array<Promisepay::Item>] List all items for a marketplace.", "Get a single item for a marketplace\n\n @see https://reference.promisepay.com/#show-item\n\n @param id [String] Marketplace item ID.\n\n @return [Promisepay::Item]", "Gets Bank account for a user on a marketplace.\n\n @see https://reference.promisepay.com/#show-user-bank-account\n\n @return [Promisepay::BankAccount]", "Gets Card account for a user on a marketplace.\n\n @see https://reference.promisepay.com/#show-user-card-account\n\n @return [Promisepay::CardAccount]", "Gets PayPal account for a user on a marketplace.\n\n @see https://reference.promisepay.com/#show-user-paypal-account\n\n @return [Promisepay::PaypalAccount]", "Set the disbursement account for a user.\n\n @see https://reference.promisepay.com/#set-user-disbursement-account\n\n @return [Boolean]", "Gets company for a user on a marketplace.\n\n @see\n\n @return [Promisepay::Company]", "Get a single fee for a marketplace\n\n @see https://reference.promisepay.com/#show-fee\n\n @param id [String] Marketplace Fee ID.\n\n @return [Promisepay::Fee]", "Create a fee for a marketplace\n\n @see https://reference.promisepay.com/#create-fee\n\n @param attributes [Hash] Item's attributes.\n\n @return [Promisepay::Item]", "Withdraw funds from a Wallet Account to a specified disbursement account.\n\n @see https://reference.promisepay.com/#withdraw-funds\n\n @param options [Hash] Optional options.\n @option options [String] :account_id Account to withdraw to.\n @option options [Integer] :amount Amount (in cents) to withdraw.\n\n @return [Hash]", "Deposit funds to a Wallet Account from a specified payment account.\n\n @see https://reference.promisepay.com/#deposit-funds\n\n @param options [Hash] Optional options.\n @option options [String] :account_id Account to deposit from.\n @option options [Integer] :amount Amount (in cents) to deposit.\n\n @return [Hash]", "Show the User the Wallet Account is associated with\n\n @return [Promisepay::User]", "Gets a transactions fee details if applicable.\n\n @see https://reference.promisepay.com/#shows-transaction-fees\n\n @return [Promisepay::Fee]", "Create a new token for an item\n\n @see https://reference.promisepay.com/#generate-card-token\n\n @param attributes [Hash] Token's attributes.\n\n @return [Hash]", "List all charges\n\n @see https://reference.promisepay.com/#list-charges\n\n @param options [Hash] Optional options.\n @option options [Integer] :limit Can ask for up to 200 charges. default: 10\n @option options [Integer] :offset Pagination help. default: 0\n\n @return [Array<Promisepay::Charge>] List all charges.", "Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.\n @param doc The document to be created.\n @param [Hash] opts the optional parameters\n @return [AsyncDoc]", "Creates a document synchronously.\n @param doc The document to be created.\n @param [Hash] opts the optional parameters\n @return [String]", "Downloads a document.\n @param id The download_id returned from status request or a callback.\n @param [Hash] opts the optional parameters\n @return [String]", "Check on the status of an asynchronously created document.\n @param id The status_id returned when creating an asynchronous document.\n @param [Hash] opts the optional parameters\n @return [AsyncDocStatus]", "A list of activities the user likes\n\n @example\n   current_user.likes\n\n @return [ActiveRecord::Relation]", "Checks if the person likes the object or not\n\n @example\n   current_user.likes?(object)\n\n @param object [type]\n\n @return [TrueClass] if the person likes the object\n @return [FalseClass] if the person does not like the object", "Add an audience to the activity\n\n @param activity: [Socializer::Activity] The activity to add the audience\n to", "Instance Methods\n Invoke the AudienceList instance. This is the primary public API method.\n Create the audience list\n\n @return [Array]\n DISCUSS: Should this return a Set instead of an Array", "Build the list of people based on the query\n\n @return [ActiveRecord::NullRelation] If query is nil or \"\", Person.none\n is returned\n @return [ActiveRecord::Relation] If a query is provided the display_name\n and guid\n for all records that match the query", "Instance Methods\n A list of people that like this activity object\n\n @return [Array]\n REFACTOR: DRY this up. Reduce database calls", "Builds an HTML time tag\n\n @param options [Hash]\n\n @return [String] An HTML time tag", "Instance Methods\n Invoke the AddDefaultCircles instance. This is the primary public API\n method.\n Add the default circles", "Instance Methods\n Invoke the ActivityAudienceList instance. This is the primary public\n API method.\n\n @return [Array]", "In the case of LIMITED audience, then go through all the audience\n circles and add contacts from those circles in the list of allowed\n audience.", "Retrieves the comments for an activity\n\n @return [ActiveRecord::AssociationRelation] a collection of\n {Socializer::Activity} objects", "Builds the like or unlike link\n\n @return [String] the html needed to display the like/unlike link", "Creates an image tag for the persons avatar\n\n @param size: nil [String]\n @param css_class: nil [String]\n @param alt: \"Avatar\" [String]\n @param title: nil [String]\n\n @return [String]  An HTML image tag", "Creates a link to the persons profile with their avatar as the content\n\n @return [String] An HTML a tag", "Builds the links for the shared toolbar\n\n @return [String] the html needed to display the toolbar links", "Returns a specific student contact\n @param id\n @param [Hash] opts the optional parameters\n @return [ContactResponse]", "Returns the contacts for a student\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [ContactsResponse]", "Returns a specific course\n @param id\n @param [Hash] opts the optional parameters\n @return [CourseResponse]", "Returns the course for a section\n @param id\n @param [Hash] opts the optional parameters\n @return [CourseResponse]", "Returns a specific district\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns a specific district admin\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictAdminResponse]", "Returns the district for a student contact\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns the district for a course\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns the district for a district admin\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns the district for a school\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns the district for a school admin\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns the district for a section\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns the district for a student\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns the district for a teacher\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns the district for a term\n @param id\n @param [Hash] opts the optional parameters\n @return [DistrictResponse]", "Returns a specific school\n @param id\n @param [Hash] opts the optional parameters\n @return [SchoolResponse]", "Returns a specific school admin\n @param id\n @param [Hash] opts the optional parameters\n @return [SchoolAdminResponse]", "Returns the school for a section\n @param id\n @param [Hash] opts the optional parameters\n @return [SchoolResponse]", "Returns the primary school for a student\n @param id\n @param [Hash] opts the optional parameters\n @return [SchoolResponse]", "Retrieves school info for a teacher.\n @param id\n @param [Hash] opts the optional parameters\n @return [SchoolResponse]", "Returns the schools for a school admin\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [SchoolsResponse]", "Returns the schools for a student\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [SchoolsResponse]", "Returns the schools for a teacher\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [SchoolsResponse]", "Returns a specific section\n @param id\n @param [Hash] opts the optional parameters\n @return [SectionResponse]", "Returns the sections for a Courses\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [SectionsResponse]", "Returns the sections for a school\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [SectionsResponse]", "Returns the sections for a student\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [SectionsResponse]", "Returns the sections for a teacher\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [SectionsResponse]", "Returns the sections for a term\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [SectionsResponse]", "Returns a specific student\n @param id\n @param [Hash] opts the optional parameters\n @return [StudentResponse]", "Returns the students for a student contact\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [StudentsResponse]", "Returns the students for a school\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [StudentsResponse]", "Returns the students for a section\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [StudentsResponse]", "Returns the students for a teacher\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [StudentsResponse]", "Returns a specific teacher\n @param id\n @param [Hash] opts the optional parameters\n @return [TeacherResponse]", "Returns the primary teacher for a section\n @param id\n @param [Hash] opts the optional parameters\n @return [TeacherResponse]", "Returns a list of teachers\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [Array<(TeachersResponse, Fixnum, Hash)>] TeachersResponse data, response status code and response headers", "Returns the teachers for a school\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [TeachersResponse]", "Returns the teachers for a section\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [TeachersResponse]", "Returns the teachers for a student\n @param id\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit\n @option opts [String] :starting_after\n @option opts [String] :ending_before\n @return [TeachersResponse]", "Returns a specific term\n @param id\n @param [Hash] opts the optional parameters\n @return [TermResponse]", "Returns the term for a section\n @param id\n @param [Hash] opts the optional parameters\n @return [TermResponse]", "Returns the specific event\n @param id\n @param [Hash] opts the optional parameters\n @return [EventResponse]", "Open socket to Apple's servers", "module methods\n Matrix and vector products\n Dot product.\n @param a [Numo::NArray] matrix or vector (>= 1-dimensinal NArray)\n @param b [Numo::NArray] matrix or vector (>= 1-dimensinal NArray)\n @return [Numo::NArray] result of dot product", "Compute a square matrix `a` to the power `n`.\n\n  * If n > 0: return `a**n`.\n  * If n == 0: return identity matrix.\n  * If n < 0: return `(a*\\*-1)*\\*n.abs`.\n\n @param a [Numo::NArray] square matrix (>= 2-dimensinal NArray).\n @param n [Integer] the exponent.\n @example\n     i = Numo::DFloat[[0, 1], [-1, 0]]\n     => Numo::DFloat#shape=[2,2]\n     [[0, 1],\n      [-1, 0]]\n     Numo::Linalg.matrix_power(i,3)\n     => Numo::DFloat#shape=[2,2]\n     [[0, -1],\n      [1, 0]]\n     Numo::Linalg.matrix_power(i,0)\n     => Numo::DFloat#shape=[2,2]\n     [[1, 0],\n      [0, 1]]\n     Numo::Linalg.matrix_power(i,-3)\n     => Numo::DFloat#shape=[2,2]\n     [[0, 1],\n      [-1, 0]]\n\n     q = Numo::DFloat.zeros(4,4)\n     q[0..1,0..1] = -i\n     q[2..3,2..3] = i\n     q\n     => Numo::DFloat#shape=[4,4]\n     [[-0, -1, 0, 0],\n      [1, -0, 0, 0],\n      [0, 0, 0, 1],\n      [0, 0, -1, 0]]\n     Numo::Linalg.matrix_power(q,2)\n     => Numo::DFloat#shape=[4,4]\n     [[-1, 0, 0, 0],\n      [0, -1, 0, 0],\n      [0, 0, -1, 0],\n      [0, 0, 0, -1]]", "Computes the Singular Values of a M-by-N matrix A.\n The SVD is written\n\n     A = U * SIGMA * transpose(V)\n\n where SIGMA is an M-by-N matrix which is zero except for its\n min(m,n) diagonal elements. The diagonal elements of SIGMA\n are the singular values of A; they are real and non-negative, and\n are returned in descending order.\n\n @param a [Numo::NArray] m-by-n matrix A (>= 2-dimensinal NArray)\n @param driver [String or Symbol] choose LAPACK solver from 'svd',\n   'sdd'. (optional, default='svd')\n @return [Numo::NArray] returns SIGMA (singular values).", "Computes an orthonormal basis for the range of matrix A.\n\n @param a [Numo::NArray] m-by-n matrix A (>= 2-dimensional NArray).\n @param rcond [Float] (optional)\n   rcond is used to determine the effective rank of A.\n   Singular values `s[i] <= rcond * s.max` are treated as zero.\n   If rcond < 0, machine precision is used instead.\n @return [Numo::NArray] The orthonormal basis for the range of matrix A.", "Computes an orthonormal basis for the null space of matrix A.\n\n @param a [Numo::NArray] m-by-n matrix A (>= 2-dimensional NArray).\n @param rcond [Float] (optional)\n   rcond is used to determine the effective rank of A.\n   Singular values `s[i] <= rcond * s.max` are treated as zero.\n   If rcond < 0, machine precision is used instead.\n @return [Numo::NArray] The orthonormal basis for the null space of matrix A.", "Computes an LU factorization of a M-by-N matrix A\n using partial pivoting with row interchanges.\n\n The factorization has the form\n\n     A = P * L * U\n\n where P is a permutation matrix, L is lower triangular with unit\n diagonal elements (lower trapezoidal if m > n), and U is upper\n triangular (upper trapezoidal if m < n).\n\n @param a [Numo::NArray] m-by-n matrix A (>= 2-dimensinal NArray)\n @param permute_l [Bool] (optional) If true, perform the matrix product of P and L.\n @return [[p,l,u]] if permute_l == false\n @return [[pl,u]]  if permute_l == true\n\n   - **p** [Numo::NArray] -- The permutation matrix P.\n   - **l** [Numo::NArray] -- The factor L.\n   - **u** [Numo::NArray] -- The factor U.", "Solves a system of linear equations\n\n     A * X = B  or  A**T * X = B\n\n with a N-by-N matrix A using the LU factorization computed by\n Numo::Linalg.lu_fact\n\n @param lu [Numo::NArray] matrix containing the factors L and U\n   from the factorization `A = P*L*U` as computed by\n   Numo::Linalg.lu_fact.\n @param ipiv [Numo::NArray] The pivot indices from\n   Numo::Linalg.lu_fact; for 1<=i<=N, row i of the matrix was\n   interchanged with row IPIV(i).\n @param b [Numo::NArray] the right hand side matrix B.\n @param trans [String or Symbol]\n   Specifies the form of the system of equations:\n     - If 'N': `A * X = B` (No transpose).\n     - If 'T': `A*\\*T* X = B` (Transpose).\n     - If 'C': `A*\\*T* X = B` (Conjugate transpose = Transpose).\n @return [Numo::NArray]  the solution matrix X.", "Computes the eigenvalues only for a square nonsymmetric matrix A.\n\n @param a [Numo::NArray] square nonsymmetric matrix (>= 2-dimensinal NArray)\n @return [Numo::NArray] eigenvalues", "Compute the condition number of a matrix\n using the norm with one of the following order.\n\n     |  ord  |  matrix norm           |\n     | ----- | ---------------------- |\n     |  nil  | 2-norm using SVD       |\n     | 'fro' | Frobenius norm         |\n     | 'inf' | x.abs.sum(axis:-1).max |\n     |    1  | x.abs.sum(axis:-2).max |\n     |    2  | 2-norm (max sing_vals) |\n\n @param a [Numo::NArray] matrix or vector (>= 1-dimensinal NArray)\n @param ord [String or Symbol] Order of the norm.\n @return [Numo::NArray] cond result\n @example\n     a = Numo::DFloat[[1, 0, -1], [0, 1, 0], [1, 0, 1]]\n     => Numo::DFloat#shape=[3,3]\n     [[1, 0, -1],\n      [0, 1, 0],\n      [1, 0, 1]]\n     LA = Numo::Linalg\n     LA.cond(a)\n     => 1.4142135623730951\n     LA.cond(a, 'fro')\n     => 3.1622776601683795\n     LA.cond(a, 'inf')\n     => 2.0\n     LA.cond(a, '-inf')\n     => 1.0\n     LA.cond(a, 1)\n     => 2.0\n     LA.cond(a, -1)\n     => 1.0\n     LA.cond(a, 2)\n     => 1.4142135623730951\n     LA.cond(a, -2)\n     => 0.7071067811865475\n     (LA.svdvals(a)).min*(LA.svdvals(LA.inv(a))).min\n     => 0.7071067811865475", "Determinant of a matrix\n\n @param a [Numo::NArray] matrix (>= 2-dimensional NArray)\n @return [Float or Complex or Numo::NArray]", "Natural logarithm of the determinant of a matrix\n\n @param a [Numo::NArray] matrix (>= 2-dimensional NArray)\n @return [[sign,logdet]]\n   - **sign** -- A number representing the sign of the determinant.\n   - **logdet** -- The natural log of the absolute value of the determinant.", "Inverse matrix from square matrix `a`\n @param a [Numo::NArray] n-by-n square matrix  (>= 2-dimensinal NArray)\n @param driver [String or Symbol] choose LAPACK diriver\n   ('ge'|'sy'|'he'|'po') + (\"sv\"|\"trf\")\n   (optional, default='getrf')\n @param uplo [String or Symbol] optional, default='U'. Access upper\n   or ('U') lower ('L') triangle. (omitted when driver:\"ge\")\n @return [Numo::NArray] The inverse matrix.\n @example\n   Numo::Linalg.inv(a,driver:'getrf')\n   => Numo::DFloat#shape=[2,2]\n   [[-2, 1],\n    [1.5, -0.5]]\n   a.dot(Numo::Linalg.inv(a,driver:'getrf'))\n   => Numo::DFloat#shape=[2,2]\n   [[1, 0],\n    [8.88178e-16, 1]]", "Validates the parsed data against the schema.", "Render the list of crumbs using renderer", "Emits a javascript block inside a +script+ tag, wrapped in CDATA\n doohickeys like all the cool JS kids do.", "create a new Loan instance\n @return [Loan]\n @param [Numeric] decimal value of the interest rate\n @param [Integer] Duration of the loan period\n @param [Float] Loan amount\n @param [Float] structure fee - fee for the market in percentages\n @param [Float] currency protection - Protection for currency changes - usually 3%, default to 0%\n @example create a 10.5% Nominal rate\n @see http://en.wikipedia.org/wiki/Nominal_interest_rate\n @api public", "Emits a jQuery script, inside its own script tag, that is to be run on document ready or load.\n\n Usage (from inside a widget method):\n jquery \"alert('hi')\" :: a jquery ready handler\n jquery \"alert('hi')\", :id => 'foo' :: a jquery ready handler, with attributes in the script tag\n jquery :load, \"alert('hi')\" :: a jquery load handler", "Creates a whole new output string, executes the block, then converts the\n output string to a string and returns it as raw text. If at all possible\n you should avoid this method since it hurts performance, and use\n +widget+ instead.", "same as _emit, but using a parent widget's output stream and helpers", "Wrap Rails' render method, to capture output from partials etc.", "Rails content_for is output if and only if no block given", "Return a character given its unicode code point or unicode name.", "Returns a new Response with no format data.\n Used to dispatch the individual format methods.", "returns true if a friendship can be blocked by given friendable", "returns true if a friendship can be unblocked by given friendable", "add message to log", "Read the deployment configuration.  Return the deployment for the\n current target.\n\n @return [String?] The deployment path for the current target.", "The constructor is only meant to be called internally.\n\n This takes the klass (class object) of a controller\n and constructs a Builder ready to apply the make_resourceful\n additions to the controller.\n This method is only meant to be called internally.\n\n Applies all the changes that have been declared\n via the instance methods of this Builder\n to the kontroller passed in to the constructor.", "Specifies parent resources for the current resource.\n Each of these parents will be loaded automatically\n if the proper id parameter is given.\n For example,\n\n   # cake_controller.rb\n   belongs_to :baker, :customer\n\n Then on GET /bakers/12/cakes,\n\n   params[:baker_id] #=> 12\n   parent?           #=> true\n   parent_name       #=> \"baker\"\n   parent_model      #=> Baker\n   parent_object     #=> Baker.find(12)\n   current_objects   #=> Baker.find(12).cakes", "checks if a user is blocked", "check if any friendship exists with another user", "deletes all the friendships", "From rspec-rails ControllerExampleGroup", "unblocks a friendship", "returns friendship with given user or nil", "Redefine the method. Will undef the method if it exists or simply\n just define it.\n\n @example Redefine the method.\n   Object.re_define_method(\"exists?\") do\n     self\n   end\n\n @param [ String, Symbol ] name The name of the method.\n @param [ Proc ] block The method body.\n\n @return [ Method ] The new method.", "makes a \"field\" on this model called rdf_type\n and sets a class level _RDF_TYPE variable with the rdf_type passed in.", "Returns a new Pattern with the same +source+, but with +delta+ overriden\n and +metadata+ merged.\n\n @param delta [Array<Numeric>, Pattern<Numeric>, Numeric]\n @param metadata [Hash]\n @return [Pattern]", "Calls the given block once for each event, passing its value, start\n position, duration and iteration as parameters.\n\n +cycle+ can be any number, even if there is no event that starts exactly\n at that moment.  It will start from the next event.\n\n If no block is given, an enumerator is returned instead.\n\n Enumeration loops forever, and starts yielding events based on pattern's\n delta and from the +cycle+ position, which is by default 0.\n\n @example block yields value, start, duration and iteration\n   Pattern.new([1, 2], delta: 0.25).each_event.take(4)\n   # => [[1, 0.0,  0.25, 0],\n   #     [2, 0.25, 0.25, 0],\n   #     [1, 0.5,  0.25, 1],\n   #     [2, 0.75, 0.25, 1]]\n\n @example +cycle+ is used to start iterating from that moment in time\n   Pattern.new([:a, :b, :c], delta: 1/2).each_event(42).take(4)\n   # => [[:a, (42/1), (1/2), 28],\n   #     [:b, (85/2), (1/2), 28],\n   #     [:c, (43/1), (1/2), 28],\n   #     [:a, (87/2), (1/2), 29]]\n\n @example +cycle+ can also be a fractional number\n   Pattern.new([:a, :b, :c]).each_event(0.97).take(3)\n   # => [[:b, 1, 1, 0],\n   #     [:c, 2, 1, 0],\n   #     [:a, 3, 1, 1]]\n\n @param cycle [Numeric]\n @yield [v, s, d, i] value, start, duration and iteration\n @return [Enumerator]", "Calls the given block passing the delta of each value in pattern\n\n This method is used internally by {#each_event} to calculate when each\n event in pattern occurs in time.  If no block is given, an Enumerator is\n returned instead.\n\n @param index [Numeric]\n @yield [d] duration\n @return [Enumerator]", "Calls the given block once for each value in source\n\n @example\n   Pattern.new([1, 2, 3]).each.to_a\n   # => [1, 2, 3]\n\n @return [Enumerator]\n @yield [Object] value", "Returns a Pattern containing all events of +self+ for which +block+ is\n true.\n\n If no block is given, an Enumerator is returned.\n\n @see Pattern#reject\n\n @yield [v, s, d, i] value, start, duration and iteration\n @yieldreturn [Boolean] whether value is selected\n @return [Pattern]", "Returns a Pattern containing all events of +self+ for which +block+\n is false.\n\n If no block is given, an Enumerator is returned.\n\n @see Pattern#select\n\n @yield [v, s, d, i] value, start, duration and iteration\n @yieldreturn [Boolean] whether event is rejected\n @return [Pattern]", "Returns the first element, or the first +n+ elements, of the pattern.\n\n If the pattern is empty, the first form returns nil, and the second form\n returns an empty array.\n\n @see #take\n\n @param n [Integer]\n @param args same arguments as {#take}\n @return [Object, Array]", "Returns a string containing a human-readable representation\n\n When source is not a Proc, this string can be evaluated to construct the\n same instance.\n\n @return [String]", "Return the field object on a +Resource+ associated with the given name.\n\n @example Get the field.\n   Person.get_field(:name)\n\n @param [ Symbol ] name The name of the field.", "Return all of the fields on a +Resource+ in a manner that\n respects Ruby's inheritance rules.  i.e. subclass fields should\n override superclass fields with the same", "Define a field attribute for the +Resource+.\n\n @example Set the field.\n   Person.add_field(:name, 'http://myfield')\n\n @param [ Symbol ] name The name of the field.\n @param [ String, RDF::URI ] predicate The predicate for the field.\n @param [ Hash ] options The hash of options.", "Create the field accessors.\n\n @example Generate the accessors.\n   Person.create_accessors(:name, \"name\")\n   person.name #=> returns the field\n   person.name = \"\" #=> sets the field\n   person.name? #=> Is the field present?\n\n @param [ Symbol ] name The name of the field.\n @param [ Symbol ] meth The name of the accessor.\n @param [ Hash ] options The options.", "Create the getter method for the provided field.\n\n @example Create the getter.\n   Model.create_field_getter(\"name\", \"name\", field)\n\n @param [ String ] name The name of the attribute.\n @param [ String ] meth The name of the method.\n @param [ Field ] field The field.", "Create the setter method for the provided field.\n\n @example Create the setter.\n   Model.create_field_setter(\"name\", \"name\")\n\n @param [ String ] name The name of the attribute.\n @param [ String ] meth The name of the method.\n @param [ Field ] field The field.", "Create the check method for the provided field.\n\n @example Create the check.\n   Model.create_field_check(\"name\", \"name\")\n\n @param [ String ] name The name of the attribute.\n @param [ String ] meth The name of the method.", "instantiates and returns a new standard field", "returns a graph of triples which describe the uris passed in.", "given a string of ntriples data, populate an RDF graph.\n If you pass a graph in, it will add to that one.", "given a construct or describe query, return a graph of triples.", "Given a select query, perform a DESCRIBE query to get a graph of data from which we\n create and hydrate a collection of resources.\n\n @option options [ String ] uri_variable The name of the uri variable in the query, if not 'uri'\n @option options [ String ] graph_variable The name of the uri variable in the query, if not 'graph'", "Generate a CONSTRUCT query for the given uri and graph pairs.", "For a select query, get a raw serialisation of the DESCRIPTION of the resources from the database.\n\n @option options [ String ] uri_variable The name of the uri variable in the query, if not 'uri'\n @option options [ String ] accept_header The http accept header (default application/n-triples)", "for n-triples we can just concatenate them", "Execute the query and return a +ResourceCollection+ of all hydrated resources\n +ResourceCollection+ is an +Enumerable+, Array-like object.\n\n @option options [ String ] return_graph Indicates whether to return the graph as one of the variables.", "Execute the query and return the first result as a hydrated resource\n\n @option options [ String ] return_graph Indicates whether to return the graph as one of the variables.", "Return how many records the current criteria would return\n\n @option options [ String ] return_graph Indicates whether to return the graph as one of the variables.", "turn this criteria into a query", "for triples in the graph passed in, add them to the passed in repository obj, and return the repository objects\n\u00a0if no repository passed, make a new one.", "Restrict this query to the graph uri passed in\n You may also pass a block to an unbound graph, ?g\n then chain a where clause to the criteria returned to bind ?g\n\n @example .graph(RDF::URI.new('http://graphoid')\n @example .graph('http://graphoid')\n @example .graph(nil) { \"?s ?p ?o\" }.where(\"?uri ?p ?g\")\n\n @param [ String, RDF::URI ] The graph uri\n @param [ Block ] A string to be executed within an unbound graph, ?g\n\n @return [ Tripod::Criteria ] A criteria object", "instantiates and returns a new LinkedFrom", "instantiates and returns a new LinkTo", "Branch name validation", "Return the value of a form element. If the element is a select box and\n has \"multiple\" declared as an attribute, then all selected options will\n be returned as an array.\n\n @return [String, Array<String>] the node's value", "Set the value of the form input.\n\n @param [String] value", "Click the node and then wait for any triggered JavaScript callbacks to\n fire.", "Accounts Create action", "Get the 3PAR WS API version.\n\n ==== Returns\n\n WSAPI version hash", "Creates a new FlashCache\n\n ==== Attributes\n\n * size_in_gib - Specifies the node pair size of the Flash Cache on the system\n      type size_in_gib: Integer\n * mode - Values supported Simulator: 1, Real: 2 (default)\n      type mode: Integer\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n       - NO_SPACE - Not enough space is available for the operation.\n * Hpe3parSdk::HTTPBadRequest\n       - INV_INPUT_EXCEEDS_RANGE - A JSON input object contains a name-value pair with a numeric value that exceeds the expected range. Flash Cache exceeds the expected range. The HTTP ref member contains the name.\n * Hpe3parSdk::HTTPConflict\n       - EXISTENT_FLASH_CACHE - The Flash Cache already exists.\n * Hpe3parSdk::HTTPForbidden\n       - FLASH_CACHE_NOT_SUPPORTED - Flash Cache is not supported.\n * Hpe3parSdk::HTTPBadRequest\n       - INV_FLASH_CACHE_SIZE - Invalid Flash Cache size. The size must be a multiple of 16 G.", "Get Flash Cache information\n\n ==== Returns\n\n FlashCache - Details of the specified flash cache", "Deletes an existing Flash Cache\n\n ==== Raises\n\n * Hpe3parSdk::HTTPForbidden\n       - FLASH_CACHE_IS_BEING_REMOVED - Unable to delete the Flash Cache, the Flash Cache is being removed.\n * Hpe3parSdk::HTTPForbidden\n       - FLASH_CACHE_NOT_SUPPORTED - Flash Cache is not supported on this system.\n * Hpe3parSdk::HTTPNotFound\n       - NON_EXISTENT_FLASH_CACHE - The Flash Cache does not exist.", "Gets the overall system capacity for the 3PAR server.\n\n ==== Returns\n\n Hash of system capacity information\n\n\n     capacity = {\n       \"allCapacity\"=> {                       # Overall system capacity\n                                               # includes FC, NL, SSD\n                                               # device types\n         \"totalMiB\"=>20054016,                 # Total system capacity\n                                               # in MiB\n         \"allocated\"=>{                        # Allocated space info\n           \"totalAllocatedMiB\"=>12535808,      # Total allocated\n                                               # capacity\n           \"volumes\"=> {                       # Volume capacity info\n             \"totalVolumesMiB\"=>10919936,      # Total capacity\n                                               # allocated to volumes\n             \"nonCPGsMiB\"=> 0,                 # Total non-CPG capacity\n             \"nonCPGUserMiB\"=> 0,              # The capacity allocated\n                                               # to non-CPG user space\n             \"nonCPGSnapshotMiB\"=>0,           # The capacity allocated\n                                               # to non-CPG snapshot\n                                               # volumes\n             \"nonCPGAdminMiB\"=> 0,             # The capacity allocated\n                                               # to non-CPG\n                                               # administrative volumes\n             \"CPGsMiB\"=>10919936,              # Total capacity\n                                               # allocated to CPGs\n             \"CPGUserMiB\"=>7205538,            # User CPG space\n             \"CPGUserUsedMiB\"=>7092550,        # The CPG allocated to\n                                               # user space that is\n                                               # in use\n             \"CPGUserUnusedMiB\"=>112988,       # The CPG allocated to\n                                               # user space that is not\n                                               # in use\n             \"CPGSnapshotMiB\"=>2411870,        # Snapshot CPG space\n             \"CPGSnapshotUsedMiB\"=>210256,     # CPG allocated to\n                                               # snapshot that is in use\n             \"CPGSnapshotUnusedMiB\"=>2201614,  # CPG allocated to\n                                               # snapshot space that is\n                                               # not in use\n             \"CPGAdminMiB\"=>1302528,           # Administrative volume\n                                               # CPG space\n             \"CPGAdminUsedMiB\"=> 115200,       # The CPG allocated to\n                                               # administrative space\n                                               # that is in use\n             \"CPGAdminUnusedMiB\"=>1187328,     # The CPG allocated to\n                                               # administrative space\n                                               # that is not in use\n             \"unmappedMiB\"=>0                  # Allocated volume space\n                                               # that is unmapped\n           },\n           \"system\"=> {                        # System capacity info\n              \"totalSystemMiB\"=> 1615872,      # System space capacity\n              \"internalMiB\"=>780288,           # The system capacity\n                                               # allocated to internal\n                                               # resources\n              \"spareMiB\"=> 835584,             # Total spare capacity\n              \"spareUsedMiB\"=> 0,              # The system capacity\n                                               # allocated to spare resources\n                                               # in use\n              \"spareUnusedMiB\"=> 835584        # The system capacity\n                                               # allocated to spare resources\n                                               # that are unused\n             }\n         },\n           \"freeMiB\"=> 7518208,                # Free capacity\n           \"freeInitializedMiB\"=> 7518208,     # Free initialized capacity\n           \"freeUninitializedMiB\"=> 0,         # Free uninitialized capacity\n           \"unavailableCapacityMiB\"=> 0,       # Unavailable capacity in MiB\n           \"failedCapacityMiB\"=> 0             # Failed capacity in MiB\n       },\n       \"FCCapacity\"=>  {                       # System capacity from FC devices only\n           ...                                 # Same structure as above\n       },\n       \"NLCapacity\"=>  {                       # System capacity from NL devices only\n           ...                                 # Same structure as above\n       },\n       \"SSDCapacity\"=>  {                      # System capacity from SSD devices only\n           ...                                 # Same structure as above\n       }\n     }", "Get the list of all 3PAR Tasks\n\n ==== Returns\n\n Array of Task", "Get the status of a 3PAR Task\n\n ==== Attributes\n\n * task_id - the task id\n      type task_id: Integer\n\n ==== Returns\n\n Task\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_BELOW_RANGE - Bad Request Task ID must be a positive value.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_EXCEEDS_RANGE - Bad Request Task ID is too large.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_TASK - Task with the specified Task ID does not exist.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_WRONG_TYPE - Task ID is not an integer.", "Creates a new VLUN.\n\n When creating a VLUN, the volumeName is required. The lun member is\n not required if auto is set to True.\n Either hostname or portPos (or both in the case of matched sets) is\n also required.  The noVcn and overrideLowerPriority members are\n optional.\n * volume_name: Name of the volume to be exported\n     type volume_name: String\n * lun: LUN id\n     type lun: Integer\n * host_name:  Name of the host which the volume is to be exported.\n     type host_name: String\n * port_pos: System port of VLUN exported to. It includes node number, slot number, and card port number\n     type port_pos: Hash\n         port_pos = {'node'=> 1,   # System node (0-7)\n                    'slot'=> 2,    # PCI bus slot in the node (0-5)\n                    'port'=> 1}    # Port number on the FC card (0-4)\n * no_vcn: A VLUN change notification (VCN) not be issued after export (-novcn).\n     type no_vcn: Boolean\n * override_lower_priority: Existing lower priority VLUNs will be overridden (-ovrd). Use only if hostname member exists.\n     type override_lower_priority: Boolean\n\n ==== Returns\n\n VLUN id\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        -  INV_INPUT_ MISSING_REQUIRED - Missing volume or hostname or lunid.\n * Hpe3parSdk::HTTPNotFound\n        -  NON_EXISTENT_VOL MISSING_REQUIRED - Specified volume does not exist.\n * Hpe3parSdk::HTTPNotFound\n        -  NON_EXISTENT_HOST - Specified hostname not found.\n * Hpe3parSdk::HTTPNotFound\n        -  NON_EXISTENT_PORT - Specified port does not exist.", "Gets VLUNs.\n\n ==== Returns\n\n Array of VLUN objects", "Gets information about a VLUN.\n\n ==== Attributes\n\n * volume_name: The volume name of the VLUN to find\n      type volume_name: String\n\n ==== Returns\n\n VLUN object\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n        -  NON_EXISTENT_VLUN - VLUN doesn't exist", "Deletes a VLUN.\n\n ==== Attributes\n\n * volume_name: Volume name of the VLUN\n     type volume_name: String\n * lun_id: LUN ID\n     type lun_id: Integer\n * host_name: Name of the host which the volume is exported. For VLUN of port type,the value is empty\n     type host_name: String\n * port: Specifies the system port of the VLUN export.  It includes the system node number, PCI bus slot number, and card port number on the FC card in the format<node>:<slot>:<cardPort>\n     type port: Hash\n\n         port = {'node'=> 1,   # System node (0-7)\n                 'slot'=> 2,   # PCI bus slot in the node (0-5)\n                 'port'=>1}    # Port number on the FC card (0-4)\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n         - INV_INPUT_MISSING_REQUIRED - Incomplete VLUN info. Missing\n         volumeName or lun, or both hostname and port.\n * Hpe3parSdk::HTTPBadRequest\n         - INV_INPUT_PORT_SELECTION - Specified port is invalid.\n * Hpe3parSdk::HTTPBadRequest\n         - INV_INPUT_EXCEEDS_RANGE - The LUN specified exceeds expected\n         range.\n * Hpe3parSdk::HTTPNotFound\n         - NON_EXISTENT_HOST - The host does not exist\n * Hpe3parSdk::HTTPNotFound\n         - NON_EXISTENT_VLUN - The VLUN does not exist\n * Hpe3parSdk::HTTPNotFound\n         - NON_EXISTENT_PORT - The port does not exist\n * Hpe3parSdk::HTTPForbidden\n         - PERM_DENIED - Permission denied", "Gets QoS Rules.\n\n ==== Returns\n\n Array of QoSRule objects", "Queries a QoS rule\n\n ==== Attributes\n\n * target_name : Name of the target. When targetType is sys, target name must be sys:all_others.\n     type target_name: String\n * target_type : Target type is vvset or sys\n     type target_type: String\n ==== Returns\n\n QoSRule object\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_QOS_RULE - QoS rule does not exist.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ILLEGAL_CHAR - Illegal character in the input.", "Modifies an existing QOS rules\n\n The QoS rule can be applied to VV sets. By using sys:all_others,\n you can apply the rule to all volumes in the system for which no\n QoS rule has been defined.\n ioMinGoal and ioMaxLimit must be used together to set I/O limits.\n Similarly, bwMinGoalKB and bwMaxLimitKB must be used together.\n If ioMaxLimitOP is set to 2 (no limit), ioMinGoalOP must also be\n to set to 2 (zero), and vice versa. They cannot be set to\n 'none' individually. Similarly, if bwMaxLimitOP is set to 2 (no\n limit), then bwMinGoalOP must also be set to 2.\n If ioMaxLimitOP is set to 1 (no limit), ioMinGoalOP must also be\n to set to 1 (zero) and vice versa. Similarly, if bwMaxLimitOP is\n set to 1 (zero), then bwMinGoalOP must also be set to 1.\n The ioMinGoalOP and ioMaxLimitOP fields take precedence over\n the ioMinGoal and ioMaxLimit fields.\n The bwMinGoalOP and bwMaxLimitOP fields take precedence over\n the bwMinGoalKB and bwMaxLimitKB fields\n\n ==== Attributes\n\n * target_name: Name of the target object on which the QoS rule will be created.\n     type target_name: String\n * target_type: Type of QoS target, either vvset or sys.Refer Hpe3parSdk::QoStargetTypeConstants for complete enumeration\n     type target_type: String\n * qos_rules: QoS options\n     type qos_rules: Hash\n     qos_rules = {\n         'priority'=> 2,         # Refer Hpe3parSdk::QoSpriorityEnumeration for complete enumeration\n         'bwMinGoalKB'=> 1024,   # bandwidth rate minimum goal in\n                                 # kilobytes per second\n         'bwMaxLimitKB'=> 1024,  # bandwidth rate maximum limit in\n                                 # kilobytes per second\n         'ioMinGoal'=> 10000,    # I/O-per-second minimum goal.\n         'ioMaxLimit'=> 2000000, # I/0-per-second maximum limit\n         'enable'=> True,        # QoS rule for target enabled?\n         'bwMinGoalOP'=> 1,      # zero none operation enum, when set to\n                                 # 1, bandwidth minimum goal is 0\n                                 # when set to 2, the bandwidth minimum\n                                 # goal is none (NoLimit)\n         'bwMaxLimitOP'=> 1,     # zero none operation enum, when set to\n                                 # 1, bandwidth maximum limit is 0\n                                 # when set to 2, the bandwidth maximum\n                                 # limit is none (NoLimit)\n         'ioMinGoalOP'=> 1,      # zero none operation enum, when set to\n                                 # 1, I/O minimum goal minimum goal is 0\n                                 # when set to 2, the I/O minimum goal is\n                                 # none (NoLimit)\n         'ioMaxLimitOP'=> 1,     # zero none operation enum, when set to\n                                 # 1, I/O maximum limit is 0\n                                 # when set to 2, the I/O maximum limit\n                                 # is none (NoLimit)\n         'latencyGoal'=> 5000,   # Latency goal in milliseconds\n         'defaultLatency'=> false# Use latencyGoal or defaultLatency?\n     }\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n     INV_INPUT_EXCEEDS_RANGE - Invalid input: number exceeds expected\n     range.\n * Hpe3parSdk::HTTPNotFound\n     NON_EXISTENT_QOS_RULE - QoS rule does not exists.\n * Hpe3parSdk::HTTPBadRequest\n     INV_INPUT_ILLEGAL_CHAR - Illegal character in the input.\n * Hpe3parSdk::HTTPBadRequest\n     EXISTENT_QOS_RULE - QoS rule already exists.\n * Hpe3parSdk::HTTPBadRequest\n     INV_INPUT_IO_MIN_GOAL_GRT_MAX_LIMIT - I/O-per-second maximum limit\n     should be greater than the minimum goal.\n * Hpe3parSdk::HTTPBadRequest\n     INV_INPUT_BW_MIN_GOAL_GRT_MAX_LIMIT - Bandwidth maximum limit\n     should be greater than the minimum goal.\n * Hpe3parSdk::HTTPBadRequest\n     INV_INPUT_BELOW_RANGE - I/O-per-second limit is below\n     range. Bandwidth limit is below range.\n * Hpe3parSdk::HTTPBadRequest\n              UNLICENSED_FEATURE - The system is not licensed for QoS.", "Deletes QoS rules.\n\n ==== Attributes\n\n * target_name: Name of the target. When target_type is sys, target_name must be sys:all_others.\n     type target_name: String\n * target_type: target type is vvset or sys\n     type target_type: String\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n                     NON_EXISTENT_QOS_RULE - QoS rule does not exist.\n * Hpe3parSdk::HTTPBadRequest\n                     INV_INPUT_ILLEGAL_CHAR - Illegal character in the input", "Gets all hosts.\n\n ==== Returns\n\n Array of Host.", "Gets host information by name.\n\n ==== Attributes\n\n * name - The name of the host to find.\n      type name: String\n\n ==== Returns\n\n Host.\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n       - INV_INPUT - Invalid URI syntax.\n * Hpe3parSdk::HTTPNotFound\n       - NON_EXISTENT_HOST - Host not found.\n * Hpe3parSdk::HTTPInternalServerError\n       - INT_SERV_ERR - Internal server error.\n * Hpe3parSdk::HTTPBadRequest\n       - INV_INPUT_ILLEGAL_CHAR - Host name contains invalid character.", "Creates a new Host.\n\n ==== Attributes\n\n * name - The name of the host.\n      type name: String\n * iscsi_names - Array of iSCSI iqns.\n      type iscsi_names: Array\n * fcwwns - Array of Fibre Channel World Wide Names.\n      type fcwwns: Array\n * optional - The optional stuff.\n      type optional: Hash\n        optional = {\n            'persona'=> 1,                  # Refer Hpe3parSdk::HostPersona for complete enumeration.\n                                            # 3.1.3 default: Generic-ALUA\n                                            # 3.1.2 default: General\n            'domain'=> 'myDomain',          # Create the host in the\n                                            # specified domain, or default\n                                            # domain if unspecified.\n            'forceTearDown'=> false,        # If True, force to tear down\n                                            # low-priority VLUN exports.\n            'descriptors'=>\n                {'location'=> 'earth',      # The host's location\n                 'IPAddr'=> '10.10.10.10',  # The host's IP address\n                 'os'=> 'linux',            # The operating system running on the host.\n                 'model'=> 'ex',            # The host's model\n                 'contact'=> 'Smith',       # The host's owner and contact\n                 'comment'=> \"Joe's box\"}   # Additional host information\n        }\n\n ==== Raises\n\n * Hpe3parSdk::HTTPForbidden\n        - PERM_DENIED - Permission denied.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_MISSING_REQUIRED - Name not specified.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_PARAM_CONFLICT - FCWWNs and iSCSINames are both specified.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_EXCEEDS_LENGTH - Host name, domain name, or iSCSI name is too long.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_EMPTY_STR - Input string (for domain name, iSCSI name, etc.) is empty.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ILLEGAL_CHAR - Any error from host-name or domain-name parsing.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_TOO_MANY_WWN_OR_iSCSI - More than 1024 WWNs or iSCSI names are specified.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_WRONG_TYPE - The length of WWN is not 16. WWN specification contains non-hexadecimal digit.\n * Hpe3parSdk::HTTPConflict\n        - EXISTENT_PATH - host WWN/iSCSI name already used by another host.\n * Hpe3parSdk::HTTPConflict\n        - EXISTENT_HOST - host name is already used.\n * Hpe3parSdk::HTTPBadRequest\n        - NO_SPACE - No space to create host.", "Modifies an existing Host.\n\n ==== Attributes\n\n * name - Name of the host.\n      type name: String\n * mod_request - Objects for host modification request.\n      type mod_request: Hash\n        mod_request = {\n            'newName'=> 'myNewName',         # New name of the host\n            'pathOperation'=> 1,             # Refer Hpe3parSdk::HostEditOperation for complete enumeration\n            'FCWWNs'=> [],                   # One or more WWN to set for the host.\n            'iSCSINames'=> [],               # One or more iSCSI names to set for the host.\n            'forcePathRemoval'=> false,      # If True, remove SSN(s) or\n                                             # iSCSI(s) even if there are\n                                             # VLUNs exported to host\n            'persona'=> 1,                   # Refer Hpe3parSdk::HostPersona for complete enumeration.\n            'descriptors'=>\n                {'location'=> 'earth',       # The host's location\n                 'IPAddr'=> '10.10.10.10',   # The host's IP address\n                 'os'=> 'linux',             # The operating system running on the host.\n                 'model'=> 'ex',             # The host's model\n                 'contact'=> 'Smith',        # The host's owner and contact\n                 'comment'=> 'Joes box'}     # Additional host information\n            'chapOperation'=> 1,             # Refer Hpe3parSdk::HostEditOperation for complete enumeration\n            'chapOperationMode'=> TARGET,    # Refer Hpe3parSdk::ChapOperationMode for complete enumeration\n            'chapName'=> 'MyChapName',       # The chap name\n            'chapSecret'=> 'xyz',            # The chap secret for the host or the target\n            'chapSecretHex'=> false,         # If True, the chapSecret is treated as Hex.\n            'chapRemoveTargetOnly'=> true    # If True, then remove target chap only\n        }\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT - Missing host name.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_PARAM_CONFLICT - Both iSCSINames & FCWWNs are specified. (lot of other possibilities).\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ONE_REQUIRED - iSCSINames or FCWwns missing.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ONE_REQUIRED - No path operation specified.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_BAD_ENUM_VALUE - Invalid enum value.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_MISSING_REQUIRED - Required fields missing.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_EXCEEDS_LENGTH - Host descriptor argument length, new host name, or iSCSI name is too long.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ILLEGAL_CHAR - Error parsing host or iSCSI name.\n * Hpe3parSdk::HTTPConflict\n        - EXISTENT_HOST - New host name is already used.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_HOST - Host to be modified does not exist.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_TOO_MANY_WWN_OR_iSCSI - More than 1024 WWNs or iSCSI names are specified.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_WRONG_TYPE - Input value is of the wrong type.\n * Hpe3parSdk::HTTPConflict\n        - EXISTENT_PATH - WWN or iSCSI name is already claimed by other host.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_BAD_LENGTH - CHAP hex secret length is not 16 bytes, or chap ASCII secret length is not 12 to 16 characters.\n * Hpe3parSdk::HTTPNotFound\n        - NO_INITIATOR_CHAP - Setting target CHAP without initiator CHAP.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_CHAP - Remove non-existing CHAP.\n * Hpe3parSdk::HTTPConflict\n        - NON_UNIQUE_CHAP_SECRET - CHAP secret is not unique.\n * Hpe3parSdk::HTTPConflict\n        - EXPORTED_VLUN - Setting persona with active export; remove a host path on an active export.\n * Hpe3parSdk::HTTPBadRequest\n        - NON_EXISTENT_PATH - Remove a non-existing path.\n * Hpe3parSdk::HTTPConflict\n        - LUN_HOSTPERSONA_CONFLICT - LUN number and persona capability conflict.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_DUP_PATH - Duplicate path specified.", "Deletes a host.\n\n ==== Attributes\n\n * name - The name of host to be deleted.\n      type name: String\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_HOST - Host not found\n * Hpe3parSdk::HTTPConflict\n        -  HOST_IN_SET - Host is a member of a set", "Finds the host with the specified FC WWN path.\n\n ==== Attributes\n\n * wwn - Lookup based on WWN.\n      type wwn: String\n\n ==== Returns\n\n Host with specified FC WWN.\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT - Invalid URI syntax.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_HOST - HOST Not Found\n * Hpe3parSdk::HTTPInternalServerError\n        - INTERNAL_SERVER_ERR - Internal server error.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ILLEGAL_CHAR - Host name contains invalid character.", "Finds the host with the specified iSCSI initiator.\n\n ==== Attributes\n\n * iqn - Lookup based on iSCSI initiator.\n      type iqn: String\n\n ==== Returns\n\n Host with specified IQN.\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT - Invalid URI syntax.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_HOST - The specified host not found.\n * Hpe3parSdk::HTTPInternalServerError\n        - INTERNAL_SERVER_ERR - Internal server error.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ILLEGAL_CHAR - The host name contains invalid character.", "Gets all host sets.\n\n ==== Returns\n\n Array of HostSet.", "Deletes a HostSet.\n\n ==== Attributes\n\n * name - The hostset to delete.\n      type name: String\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_SET - The set does not exists.\n * Hpe3parSdk::HTTPConflict\n        - EXPORTED_VLUN - The host set has exported VLUNs.", "Modifies a HostSet.\n\n ==== Attributes\n\n * name - Hostset name\n      type name: String\n * action - Add or Remove host(s) from the set\n      type action: Refer values of Hpe3parSdk::SetCustomAction::MEM_ADD and Hpe3parSdk::SetCustomAction::MEM_REMOVE\n * setmembers - Host(s) to add to the set, the existence of the host(s) will not be checked\n      type setmembers: Array of String\n * new_name - New name of set\n      type new_name: String\n * comment - New comment for the set\n      type comment: String\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - EXISTENT_SET - The set already exits.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_SET - The set does not exists.\n * Hpe3parSdk::HTTPConflict\n        - MEMBER_IN_DOMAINSET - The host is in a domain set.\n * Hpe3parSdk::HTTPConflict\n        - MEMBER_IN_SET - The object is already part of the set.\n * Hpe3parSdk::HTTPNotFound\n        - MEMBER_NOT_IN_SET - The object is not part of the set.\n * Hpe3parSdk::HTTPConflict\n        - MEMBER_NOT_IN_SAME_DOMAIN - Objects must be in the same domain to perform this operation.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_DUP_NAME - Invalid input (duplicate name).\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_PARAM_CONFLICT - Invalid input (parameters cannot be present at the same time).\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ILLEGAL_CHAR - Invalid contains one or more illegal characters.", "Returns an array of every Hostset the given host is a part of. The array can contain zero, one, or multiple items.\n\n ==== Attributes\n\n * host_name - The host name of whose hostset is to be found.\n      type host_name: String\n\n ==== Returns\n\n Array of HostSet.", "Gets hostset information by name.\n\n ==== Attributes\n\n * name - The name of the hostset to find.\n      type name: String\n\n ==== Returns\n\n HostSet.\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_SET - The set does not exist.", "Gets all of the VLUNs on a specific host.\n\n ==== Attributes\n\n * host_name - Name of the host.\n      type host_name: String\n\n ==== Returns\n\n Array of VLUN.\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_HOST - The specified host not found.", "Gets all Volumes in the array\n\n ==== Returns\n\n Array of VirtualVolume", "Gets the list of snapshots in the array\n\n ==== Returns\n\n Array of VirtualVolume", "Gets information about a volume by name\n\n ==== Attributes\n\n * name - The name of the volume to find\n    type name: String\n\n ==== Returns\n\n VirtualVolume\n\n ==== Raises\n\n * Hpe3parSdk::HPE3PARException\n       Error with code: 23 message: volume does not exist", "Gets information about a volume by wwn\n\n ==== Attributes\n\n * wwn - The wwn of the volume to find\n    type wwn: String\n\n ==== Returns\n\n * VirtualVolume\n\n ==== Raises\n\n * Hpe3parSdk::HPE3PARException\n       Error with code: 23 message: volume does not exist", "Creates a new volume.\n\n ==== Attributes\n\n * name - the name of the volume\n      type name: String\n * cpg_name - the name of the destination CPG\n      type cpg_name: String\n * size_MiB - size in MiB for the volume\n      type size_MiB: Integer\n * optional - hash of other optional items\n      type optional: hash\n\n      optional = {\n         'id' => 12,                     # Volume ID. If not specified, next\n                                         # available is chosen\n         'comment' => 'some comment',    # Additional information up to 511\n                                         # characters\n         'policies: {                    # Specifies VV policies\n            'staleSS' => false,          # True allows stale snapshots.\n            'oneHost' => true,           # True constrains volume export to\n                                         # single host or host cluster\n            'zeroDetect' => true,        # True requests Storage System to\n                                         # scan for zeros in incoming write\n                                         # data\n            'system' => false,           # True special volume used by system\n                                         # False is normal user volume\n            'caching' => true},          # Read-only. True indicates write &\n                                         # read caching & read ahead enabled\n         'snapCPG' => 'CPG name',        # CPG Used for snapshots\n         'ssSpcAllocWarningPct' => 12,   # Snapshot space allocation warning\n         'ssSpcAllocLimitPct' => 22,     # Snapshot space allocation limit\n         'tpvv' => true,                 # True: Create TPVV\n                                         # False (default) Create FPVV\n         'usrSpcAllocWarningPct' => 22,  # Enable user space allocation\n                                         # warning\n         'usrSpcAllocLimitPct' => 22,    # User space allocation limit\n         'expirationHours' => 256,       # Relative time from now to expire\n                                         # volume (max 43,800 hours)\n         'retentionHours' => 256         # Relative time from now to retain\n    }\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT - Invalid Parameter\n * Hpe3parSdk::HTTPBadRequest\n        - TOO_LARGE - Volume size above limit\n * Hpe3parSdk::HTTPBadRequest\n        - NO_SPACE - Not Enough space is available\n * Hpe3parSdk::HTTPForbidden\n        - PERM_DENIED - Permission denied\n * Hpe3parSdk::HTTPConflict\n        - EXISTENT_SV - Volume Exists already", "Modifies a volume\n\n ==== Attributes\n\n * name - the name of the volume\n      type name: String\n * volumeMods - Hash of volume attributes to change\n      type volumeMods: Hash\n       volumeMods = {\n         'newName' => 'newName',           # New volume name\n         'comment' => 'some comment',      # New volume comment\n         'snapCPG' => 'CPG name',          # Snapshot CPG name\n         'policies: {                      # Specifies VV policies\n            'staleSS' => false,            # True allows stale snapshots.\n            'oneHost' => true,             # True constrains volume export to\n                                           # single host or host cluster\n            'zeroDetect' => true,          # True requests Storage System to\n                                           # scan for zeros in incoming write\n                                           # data\n            'system' => false,             # True special volume used by system\n                                           # False is normal user volume\n            'caching' => true},            # Read-only. True indicates write &\n                                           # read caching & read ahead enabled\n         'ssSpcAllocWarningPct' => 12,     # Snapshot space allocation warning\n         'ssSpcAllocLimitPct' => 22,       # Snapshot space allocation limit\n         'tpvv' => true,                   # True: Create TPVV\n                                           # False: (default) Create FPVV\n         'usrSpcAllocWarningPct' => 22,    # Enable user space allocation\n                                           # warning\n         'usrSpcAllocLimitPct' => 22,      # User space allocation limit\n         'userCPG' => 'User CPG name',     # User CPG name\n         'expirationHours' => 256,         # Relative time from now to expire\n                                           # volume (max 43,800 hours)\n         'retentionHours' => 256,          # Relative time from now to retain\n                                           # volume (max 43,800 hours)\n         'rmSsSpcAllocWarning' => false,   # True removes snapshot space\n                                           # allocation warning.\n                                           # False sets it when value > 0\n         'rmUsrSpcAllocWarwaning' => false,# True removes user space\n                                           #  allocation warning.\n                                           # False sets it when value > 0\n         'rmExpTime' => false,             # True resets expiration time to 0.\n                                           # False sets it when value > 0\n         'rmSsSpcAllocLimit' => false,     # True removes snapshot space\n                                           # allocation limit.\n                                           # False sets it when value > 0\n         'rmUsrSpcAllocLimit' => false     # True removes user space\n                                           # allocation limit.\n                                           # False sets it when value > 0\n        }\n\n ==== Raises:\n\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_WARN_GT_LIMIT - Allocation warning level is higher than\n        the limit.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_USR_ALRT_NON_TPVV - User space allocation alerts are\n        valid only with a TPVV.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_RETAIN_GT_EXPIRE - Retention time is greater than\n        expiration time.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_VV_POLICY - Invalid policy specification (for example,\n        caching or system is set to true).\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_EXCEEDS_LENGTH - Invalid input: string length exceeds\n        limit.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_TIME - Invalid time specified.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_MODIFY_USR_CPG_TPVV - usr_cpg cannot be modified\n        on a TPVV.\n * Hpe3parSdk::HTTPBadRequest\n        - UNLICENSED_FEATURE - Retention time cannot be modified on a\n        system without the Virtual Lock license.\n * Hpe3parSdk::HTTPForbidden\n        - CPG_NOT_IN_SAME_DOMAIN - Snap CPG is not in the same domain as\n        the user CPG.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_PEER_VOLUME - Cannot modify a peer volume.\n * Hpe3parSdk::HTTPInternalServerError\n        - INT_SERV_ERR - Metadata of the VV is corrupted.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_SYS_VOLUME - Cannot modify retention time on a\n        system volume.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_INTERNAL_VOLUME - Cannot modify an internal\n        volume\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_VOLUME_NOT_DEFINED_ALL_NODES - Cannot modify a\n        volume until the volume is defined on all volumes.\n * Hpe3parSdk::HTTPConflict\n        - INVALID_OPERATION_VV_ONLINE_COPY_IN_PROGRESS - Cannot modify a\n        volume when an online copy for that volume is in progress.\n * Hpe3parSdk::HTTPConflict\n        - INVALID_OPERATION_VV_VOLUME_CONV_IN_PROGRESS - Cannot modify a\n        volume in the middle of a conversion operation.\n * Hpe3parSdk::HTTPConflict\n        - INVALID_OPERATION_VV_SNAPSPACE_NOT_MOVED_TO_CPG - Snapshot space\n        of a volume needs to be moved to a CPG before the user space.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_VOLUME_ACCOUNTING_IN_PROGRESS - The volume\n        cannot be renamed until snapshot accounting has finished.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_ZERO_DETECT_TPVV - The zero_detect policy can be\n        used only on TPVVs.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_CPG_ON_SNAPSHOT - CPG cannot be assigned to a\n        snapshot.", "Grows an existing volume by 'amount' Mebibytes.\n\n ==== Attributes\n\n * name - the name of the volume\n      type name: String\n * amount: the additional size in MiB to add, rounded up to the next chunklet size (e.g. 256 or 1000 MiB)\n      type amount: Integer\n\n ==== Raises:\n\n * Hpe3parSdk::HTTPForbidden\n        - VV_NOT_IN_SAME_DOMAIN - The volume is not in the same domain.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_VOL - The volume does not exist.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_UNSUPPORTED_VV_TYPE - Invalid operation: Cannot\n        grow this type of volume.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_TUNE_IN_PROGRESS - Invalid operation: Volume\n       tuning is in progress.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_EXCEEDS_LENGTH - Invalid input: String length exceeds\n        limit.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_VV_GROW_SIZE - Invalid grow size.\n * Hpe3parSdk::HTTPForbidden\n        - VV_NEW_SIZE_EXCEEDS_CPG_LIMIT - New volume size exceeds CPG limit\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_INTERNAL_VOLUME - This operation is not allowed\n        on an internal volume.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_VOLUME_CONV_IN_PROGRESS - Invalid operation: VV\n        conversion is in progress.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_VOLUME_COPY_IN_PROGRESS - Invalid operation:\n        online copy is in progress.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_CLEANUP_IN_PROGRESS - Internal volume cleanup is\n        in progress.\n * Hpe3parSdk::HTTPForbidden\n        - VV_IS_BEING_REMOVED - The volume is being removed.\n * Hpe3parSdk::HTTPForbidden\n        - VV_IN_INCONSISTENT_STATE - The volume has an internal consistency\n        error.\n * Hpe3parSdk::HTTPForbidden\n        - VV_SIZE_CANNOT_REDUCE - New volume size is smaller than the\n        current size.\n * Hpe3parSdk::HTTPForbidden\n        - VV_NEW_SIZE_EXCEEDS_LIMITS - New volume size exceeds the limit.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_SA_SD_SPACE_REMOVED - Invalid operation: Volume\n        SA/SD space is being removed.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_IS_BUSY - Invalid operation: Volume is currently\n        busy.\n * Hpe3parSdk::HTTPForbidden\n        - VV_NOT_STARTED - Volume is not started.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_IS_PCOPY - Invalid operation: Volume is a\n        physical copy.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_NOT_IN_NORMAL_STATE - Volume state is not normal\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_PROMOTE_IN_PROGRESS - Invalid operation: Volume\n        promotion is in progress.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_PARENT_OF_PCOPY - Invalid operation: Volume is\n        the parent of physical copy.\n * Hpe3parSdk::HTTPBadRequest\n        - NO_SPACE - Insufficent space for requested operation.", "Creates a physical copy of a VirtualVolume\n\n ==== Attributes\n\n * src_name - the source volume name\n      type src_name: String\n * dest_name - the destination volume name\n      type dest_name: String\n * dest_cpg - the destination CPG\n      type dest_cpg: String\n * optional - Hash of optional parameters\n      type optional: Hash\n\n      optional = {\n       'online' => false,                # should physical copy be\n                                         # performed online?\n       'tpvv' => false,                  # use thin provisioned space\n                                         # for destination\n                                         # (online copy only)\n       'snapCPG' => 'OpenStack_SnapCPG', # snapshot CPG for the\n                                         # destination\n                                         # (online copy only)\n       'saveSnapshot' => false,          # save the snapshot of the\n                                         # source volume\n       'priority' => 1                   # taskPriorityEnum (does not\n                                         # apply to online copy - Hpe3parSdk::TaskPriority)\n      }", "Deletes a physical copy\n\n ==== Attributes\n\n * name - the name of the clone volume\n      type name: String\n\n ==== Raises:\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_VOL - The volume does not exist\n * Hpe3parSdk::HTTPForbidden\n        - PERM_DENIED - Permission denied\n * Hpe3parSdk::HTTPForbidden\n        - RETAINED - Volume retention time has not expired\n * Hpe3parSdk::HTTPForbidden\n        - HAS_RO_CHILD - Volume has read-only child\n * Hpe3parSdk::HTTPConflict\n        - HAS_CHILD - The volume has a child volume\n * Hpe3parSdk::HTTPConflict\n        - IN_USE - The volume is in use by VV set, VLUN, etc", "Tunes a volume\n\n ==== Attributes\n\n * name - the volume name\n      type name: String\n * tune_operation - Enum of tune operation - 1: Change User CPG, 2: Change snap CPG\n      type dest_name: Integer\n * optional - hash of optional parameters\n      type optional: hash\n\n      optional = {\n       'userCPG' => 'user_cpg',        # Specifies the new user\n                                       # CPG to which the volume\n                                       # will be tuned.\n       'snapCPG' => 'snap_cpg',        # Specifies the snap CPG to\n                                       # which the volume will be\n                                       # tuned.\n       'conversionOperation' => 1,     # conversion operation enum. Refer Hpe3parSdk::VolumeConversionOperation\n       'keepVV' => 'new_volume',       # Name of the new volume\n                                       # where the original logical disks are saved.\n       'compression' => true           # Enables (true) or disables (false) compression.\n                                       # You cannot compress a fully provisioned volume.\n      }", "Returns an array of every VolumeSet the given volume is a part of.\n The array can contain zero, one, or multiple items.\n\n ==== Attributes\n\n * name - the volume name\n      type name: String\n\n ==== Returns\n\n Array of VolumeSet\n\n ==== Raises\n\n * Hpe3parSdk::HTTPForbidden\n       - VV_IN_INCONSISTENT_STATE - Internal inconsistency error in vol\n * Hpe3parSdk::HTTPForbidden\n        - VV_IS_BEING_REMOVED - The volume is being removed\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_VOLUME - The volume does not exists\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_SYS_VOLUME - Illegal op on system vol\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_INTERNAL_VOLUME - Illegal op on internal vol", "Gets the Volume Sets\n\n ==== Returns\n\n Array of VolumeSet", "Gets the information about a Volume Set.\n\n ==== Attributes\n\n * name - The name of the CPG to find\n      type name: String\n\n ==== Returns\n\n VolumeSet\n\n ==== Raises\n\n * Hpe3parSdk::HPE3PARException\n       Error with code: 102 message: Set does not exist", "Creates a new volume set\n\n ==== Attributes\n\n * name - the volume set to create\n      type name: String\n * domain: the domain where the set lives\n      type domain: String\n * comment: the comment for the vv set\n      type comment: String\n * setmembers: the vv(s) to add to the set, the existence of the vv(s) will not be checked\n      type name: Array of String\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT Invalid URI Syntax.\n * Hpe3parSdk::HTTPBadRequest\n        - NON_EXISTENT_DOMAIN - Domain doesn't exist.\n * Hpe3parSdk::HTTPBadRequest\n        - NO_SPACE - Not Enough space is available.\n * Hpe3parSdk::HTTPBadRequest\n        - BAD_CPG_PATTERN  A Pattern in a CPG specifies illegal values.\n * Hpe3parSdk::HTTPForbidden\n        - PERM_DENIED - Permission denied\n * Hpe3parSdk::HTTPConflict\n        - EXISTENT_CPG - CPG Exists already", "Deletes the volume set. You must clear all QOS rules before a volume set can be deleted.\n\n ==== Attributes\n\n * name - The name of the VolumeSet\n      type name: String\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n       - NON_EXISTENT_SET - The set does not exists.\n * Hpe3parSdk::HTTPConflict\n        -  - EXPORTED_VLUN - The host set has exported VLUNs. The VV set was exported.\n * Hpe3parSdk::HTTPConflict\n        - VVSET_QOS_TARGET - The object is already part of the set.", "Modifies a volume set by adding or removing a volume from the volume\n set. It's actions is based on the enums MEM_ADD or MEM_REMOVE.\n\n ==== Attributes\n\n * action: add or remove volume from the set\n      type name: Hpe3parSdk::SetCustomAction\n * name: the volume set name\n      type name: String\n * newName: new name of set\n      type newName: String\n * comment: the comment for on the vv set\n      type comment: String\n * flash_cache_policy: the flash-cache policy for the vv set\n      type flash_cache_policy: enum\n * setmembers: the vv to add to the set, the existence of the vv will not be checked\n      type name: Array of String\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - EXISTENT_SET - The set already exits.\n * Hpe3parSdk::HTTPBadRequest\n        - EXISTENT_SET - The set already exits.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_SET - The set does not exists.\n * Hpe3parSdk::HTTPConflict\n        - MEMBER_IN_DOMAINSET - The host is in a domain set.\n * Hpe3parSdk::HTTPConflict\n        - MEMBER_IN_SET - The object is already part of the set.\n * Hpe3parSdk::HTTPNotFound\n        - MEMBER_NOT_IN_SET - The object is not part of the set.\n * Hpe3parSdk::HTTPConflict\n        - MEMBER_NOT_IN_SAME_DOMAIN - Objects must be in the same domain to\n        perform this operation.\n * Hpe3parSdk::HTTPForbidden\n        - VV_IN_INCONSISTENT_STATE - The volume has an internal\n        inconsistency error.\n * Hpe3parSdk::HTTPForbidden\n        - VV_IS_BEING_REMOVED - The volume is being removed.\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_VOLUME - The volume does not exists.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_SYS_VOLUME - The operation is not allowed on a\n        system volume.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_INTERNAL_VOLUME - The operation is not allowed\n        on an internal volume.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_DUP_NAME - Invalid input (duplicate name).\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_PARAM_CONFLICT - Invalid input (parameters cannot be\n        present at the same time).\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_ILLEGAL_CHAR - Invalid contains one or more illegal\n        characters.", "Creates a snapshot of an existing VolumeSet\n\n ==== Attributes\n\n * name: Name of the Snapshot. The vvname pattern is described in \"VV Name Patterns\" in the HPE 3PAR Command Line Interface Reference, which is available at the following website: http://www.hp.com/go/storage/docs\n      type name: String\n * copy_of_name: the name of the parent volume\n      type copy_of_name: String\n * comment: the comment on the vv set\n      type comment: String\n * optional: Hash of optional params\n      type optional: Hash\n      optional = {\n       'id' => 12,                   # Specifies ID of the volume set\n                                     # set, next by default\n      'comment' => \"some comment\",\n      'readOnly' => true,            # Read Only\n      'expirationHours' => 36,       # time from now to expire\n      'retentionHours' => 12         # time from now to expire\n      }\n\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - INVALID_INPUT_VV_PATTERN - Invalid volume pattern specified\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_SET - The set does not exists.\n * Hpe3parSdk::HTTPNotFound\n        - EMPTY_SET - The set is empty\n * Hpe3parSdk::HTTPServiceUnavailable\n        - VV_LIMIT_REACHED - Maximum number of volumes reached\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_VOL - The storage volume does not exist\n * Hpe3parSdk::HTTPForbidden\n        - VV_IS_BEING_REMOVED - The volume is being removed\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_READONLY_TO_READONLY_SNAP - Creating a read-only copy from a read-only volume is not permitted\n * Hpe3parSdk::HTTPConflict\n        - NO_SNAP_CPG - No snapshot CPG has been configured for the volume\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_DUP_NAME - Invalid input (duplicate name).\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_SNAP_PARENT_SAME_BASE - Two parent snapshots share the same base volume\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_ONLINE_COPY_IN_PROGRESS - Invalid operation. Online copyis in progress\n * Hpe3parSdk::HTTPServiceUnavailable\n        - VV_ID_LIMIT_REACHED - Max number of volumeIDs has been reached\n * Hpe3parSdk::HTTPNotFound\n        - NON_EXISTENT_VOLUME - The volume does not exists\n * Hpe3parSdk::HTTPForbidden\n        - VV_IN_STALE_STATE - The volume is in a stale state.\n * Hpe3parSdk::HTTPForbidden\n        - VV_NOT_STARTED - Volume is not started\n * Hpe3parSdk::HTTPForbidden\n        - VV_UNAVAILABLE - The volume is not accessible\n * Hpe3parSdk::HTTPServiceUnavailable\n        - SNAPSHOT_LIMIT_REACHED - Max number of snapshots has been reached\n * Hpe3parSdk::HTTPServiceUnavailable\n        - CPG_ALLOCATION_WARNING_REACHED - The CPG has reached the allocation warning\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_VOLUME_CONV_IN_PROGRESS - Invalid operation: VV conversion is in progress.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_CLEANUP_IN_PROGRESS - Internal volume cleanup is in progress.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_PEER_VOLUME - Cannot modify a peer volume.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_VV_VOLUME_CONV_IN_PROGRESS - INV_OPERATION_VV_ONLINE_COPY_IN_PROGRESS  - The volume is the target of an online copy.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_INTERNAL_VOLUME - Illegal op on internal vol\n * Hpe3parSdk::HTTPConflict\n        - EXISTENT_ID - An ID exists\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_VV_NOT_IN_NORMAL_STATE - Volume state is not normal\n * Hpe3parSdk::HTTPForbidden\n        - VV_IN_INCONSISTENT_STATE - Internal inconsistency error in vol\n * Hpe3parSdk::HTTPBadRequest\n        - INVALID_INPUT_VV_PATTERN - - INV_INPUT_RETAIN_GT_EXPIRE - Retention time is greater than expiration time.\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT_TIME - Invalid time specified.\n * Hpe3parSdk::HTTPForbidden\n        - INV_OPERATION_SNAPSHOT_NOT_SAME_TYPE - Some snapshots in the volume set are read-only, some are read-write", "Creates a snapshot of an existing Volume.\n\n ==== Attributes\n\n * name - the name of the Snapshot\n      type name: String\n * copy_of_name - the name of the parent volume\n      type copy_of_name: String\n * optional - Hash of other optional items\n      type optional: Hash\n\n      optional = {\n             'id' => 12,                   # Specifies the ID of the volume,\n                                           # next by default\n             'comment' => \"some comment\",\n             'readOnly' => true,           # Read Only\n             'expirationHours' => 36,      # time from now to expire\n             'retentionHours' => 12        # time from now to expire\n      }\n\n ==== Raises\n\n * Hpe3parSdk::HTTPNotFound\n        - INON_EXISTENT_VOL - The volume does not exist\n * Hpe3parSdk::HTTPForbidden\n        - PERM_DENIED - Permission denied", "Gets the snapshots of a particular volume\n\n ==== Attributes\n\n * name - the name of the volume\n      type name: String\n\n ==== Returns\n\n Array of VirtualVolume", "Gets an array of all ports on the 3PAR.\n\n ==== Returns\n\n Array of Port.", "Gets an array of Fibre Channel Ports.\n\n * state - Port link state.\n      type name: Integer. Refer Hpe3parSdk::PortLinkState for complete enumeration.\n\n ==== Returns\n\n Array of Fibre Channel Port.", "Gets an array of iSCSI Ports.\n\n * state - Port link state.\n      type name: Integer. Refer Hpe3parSdk::PortLinkState for complete enumeration.\n\n ==== Returns\n\n Array of iSCSI Port.", "Gets an array of IP Ports.\n\n ==== Attributes\n\n * state - Port link state.\n      type name: Integer. Refer Hpe3parSdk::PortLinkState for complete enumeration.\n\n ==== Returns\n\n Array of IP Port.", "Gets entire list of CPGs.\n\n ==== Returns\n\n CPG array", "Gets information about a Cpg.\n\n ==== Attributes\n\n * name - The name of the cpg to find\n      type name: String\n\n ==== Returns\n\n CPG\n\n ==== Raises\n\n * Hpe3parSdk::HPE3PARException\n       Error with code: 15 message: cpg does not exist", "Creates a new CPG.\n\n ==== Attributes\n\n * name - Name of the cpg\n      type name: String\n * optional - Hash of other optional items\n      type optional: Hash\n\n      optional = {\n            'growthIncrementMiB' 100,    # Growth increment in MiB for\n                                          # each auto-grown operation\n            'growthLimitMiB': 1024,       # Auto-grow operation is limited\n                                          # to specified storage amount\n            'usedLDWarningAlertMiB': 200, # Threshold to trigger warning\n                                          # of used logical disk space\n            'domain': 'MyDomain',         # Name of the domain object\n            'LDLayout': {\n                'RAIDType': 1,            # Disk Raid Type\n                'setSize': 100,           # Size in number of chunklets\n                'HA': 0,                  # Layout supports failure of\n                                          # one port pair (1),\n                                          # one cage (2),\n                                          # or one magazine (3)\n                'chunkletPosPref': 2,     # Chunklet location perference\n                                          # characteristics.\n                                          # Lowest Number/Fastest transfer\n                                          # = 1\n                                          # Higher Number/Slower transfer\n                                          # = 2\n                'diskPatterns': []}       # Patterns for candidate disks\n    }\n\n ==== Raises\n * Hpe3parSdk::HTTPBadRequest\n        - INV_INPUT Invalid URI Syntax.\n * Hpe3parSdk::HTTPBadRequest\n        - NON_EXISTENT_DOMAIN - Domain doesn't exist.\n * Hpe3parSdk::HTTPBadRequest\n        - NO_SPACE - Not Enough space is available.\n * Hpe3parSdk::HTTPBadRequest\n        - BAD_CPG_PATTERN  A Pattern in a CPG specifies illegal values.\n * Hpe3parSdk::HTTPForbidden\n        - PERM_DENIED - Permission denied\n * Hpe3parSdk::HTTPConflict\n        - EXISTENT_CPG - Cpg Exists already", "Modifies a CPG.\n\n ==== Attributes\n\n * name - Name of the CPG\n      type name: String\n * optional - hash of other optional items\n      type optional: Hash\n\n      optional = {\n            'newName'=> \"newCPG:,          # Specifies the name of the\n                                           # CPG to update.\n            'disableAutoGrow'=>false,      # Enables (false) or\n                                           # disables (true) CPG auto\n                                           # grow. Defaults to false.\n            'rmGrowthLimit'=> false,       # Enables (false) or\n                                           # disables (true) auto grow\n                                           # limit enforcement. Defaults\n                                           # to false.\n            'rmWarningAlert'=> false,      # Enables (false) or\n                                           # disables (true) warning\n                                           # limit enforcement. Defaults\n                                           # to false.\n      }", "Gets available space information about a cpg.\n\n ==== Attributes\n\n * name - The name of the cpg to find\n      type name: String\n\n ==== Returns\n\n Available space details in form of LDLayoutCapacity object\n\n ==== Raises\n\n * Hpe3parSdk::HPE3PARException\n       Error with code: 15 message: cpg does not exist", "Deletes a CPG.\n\n ==== Attributes\n\n * name - The name of the CPG\n      type name: String\n\n ==== Raises\n\n * Hpe3parSdk::HPE3PARException\n       Error with code: 15 message: CPG does not exist\n * Hpe3parSdk::HTTPForbidden\n        -  IN_USE - The CPG Cannot be removed because it's in use.\n * Hpe3parSdk::HTTPForbidden\n        - PERM_DENIED - Permission denied", "Gets the status of an online physical copy\n\n ==== Attributes\n\n * name - The name of the volume\n      type name: str\n\n ==== Returns\n\n Status of online copy (String)\n\n ==== Raises\n\n * Hpe3parSdk::HPE3PARException\n       Error: message: Volume not an online physical copy", "Stops an offline physical copy operation\n\n ==== Attributes\n\n * name - The name of the volume\n      type name: String", "Stops an online physical copy operation\n\n ==== Attributes\n\n * name - The name of the volume\n      type name: String", "Resynchronizes a physical copy.\n\n ==== Attributes\n\n * name - The name of the volume\n      type name: String", "Waits for a 3PAR task to end.\n\n ==== Attributes\n\n * task_id - The Id of the task to be waited upon.\n      type task_id: Integer\n * poll_rate_secs - The polling interval in seconds.\n      type poll_rate_secs: Integer", "Cancel a 3PAR task\n\n ==== Attributes\n\n * task_id - The Id of the task to be cancelled.\n      type task_id: Integer\n ==== Raises\n\n * Hpe3parSdk::HTTPBadRequest\n        - NON_ACTIVE_TASK - The task is not active at this time.\n * Hpe3parSdk::HTTPConflict\n        - INV_OPERATION_CANNOT_CANCEL_ TASK - Invalid operation: Task cannot be cancelled.", "Logout from the 3PAR Array", "Call ey-agent to return nginx or apache status as well as database status", "Show a status page showing the health of monitored features\n Returns a 404 if any features have a success of unsuccessful\n\n Skip features: z2live.com/health/status?skip=mongo,mysql\n Include features: z2live.com/health/status?feature=mongo", "Render the result", "Skip features by appending skip=mongo,fun,etc\n Include features by appending feature=mongo,urban_airship,etc to filter", "set app debug mode, ensuring it's valid, and shutting it down", "Process the response body to make sure that its contains the list name defined on resource\n Returns the list name present on body and the body itself", "Return any listname described on resource", "Discover what list name defined on resource is present on body\n If none of then is find assume that the body is a single resource\n and add it value into array and assing to any list name", "Mounts a friendly response for the change password request\n\n @param [response] response provided by LXCA in change password endpoint\n @return [Hash] represents LXCA response\n   :changed [Boolean] says if the password was changed or not\n   :message [String] message from LXCA about the operation", "Captures the HTML code built inside the +block+.  This is done by creating a new\n stream for the builder object, running the block and passing back its stream as a string.\n\n   >> Markaby::Builder.new.capture { h1 \"TEST\"; h2 \"CAPTURE ME\" }\n   => \"<h1>TEST</h1><h2>CAPTURE ME</h2>\"", "Create a tag named +tag+. Other than the first argument which is the tag name,\n the arguments are the same as the tags implemented via method_missing.", "splitted create_uri just to fix codeclimate error", "Jobs acess and searching", "Force strings to UTF8", "This is overridden by the ActiveRecord adapter as the attribute accessors\n don't show up in instance_methods.", "Create a new post from scratch. Return filename\n This would not commit the file.", "Merge existing yaml with post params", "Update exiting post.", "Jekyll site instance", "Gives out a sorted list of post template data\n for a post or draft", "Provides the default exception handling for the given block.", "Creates the structure of the tree, as a hash of SNP splits and values.\n\n It just initializes the needed variables and then defines the first node of the tree.\n The rest of the structure of the tree is computed recursively building every node calling +build_node+.", "This is the first method to be called on Configuration when a config.yml file\n exists with user input options for the forest.\n\n * The method will read the config file and change the default value of the selected options.\n * Then based on the options and the existence of training, testing and forest files, it will mark:\n   - if training is needed,\n   - if testing is needed,\n   - which forest will be used for the testing.\n * Finally it will run basic checks on the input data trying to prevent future program errors.", "Returns the firstname and lastname as a string\n\n If both are blank, returns the login\n\n @option options :flipped (false)\n   Flip the firstname and lastname", "Delivers a welcome mail depending from user's role.", "Overwriting the default of Devise", "Traverse a testing set through every regression tree of the forest and get averaged predictions for every individual in the sample.", "The document identifier class corresponding to the given code", "list all entries as a serialization\n @return [String]", "hash uses => , because the hash is imported from JSON\n @param code [String]\n @param year [String]\n @param opts [Hash]\n @param stdclass [Symbol]\n @return [Hash]", "Returns all items\n @return [Array<Hash>]", "Nuclear termination\n  if trace_only is \"true\", we only print what we're going to do but not actually do it", "Populates the instance's attributes based on the `raw_data`.", "Change the default link renderer for will_paginate", "Decides if and how a column will be changed\n Provide the details of a previously column, or simply nil to create a new column", "An internal method used to get a hash of values that we are going to set from a Salesforce outbound message hash", "Gets passed the Salesforce outbound message hash of changed values and updates the corresponding model", "def salesforce_object_exists?\n      return salesforce_object_exists_method if respond_to? salesforce_exists_method\n      return salesforce_object_exists_default\n    end\n Finds a salesforce record by its Id and returns nil or its SystemModstamp", "create a hash of updates to send to salesforce", "if attributes specified in the async_attributes array are the only attributes being modified, then sync the data\n via delayed_job", "sync model data to Salesforce, adding any Salesforce validation errors to the models errors", "to be used in a before_filter, checks ip ranges specified in configuration\n and renders a 404 unless the request matches", "Low-level connection methods", "Return a content item merged with a hash and with the excluded fields removed.\n If the resulting content item isn't valid against the schema an error will be raised.\n\n Example without block:\n\n      generator.payload\n      # => {\"base_path\"=>\"/e42dd28e\", \"title\"=>\"dolor est...\", \"publishing_app\"=>\"elit\"...}\n\n Example with block:\n\n      generator.payload do |payload|\n        payload.merge('base_path' => \"Test base path\")\n      end\n      # => {\"base_path\"=>\"Test base path\", \"title\"=>\"dolor est...\", \"publishing_app\"=>\"elit\"...}\n\n @param [Block] the base payload is passed inton the block, with the block result then becoming\n   the new payload. The new payload is then validated. (optional)\n @return [Hash] A content item\n @raise [GovukSchemas::InvalidContentGenerated]", "Receives an array of elements\n and returns another without invisibles.", "With no block, returns the number of keys. If a block is given, counts the\n number of elements yielding a true value.", "augmented tree\n using a start point as resresentative value of the node", "Allows accessing a hash attribute as a method.", "Allows accessing a hash attribute as hash key, either a string or symbol.", "Sets a hash by key.", "Authorize and capture funds", "Void an authorized invoice", "Override host tags with presets\n @param [Beaker::Host] host Beaker host\n @return [Hash] Tag hash", "Verify invoices exist for the entire subscription period up until today", "Gets the activemerchant package based on the shipping package", "Gets the 3d dimensions of the variants after they're stacked", "Initialize the cart in the session", "Parses any parameters in the URL and adds them to the params", "Logs in a user", "Returns whether or not a user is logged in", "Checks to see if a token is given. If so, it tries to validate the token\n and log the user in.", "Checks to see if a remember me cookie value is present.", "Removes a given parameter from a URL querystring", "Make sure we're not under construction or on a forwarded domain", "Step 3 - Shipping method\n @route GET /checkout/shipping/json", "Step 5 - Update Stripe Details\n @route PUT /checkout/stripe-details", "Sends a notification email to the fulfillment dept about a new invoice", "Sends a notification email to the shipping dept that an invoice is ready to be shipped", "Lazily build and return a module that implements accessors for each field\n @return [Module] A module containing all accessor methods", "Add an attribute to the blueprint. Attributes will be stored in the xapian documents an can be\n accessed from a search result.\n @param [String] name The name of the method that delivers the value for the attribute\n @param [Hash] options\n @option options [Integer] :weight (1) The weight for this attribute.\n @option options [Boolean] :index (true) Should the attribute be indexed?\n @option options [Symbol] :as should add type info for range queries (:date, :numeric)\n @example For complex attribute configurations you may pass a block:\n   XapianDb::DocumentBlueprint.setup(:IndexedObject) do |blueprint|\n     blueprint.attribute :complex do\n       if @id == 1\n         \"One\"\n       else\n         \"Not one\"\n       end\n     end\n   end", "Add a list of attributes to the blueprint. Attributes will be stored in the xapian documents ans\n can be accessed from a search result.\n @param [Array] attributes An array of method names that deliver the values for the attributes", "Add an indexed value to the blueprint. Indexed values are not accessible from a search result.\n @param [Array] args An array of arguments; you can pass a method name, an array of method names\n   or a method name and an options hash.\n @param [Block] &block An optional block for complex configurations\n Avaliable options:\n - :weight (default: 1) The weight for this indexed value\n @example Simple index declaration\n   blueprint.index :name\n @example Index declaration with options\n   blueprint.index :name, :weight => 10\n @example Mass index declaration\n   blueprint.index :name, :first_name, :profession\n @example Index declaration with a block\n   blueprint.index :complex, :weight => 10 do\n     # add some logic here to calculate the value for 'complex'\n   end", "Define the natural sort order.\n @param [String] name The name of the method that delivers the sort expression\n @param [Block] &block An optional block for complex configurations\n Pass a method name or a block, but not both", "Set the global database to use\n @param [String] path The path to the database. Either apply a file sytem path or :memory\n   for an in memory database", "Set the adapter\n @param [Symbol] type The adapter type; the following adapters are available:\n   - :generic ({XapianDb::Adapters::GenericAdapter})\n   - :active_record ({XapianDb::Adapters::ActiveRecordAdapter})\n   - :datamapper ({XapianDb::Adapters::DatamapperAdapter})", "Set the index writer\n @param [Symbol] type The writer type; the following adapters are available:\n   - :direct ({XapianDb::IndexWriters::DirectWriter})\n   - :beanstalk ({XapianDb::IndexWriters::BeanstalkWriter})\n   - :resque ({XapianDb::IndexWriters::ResqueWriter})\n   - :sidekiq ({XapianDb::IndexWriters::SidekiqWriter})", "Set the language.\n @param [Symbol] lang The language; apply the two letter ISO639 code for the language\n @example\n   XapianDb::Config.setup do |config|\n     config.language :de\n   end\n see {LANGUAGE_MAP} for supported languages", "Taken from Rails", "Asserts that the given mock received the given method.\n\n Examples:\n\n   assert_received(mock, :to_s)\n   assert_received(Radio, :new) {|expect| expect.with(1041) }\n   assert_received(radio, :volume) {|expect| expect.with(11).twice }", "Decorate a Xapian match with field accessors for each configured attribute\n @param [Xapian::Match] a match\n @return [Xapian::Match] the decorated match", "Delete all docs of a specific class.\n\n If `klass` tracks its descendants, then docs of any subclasses will be deleted, too.\n (ActiveRecord does this by default; the gem 'descendants_tracker' offers an alternative.)\n\n @param [Class] klass A class that has a {XapianDb::DocumentBlueprint} configuration", "Perform a search\n @param [String] expression A valid search expression.\n @param [Hash] options\n @option options [Integer] :per_page How many docs per page?\n @option options [Array<Integer>] :sort_indices (nil) An array of attribute indices to sort by. This\n   option is used internally by the search method implemented on configured classes. Do not use it\n   directly unless you know what you do\n @option options [Boolean] :sort_decending (false) Reverse the sort order?\n @example Simple Query\n   resultset = db.search(\"foo\")\n @example Wildcard Query\n   resultset = db.search(\"fo*\")\n @example Boolean Query\n   resultset = db.search(\"foo or baz\")\n @example Field Query\n   resultset = db.search(\"name:foo\")\n @return [XapianDb::Resultset] The resultset", "A very simple implementation of facets using Xapian collapse key.\n @param [Symbol, String] attribute the name of an attribute declared in one ore more blueprints\n @param [String] expression A valid search expression (see {#search} for examples).\n @return [Hash<Class, Integer>] A hash containing the classes and the hits per class", "Store all configured fields", "Index all configured text methods", "Get the values to index from an object", "note that group_by requires the entire file to be\n read into memory", "Returns true if the row exists in this table\n\n @param [Workbook::Row] row to test for\n @return [Boolean] whether the row exist in this table", "Returns The dimensions of this sheet based on longest row\n @return [Array] x-width, y-height", "Create or find a format by name\n @return [Workbook::Format] The new or found format\n @param [String] name of the format (e.g. whatever you want, in diff names such as 'destroyed', 'updated' and 'created' are being used)\n @param [Symbol] variant can also be a strftime formatting string (e.g. \"%Y-%m-%d\")", "Loads an external file into an existing worbook\n\n @param [String] filename   a string with a reference to the file to be opened\n @param [String] extension  an optional string enforcing a certain parser (based on the file extension, e.g. 'txt', 'csv' or 'xls')\n @return [Workbook::Book] A new instance, based on the filename", "Open the file in binary, read-only mode, do not read it, but pas it throug to the extension determined loaded\n\n @param [String] filename a string with a reference to the file to be opened\n @param [String] extension an optional string enforcing a certain parser (based on the file extension, e.g. 'txt', 'csv' or 'xls')\n @return [Workbook::Book] A new instance, based on the filename", "Open the file in non-binary, read-only mode, read it and parse it to UTF-8\n\n @param [String] filename   a string with a reference to the file to be opened\n @param [String] extension  an optional string enforcing a certain parser (based on the file extension, e.g. 'txt', 'csv' or 'xls')", "Writes the book to a file. Filetype is based on the extension, but can be overridden\n\n @param [String] filename   a string with a reference to the file to be written to\n @param [Hash] options  depends on the writer chosen by the file's filetype", "Helper method to convert text in a file to UTF-8\n\n @param [String] text a string to convert", "Create or open the existing sheet at an index value\n\n @param [Integer] index    the index of the sheet", "Returns the missing elements in an array set", "For a Range, will return value.first or value.last. A non-Range will return itself.", "Set the table this column belongs to\n @param [Workbook::Table] table this column belongs to", "Validate arguments against acceptable values.\n\n Raises error if value is found which is not on\n list of acceptable values.\n\n If acceptable values are hash's, keys are compared\n and on matches the values are used as the # of following\n arguments to skip in the validator\n\n *Note* args / acceptable params are converted to strings\n before comparison\n\n @example\n   args = Arguments.new :args => ['custom', 'another']\n   args.validate! 'custom', 'another'  #=> nil\n   args.validate! 'something'          #=> ArgumentError\n\n   args = Arguments.new :args => ['with_id', 123, 'another']\n   args.validate! :with_id => 1, :another => 0 #=> nil\n   args.validate! :with_id => 1                #=> ArgumentError", "Extract groups of values from argument list\n\n Groups are generated by comparing arguments to keys in the\n specified map and on matches extracting the # of following\n arguments specified by the map values\n\n Note arguments / keys are converted to strings before comparison\n\n @example\n   args = Arguments.new :args => ['with_id', 123, 'custom', 'another']\n   args.extract :with_id => 1, :custom => 0\n     # => [['with_id', 123], ['custom']]", "Set job metadata and execute job with specified params.\n\n Used internally by thread pool", "Internal helper, launch worker thread", "Internal helper, performs checks on workers", "Set reference to the table this row belongs to and add the row to this table\n\n @param [Workbook::Table] t the table this row belongs to", "Returns an array of cells allows you to find cells by a given color, normally a string containing a hex\n\n @param [String] color  a CSS-style hex-string\n @param [Hash] options Option :hash_keys (default true) returns row as an array of symbols\n @return [Array<Symbol>, Workbook::Row<Workbook::Cell>]", "Compact detaches the row from the table", "Applies the formatting options of self with its parents until no parent can be found\n @return [Workbook::Format] new Workbook::Format that is the result of merging current style with all its parent's styles.", "Load stats from provided arg or github", "Internal helper, run connection event handlers for specified event, passing\n self and args to handler", "Internal helper, extract client info from connection", "Internal helper, handle message received", "Internal helper, handle request message received", "Internal helper, handle response message received", "Internal helper, block until response matching message id is received", "Loads module from fs and adds handlers defined there\n\n Assumes module includes a 'dispatch_<module_name>' method\n which accepts a dispatcher and defines handlers on it.\n\n @param [String] name location which to load module(s) from, may be\n   a file, directory, or path specification (dirs seperated with ':')\n @return self", "Register json-rpc handler with dispatcher\n\n @param [String,Regex] signature request signature to match\n @param [Callable] callback callable object which to bind to signature\n @param [Callable] bl block parameter will be set to callback if specified\n @return self", "Return handler for specified method.\n\n Currently we match method name string or regex against signature\n @param [String] rjr_method string rjr method to match\n @return [Callable, nil] callback proc registered to handle rjr_method\n   or nil if not found", "Return the environment registered for the specified method", "EMAdapter initializer\n Start the eventmachine reactor thread if not running", "Invoke the request by calling the registered handler with the registered\n method parameters in the local scope", "returns an array of valid types for the normalized number\n if array is empty, we can assume that the number is invalid", "Lint all python files inside a given directory. Defaults to \".\"\n @return [void]", "create! doesn't return the SalesForce object back\n It will return only the object id", "Create a new producer.\n\n @param [Hash] opts\n @option opts [String] :host (\"localhost\") server hostname\n @option opts [Fixnum] :port (6380) server port\n @option opts [Hash] :redis Configuration options for the underlying\n   Redis client\n\n @return [Producer]\n Produce a message to a topic. This is an asynchronous operation.\n\n @param topic [String]\n @param msg [#to_s] the message\n @param key [#to_s] an optional partition hashing key. Two or more messages\n   with the same key will always be written to the same partition.\n\n @example Simple produce\n   producer = Rafka::Producer.new\n   producer.produce(\"greetings\", \"Hello there!\")\n\n @example Produce two messages with a hashing key. Those messages are guaranteed to be written to the same partition\n     producer = Rafka::Producer.new\n     produce(\"greetings\", \"Aloha\", key: \"abc\")\n     produce(\"greetings\", \"Hola\", key: \"abc\")", "publish a message with defaults\n @param topic_name [#to_s, nil]\n @param event_name [#to_s, nil]\n @param schema_name [#to_s, nil]\n @param primary_key [#to_s, nil]\n @param body [#to_json]", "Initialize a new consumer.\n\n @param [Hash] opts\n @option opts [String] :host (\"localhost\") server hostname\n @option opts [Fixnum] :port (6380) server port\n @option opts [String] :topic Kafka topic to consume (required)\n @option opts [String] :group Kafka consumer group name (required)\n @option opts [String] :id (random) Kafka consumer id\n @option opts [Boolean] :auto_commit (true) automatically commit\n   offsets\n @option opts [Hash] :librdkafka ({}) librdkafka configuration. It will\n   be merged over the existing configuration set in the server.\n   See https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md\n   for more information\n @option opts [Hash] :redis ({}) Configuration for the underlying Redis\n   client. See {REDIS_DEFAULTS}\n\n @raise [RuntimeError] if a required option was not provided\n   (see {REQUIRED_OPTS})\n\n @return [Consumer]\n Consumes the next message.\n\n If :auto_commit is true, offsets are committed automatically.\n In the block form, offsets are committed only if the block executes\n without raising any exceptions.\n\n If :auto_commit is false, offsets have to be committed manually using\n {#commit}.\n\n @param timeout [Fixnum] the time in seconds to wait for a message. If\n   reached, {#consume} returns nil.\n\n @yieldparam [Message] msg the consumed message\n\n @raise [MalformedMessageError] if the message cannot be parsed\n @raise [ConsumeError] if there was a server error\n\n @return [nil, Message] the consumed message, or nil of there wasn't any\n\n @example Consume a message\n   msg = consumer.consume\n   msg.value # => \"hi\"\n\n @example Consume a message and commit offset if the block does not raise an exception\n   consumer.consume { |msg| puts \"I received #{msg.value}\" }", "Consume a batch of messages.\n\n Messages are accumulated in a batch until (a) batch_size number of\n messages are accumulated or (b) batching_max_sec seconds have passed.\n When either of the conditions is met the batch is returned.\n\n If :auto_commit is true, offsets are committed automatically.\n In the block form, offsets are committed only if the block executes\n without raising any exceptions.\n\n If :auto_commit is false, offsets have to be committed manually using\n {#commit}.\n\n @note Either one of, or both batch_size and batching_max_sec may be\n   provided, but not neither.\n\n @param timeout [Fixnum] the time in seconds to wait for each message\n @param batch_size [Fixnum] maximum number of messages to accumulate\n   in the batch\n @param batching_max_sec [Fixnum] maximum time in seconds to wait for\n   messages to accumulate in the batch\n\n @yieldparam [Array<Message>] msgs the batch\n\n @raise [MalformedMessageError] if a message cannot be parsed\n @raise [ConsumeError] if there was a server error\n @raise [ArgumentError] if neither batch_size nor batching_max_sec were\n   provided\n\n @return [Array<Message>] the batch\n\n @example Consume a batch of 10 messages\n   msgs = consumer.consume_batch(batch_size: 10)\n   msgs.size # => 10\n\n @example Accumulate messages for 5 seconds and consume the batch\n   msgs = consumer.consume_batch(batching_max_sec: 5)\n   msgs.size # => 3813", "Commit offsets for the given messages.\n\n If more than one messages refer to the same topic/partition pair,\n only the largest offset amongst them is committed.\n\n @note This is non-blocking operation; a successful server reply means\n   offsets are received by the server and will _eventually_ be submitted\n   to Kafka. It is not guaranteed that offsets will be actually committed\n   in case of failures.\n\n @param msgs [Array<Message>] any number of messages for which to commit\n   offsets\n\n @raise [ConsumeError] if there was a server error\n\n @return [Hash{String=>Hash{Fixnum=>Fixnum}}] the actual offsets sent\n   to the server for commit. Keys contain topics while values contain\n   the respective partition/offset pairs.", "Accepts one or more messages and prepare them for commit.\n\n @param msgs [Array<Message>]\n\n @return [Hash{String=>Hash{Fixnum=>Fixnum}}] the offsets to be committed.\n   Keys denote the topics while values contain the partition=>offset pairs.", "add a type, meaning the instance given must be a valid type", "all methods form all types", "Create a magical envelope XML document around the original body\n and sign it with a private key\n @param [String] body\n @param [OpenSSL::PKey::RSA] key The private part of the key will be used\n @return [String] Magical envelope XML", "Deliver the magical envelope to a Salmon endpoint\n @param [String] salmon_url Salmon endpoint URL\n @param [String] envelope Magical envelope\n @raise [HTTP::Error] Error raised upon delivery failure\n @raise [OpenSSL::SSL::SSLError] Error raised upon SSL-related failure during delivery\n @return [HTTP::Response]", "Verify the magical envelope's integrity\n @param [String] raw_body Magical envelope\n @param [OpenSSL::PKey::RSA] key The public part of the key will be used\n @return [Boolean]", "To avoid many an if, it can be handy to swap variable names.\n But since the names in the builder are not variables, we need this method.\n As it says, swap the two names around. Names must exist", "translate one method, which means the method itself and all blocks inside it\n returns an array of assemblers", "Verify that the feed contents were meant for this subscription\n @param [String] content\n @param [String] signature\n @return [Boolean]", "Halts memoization of API calls and clears the memoization cache.", "This implements branch logic, which is simply assembler branch\n\n The only target for a call is a Block, so we just need to get the address for the code\n and branch to it.", "pad the string with the given character to the given length", "set the character at the given index to the given character\n character must be an integer, as is the index\n the index starts at one, but may be negative to count from the end\n indexes out of range will raise an error", "private method to account for", "compare the word to another\n currently checks for same class, though really identity of the characters\n in right order would suffice", "given a something, determine if it is a Name\n\n Return a Name, and a possible rest that has a hoisted part of the statement\n\n eg  if( @var % 5) is not normalized\n but if(tmp_123) is with tmp_123 = @var % 5 hoisted above the if\n\n also constants count, though they may not be so useful in ifs, but returns", "initialize with a given object, first parameter\n The object will be the key in global position map\n\n The actual position starts as -1 (invalid)\n utility to register events of type :position_changed\n can give an object and a PositionListener will be created for it", "look for InstructionListener and return its code if found", "basically move both left and right values into register\n subtract them and see if IsZero comparison", "load the slots into a register\n the code is added to compiler\n the register returned", "Process previously stored vool source to binary.\n Binary code is generated byu calling to_risc, then positioning and calling\n create_binary on the linker. The linker may then be used to creat a binary file.\n The biary the method name refers to is binary code in memory, or in BinaryCode\n objects to be precise.", "ruby_to_vool compiles the ruby to ast, and then to vool", "Connect to the PokitDok API with the specified Client ID and Client\n Secret.\n\n +client_id+     your client ID, provided by PokitDok\n +client_secret+ your client secret, provided by PokitDok\n +version+ The API version that should be used for requests.  Defaults to the latest version.\n +base+ The base URL to use for API requests.  Defaults to https://platform.pokitdok.com\n\n  TODO: Make it simpler to pass in params out of order (also so you don't have to do init(..., nil, nil, nil, param))\n\n\n ******************************\n General Use APIs\n ******************************\n\n Invokes the the general request method for submitting API request.\n\n +endpoint+ the API request path\n +method+ the http request method that should be used\n +file+ file when the API accepts file uploads as input\n +params+ an optional Hash of parameters\n\n NOTE: There might be a better way of achieving the seperation of get/get_request\n but currently using the \"send\" method will go down the ancestor chain until the correct\n method is found. In this case the 'httpMethod'_request", "Invokes the pharmacy network cost endpoint.\n\n +params+ an optional Hash of parameters", "determine how given name need to be accsessed.\n For blocks the options are args or frame\n or then the methods arg or frame", "load receiver and then each arg into the new message\n delegates to SlotLoad for receiver and to the actual args.to_risc", "Trigger the given event name and passes all args to each handler\n for this event.\n\n   obj.trigger(:foo)\n   obj.trigger(:foo, 1, 2, 3)\n\n @param [String, Symbol] name event name to trigger", "Instruction interpretation starts here", "Position all BinaryCode.\n\n So that all code from one method is layed out linearly (for debugging)\n we go through methods, and then through all codes from the method\n\n start at code_start.", "need to pass the platform to translate new jumps", "insert a jump to the next instruction, at the last instruction\n thus hopping over the object header", "when the argument changes position, we update the next objects\n position to reflect that change", "using the registers type, resolve the slot to an index\n Using the index and the register, add a SlotToReg to the instruction", "reduce integer to fixnum and add instruction if builder is used", "helper method to calculate with register symbols", "create operator instruction for self and add\n doesn't read quite as smoothly as one would like, but better than the compiler version", "to_mom all the statements. Append subsequent ones to the first, and return the\n first.\n\n For ClassStatements this creates and returns a MomCompiler", "this part of the init is seperate because at boot time we can not use normal new\n new is overloaded to grab the type from space, and before boot, that is not set up", "add the name of an instance variable\n Type objects are immutable, so a new object is returned\n As types are also unique, two same adds will result in identical results", "don't overwrite instance variables, to make assembly repeatable\n this also loads constants, which are issued as pc relative adds", "shared methods for handling manifest lookups\n\n  note: required attribs (in host class) include:\n     - opts.config_path", "objects must be written in same order as positioned by the linker, namely\n - intial jump\n - all objects\n - all BinaryCode", "Write the BinaryCode objects of all methods to stream.\n Really like any other object, it's just about the ordering", "Write any object just logs a bit and passes to write_any_out", "write type of the instance, and the variables that are passed\n variables ar values, ie int or refs. For refs the object needs to save the object first", "write means we write the resulting address straight into the assembler stream\n object means the object of which we write the address", "index of item\n return  nil if no such item", "return the next of given. Nil if item not in list or there is not next", "Downloads the file at the given path relative to the configured mode's\n root.\n\n Returns the contents of the downloaded file as a +String+. Support for\n streaming downloads and range queries is available server-side, but not\n available in this API client due to limitations of the OAuth gem.\n\n Options:\n\n +mode+:: Temporarily changes the API mode. See the MODES array.", "Deletes a file or folder at the given path. The path is assumed to be\n relative to the configured mode's root.\n\n Raises FileNotFoundError if the file or folder does not exist at +path+.\n\n Options:\n\n +mode+:: Temporarily changes the API mode. See the MODES array.\n\n TODO The API documentation says this method returns 404 if the path does not exist, but it actually returns 5xx.", "Renames a file. Takes the same options and raises the same exceptions as\n the move method.\n\n Calling\n\n  session.rename 'path/to/file', 'new_name'\n\n is equivalent to calling\n\n  session.move 'path/to/file', 'path/to/new_name'", "Returns a cookie-protected URL that the authorized user can use to view\n the file at the given path. This URL requires an authorized user.\n\n The path is assumed to be relative to the configured mode's root.\n\n Options:\n\n +mode+:: Temporarily changes the API mode. See the MODES array.", "Creates and returns a shareable link to files or folders.\n\n The path is assumed to be relative to the configured mode's root.\n\n Options:\n\n +mode+:: Temporarily changes the API mode. See the MODES array.", "Returns a +Struct+ containing metadata on a given file or folder. The path\n is assumed to be relative to the configured mode's root.\n\n If you pass a directory for +path+, the metadata will also contain a\n listing of the directory contents (unless the +suppress_list+ option is\n true).\n\n For information on the schema of the return struct, see the Dropbox API\n at https://www.dropbox.com/developers/docs#metadata\n\n The +modified+ key will be converted into a +Time+ instance. The +is_dir+\n key will also be available as <tt>directory?</tt>.\n\n Options:\n\n +suppress_list+:: Set this to true to remove the directory list from\n                   the result (only applicable if +path+ is a directory).\n +limit+:: Set this value to limit the number of entries returned when\n           listing a directory. If the result has more than this number of\n           entries, a TooManyEntriesError will be raised.\n +prior_response+:: The response from a prior call to metadata for the same\n                    path. If the metadata has not changed since the prior\n                    call, the entire metadata will not be re-downloaded.\n                    Operation is undefined if the given value was for a\n                    call to metadata with a different path.\n +mode+:: Temporarily changes the API mode. See the MODES array.", "update label positions. All else done in position_changing", "set key with value, returns value", "yield to each key value pair", "Array + Hashes", "this is a call to super with args and\n same name as current method, which is set later", "get the method and if not found, try superclasses. raise error if not found", "Create Albums.\n\n @param data [Single Albums Object, Array of Albums Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns an Albums objects array if generate_objects flag is set\n\n @example\n          rest_client.create_albums(albums_obj)\n          rest_client.create_albums(albums_obj_array)\n          rest_client.create_albums(albums_obj,true)\n          rest_client.create_albums(albums_obj_array,true)", "Modify Albums.\n\n @param data [Single Albums Object, Array of Albums Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns an Albums objects array if generate_objects flag is set\n\n @example\n          rest_client.update_albums(albums_obj)\n          rest_client.update_albums(albums_obj,true)\n          rest_client.update_albums(albums_obj_array)\n          rest_client.update_albums(albums_obj_array,true)", "Modify system Categories.\n\n @param data [Single Categories Object, Array of Categories Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns a Categories objects array if generate_objects flag is set\n\n @example\n          rest_client.update_categories(categories_obj)\n          rest_client.update_categories(categories_obj,true)\n          rest_client.update_categories(categories_obj_array)\n          rest_client.update_categories(categories_obj_array,true)", "Create CopyrightHoloders.\n\n @param data [Single CopyrightPolicies Object, Array of CopyrightPolicies Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns a CopyrightHolders objects array if generate_objects flag is set\n\n @example\n          rest_client.create_copyright_holders(copyright_holders_obj)\n          rest_client.create_copyright_holders(copyright_holders_obj_array)\n          rest_client.create_copyright_holders(copyright_holders_obj,true)\n          rest_client.create_copyright_holders(copyright_holders_obj_array,true)", "Modify CopyrightHolders.\n\n @param data [Single CopyrightHolders Object, Array of CopyrightHoloders Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns a CopyrightHolders objects array if generate_objects flag is set\n\n @example\n          rest_client.update_copyright_holders(copyright_holders_obj)\n          rest_client.update_copyright_holders(copyright_holders_obj,true)\n          rest_client.update_copyright_holders(copyright_holders_obj_array)\n          rest_client.update_copyright_holders(copyright_holders_obj_array,true)", "Create CopyrightPolicies.\n\n @param data [Single CopyrightPolicies Object, Array of CopyrightPolicies Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns a CopyrightPolicies objects array if generate_objects flag is set\n\n @example\n          rest_client.create_copyright_policies(copyright_policies_obj)\n          rest_client.create_copyright_policies(copyright_policies_obj_array)\n          rest_client.create_copyright_policies(copyright_policies_obj,true)\n          rest_client.create_copyright_policies(copyright_policies_obj_array,true)", "Modify CopyrightPolicies.\n\n @param data [Single CopyrightPolicies Object, Array of CopyrightPolicies Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns a CopyrightPolicies objects array if generate_objects flag is set\n\n @example\n          rest_client.update_copyright_policies(copyright_policies_obj)\n          rest_client.update_copyright_policies(copyright_policies_obj,true)\n          rest_client.update_copyright_policies(copyright_policies_obj_array)\n          rest_client.update_copyright_policies(copyright_policies_obj_array,true)", "Create fields.\n\n @param data [Single Fields Object, Array of Fields Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns a Fields objects array if generate_objects flag is set\n\n @example\n          rest_client.create_fields(fields_obj)\n          rest_client.create_fields(fields_obj_array)\n          rest_client.create_fields(fields_obj,true)\n          rest_client.create_fields(fields_obj_array,true)", "Modify fields.\n\n @param data [Single Fields Object, Array of Fields Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns a Fields objects array if generate_objects flag is set\n\n @example\n          rest_client.update_fields(fields_obj)\n          rest_client.update_fields(fields_obj,true)\n          rest_client.update_fields(fields_obj_array)\n          rest_client.update_fields(fields_obj_array,true)", "FIELD LOOKUP STRINGS \n                      \n\n Retrieves options for Fixed Suggestion, Suggestion, and Option field types.\n\n @param field [Fields Object, Hash, String, Integer] Argument must specify the field id (Required)\n @param query_obj[RestOptions Object] Takes a RestOptions object or a SQL WHERE clause (Optional)\n @param with_nested_resources [Boolean] Returns any nested objects if applicable (Optional)\n @param use_http_query [Boolean] Filtering done on the server when set - faster but less granular -> \"or\" operator not supported (Optional)\n @return [Array] Array of FieldLookupStrings.\n\n @example\n          rest_client.get_field_lookup_strings(27)\n          rest_client.get_field_lookup_strings(27,rest_options_object)\n          rest_client.get_field_lookup_strings(27,\"where value = 'my value'\",false,false)\n          rest_client.get_field_lookup_strings(27,\"where value = 'my value'\",false,true)", "creates options for Fixed Suggestion, Suggestion, and Option field types.\n\n @param field [Fields Object, Hash, String, Integer] Argument must specify the field id (Required)\n @param data [Single FieldLookupString Object, Array of FieldLookupString Objects]\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Array of FieldLookupStrings objects if generate_objects flag is set\n\n @example\n          rest_client.create_field_lookup_strings(field_obj,field_lookup_strings_obj)\n          rest_client.create_field_lookup_strings(field_obj,field_lookup_strings_obj,true)\n          rest_client.create_field_lookup_strings(field_obj,field_lookup_strings_obj_array)\n          rest_client.create_field_lookup_strings(field_obj,field_lookup_strings_obj_array,true)", "Modifies options for Fixed Suggestion, Suggestion, and Option field types.\n\n @param field [Fields Object, Hash, String, Integer] Argument must specify the field id (Required)\n @param data [Single FieldLookupString Object, Array of FieldLookupString Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns Array of FieldLookupStrings objects if generate_objects flag is set\n\n @example\n          rest_client.update_field_lookup_strings(field_obj,field_lookup_strings_obj)\n          rest_client.update_field_lookup_strings(field_obj,field_lookup_strings_obj,true)\n          rest_client.update_field_lookup_strings(field_obj,field_lookup_strings_obj_array)\n          rest_client.update_field_lookup_strings(field_obj,field_lookup_strings_obj_array,true)", "Uploads a file to OpenAsset.\n\n @param file [String] the path to the file being uploaded\n @param category [Categories Object,String,Integer] containing Target Category ID in OpenAsset (Required)\n @param project [Projects Object, String, Integer] Project ID in OpenAsset (Specified only when Category is project based)\n @return [JSON Object] HTTP response JSON object. Returns Files objects array if generate_objects flag is set\n\n FOR PROJECT UPLOADS\n @example\n          rest_client.upload_file('/path/to/file', category_obj, project_obj)\n          rest_client.upload_file('/path/to/file','2','10')\n          rest_client.upload_file('/path/to/file', 2, 10)\n          rest_client.upload_file('/path/to/file', category_obj, project_obj, true)\n          rest_client.upload_file('/path/to/file','2','10', true)\n          rest_client.upload_file('/path/to/file', 2, 10, true)\n\n\n FOR REFERENCE UPLOADS\n @example\n          rest_client.upload_file('/path/to/file', category_obj)\n          rest_client.upload_file('/path/to/file','2')\n          rest_client.upload_file('/path/to/file', 2,)\n          rest_client.upload_file('/path/to/file', category_obj, nil, true)\n          rest_client.upload_file('/path/to/file','2', nil, true)\n          rest_client.upload_file('/path/to/file', 2, nil, true)", "Replace a file in OpenAsset.\n\n @param original_file_object [Single Files Object] (Required) File Object in OA\n @param replacement_file_path [String] (Required)\n @param retain_original_filename_in_oa [Boolean] (Optional, Default => false)\n @param generate_objects [Boolean] Return an array of Files or JSON objects in response body (Optional, Default => false)\n @return [JSON object or Files Object Array ]. Returns Files objects array if generate_objects flag is set\n\n @example\n          rest_client.replace_file(file_obj,'C:\\Users\\root\\Pictures\\new_img.jpg')\n          rest_client.replace_file(file_obj,'C:\\Users\\root\\Pictures\\new_img.jpg',true,true)\n          rest_client.replace_file(file_obj,'C:\\Users\\root\\Pictures\\new_img.jpg',false,false)\n          rest_client.replace_file(file_obj,'C:\\Users\\root\\Pictures\\new_img.jpg',false,true)\n          rest_client.replace_file(file_obj,'C:\\Users\\root\\Pictures\\new_img.jpg',true,false)", "Download Files.\n\n @param files [Single Files Object, Array of Files Objects] (Required)\n @param image_size [Integer, String] (Accepts image size id or postfix string:\n                     Defaults to '1' => original image size id)\n @param download_location [String] (Default: Creates folder called Rest_Downloads in the current directory.)\n @return [nil].\n\n @example\n          rest_client.download_files(File_object)\n          rest_client.download_files(File_objects_array)\n          rest_client.download_files(File_object,'C:\\Folder\\Path\\Specified')\n          rest_client.download_files(File_objects_array,'C:\\Folder\\Path\\Specified')", "Update Files.\n\n @param data [Single Files Object, Array of Files Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns Files objects array if generate_objects flag is set\n\n @example\n          rest_client.update_files(files_obj)\n          rest_client.update_files(files_obj,true)\n          rest_client.update_files(files_obj_array)\n          rest_client.update_files(files_obj_array,true)", "Create Groups.\n\n @param data [Single Groups Object, Array of Groups Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Groups objects array if generate_objects flag is set\n\n @example\n          rest_client.create_groups(groups_obj)\n          rest_client.create_groups(groups_obj,true)\n          rest_client.create_groups(groups_obj_array)\n          rest_client.create_groups(groups_obj_array,true)", "Update Groups.\n\n @param data [Single Groups Object, Array of Groups Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Groups objects array if generate_objects flag is set\n\n @example\n          rest_client.update_groups(groups_obj)\n          rest_client.update_groups(groups_obj,true)\n          rest_client.update_groups(groups_obj_array)\n          rest_client.update_groups(groups_obj_array,true)", "Create new file Keywords in OpenAsset.\n\n @param data [Single Keywords Object, Array of Keywords Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Keywords objects array if generate_objects flag is set\n\n @example\n          rest_client.create_keywords(keywords_obj)\n          rest_client.create_keywords(keywords_obj_array)\n          rest_client.create_keywords(keywords_obj,true)\n          rest_client.create_keywords(keywords_obj_array,true)", "Modify file Keywords.\n\n @param data [Single Keywords Object, Array of Keywords Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns Keywords objects array if generate_objects flag is set\n\n @example\n          rest_client.update_keywords(keywords_obj)\n          rest_client.update_keywords(keywords_obj,true)\n          rest_client.update_keywords(keywords_obj_array)\n          rest_client.update_keywords(keywords_obj_array,true)", "Merge Keywords.\n\n @param target [ Keywords Object, id ](Required)\n @param source [ Array of Keywords objects or ids ](Required)\n @return [JSON object] HTTP response JSON object.\n\n @example\n          rest_client.merge_keywords(keywords_obj,keywords_obj_array)\n          rest_client.merge_keywords('1',['1','2','3'])", "Create file keyword categories.\n\n @param data [Single KeywordCategories Object, Array of KeywordCategories Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns KeywordCategories objects array if generate_objects flag is set\n\n @example\n          rest_client.create_keyword_categories(keyword_categories_obj)\n          rest_client.create_keyword_categories(keyword_categories_obj_array)\n          rest_client.create_keyword_categories(keyword_categories_obj,true)\n          rest_client.create_keyword_categories(keyword_categories_obj_array,true)", "Modify file keyword categories.\n\n @param data [Single KeywordCategories Object, Array of KeywordCategories Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object.. Returns KeywordCategories objects array if generate_objects flag is set\n\n @example\n          rest_client.update_keyword_categories(keyword_categories_obj)\n          rest_client.update_keyword_categories(keyword_categories_obj,true)\n          rest_client.update_keyword_categories(keyword_categories_obj_array)\n          rest_client.update_keyword_categories(keyword_categories_obj_array,true)", "Merge Keyword Categories.\n\n @param target [ Keyword Categories Object, id ](Required)\n @param source [ Array of Keyword Categories objects or ids ](Required)\n @return [JSON object] HTTP response JSON object.\n\n @example\n          rest_client.merge_keyword_categories(keywords_categories_obj,keyword_categories_obj_array)\n          rest_client.merge_keyword_categories('1',['1','2','3'])", "Create Photographers.\n\n @param data [Single Photographers Object, Array of Photographers Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Photographers objects array if generate_objects flag is set\n\n @example\n          rest_client.create_photographers(photographers_obj)\n          rest_client.create_photographers(photographers_obj,true)\n          rest_client.create_photographers(photographers_obj_array)\n          rest_client.create_photographers(photographers_obj_array,true)", "Modify Photographers.\n\n @param data [Single Photographers Object, Array of Photographers Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns Photographers objects array if generate_objects flag is set\n\n @example\n          rest_client.update_photographers(photographers_obj)\n          rest_client.update_photographers(photographers_obj,true)\n          rest_client.update_photographers(photographers_obj_array)\n          rest_client.update_photographers(photographers_obj_array,true)", "Create Projects.\n\n @param data [Single Projects Object, Array of Projects Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Projects objects array if generate_objects flag is set\n\n @example\n          rest_client.create_projects(projects_obj)\n          rest_client.create_projects(projects_obj,true)\n          rest_client.create_projects(projects_obj_array)\n          rest_client.create_projects(projects_obj_array,true)", "Modify Projects.\n\n @param data [Single Projects Object, Array of Projects Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns Projects objects array if generate_objects flag is set\n\n\n @example\n          rest_client.update_projects(projects_obj)\n          rest_client.update_projects(projects_obj,true)\n          rest_client.update_projects(projects_obj_array)\n          rest_client.update_projects(projects_obj_array,true)", "Create Project Keywords.\n\n @param data [Single ProjectKeywords Object, Array of ProjectKeywords Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns ProjectKeywords objects array if generate_objects flag is set\n\n @example\n          rest_client.create_project_keywords(project_keywords_obj)\n          rest_client.create_project_keywords(project_keywords_obj,true)\n          rest_client.create_project_keywords(project_keywords_obj_array)\n          rest_client.create_project_keywords(project_keywords_obj_array,true)", "Modify Project Keywords.\n\n @param data [Single ProjectKeywords Object, Array of ProjectKeywords Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns ProjectKeywords objects array if generate_objects flag is set\n\n @example\n          rest_client.update_project_keywords(project_keywords_obj)\n          rest_client.update_project_keywords(project_keywords_obj,true)\n          rest_client.update_project_keywords(project_keywords_obj_array)\n          rest_client.update_project_keywords(project_keywords_obj_array,true)", "Merge Project Keywords\n\n @param target [ Project Keywords Object, id ](Required)\n @param source [ Array of Project Keywords objects or ids ](Required)\n @return [JSON object] HTTP response JSON object.\n\n @example\n          rest_client.merge_project_keywords(project_keywords_obj,project_keywords_obj_array)\n          rest_client.merge_project_keywords('1',['1','2','3'])", "Create project keyword categories.\n\n @param data [Single ProjectKeywordCategories Object, Array of ProjectKeywordCategories Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns ProjectKeywordCategories objects array if generate_objects flag is set\n\n @example\n          rest_client.create_project_keyword_categories(project_keyword_categories_obj)\n          rest_client.create_project_keyword_categories(project_keyword_categories_obj,true)\n          rest_client.create_project_keyword_categories(project_keyword_categories_obj_array)\n          rest_client.create_project_keyword_categories(project_keyword_categories_obj_array,true)", "Modify project keyword categories.\n\n @param data [Single ProjectKeywordCategories Object, Array of ProjectKeywordCategories Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns ProjectKeywordCategories objects array if generate_objects flag is set\n\n @example\n          rest_client.update_project_keyword_categories(project_keyword_categories_obj)\n          rest_client.update_project_keyword_categories(project_keyword_categories_obj,true)\n          rest_client.update_project_keyword_categories(project_keyword_categories_obj_array)\n          rest_client.update_project_keyword_categories(project_keyword_categories_obj_array,true)", "Merge Project Keyword Categories\n\n @param target [ Project Keyword Categories Object, id ](Required)\n @param source [ Array of Project Keyword Categories objects or ids ](Required)\n @return [JSON object] HTTP response JSON object.\n\n @example\n          rest_client.merge_project_keyword_categories(project_keywords_obj,project_keywords_obj_array)\n          rest_client.merge_project_keyword_categories('1',['1','2','3'])", "Create Employee Keywords.\n\n @param data [Single EmployeeKeywords Object, Array of EmployeeKeywords Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns EmployeeKeywords objects array if generate_objects flag is set\n\n @example\n          rest_client.create_employee_keywords(employee_keywords_obj)\n          rest_client.create_employee_keywords(employee_keywords_obj,true)\n          rest_client.create_employee_keywords(employee_keywords_obj_array)\n          rest_client.create_employee_keywords(employee_keywords_obj_array,true)", "Modify Employee Keywords.\n\n @param data [Single EmployeeKeywords Object, Array of EmployeeKeywords Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns EmployeeKeywords objects array if generate_objects flag is set\n\n @example\n          rest_client.update_employee_keywords(employee_keywords_obj)\n          rest_client.update_employee_keywords(employee_keywords_obj,true)\n          rest_client.update_employee_keywords(employee_keywords_obj_array)\n          rest_client.update_employee_keywords(employee_keywords_obj_array,true)", "Merge Employee Keywords\n\n @param target [ Employee Keywords Object, id ](Required)\n @param source [ Array of Employee Keywords objects or ids ](Required)\n @return [JSON object] HTTP response JSON object.\n\n @example\n          rest_client.merge_employee_keywords(employee_keywords_obj,employee_keywords_obj_array)\n          rest_client.merge_employee_keywords('1',['1','2','3'])", "Create employee keyword categories.\n\n @param data [Single EmployeeKeywordCategories Object, Array of EmployeeKeywordCategories Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns EmployeeKeywordCategories objects array if generate_objects flag is set\n\n @example\n          rest_client.create_employee_keyword_categories(employee_keyword_categories_obj)\n          rest_client.create_employee_keyword_categories(employee_keyword_categories_obj,true)\n          rest_client.create_employee_keyword_categories(employee_keyword_categories_obj_array)\n          rest_client.create_employee_keyword_categories(employee_keyword_categories_obj_array,true)", "Modify employee keyword categories.\n\n @param data [Single EmployeeKeywordCategories Object, Array of EmployeeKeywordCategories Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns EmployeeKeywordCategories objects array if generate_objects flag is set\n\n @example\n          rest_client.update_employee_keyword_categories(employee_keyword_categories_obj)\n          rest_client.update_employee_keyword_categories(employee_keyword_categories_obj,true)\n          rest_client.update_employee_keyword_categories(employee_keyword_categories_obj_array)\n          rest_client.update_employee_keyword_categories(employee_keyword_categories_obj_array,true)", "Merge Employee Keyword Categories\n\n @param target [ Employee Keyword Categories Object, id ](Required)\n @param source [ Array of Employee Keyword Categories objects or ids ](Required)\n @return [JSON object] HTTP response JSON object.\n\n @example\n          rest_client.merge_employee_keyword_categories(employee_keywords_obj,employee_keywords_obj_array)\n          rest_client.merge_employee_keyword_categories('1',['1','2','3'])", "Create Searches.\n\n @param data [Single Searches Object, Array of Searches Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Searches objects array if generate_objects flag is set\n\n @example\n          rest_client.create_searches(searches_obj)\n          rest_client.create_searches(searches_obj,true)\n          rest_client.create_searches(searches_obj_array)\n          rest_client.create_searches(searches_obj_array,true)", "Modify Searches.\n\n @param data [Single Searches Object, Array of Searches Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns Searches objects array if generate_objects flag is set\n\n @example\n          rest_client.update_searches(searches_obj)\n          rest_client.update_searches(searches_obj,true)\n          rest_client.update_searches(searches_obj_array)\n          rest_client.update_searches(searches_obj_array,true)", "Create image Sizes.\n\n @param data [Single Sizes Object, Array of Sizes Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns ImageSizes objects array if generate_objects flag is set\n\n @example\n          rest_client.create_image_sizes(image_sizes_obj)\n          rest_client.create_image_sizes(image_sizes_obj,true)\n          rest_client.create_image_sizes(image_sizes_obj_array)\n          rest_client.create_image_sizes(image_sizes_obj_array,true)", "Modify image Sizes.\n\n @param data [Single Sizes Object, Array of Sizes Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after updating object\n @return [JSON object] HTTP response JSON object. Returns ImageSizes objects array if generate_objects flag is set\n\n @example\n          rest_client.update_image_sizes(image_sizes_obj)\n          rest_client.update_image_sizes(image_sizes_obj,true)\n          rest_client.update_image_sizes(image_sizes_obj_array)\n          rest_client.update_image_sizes(image_sizes_obj_array,true)", "Create Users.\n\n @param data [Single Users Object, Array of Users Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Users objects array if generate_objects flag is set\n\n @example\n          rest_client.create_users(users_obj)\n          rest_client.create_users(users_obj,true)\n          rest_client.create_users(users_obj_array)\n          rest_client.create_users(users_obj_array,true)", "Update Users.\n\n @param data [Single Users Object, Array of Users Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Users objects array if generate_objects flag is set\n\n @example\n          rest_client.update_users(users_obj)\n          rest_client.update_users(users_obj,true)\n          rest_client.update_users(users_obj_array)\n          rest_client.update_users(users_obj_array,true)", "Create employees.\n\n @param data [Single employees Object, Array of employees Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns employees objects array if generate_objects flag is set\n\n @example\n          rest_client.create_employees(employees_obj)\n          rest_client.create_employees(employees_obj,true)\n          rest_client.create_employees(employees_obj_array)\n          rest_client.create_employees(employees_obj_array,true)", "Update Employees.\n\n @param data [Single Users Object, Array of Employees Objects] (Required)\n @param generate_objects [Boolean] (Optional)\n        Caution: Hurts performance -> Only use if performing further edits after object creation\n @return [JSON object] HTTP response JSON object. Returns Employees objects array if generate_objects flag is set\n\n @example\n          rest_client.update_employees(employees_obj)\n          rest_client.update_employees(employees_obj,true)\n          rest_client.update_employees(employees_obj_array)\n          rest_client.update_employees(employees_obj_array,true)", "Sets the options, this is a separate method as we want to override certain\n things set in the rogerfile from the commandline", "Get the first free port for host above port\n Will only ever test 100 ports.", "See if a certain port is free on a certain host", "See what handlers work", "Render source with a specific tilt template class", "Get the front matter portion of the file and extract it.", "Use a certain pre-processor\n\n @examples\n   release.use :sprockets, sprockets_config", "Actually perform the release", "The handler to use", "Actually load the rogerfile", "The render function\n\n The render function will take care of rendering the right thing\n in the right context. It will:\n\n - Wrap templates with layouts if it's defined in the frontmatter and\n   load them from the right layout path.\n - Render only partials if called from within an existing template\n\n If you just want to render an arbitrary file, use #render_file instead\n\n @option options [Hash] :locals Locals to use during rendering\n @option options [String] :source The source for the template\n @option options [String, nil] :layout The default layout to use", "Render any file on disk. No magic. Just rendering.\n\n A couple of things to keep in mind:\n - The file will be rendered in this rendering context\n - Does not have layouts or block style\n - When you pass a relative path and we are within another template\n   it will be relative to that template.\n\n @options options [Hash] :locals", "Gets the layout for a specific template", "Will check the template nesting if we haven't already\n rendered this path before. If it has we'll throw an argumenteerror", "Will instantiate a Template or throw an ArgumentError\n if it could not find the template", "Find a partial", "Will set up a new  template context for this renderer", "Runs the template on a single file and return processed source.", "Finds the template path for \"name\"", "Filter a list of files to see wether or not we can process them.\n Will take into account that the longest match with path will\n be the first result.", "Check if the name is a directory and append index\n Append preferred extension or html if it doesn't have one yet", "We ensure that the passed callback is actually callable on the object\n we're cloning. This is needed for associations because deep_cloneable\n calls the callback for every associated object.", "Stores the elapsed real time used to execute the given block in the given\n hash for the given key and returns the result from the block.  If the hash\n already has a value for that key, the time is accumulated.\n\n   timings = {}\n\n   Benchmark.realtime_store(timings, :sleep) { sleep 2; \"foo\" } # => \"foo\"\n   timings # => {:sleep => 2.00}\n\n   Benchmark.realtime_store(timings, :sleep) { sleep 2; \"bar\" } # => \"bar\"\n   timings # => {:sleep => 4.00}", "Stores the elapsed real time used to execute the given block for the given\n key and returns the hash as well as the result from the block.  The hash is\n stored globally, keyed on thread id, and is cleared once the topmost nested\n call completes.  If the hash already has a value for that key, the time is\n accumulated.\n\n   Benchmark.realtime_block(:sleep) do\n     sleep 2\n     \"foo\"\n   end # => [\"foo\", {:sleep => 2.00}]\n\n   Benchmark.realtime_block(:outer_sleep) do\n     sleep 2\n     Benchmark.realtime_block(:inner_sleep) { sleep 2 }\n     \"bar\"\n   end # => [\"bar\", {:inner_sleep => 2.00, :outer_sleep => 4.00}]\n\n   Benchmark.realtime_block(:outer_sleep) do\n     sleep 2\n     2.times do\n       Benchmark.realtime_block(:inner_sleep) { sleep 2 }\n     end\n     \"baz\"\n   end # => [\"baz\", {:inner_sleep => 4.00, :outer_sleep => 6.00}]", "Returns whether or not the object is in the given namespace.\n\n   Aaa::Bbb::Ccc::Ddd.in_namespace?(Aaa::Bbb)            #=> true\n   Aaa::Bbb::Ccc::Ddd.new.in_namespace?(Aaa::Bbb)        #=> true\n   Aaa::Bbb::Ccc::Eee.in_namespace?(\"Aaa::Bbb\")          #=> true\n   Aaa::Bbb::Ccc::Eee.in_namespace?(Aaa::Bbb::Ccc::Ddd)  #=> false", "Returns a Hash of each element to the count of those elements.  Optionally\n  pass a block to count by a different criteria.\n\n   [1, 2, 3, 1, 3, 1].counts  # => {1 => 3, 2 => 1, 3 => 2}\n   %w(a aa aaa a aaa a).counts { |i| i.length }  # => {1 => 3, 2 => 1, 3 => 2}", "Instantiate a new resource type with the given parameters.\n @param params [Hash] the parameters to interpolate in the resource type.\n @return [Raml::ResourceType::Instance] the instantiated resouce type.", "Iterates over rng, starting with the beginning of rng, incrementing by the\n value, and passing that element to the block. Unlike +step+, +step_value+\n invokes the + operator to iterate over the range elements. Unless the end is\n excluded from the range, the final value of the iteration will always be the\n end value, even if the increment value goes past the end of the range.\n\n This method has performance benefits over +step+ when working with ranges of\n Time objects, for example, where step calling succ may be called an\n inordinate number of times.\n\n    t = Time.now.midnight\n    range = (t - 3.days)..t\n    range.step_value(1.day) {|x| puts x}\n\n produces:\n    Tue Dec 14 00:00:00 -0500 2010\n    Wed Dec 15 00:00:00 -0500 2010\n    Thu Dec 16 00:00:00 -0500 2010\n    Fri Dec 17 00:00:00 -0500 2010", "Returns whether the Array contains any of the items.\n\n   [1, 2, 3].include_any?(1, 2)  #=> true\n   [1, 2, 3].include_any?(1, 4)  #=> true\n   [1, 2, 3].include_any?(4, 5)  #=> false", "Returns whether the Array contains none of the items.\n\n   [1, 2, 3].include_none?(1, 2)  #=> false\n   [1, 2, 3].include_none?(1, 4)  #=> false\n   [1, 2, 3].include_none?(4, 5)  #=> true", "Returns whether the Array contains all of the items.\n\n   [1, 2, 3].include_all?(1, 2)  #=> true\n   [1, 2, 3].include_all?(1, 4)  #=> false\n   [1, 2, 3].include_all?(4, 5)  #=> false", "Sends the notice data off to Airbrake for processing.\n\n @param [String] data The XML notice to be sent off", "Retrieve a descendant by its name", "Applies resource types and traits, and inlines schemas.  It should be called\n before documentation is generated.", "Stretch receiver to be the same size as the longest argument Array.  Modifies the receiver in place.\n\n   [1, 2].stretch!([3, 4], [5, 6, 7])  #=> [1, 2, nil]", "Converts the given notice to XML", "Gets a property named +attribute+ of an exception, either from an actual\n exception or a hash.\n\n If an exception is available, #from_exception will be used. Otherwise,\n a key named +attribute+ will be used from the #args.\n\n If no exception or hash key is available, +default+ will be used.", "Second argument can be the whitelist_attributes array or keyword\n arguments. This is to ensure backwards compatibility with old plugins.", "cache_with_timeout creates singleton methods that cache the\n   results of the given block, but only for a short amount of time.\n   If the method is called again after time has passed, then the\n   cache is cleared and the block is reevaluated.  Note that the\n   cache is only cleared on the next invocation after the time has\n   passed, so if the block retains references to large objects,\n   they will never be garbage collected if the method is never\n   called again.\n\n   The methods created are\n   - `method`\n   - `#{method}_clear_cache` - Will clear the cached value on demand\n   - `#{method}_cached?` - Says whether or not there is a value cached\n\n Example:\n    class Foo\n      cache_with_timeout(:expensive_operation) do\n        sleep 100\n        rand(100)\n      end\n    end\n\n    Foo.expensive_operation # => 42\n    Foo.expensive_operation # => 42\n    # ... wait 5+ minutes ...\n    Foo.expensive_operation # => 18\n\n @param [String|Symbol] method The name of the method to create.\n @param [Integer] timeout The number of seconds after which the cache is\n   cleared (defaults to: 300 (5 minutes))\n @returns [Symbol] The name of the method created.", "expand local, canonicalize, remappings\n @param [String] caller_id caller_id\n @param [String] ns namespace\n @param [String] name target name\n @param [Array] remappings name remappings\n @return [String] resolved name", "main loop of this connection.\n read data and do callback.\n @param [IO] socket\n @return [Boolean] result of callback", "this is called by socket accept\n @param [IO] socket given socket", "add tcpros connection as server\n @param [String] caller_id caller_id of subscriber\n @return [TCPROS::Server] connection object", "send a message to reciever\n @param [IO] socket socket for writing\n @param [Class] msg msg class instance", "this is called if a socket accept a connection.\n This is GServer's function\n @param [IO] socket given socket", "set parameter for 'key'\n @param [String] key key of parameter\n @param [String, Integer, Float, Boolean] value value of parameter\n @return [Boolean] true if succeed\n @raise", "delete parameter 'key'\n @param [String] key key for remove\n @return [Boolean] return true if success, false if it is not exist", "search the all namespace for key\n @param [String] key key for search\n @return [Array] values", "check if the master has the key\n @param [String] key key for check\n @return [String, Integer, Float, Boolean] value of key", "get the all keys of parameters\n @return [Array] all keys", "subtract time value.\n @param [Time] other\n @return [Duration] duration", "call the service by sending srv request message,\n and receive response message.\n @param [Message] srv_request call with this request\n @param [Message] srv_response response is stored in this message\n @return [Boolean] result of call", "kill old node if the same caller_id node is exits.\n @param [String] caller_id new node's caller_id\n @param [String] api new node's XMLRPC URI", "get available port number by opening port 0.\n @return [Integer] port_num", "wait until service is available\n @param [String] service_name name of service for waiting\n @param [Float] timeout_sec wait for this seconds, then time out\n @return [Boolean] true: available, false: time out", "register a service to master,\n and add it in the controlling server list.\n raise if fail.\n @param [ServiceServer] service_server ServiceServer to be added\n @return [ServiceServer] service_server", "register a subscriber to master. raise if fail.\n @param [Subscriber] subscriber Subscriber to be added\n @return [Subscriber] subscriber", "register callback for paramUpdate\n @param [ParameterSubscriber] subscriber ParameterSubscriber instance to be added\n @return [ParameterSubscriber] subscriber", "register a publisher. raise if fail.\n @param [Publisher] publisher Publisher instance to be added\n @return [Publisher] publisher", "shutdown a publisher.\n @param [Publisher] publisher Publisher to be shutdown", "shutdown a subscriber.\n @param [Subscriber] subscriber Subscriber to be shutdown", "shutdown a service server.\n @param [ServiceServer] service ServiceServer to be shutdown", "start recieving data.\n The received messages are pushed into a message queue.", "write message to socket.\n @param [IO] socket socket for writing\n @param [Message] msg message for writing\n @return [String] wrote data", "read the size of data and read it from socket.\n @param [IO] socket socket for reading\n @return [String] received data", "read a connection header from socket\n @param [String] socket socket for reading\n @return [Header] header", "initialize with hash\n @param [Hash] data\n add key-value data to this header.\n @param [String] key key for header\n @param [String] value value for key\n @return [Header] self", "deserialize the data to header.\n this does not contain total byte number.\n @param [String] data\n @return [Header] self", "serialize the data into header.\n return the byte of the serialized data.\n @param [IO] buff where to write data\n @return [Integer] byte of serialized data", "unregister a service\n @param [String] service name of service\n @param [String] service_api service api uri\n @return [Boolean] true success\n @raise RuntimeError", "register a subscriber\n @param [String] topic topic name\n @param [String] topic_type topic type\n @return [Array] URI of current publishers\n @raise [RuntimeError] if error", "unregister a subscriber\n @param [String] topic name of topic to unregister\n @return [Boolean] true\n @raise RuntimeError", "register a publisher\n @param [String] topic topic name of topic\n @param [String] topic_type type of topic\n @return [Array] URI of current subscribers\n @raise RuntimeError", "unregister a publisher\n @param [String] topic name of topic\n @return [Boolean] true\n @raise RuntimeError", "this method is not described in the wiki.\n subscribe to the parameter key.\n @param [String] key name of parameter\n @return [Boolean] true\n @raise [RuntimeError] if fail", "unsubscribe to the parameter key.\n this method is not described in the wiki.\n @param [String] key name of parameter key\n @return [Boolean] true\n @raise [RuntimeError] if failt", "get the all published topics\n @param [String] subgraph namespace for check\n @return [Array] topic names.\n @raise", "look up a service by name\n @param [String] service name of service\n @return [String, nil] URI of service if found, nil not found.", "get the param for key.\n You can set default value. That is uesed when the key is not set yet.\n @param [String] key key for search the parameters\n @param [String, Integer, Float, Boolean] default default value\n @return [String, Integer, Float, Boolean] parameter value for key", "start publishing the topic.\n\n @param [String] topic_name name of topic (string)\n @param [Class] topic_type topic class\n @param [Hash] options :latched, :resolve\n @option options [Boolean] :latched (false) latched topic\n @option options [Boolean] :resolve (true) resolve topic_name or not. This is for publish /rosout with namespaced node.\n @return [Publisher] Publisher instance", "start service server.\n\n @param [String] service_name name of this service (string)\n @param [Service] service_type service class\n @param [Proc] callback service definition\n @return [ServiceServer] ServiceServer instance", "start to subscribe a topic.\n\n @param [String] topic_name name of topic (string)\n @param [Class] topic_type Topic instance\n @return [Subscriber] created Subscriber instance", "subscribe to the parameter.\n\n @param [String] param name of parameter to subscribe\n @param [Proc] callback callback when parameter updated\n @return [ParameterSubscriber] created ParameterSubscriber instance", "converts strings if it is float and int numbers.\n @example\n   convert_if_needed('10') # => 10\n   convert_if_needed('0.1') # => 0.1\n   convert_if_needed('string') # => 'string'\n @param [String] value string\n @return [Float, Integer, String] return converted value.", "parse all args.\n @param [Array] args arguments for parse", "request topic to master and start connection with publisher.\n @param [String] uri uri to connect\n @return [TCPROS::Client] new connection", "connection information fro slave API\n @return [Array] connection info", "Cache user emails so we don't have to make an extra SQL request\n for every activity", "create new candidate for given job\n @param candidate  [Hash] the candidate data as described in\n    https://workable.readme.io/docs/job-candidates-create\n    including the `{\"candidate\"=>{}}` part\n @param shortcode  [String] job short code\n @param stage_slug [String] optional stage slug\n @return [Hash] the candidate information without `{\"candidate\"=>{}}` part", "create a comment on the candidate's timeline\n @param candidate_id [String] the candidate's id\n @param member_id [String] id of the member leaving the comment\n @param comment_text [String] the comment's text\n @param policy [String] option to set the view rights of the comment\n @param attachment [Hash] optional attachment for the comment\n @param attachment :name [String] filename of the attachment\n @param attachment :data [String] payload of the attachment, encoded in base64", "disqualify a candidate\n @param candidate_id [String] the candidate's id\n @param member_id [String] id of the member performing the disqualification\n @param reason [String] why the candidate should be disqualified", "revert a candidate's disqualification\n @param candidate_id [String] the candidate's id\n @param member_id [String] id of the member reverting the disqualification", "copy a candidate to another job\n @param candidate_id [String] the candidate's id\n @param member_id [String] id of the member performing the copy\n @param shortcode [String] shortcode of the job that the candidate will be copied to\n @param stage [String] stage the candidate should be copied to", "moves a candidate to another stage\n @param candidate_id [String] the candidate's id\n @param member_id [String] id of the member performing the move\n @param stage [String] stage the candidate should be moved to", "creates a rating for a candidate\n @param candidate_id [String] the candidate's id\n @param member_id [String] id of the member adding the rating\n @param comment [String] a comment about the scoring of the candidate\n @param score [String] one of 'negative', 'positive', or 'definitely'", "do the get request to api", "do the post request to api", "generic part of requesting api", "parse the api response", "region File Creation", "selects transformation strategy based on the inputs\n @param transformation [Method|Proc|nil] the transformation to perform\n @param data           [Hash|Array|nil]  the data to transform\n @return               [Object|nil]\n    results of the transformation if given, raw data otherwise", "This method returns an XML representation of current repository which\n includes Categories, Nodes and Notes", "Iterates through each response entry through all pages\n @return [Enumerator<Hash>]", "Iterates through every single page\n @return [Enumerator<Array<Hash>>]", "Returns plain JSON response received from Disqus\n @param [Hash] arguments\n @return [String]", "overwrite the enum method", "Require specification of certain attributes\n\n @raise [ArgumentError] if any requested attribute does not have a value\n @return [Hash] of matching attributes", "Require specification of one or more attributes.\n\n @raise [ArgumentError] if no requested attributes have values\n @return [Hash] of matching attributes", "Leverage the jira-ruby Issue.jql search feature\n\n @param [Type String] jql Valid JQL query\n @return [Type Array] 0-m JIRA Issues returned from query", "Build the hash of options that Excon requires for an HTTP request.\n\n method       - A Symbol with the HTTP method (:get, :post, etc).\n query_params - Any query parameters to add to the request.\n\n Returns a Hash.", "Start the local server and listen for connections\n\n @param [SSRFProxy::HTTP] ssrf A configured SSRFProxy::HTTP object\n @param [String] interface Listen interface (Default: 127.0.0.1)\n @param [Integer] port Listen port (Default: 8081)\n\n @raise [SSRFProxy::Server::Error::InvalidSsrf]\n        Invalid SSRFProxy::SSRF object provided.\n @raise [SSRFProxy::Server::Error::ProxyRecursion]\n        Proxy recursion error. SSRF Proxy cannot use itself as an\n        upstream proxy.\n @raise [SSRFProxy::Server::Error::RemoteProxyUnresponsive]\n        Could not connect to remote proxy.\n @raise [SSRFProxy::Server::Error::AddressInUse]\n        Could not bind to the port on the specified interface as\n        address already in use.\n\n @example Start SSRF Proxy server with the default options\n   ssrf_proxy = SSRFProxy::Server.new(\n     SSRFProxy::HTTP.new('http://example.local/?url=xxURLxx'),\n     '127.0.0.1',\n     8081)\n   ssrf_proxy.serve\n\n\n Checks if a port is open or not on a remote host\n From: https://gist.github.com/ashrithr/5305786\n\n @param [String] ip connect to IP\n @param [Integer] port connect to port\n @param [Integer] seconds connection timeout", "Handle client socket connection\n\n @param [Celluloid::IO::TCPSocket] socket client socket", "Encode IP address of a given URL\n\n @param [String] url target URL\n @param [String] mode encoding (int, ipv6, oct, hex, dotted_hex)\n\n @return [String] encoded IP address", "Run a specified URL through SSRF rules\n\n @param [String] url request URL\n @param [String] rules comma separated list of rules\n\n @return [String] modified request URL", "Guess content type based on file extension\n\n @param [String] ext File extension including dots\n\n @example Return mime type for extension '.png'\n   guess_mime('favicon.png')\n\n @return [String] content-type value", "Guess content type based on magic bytes\n\n @param [String] content File contents\n\n @return [String] content-type value", "Complete hack to get around issues with Haml\n  Haml does some hacking to ActionView's with_output_buffer and\n  output_buffer. In doing so, they make certain assumptions about\n  the layout and the view template. The Blocks gem doesn't capture\n  blocks immediately but rather stores them for later capturing.\n  This can produce an issue if a block that is stored was in Haml\n  but the Layout is in ERB. Haml will think that any blocks it\n  captures while rendering the layout will be in ERB format. However,\n  the block would need to be captured in Haml using a Haml buffer.\n  This workaround accomplishes that.", "Add a setup block.\n\n A setup block defines the topic of the context. There can be multiple setup\n blocks; each can access the previous topic through the +topic+ attribute.\n\n   context \"A string\" do\n     setup { \"foo\" }\n     setup { topic * 2 }\n     asserts(:length).equals(6)\n   end\n\n If you provide +true+ as the first argument, the setup will be unshifted onto the list of setups,\n ensuring it will be run before any other setups. This is really only useful for context middlewares.\n\n @param [Boolean] premium indicates importance of the setup\n @return [Riot::Setup]", "Move the cursor to specified row.\n\n The main window and the headers will be updated reflecting the displayed files and directories.\n The row number can be out of range of the current page.", "Change the current directory.", "Fetch files from current directory.\n Then update each windows reflecting the newest information.", "Change the file permission of the selected files and directories.\n\n ==== Parameters\n * +mode+ - Unix chmod string (e.g. +w, g-r, 755, 0644)", "Change the file owner of the selected files and directories.\n\n ==== Parameters\n * +user_and_group+ - user name and group name separated by : (e.g. alice, nobody:nobody, :admin)", "Fetch files from current directory or current .zip file.", "Focus at the first file or directory of which name starts with the given String.", "Focus at the last file or directory of which name starts with the given String.", "Update the main window with the loaded files and directories. Also update the header.", "Sort the loaded files and directories in already given sort order.", "Search files and directories from the current directory, and update the screen.\n\n * +pattern+ - Search pattern against file names in Ruby Regexp string.\n\n === Example\n\n a        : Search files that contains the letter \"a\" in their file name\n .*\\.pdf$ : Search PDF files", "Copy selected files and directories to the destination.", "Move selected files and directories to the destination.", "Rename selected files and directories.\n\n ==== Parameters\n * +pattern+ - new filename, or a shash separated Regexp like string", "Soft delete selected files and directories.\n\n If the OS is not OSX, performs the same as `delete` command.", "Delete selected files and directories.", "Create a new directory.", "Create a new empty file.", "Archive selected files and directories into a .zip file.", "Unarchive .zip and .tar.gz files within selected files and directories into current_directory.", "Move to the given page number.\n\n ==== Parameters\n * +page+ - Target page number", "Update the header information concerning currently marked files or directories.", "Update the header information concerning total files and directories in the current directory.", "Accept user input, and directly execute it as a Ruby method call to the controller.\n\n ==== Parameters\n * +preset_command+ - A command that would be displayed at the command line before user input.", "Accept user input, and directly execute it in an external shell.", "Let the user answer y or n.\n\n ==== Parameters\n * +prompt+ - Prompt message", "Open current file or directory with the editor.", "Open current file or directory with the viewer.", "Setups a new Assertion. By default, the assertion will be a \"positive\" one, which means +evaluate+ will\n be call on the associated assertion macro. If +negative+ is true, +devaluate+ will be called instead.\n Not providing a definition block is just kind of silly since it's used to generate the +actual+ value\n for evaluation by a macro.\n\n @param [String] definition A small description of what this assertion is testing\n @param [Boolean] negative Determines whether this is a positive or negative assertion\n @param [lambda] definition The block that will return the +actual+ value when eval'ed\n Given a {Riot::Situation}, execute the assertion definition provided to this Assertion, hand off to an\n assertion macro for evaluation, and then return a status tuple. If the macro to be used expects any\n exception, catch the exception and send to the macro; else just return it back.\n\n Currently supporting 3 evaluation states: :pass, :fail, and :error\n\n @param [Riot::Situation] situation An instance of a {Riot::Situation}\n @return [Array<Symbol, String>] array containing evaluation state and a descriptive explanation", "Generates a message for assertions that error out. However, in the additional stacktrace, any mentions\n of Riot and Rake framework methods calls are removed. Makes for a more readable error response.\n\n @param [Exception] e the exception to generate the backtrace from\n @return [String] the error response message", "\"O\"pen terminal here.", "Mark or unmark \"a\"ll files and directories.", "cd into a directory, or view a file.", "cd to the upper hierarchy.", "Converts any method call into a more readable string by replacing underscores with spaces. Any\n arguments to the method are inspected and appended to the final message. Blocks are currently ignored.\n\n @param [String, Symbol] meth the method name to be converted into a more readable form\n @param [Array<Object>] *phrases an array of objects to be inspected\n @return [Riot::Message] this instance for use in chaining calls", "Called immediately after an assertion has been evaluated. From this method either +pass+, +fail+,\n or +error+ will be called.\n\n @param [String] description the description of the assertion\n @param [Array<Symbol, *[Object]>] response the evaluation response from the assertion", "Returns an array of valid URI-encoded UTF-8 characters.", "If the first byte is between 0xC0 and 0xDF, the UTF-8 character has two bytes;\n if it is between 0xE0 and 0xEF, the UTF-8 character has 3 bytes;\n and if it is 0xF0 and 0xFF, the UTF-8 character has 4 bytes.\n first_byte is a string like \"0x13\"", "get services with a list of logical ids", "Trigger synchronization of all active organizations", "Recursively cleans all elements in place.\n\n Only allow tags in whitelist. Always parse the html with a parser and delete\n all tags that arent on the list.\n\n For feed elements that can contain HTML:\n - feed.(title|description)\n - feed.entries[n].(title|description|content)", "get a parameter from the store to a Tmpfile", "run a command on stack instances", "Report on the unused columns that were selected during the course of the\n processing the action on the given controller.", "Replaces ids from the external application by arrays containing them", "Builds an id_hash from the id and organization", "Recursive method for folding references", "Recursive method for unfolding references", "Returns the connec_entity without all the fields that are not id_references", "Recursive method for filtering connec entities", "Merges the id arrays from two hashes while keeping only the id_references fields", "Recursive helper for merging id hashes", "convert to hash for registering new taskdef", "update taskdef for a service, triggering a deploy\n modify current taskdef in block", "Store a file in the archive without any compression.\n\n @param [String] filename under the which the data should be stored\n @param [#to_s] content to be compressed", "Store a file with maximum compression in the archive.\n\n @param [String] filename under the which the data should be stored\n @param [#to_s] content to be compressed", "Returns an array of columns plucked from the result rows.\n Experimental function, as this could still use too much memory\n and negate the purpose of this libarary.\n Should this return a lazy enumerator instead?", "Weigh accounts by how well they match the row", "Execute textlint and send comment\n @return [void]", "Default values for Karafka settings", "Given a hash of Request parameters, do they meet the requirements?", "Construct the request from the given parameters.\n\n Yields the Request\n\n Returns the Request.\n Raises a Weary::Resource::UnmetRequirementsError if the requirements\n   are not met.", "Using the current position and move, figure out where the piece\n came from.", "From the destination square, move in each direction stopping if we\n reach the end of the board. If we encounter a piece, add it to the\n list of origin possibilities if it is the moving piece, or else\n check the next direction.", "From the destination square, make each move. If it is a valid\n square and matches the moving piece, add it to the list of origin\n possibilities.", "Computes the possbile pawn origins based on the destination square\n and whether or not the move is a capture.", "Try to disambiguate based on the standard algebraic notation.", "A pawn can't move two spaces if there is a pawn in front of it.", "A piece can't move if it would result in a discovered check.", "If the move is a capture and there is no piece on the\n destination square, it must be an en passant capture.", "A Rack interface for the Request. Applies itself and whatever\n middlewares to the env and passes the new env into the adapter.\n\n environment - A Hash for the Rack env.\n\n Returns an Array of three items; a Rack tuple.", "Returns a future-wrapped Response.", "Stolen from Faraday", "Returns all +items+ as HTML hidden field tags.", "Find affiliate commission of the office at the time the order was created", "Interactively step through the game\n\n Use +d+ to move forward, +a+ to move backward, and +^C+ to exit.", "Create a new instance of the Client class in order to access the GrabzIt API.\n\n @param applicationKey [String] your application key\n @param applicationSecret [String] your application secret\n @see http://grabz.it/register.aspx You can get an application key and secret by registering for free with GrabzIt\n This method specifies the URL of the online video that should be converted into a animated GIF\n\n @param url [String] The URL of the video to convert into a animated GIF\n @param options [AnimationOptions, nil] a instance of the AnimationOptions class that defines any special options to use when creating the animated GIF\n @return [void]", "This method specifies the URL that should be converted into a image screenshot\n\n @param url [String] the URL to capture as a screenshot\n @param options [ImageOptions, nil] a instance of the ImageOptions class that defines any special options to use when creating the screenshot\n @return [void]", "This method specifies the HTML that should be converted into a image\n\n @param html [String] the HTML to convert into a image\n @param options [ImageOptions, nil] a instance of the ImageOptions class that defines any special options to use when creating the image\n @return [void]", "This method specifies the URL that the HTML tables should be extracted from\n\n @param url [String] the URL to extract HTML tables from\n @param options [TableOptions, nil] a instance of the TableOptions class that defines any special options to use when converting the HTML table\n @return [void]", "This method specifies the HTML that the HTML tables should be extracted from\n\n @param html [String] the HTML to extract HTML tables from\n @param options [TableOptions, nil] a instance of the TableOptions class that defines any special options to use when converting the HTML table\n @return [void]", "This method specifies the URL that should be converted into a PDF\n\n @param url [String] the URL to capture as a PDF\n @param options [PDFOptions, nil] a instance of the PDFOptions class that defines any special options to use when creating the PDF\n @return [void]", "This method specifies the HTML that should be converted into a PDF\n\n @param html [String] the HTML to convert into a PDF\n @param options [PDFOptions, nil] a instance of the PDFOptions class that defines any special options to use when creating the PDF\n @return [void]", "This method specifies the URL that should be converted into a DOCX\n\n @param url [String] the URL to capture as a DOCX\n @param options [DOCXOptions, nil] a instance of the DOCXOptions class that defines any special options to use when creating the DOCX\n @return [void]", "This method specifies the HTML that should be converted into a DOCX\n\n @param html [String] the HTML to convert into a DOCX\n @param options [DOCXOptions, nil] a instance of the DOCXOptions class that defines any special options to use when creating the DOCX\n @return [void]", "Calls the GrabzIt web service to take the screenshot\n\n The handler will be passed a URL with the following query string parameters:\n - message (is any error message associated with the screenshot)\n - customId (is a custom id you may have specified in the [AnimationOptions], [ImageOptions], [PDFOptions] or [TableOptions] classes)\n - id (is the unique id of the screenshot which can be used to retrieve the screenshot with the {#get_result} method)\n - filename (is the filename of the screenshot)\n - format (is the format of the screenshot)\n @note This is the recommended method of saving a screenshot\n @param callBackURL [String, nil] the handler the GrabzIt web service should call after it has completed its work\n @return [String] the unique identifier of the screenshot. This can be used to get the screenshot with the {#get_result} method\n @raise [RuntimeError] if the GrabzIt service reports an error with the request it will be raised as a RuntimeError", "Calls the GrabzIt web service to take the screenshot and saves it to the target path provided. if no target path is provided\n it returns the screenshot byte data.\n\n @note Warning, this is a SYNCHONOUS method and can take up to 5 minutes before a response\n @param saveToFile [String, nil] the file path that the screenshot should saved to.\n @example Synchronously save the screenshot to test.jpg\n   save_to('images/test.jpg')\n @raise [RuntimeError] if the screenshot cannot be saved a RuntimeError will be raised that will contain an explanation\n @return [Boolean] returns the true if it is successfully saved to a file, otherwise if a target path is not provided it returns the screenshot's byte data.", "Get the current status of a GrabzIt screenshot\n\n @param id [String] the id of the screenshot\n @return [ScreenShotStatus] a object representing the status of the screenshot", "This method returns the screenshot itself. If nothing is returned then something has gone wrong or the screenshot is not ready yet\n\n @param id [String] the id of the screenshot\n @return [Object] returns the screenshot\n @raise [RuntimeError] if the GrabzIt service reports an error with the request it will be raised as a RuntimeError", "Get all the cookies that GrabzIt is using for a particular domain. This may include your user set cookies as well\n\n @param domain [String] the domain to return cookies for\n @return [Array<Cookie>] an array of cookies\n @raise [RuntimeError] if the GrabzIt service reports an error with the request it will be raised as a RuntimeError", "Sets a new custom cookie on GrabzIt, if the custom cookie has the same name and domain as a global cookie the global\n\n cookie is overridden\n @note This can be useful if a websites functionality is controlled by cookies\n @param name [String] the name of the cookie to set\n @param domain [String] the domain of the website to set the cookie for\n @param value [String, ''] the value of the cookie\n @param path [String, '/'] the website path the cookie relates to\n @param httponly [Boolean, false] is the cookie only used on HTTP\n @param expires [String, ''] when the cookie expires. Pass a nil value if it does not expire\n @return [Boolean] returns true if the cookie was successfully set\n @raise [RuntimeError] if the GrabzIt service reports an error with the request it will be raised as a RuntimeError", "Delete a custom cookie or block a global cookie from being used\n\n @param name [String] the name of the cookie to delete\n @param domain [String] the website the cookie belongs to\n @return [Boolean] returns true if the cookie was successfully set\n @raise [RuntimeError] if the GrabzIt service reports an error with the request it will be raised as a RuntimeError", "Add a new custom watermark\n\n @param identifier [String] the identifier you want to give the custom watermark. It is important that this identifier is unique.\n @param path [String] the absolute path of the watermark on your server. For instance C:/watermark/1.png\n @param xpos [Integer] the horizontal position you want the screenshot to appear at: Left = 0, Center = 1, Right = 2\n @param ypos [Integer] the vertical position you want the screenshot to appear at: Top = 0, Middle = 1, Bottom = 2\n @return [Boolean] returns true if the watermark was successfully set\n @raise [RuntimeError] if the GrabzIt service reports an error with the request it will be raised as a RuntimeError", "Delete a custom watermark\n\n @param identifier [String] the identifier of the custom watermark you want to delete\n @return [Boolean] returns true if the watermark was successfully deleted\n @raise [RuntimeError] if the GrabzIt service reports an error with the request it will be raised as a RuntimeError", "This method enables a local proxy server to be used for all requests\n\n @param value [String] the URL, which can include a port if required, of the proxy. Providing a null will remove any previously set proxy", "This method will decrypt a encrypted capture file, using the key you passed to the encryption key parameter.\n\n @param path [String] the path of the encrypted capture\n @param key [String] the encryption key", "This method will decrypt a encrypted capture, using the key you passed to the encryption key parameter.\n\n @param path [String] the encrypted bytes\n @param key [String] the encryption key\n @return [Array<Byte>] an array of decrypted bytes", "halt and render the given errors in the body on the 'errors' key", "returns a rack response with the given object encoded in the appropriate format for the requests.\n\n arguments are in the order of what tends to vary most frequently\n rather than rack's way, so headers come last", "reads the request body", "returns the parsed contents of the request body.\n\n checks the Content-Type of the request, and unless it's supported (or omitted - in which case assumed to be the\n first supported media type), halts with 415.\n\n if the body is not parseable, then halts with 400.", "for methods where parameters which are required in the path may also be specified in the\n body, this takes the path_params and the body object and ensures that they are consistent\n any place they are specified in the body.", "parses the body to an object", "deal with the vagaries of getting the response body in a form which JSON\n gem will not cry about generating", "takes a body and a content type; returns the body, altered according to options.\n\n - with coloring (ansi colors for terminals) possibly added, if it's a recognized content type and\n   #color? is true\n - formatted prettily if #pretty? is true", "Generate select code for the table taking all parameters in account", "Compute includes Hash", "Generate the code from a conditions option", "Checks environment for default configuration load paths.  Adds them to load paths if found.", "Reads and parses the config data from the specified file.", "Parses contents of the config file based on file type.\n XML files expect the root element to be the same as the\n file name.", "Parses xml file and processes any references in the property values.", "Returns a merge of hashes.", "Recursively makes hashes into frozen IndifferentAccess Config Hash\n Arrays are also traversed and frozen.", "If a config file name is specified, flushes cached config values\n for specified config file. Otherwise, flushes all cached config data.\n The latter should be avoided in production environments, if possible.", "Sets a custome overlay for", "Returns a list of suffixes to try for a given config name.\n\n A config name with an explicit overlay (e.g.: 'name_GB')\n overrides any current _overlay.\n\n This allows code to specifically ask for config overlays\n for a particular locale.", "Get each config file's yaml hash for the given config name,\n to be merged later. Files will only be loaded if they have\n not been loaded before or the files have changed within the\n last five minutes, or force is explicitly set to true.", "Returns whether or not the config for the given config name has changed\n since it was last loaded.\n\n Returns true if any files for config have changes since\n last load.", "Get the merged config hash for the named file.\n Returns a cached indifferent access faker hash merged\n from all config files for a name.", "If name is specified, checks that file for changes and\n reloads it if there are.  Otherwise, checks all files\n in the cache, reloading the changed files.", "If config files have changed, caches are flushed, on_load triggers are run.", "Get the value specified by the args, in the file specified by th name", "Get a hash of merged config data.\n Will auto check every 5 minutes, for longer running apps, unless reload is disabled.", "Short-hand access to config file by its name.\n\n Example:\n\n   RConfig.provider(:foo) => RConfig.with_file(:provider).foo\n   RConfig.provider.foo   => RConfig.with_file(:provider).foo", "Add a query to this Layer's c list.", "Add a layer to the c list of layers and yield the new layer.", "Add a raster layer", "A convienence method to use Active Record configuration and add a new\n layer.", "Render the data to a blob of png data.", "Initialize a query with a string containing OGR SQL.\n Styles will take a hash of style declarations and adds them to the internal\n c list.", "Adds the specified path to the list of directories to search for\n configuration files.\n It only allows one path to be entered at a time.", "Sets the flag indicating whether or not reload should be executed.", "Sets the number of seconds between reloading of config files\n and automatic reload checks. Defaults to 5 minutes. Setting", "Flushes cached config data, so that it can be reloaded from disk.\n It is recommended that this should be used with caution, and any\n need to reload in a production setting should minimized or\n completely avoided if possible.", "block for processing XML document fragments as XHTML,\n to allow for HTMLentities", "extract names for all anchors, xref and label", "move footnotes into key, and get rid of footnote reference\n since it is in diagram", "in StanDoc, prefaces have no numbering; they are referenced only by title", "Destroy the current sandbox, if it exists", "Create the sandbox unless it already exits", "Load a cookbook from the given array of cookbook names\n\n @param [Array<String>] cookbook_names\n   the list of cookbooks to search for\n @return [Array<Berkshelf::CachedCookbook>]\n   the array of cached cookbooks", "Load an individual cookbook by its name\n\n @param [String] cookbook_name\n   the name of the cookbook to load\n @return [Berkshelf::CachedCookbook]\n   the cached cookbook\n @raise [Strainer::Error::CookbookNotFound]\n   when the cookbook was not found in any of the sources", "Load the current root entirely as a cookbook. This is useful when testing within\n a cookbook, instead of a chef repo", "Collect all cookbooks and the dependencies specified in their metadata.rb\n for copying\n\n @return [Array<Berkshelf::CachedCookbook>]\n   a list of cached cookbooks", "Determines if the current project is a chef repo\n\n @return [Boolean]\n   true if the current project is a chef repo, false otherwise", "Return a list of all directory folders at the root of the repo.\n This is useful for detecting if it's a chef repo or cookbook\n repo.\n\n @return [Array]\n   the list of root-level directories", "Creates a Strainer runner\n\n @param [Array<String>] cookbook_names\n   an array of cookbook_names to test and load into the sandbox\n @param [Hash] options\n   a list of options to pass along\n Runs the Strainer runner", "Instantiate an instance of this class from a cookbook\n\n @param [Berkshelf::CachedCookbook] cookbook\n   the cached cookbook to search for a Strainerfile\n @param [Hash] options\n   a list of options to pass along\n @return [Strainerfile]\n   an instance of this class\n Get the list of commands to run, filtered by the `@options` hash for either\n `:ignore` or `:only`\n\n @return [Array<Strainer::Command>]\n   the list of commands to execute", "Parse the given Strainerfile", "Have this command output text, prefixing with its output with the\n command name\n\n @param [String] message\n   the message to speak\n @param [Hash] options\n   a list of options to pass along", "Execute a block inside the sandbox directory defined in 'Strainer.sandbox_path'.\n This will first change the 'PWD' env variable to the sandbox path, and then\n pass the given block into 'Dir.chdir'. 'PWD' is restored to the original value\n\u00a0when the block is finished.\n\n @yield The block to execute inside the sandbox\n @return [Boolean]\n   `true` if the command exited successfully, `false` otherwise", "Execute a block inside the sandboxed cookbook directory.\n\n @yield The block to execute inside the cookbook sandbox\n @return [Boolean]\n   `true` if the command exited successfully, `false` otherwise", "Run a command using PTY\n\n @param [String] command\n   the command to run", "Print a red error message to the STDERR.\n\n @param [String] message\n   the message to print\n @param [Symbol] color\n   the color to use", "evaluate all possible methods for the token value and return sanitized result", "ajax method for updating language rules in edit mode", "ajax method for updating language cases in edit mode", "ajax method for updating language case rules in edit mode", "language selector window", "language selector processor", "parse with safety - we don't want to disconnect existing translations from those rules", "used by a client app", "make sure that the current user is a translator", "make sure that the current user is a language manager", "Sets up the Elasticsearch client\n\n @option [String] :hosts ('localhost:9200') The Elasticsearch hosts\n   to connect to\n @return [Elasticsearch::Transport::Client] Elasticsearch transport client\n The Elasticsearch client object", "Creates an instance of tr8nProxy object", "Create zip archivement", "Reload all mixins.\n\n @return [void]", "Return the first callee outside the liquid-ext gem", "Return the calling line", "Returns a corresponding public method object of the actual context.\n\n @param method_name [String,Symbol] Method name\n @raise [::NameError]\n @raise [Symbiont::Trigger::ContextNoMethodError, ::NoMethodError]\n @return [Method]\n\n @see [Symbiont::Trigger#method]\n\n @api private\n @since 0.5.0", "Gets the method object taken from the context that can respond to it.\n Considers only public methods.\n\n @param method_name [Symbol,String] A name of required method.\n @param required_contexts [Array<Object>]\n   A set of objects that should be used as the main context series for method resolving\n   algorithm.\n @param direction [Array<Symbol>]\n   An array of symbols that represents the direction of contexts.\n @return [Method]\n\n @see Symbiont::PublicTrigger\n @see Symbiont::Trigger#method\n\n @api public\n @since 0.3.0", "Gets the method object taken from the context that can respond to it.\n Considers private methods and public methods.\n\n @param method_name [Symbol,String] A name of required method.\n @param required_contexts [Array<Object>]\n   A set of objects that should be used as the main context series for method resolving\n   algorithm.\n @param direction [Array<Symbol>]\n   An array of symbols that represents the direction of contexts.\n @return [Method]\n\n @see Symbiont::PrivateTrigger\n @see Symbiont::Trigger#method\n\n @api public\n @since 0.3.0", "Factory method that instantiates a public trigger with the desired execution context,\n the direction of method dispatching and the closure that needs to be performed.\n\n @param required_contexts [Array<Object>]\n   A set of objects that should be used as the main context series for method resolving\n   algorithm.\n @param direction [Array<Symbol>]\n   An array of symbols that represents the direction of contexts. Possible values:\n\n     - Symbiont::IOK\n     - Symbiont::OIK\n     - Symbiont::OKI\n     - Symbiont::IKO\n     - Symbiont::KOI\n     - Symbiont::KIO\n @return [Symbiont::PublicTrigger]\n\n @see Symbiont::PublicTrigger\n @see Symbiont::Trigger\n\n @api private\n @since 0.3.0", "Factory method that instantiates a private trigger with the desired execution context,\n the direction of method dispatching and the closure that needs to be performed.\n\n @param required_contexts [Array<Object>]\n   A set of objects that should be used as the main context series for method resolving\n   algorithm.\n @param direction [Array<Symbol>]\n   An array of symbols that represents the direction of contexts. Possible values:\n\n     - Symbiont::IOK\n     - Symbiont::OIK\n     - Symbiont::OKI\n     - Symbiont::IKO\n     - Symbiont::KOI\n     - Symbiont::KIO\n @return [Symbiont::PrivateTrigger]\n\n @see Symbiont::PrivateTrigger\n @see Symbiont::Trigger\n\n @api private\n @since 0.3.0", "Trace the given +bitmap+\n\n ==== Attributes\n\n * +bitmap+ - an instance of Potracer::Bitmap. If not given the +@bitmap+\n   is used.\n * +params+ - an instance of Potracer::Params. If not given +@params+ is\n   used.\n * +block+ - optional block called to report trace progress", "New values can be assigned to context on-the-fly,\n but it's not possible to change anything.", "Expose the running process to manual\n input on the terminal, and write stdout\n back to the user.", "Execute a single action.", "Create a new consumer\n\n @param queue_name [String] Your queue name. This is specific to your application,\n                            and should already exist and have a binding via puppet\n @param processor [Object] An object that responds to `process`\n @param rabbitmq_connection [Object] A Bunny connection object derived from `Bunny.new`\n @param statsd_client [Statsd] An instance of the Statsd class\n @param logger [Object] A Logger object for emitting errors (to stderr by default)", "Send an update signal to the process.\n\n @param sig [Integer] The signal to send, default 0 (or no action requested)", "Random bytes generator.\n\n It returns an Array of integers with values between 0 and 255\n\n It receives the number of random bytes to generate (max 2048, default 10)", "Determine if we should call +repair_executable+\n for the file at the provided +path+ String.\n\n Will this corrupt binaries? Yes... Yes. it. will.\n\n This also fails on UTF-8 files since Ruby's regex\n appears to choke on UTF-8??", "Random Integers Generator.\n\n Configuration options:\n * <tt>:num</tt> - The number of integers requested. Posibles values: [1,1e4]. Default: 10\n * <tt>:min</tt> - The smallest value allowed for each integer. Posibles values: [-1e9,1e9]. Default: 1\n * <tt>:max</tt> - The smallest value allowed for each integer. Posibles values: [-1e9,1e9]. Default: 100\n * <tt>:base</tt> - The base that will be used to print the numbers. Posibles values: 2, 8, 10, 16 (binary, octal, decimal or hexadecimal). Default: 10\n\n It returns an Array of integers with the size indicated by <tt>:num</tt>\n\n   integers(num: 15, max: 2, min: 200, base: 8)  #=> array of 15 base 8 numbers between 2 and 200\n   integers(num: 4, max: 33)                     #=> [31, 25, 28, 6]", "The Sequence Generator\n\n It will randomize a given interval of integers, i.e., arrange them in random order.\n\n It needs two params:\n * <tt>min</tt> - The lower bound of the interval (inclusive). Posibles values: [-1e9,1e9]\n * <tt>max</tt> - The upper bound of the interval (inclusive). Posibles values: [-1e9,1e9]\n\n The length of the sequence (the largest minus the smallest value plus 1) can be no greater than 10,000.\n\n It returns an Array of all the integers of the given interval arranged randomly\n\n   sequence(2, 15)  #=> [13, 2, 10, 4, 9, 15 ,12, 3, 5, 7, 6, 14, 8, 11]", "Random Strings Generator.\n\n It will generate truly random strings of various length and character compositions.\n\n Configuration options:\n * <tt>:num</tt> - The number of strings requested. Posibles values: [1,1e4]. Default: 10\n * <tt>:len</tt> - The length of the strings. All the strings produced will have the same length. Posibles values: [1,20]. Default: 8\n * <tt>:digits</tt> - Determines whether digits (0-9) are allowed to occur in the strings. Posibles values: ['on', 'off']. Default: on\n * <tt>:upperalpha</tt> - Determines whether uppercase alphabetic characters (A-Z) are allowed to occur in the strings. Posibles values: ['on', 'off']. Default: on\n * <tt>:loweralpha</tt> - Determines lowercase alphabetic characters (a-z) are allowed to occur in the strings. Posibles values: ['on', 'off']. Default: on\n * <tt>:unique</tt> - Determines whether the strings picked should be unique (as a series of raffle tickets drawn from a hat) or not (as a series of die rolls).\n If unique is set to on, then there is the additional constraint that the number of strings requested (num) must be less than or equal to the number of strings\n that exist with the selected length and characters. Posibles values: ['on', 'off']. Default: on\n\n It returns an Array of Strings of the size indicated with <tt>:num</tt>\n\n   strings(num: 15, len: 2, digits: 'off', upperalpha: 'off')  #=> array of 15 strings of size 2 composed by diggits and lowercase letters with no repetition.\n   strings(num: 4, len: 10)                                    #=> [\"iloqQz2nGa\", \"D2mgs12kD6\", \"yMe1eDsinJ\", \"ZQPaEol6xr\"]", "Add a library to the package.\n\n @return [Sprout::Library] The newly created library that was added.\n @param name [Symbol] Name that will be used to retrieve this library on +load+.\n @param path [File, Path, Array] File or files that will be associated with\n   this library and copied into the target project library folder when loaded.\n   (If the path is a directory, all files forward of that directory will be included.)", "Add an executable to the RubyGem package.\n\n @param name [Symbol] that will be used to retrieve this executable later.\n @param path [File] relative path to the executable that will be associated\n with this name.", "Creates a new process, executes the command\n and returns whatever the process wrote to stdout, or stderr.\n\n Raises a +Sprout::Errors::ExecutionError+ if the process writes to stderr", "Execute a new process in a separate thread and yield whatever output\n is written to its stderr and stdout.\n\n @return [Sprout::ProcessRunner]\n @param tool [File] Path to the executable.\n @param options [String] The command line options that the executable accepts.\n @param prompt [Regex] The prompt that will trigger the listener block to be called.\n @yield [String] Message that was received from the process, called when #prompt is encountered.", "Get a process runner and execute the provided +executable+,\n with the provided +options+.\n\n +executable+ String path to the external executable file.\n\n +options+ String commandline options to send to the +executable+.", "Gets the process runner and calls\n platform-specific execute method", "Needs for cases when custom exceptions needs a several required arguments", "Set a custom streaks value that takes into account GitHub,\n which makes available streak data for longer than a year", "Guesses the user's name based on system environment", "Set a custom longest_streak that takes into account GitHub's\n historical records", "Downloads new data from Github", "Overrides Personable mixin", "remove hostname and corresponding from known_hosts file.  Avoids warning when reusing elastic_ip, and\n less likely, if amazone reassigns ip.  By default removes both dns_name and ip", "Create a data object and turn on caching\n\n The data as a hash where the keys are dates and values are scores", "All streaks for a user", "Outliers of the set", "Return the list split into quartiles", "Return the quartile of a given score", "Pad the dataset to full week increments", "For use in layouts", "create an image file and copy this instance to the image file.", "First, change the min_count to", "Mapping of Rails and Ruby Logger levels to Sapience levels", "Subscribes any listeners configured in Renalware.config.broadcast_subscription_map\n to the current instance.\n\n Example usage\n\n   class SomeServiceObject\n     include Broadcasting\n\n     def call\n       ..\n     end\n   end\n\n   SomeServiceObject.new(..).broadcasting_to_configured_subscribers.call(..)\n\n See https://github.com/krisleech/wisper", "Adds a chef recipe to the cloud\n\n The hsh parameter is inserted into the override_attributes.\n The insertion is performed as follows. If\n the recipe name = \"foo::bar\" then effectively the call is\n\n override_attributes.merge! { :foo => { :bar => hsh } }", "Dynamically supply the log level with every measurement call", "The list of treatment options, stored in I18n", "Returns a Logger instance\n\n Return the logger for a specific class, supports class specific log levels\n   logger = Sapience::Logger.new(self)\n OR\n   logger = Sapience::Logger.new('MyClass')\n\n Parameters:\n  application\n    A class, module or a string with the application/class name\n    to be used in the logger\n\n  level\n    The initial log level to start with for this logger instance\n    Default: Sapience.config.default_level\n\n  filter [Regexp|Proc]\n    RegExp: Only include log messages where the class name matches the supplied\n    regular expression. All other messages will be ignored\n    Proc: Only include log messages where the supplied Proc returns true\n          The Proc must return true or false\n Place log request on the queue for the Appender thread to write to each\n appender in the order that they were registered", "Thread specific context information to be logged with every log entry\n\n Add a payload to all log calls on This Thread within the supplied block\n\n   logger.with_payload(tracking_number: 12345) do\n     logger.debug('Hello World')\n   end\n\n If a log call already includes a pyload, this payload will be merged with\n the supplied payload, with the supplied payload taking precedence\n\n   logger.with_payload(tracking_number: 12345) do\n     logger.debug('Hello World', result: 'blah')\n   end", "Whether to log the supplied message based on the current filter if any", "Extract the callers backtrace leaving out Sapience", "Dereference a resource that can be a URL or path to a JSON file or a hash\n Returns a Hash with all values that are URLs or paths dereferenced", "Describe instances\n Describe the instances that are available on this cloud\n @params id (optional) if present, details about the instance\n with the id given will be returned\n if not given, details for all instances will be returned", "prepare options for AWS gem", "Proxy to the raw Grempe amazon-aws @ec2 instance", "Read credentials from credential_file if one exists", "powerfull method that sets any value in config. It try to be\n smart to at first modify existing value, then replace commented out code\n and if even that doesn't work, then append it at the end\n @note prefer to use specialized methods of children", "Single version historical analysis\n\n @return [String] Human readable description of changes", "Calls block and if it failed, raise exception with details from augeas\n why it failed\n @yield call to aug that is secured\n @raise [RuntimeError]", "Attribute change analysis\n\n\n @return [String] Summary analysis of changes", "Fetch a configuration value.  The name must be a lowercase version of an\n uppercase name defined in the environment.  A NoMethodError is raised if\n no value matching the specified name is available.", "Define a required string config var.", "Define a required integer config var.", "Define a required boolean config var.", "Define a required string config var with a default value.", "Define a required integer config var with a default value.", "Define a required boolean config var with a default value.", "Convert a string to boolean.  An ArgumentError is raised if the string\n is not a valid boolean.", "Define a handler for a configuration value.", "Analyze the source control data, filter, sort, and find more information\n on the edited files", "collect all the data into a single hash data structure.", "Get a hash with status info for this batch server\n @example Status info for OSC Oakley batch server\n   my_conn.get_status\n   #=>\n   #{\n   #  \"oak-batch.osc.edu:15001\" => {\n   #    :server_state => \"Idle\",\n   #    ...\n   #  }\n   #}\n @param filters [Array<Symbol>] list of attribs to filter on\n @return [Hash] status info for batch server", "Get a list of hashes of the queues on the batch server\n @example Status info for OSC Oakley queues\n   my_conn.get_queues\n   #=>\n   #{\n   #  \"parallel\" => {\n   #    :queue_type => \"Execution\",\n   #    ...\n   #  },\n   #  \"serial\" => {\n   #    :queue_type => \"Execution\",\n   #    ...\n   #  },\n   #  ...\n   #}\n @param id [#to_s] the id of requested information\n @param filters [Array<Symbol>] list of attribs to filter on\n @return [Hash] hash of details for the queues", "Get a list of hashes of the nodes on the batch server\n @example Status info for OSC Oakley nodes\n   my_conn.get_nodes\n   #=>\n   #{\n   #  \"n0001\" => {\n   #    :np => \"12\",\n   #    ...\n   #  },\n   #  \"n0002\" => {\n   #    :np => \"12\",\n   #    ...\n   #  },\n   #  ...\n   #}\n @param id [#to_s] the id of requested information\n @param filters [Array<Symbol>] list of attribs to filter on\n @return [Hash] hash of details for nodes", "Get a list of hashes of the selected jobs on the batch server\n @example Status info for jobs owned by Bob\n   my_conn.select_jobs(attribs: [{name: \"User_List\", value: \"bob\", op: :eq}])\n   #=>\n   #{\n   #  \"10219837.oak-batch.osc.edu\" => {\n   #    :Job_Owner => \"bob@oakley02.osc.edu\",\n   #    :Job_Name => \"CFD_Solver\",\n   #    ...\n   #  },\n   #  \"10219839.oak-batch.osc.edu\" => {\n   #    :Job_Owner => \"bob@oakley02.osc.edu\",\n   #    :Job_Name => \"CFD_Solver2\",\n   #    ...\n   #  },\n   #  ...\n   #}\n @param attribs [Array<#to_h>] list of hashes describing attributes to\n   select on\n @return [Hash] hash of details of selected jobs", "Get a list of hashes of the jobs on the batch server\n @example Status info for OSC Oakley jobs\n   my_conn.get_jobs\n   #=>\n   #{\n   #  \"10219837.oak-batch.osc.edu\" => {\n   #    :Job_Owner => \"bob@oakley02.osc.edu\",\n   #    :Job_Name => \"CFD_Solver\",\n   #    ...\n   #  },\n   #  \"10219838.oak-batch.osc.edu\" => {\n   #    :Job_Owner => \"sally@oakley01.osc.edu\",\n   #    :Job_Name => \"FEA_Solver\",\n   #    ...\n   #  },\n   #  ...\n   #}\n @param id [#to_s] the id of requested information\n @param filters [Array<Symbol>] list of attribs to filter on\n @return [Hash] hash of details for jobs", "Submit a script to the batch server\n @example Submit a script with a few PBS directives\n   my_conn.submit_script(\"/path/to/script\",\n     headers: {\n       Job_Name: \"myjob\",\n       Join_Path: \"oe\"\n     },\n     resources: {\n       nodes: \"4:ppn=12\",\n       walltime: \"12:00:00\"\n     },\n     envvars: {\n       TOKEN: \"asd90f9sd8g90hk34\"\n     }\n   )\n   #=> \"6621251.oak-batch.osc.edu\"\n @param script [#to_s] path to the script\n @param queue [#to_s] queue to submit script to\n @param headers [Hash] pbs headers\n @param resources [Hash] pbs resources\n @param envvars [Hash] pbs environment variables\n @param qsub [Boolean] whether use library or binary for submission\n @return [String] the id of the job that was created\n @deprecated Use {#submit} instead.", "Submit a script expanded into a string to the batch server\n @param string [#to_s] script as a string\n @param (see #submit_script)\n @return [String] the id of the job that was created\n @deprecated Use {#submit} instead.", "Submit a script expanded as a string to the batch server\n @param content [#to_s] script as a string\n @param args [Array<#to_s>] arguments passed to `qsub` command\n @param env [Hash{#to_s => #to_s}] environment variables set\n @param chdir [#to_s, nil] working directory where `qsub` is called from\n @raise [Error] if `qsub` command exited unsuccessfully\n @return [String] the id of the job that was created", "Submit a script using Torque library", "Mapping of Torque attribute to `qsub` arguments", "Call a forked PBS command for a given host", "`fetch` can be called recursively in the `yield`ed block, so must\n make sure not to try to lock the Mutex if it's already locked by the\n current thread, as this would result in an error.", "compiles nodes into output code", "Parses the exception JSON message.\n\n The message must be a list of JSON messages merged by a new line.\n\n A valid exception message example:\n\n ```\n {\"stream\":\"Step 1 : FROM alpine:3.2\\n\"}\n {\"stream\":\" ---\\u003e d6ead20d5571\\n\"}\n {\"stream\":\"Step 2 : RUN apk add --update wrong-package-name\\n\"}\n {\"stream\":\" ---\\u003e Running in 290a46fa8bf4\\n\"}\n {\"stream\":\"fetch http://dl-4.alpinelinux.org/alpine/v3.2/main/...\\n\"}\n {\"stream\":\"ERROR: unsatisfiable constraints:\\n\"}\n {\"stream\":\"  wrong-package-name (missing):\\n    required by: world...\\n\"}\n {\"errorDetail\":{\"message\":\"The command ...\"},\"error\":\"The command ...\"}\n ```\n\n @example\n   self.parse_exception(e)\n   #=> [{ \"stream\" => \"Step 1 : FROM alpine:3.2\\n\" }, \"errorDetail\" => ...\n\n @param e [Exception] The exception object to parse.\n\n @return [Array<Hash>] The list of JSON messages parsed.\n\n @return\n\n @api private", "Gets all the console output from the stream logs.\n\n @param e_ary [Array<Hash>] The list of JSON messages already parsed.\n\n @return [String] The generated stdout output.\n\n @api private", "Gets the source to generate the image from.\n\n Possible values: `:string`, `:template`, `:id`, `:path`.\n\n @example Building an Image from a Path\n   self.source #=> :path\n\n @example Building an Image from a Template\n   self.source #=> :template\n\n @return [Symbol] The source.\n\n @api private", "Sets or gets the Docker image.\n\n @param img [Docker::Image] The Docker image to set.\n\n @return [Docker::Image] The Docker image object.\n\n @api private", "Gets the default options configured using `RSpec.configuration`.\n\n @example\n   self.rspec_options #=> {:path=>\".\", :rm=>true, :log_level=>:silent}\n\n @return [Hash] The configuration options.\n\n @api private", "Gets the default configuration options after merging them with RSpec\n configuration options.\n\n @example\n   self.default_options #=> {:path=>\".\", :rm=>true, :log_level=>:silent}\n\n @return [Hash] The configuration options.\n\n @api private", "Parses the configuration options passed to the constructor.\n\n @example\n   self.parse_options #=> {:path=>\".\", :rm=>true, :log_level=>:silent}\n\n @param opts [Array<String, Hash>] The list of optitag. The strings will\n   be interpreted as `:path`, others will be merged.\n\n @return [Hash] The configuration options.\n\n @see #initialize\n\n @api private", "Builds the image from a string. Generates the Docker tag if required.\n\n It also saves the generated image in the object internally.\n\n This creates a temporary directory where it copies all the files and\n generates the temporary Dockerfile.\n\n @param string [String] The Dockerfile content.\n @param dir [String] The directory to copy the files from. Files that are\n   required by the Dockerfile passed in *string*. If not passed, then\n   the 'string_build_path' option is used. If that is not used, '.' is\n   assumed.\n\n @return void\n\n @api private", "Builds the image from a directory with a Dockerfile.\n\n It also saves the generated image in the object internally.\n\n @param dir [String] The directory path.\n\n @return void\n\n @raise [Dockerspec::DockerError] For underlaying docker errors.\n\n @api private", "Builds the image from a directory or a file.\n\n It also saves the generated image in the object internally.\n\n @param path [String] The path.\n\n @return void\n\n @api private", "Builds the image from a template.\n\n It also saves the generated image in the object internally.\n\n @param file [String] The Dockerfile [Erubis]\n (http://www.kuwata-lab.com/erubis/users-guide.html) template path.\n\n @return void\n\n @api private", "Gets the image from a Image ID.\n\n It also saves the image in the object internally.\n\n @param id [String] The Docker image ID.\n\n @return void\n\n @raise [Dockerspec::DockerError] For underlaying docker errors.\n\n @api private", "Adds a repository name and a tag to the Docker image.\n\n @return void\n\n @api private", "fix for ActiveRecord < 4, doesn't implement in_time_zone for Date", "active state nav", "Return a list of users who have favorited this listing", "The collection of listings associated with this shop", "The addresses associated with this user.", "The profile associated with this user.", "Results of the API request", "Create a new client that will connect to the specified host", "Encodes the request as multipart", "rack converts X_FOO to HTTP_X_FOO, so strip \"HTTP_\"", "Look in current context and recursively through any available parent contexts to\n find definition of command. An Exception is raised if no implementation of command\n is found.", "Decodes a transit value to a corresponding object\n\n @param node a transit value to be decoded\n @param cache\n @param as_map_key\n @return decoded object", "Return list of not inherited models", "Runs the supplied command in a subshell.\n\n @param  command               String   The command to be run\n @param  expected_exit_status  Integer  The expected exit status of the command in [0, 255]\n @param  timeout               Integer  How long the command should be allowed to run for\n                                        nil indicates no timeout\n @param  options               Hash     Options to be passed to Posix::Spawn\n                                        See https://github.com/rtomayko/posix-spawn\n @param  env                   Hash     Environment to be passed to Posix::Spawn\n                                        See https://github.com/rtomayko/posix-spawn\n\n @raise  VCAP::SubprocessStatusError    Thrown if the exit status does not match the expected\n                                        exit status.\n @raise  VCAP::SubprocessTimeoutError   Thrown if a timeout occurs.\n @raise  VCAP::SubprocessReadError      Thrown if there is an error reading from any of the pipes\n                                        to the child.\n\n @return Array                          An array of [stdout, stderr, status]. Note that status\n                                        is an instance of Process::Status.", "create_doc creates a document of the specified format\n from the given string.", "doc_of_type takes a document type and a string and\n returns a document of that type in the current format.", "export_status checks the status of a mailbox export\n request.  It takes the username and the request_id\n as arguments\n\n export_status 'username', 847576\n\n export_status will return the body of the HTTP response\n from Google", "fetch_export downloads the mailbox export from Google.\n It takes a username, request id and a filename as\n arguments.  If the export consists of more than one file\n the file name will have numbers appended to indicate the\n piece of the export.\n\n fetch_export 'lholcomb2', 838382, 'lholcomb2'\n\n fetch_export reutrns nil in the event that the export is\n not yet ready.", "download makes a get request of the provided url\n and writes the body to the provided filename.\n\n download 'url', 'save_file'", "get_groups retrieves all the groups from the domain\n\n get_groups\n\n get_groups returns the final response from Google.", "get_next_page retrieves the next page in the response.", "fetch_feed retrieves the remaining pages in the request.\n It takes a page and a limit as arguments.", "Leading underscores are used to indicate a parameter isn't used", "Copy template files", "Adds missing lines to the files", "Finds a person by their email, then finds the first deal related to that\n person and updates it with the params provided", "Create a deep clone of the tree", "Clone a tree without the branch starting at node", "It's important to define all block specs we need to lazy load", "Replaces custom fields with their Pipedrive ID\n if the ID is defined in the configuration\n\n So if the body looked like this with a custom field\n called middle_name:\n\n { middle_name: \"Dave\" }\n\n And it has a Pipedrive ID (\"123abc\"), this will put in this custom ID\n\n { \"123abc\": \"Dave\" }\n\n meaning you don't have to worry about the custom IDs", "write config file", "Perform a credit check", "Compile the complete XML request to send to Callcredit", "Checks to be performed", "Checks for presence of @shutdown every 1 second and if found instructs\n all the channel's work pool consumers to shutdown. Each work pool thread\n will finish its current task and then join the main thread. Once all the\n threads have joined then `channel.work_pool.join` will cease blocking and\n return, causing the process to terminate.", "Declare a queue and subscribe to it\n\n @param consumer_class [Class] to subscribe to", "Handle receipt of a subscribed message\n\n @param consumer_class [Class] that was subscribed to\n @param delivery_info [Bunny::DeliveryInfo]\n @param properties [Bunny::MessageProperties]\n @param message [String] to deserialize", "Update the name of this process, as viewed in `ps` or `top`\n\n @example idle\n   set_process_name #=> \"songkick_queue[idle]\"\n @example consumer running, namespace is removed\n   set_process_name(Foo::TweetConsumer, 'a729bcd8') #=> \"songkick_queue[TweetConsumer#a729bcd8]\"\n @param status [String] of the program\n @param message_id [String] identifying the message currently being consumed", "Serializes the given message and publishes it to the default RabbitMQ exchange\n\n @param queue_name [String] to publish to\n @param message [#to_json] to serialize and enqueue\n @option options [String] :message_id to pass through to the consumer (will be logged)\n @option options [String] :produced_at time when the message was created, ISO8601 formatted\n\n @raise [TooManyReconnectAttemptsError] if max reconnect attempts is exceeded\n\n @return [Bunny::Exchange]", "Disables this Watcher, so that it doesn't fire any more events.\n\n @raise [SystemCallError] if the watch fails to be disabled for some reason", "The absolute path of the file that the event occurred on.\n\n This is actually only as absolute as the path passed to the {Watcher}\n that created this event.\n However, it is relative to the working directory,\n assuming that hasn't changed since the watcher started.\n\n @return [String]", "Blocks until there are one or more filesystem events\n that this notifier has watchers registered for.\n Once there are events, the appropriate callbacks are called\n and this function returns.\n\n @see #run", "Create a new Ohai Mock with fauxhai.\n\n @param [Hash] options\n   the options for the mocker\n @option options [String] :platform\n   the platform to mock\n @option options [String] :version\n   the version of the platform to mock\n @option options [String] :path\n   the path to a local JSON file\n @option options [Bool] :github_fetching\n   whether to try loading from Github", "As major releases of Ohai ship it's difficult and sometimes impossible\n to regenerate all fauxhai data. This allows us to deprecate old releases\n and eventually remove them while giving end users ample warning.", "Calls the specified service\n\n @param service [Class<TheHelp::Service>]\n @param args [Hash<Symbol, Object>] Any additional keyword arguments are\n        passed directly to the service.\n @return [self]", "Build the full command line.\n\n @param [String] command The command to run\n @param [Hash,Array] params Optional command line parameters. They can\n   be passed as a Hash or associative Array. The values are sanitized to\n   prevent command line injection.  Keys as Symbols are prefixed with `--`,\n   and `_` is replaced with `-`.\n\n   - `{:k => \"value\"}`              generates `-k value`\n   - `[[:k, \"value\"]]`              generates `-k value`\n   - `{:k= => \"value\"}`             generates `-k=value`\n   - `[[:k=, \"value\"]]`             generates `-k=value` <br /><br />\n\n   - `{:key => \"value\"}`            generates `--key value`\n   - `[[:key, \"value\"]]`            generates `--key value`\n   - `{:key= => \"value\"}`           generates `--key=value`\n   - `[[:key=, \"value\"]]`           generates `--key=value` <br /><br />\n\n   - `{\"--key\" => \"value\"}`         generates `--key value`\n   - `[[\"--key\", \"value\"]]`         generates `--key value`\n   - `{\"--key=\" => \"value\"}`        generates `--key=value`\n   - `[[\"--key=\", \"value\"]]`        generates `--key=value` <br /><br />\n\n   - `{:key_name => \"value\"}`       generates `--key-name value`\n   - `[[:key_name, \"value\"]]`       generates `--key-name value`\n   - `{:key_name= => \"value\"}`       generates `--key-name=value`\n   - `[[:key_name=, \"value\"]]`       generates `--key-name=value` <br /><br />\n\n   - `{\"-f\" => [\"file1\", \"file2\"]}` generates `-f file1 file2`\n   - `[[\"-f\", \"file1\", \"file2\"]]`   generates `-f file1 file2` <br /><br />\n\n   - `{:key => nil}`                generates `--key`\n   - `[[:key, nil]]`                generates `--key`\n   - `[[:key]]`                     generates `--key` <br /><br />\n\n   - `{nil => [\"file1\", \"file2\"]}`  generates `file1 file2`\n   - `[[nil, [\"file1\", \"file2\"]]]`  generates `file1 file2`\n   - `[[nil, \"file1\", \"file2\"]]`    generates `file1 file2`\n   - `[[\"file1\", \"file2\"]]`         generates `file1 file2`\n\n @return [String] The full command line", "core save method coordinating how to save the user.\n we dont' want to ru validations based on the\n authentication mission we are trying to accomplish.\n instead, we just return save as false.\n the next time around, when we recieve the callback,\n we will run the validations.\n when you call 'current_user_session' in ApplicationController,\n it leads to calling 'save' on this User object via \"session.record.save\",\n from the 'persisting?' method.  So we don't want any of this to occur\n when that save is called, and the only way to check currently is\n to check if there is a block_given?", "user adds a few extra things to this method from Process\n modules work like inheritance", "single implementation method for oauth.\n this is called after we get the callback url and we are saving the user\n to the database.\n it is called by the validation chain.", "Serialized can be Proc and Method\n\n === Func\n * *string:* already serialized proc\n * *proc:* proc\n * *symbol:* name of method\n * *method:* Method class", "Serialize method as string\n\n   def test(x)\n     x*x\n   end\n   serialize_function_from_method(method(:test))\n\n   # => \"def test(x)\\n  x*x\\nend\\n\"", "Initialize java SparkConf and load default configuration.", "Rescue from NoSuchElementException", "Load environment variables for executor from ENV.\n\n == Examples:\n   SPARK_RUBY_EXECUTOR_ENV_KEY1=\"1\"\n   SPARK_RUBY_EXECUTOR_ENV_KEY2=\"2\"", "These methods must be on one method because iterator is Lazy\n which mean that exception can be raised at `serializer` or `compute`", "Initializing RDD, this method is root of all Pipelined RDD - its unique\n If you call some operations on this class it will be computed in Java\n\n == Parameters:\n jrdd:: org.apache.spark.api.java.JavaRDD\n context:: {Spark::Context}\n serializer:: {Spark::Serializer}", "Take the first num elements of the RDD.\n\n It works by first scanning one partition, and use the results from\n that partition to estimate the number of additional partitions needed\n to satisfy the limit.\n\n == Example:\n   rdd = $sc.parallelize(0..100, 20)\n   rdd.take(5)\n   # => [0, 1, 2, 3, 4]", "Aggregate the elements of each partition, and then the results for all the partitions, using\n given combine functions and a neutral \"zero value\".\n\n This function can return a different result type. We need one operation for merging.\n\n Result must be an Array otherwise Serializer Array's zero value will be send\n as multiple values and not just one.\n\n == Example:\n   # 1 2 3 4 5  => 15 + 1 = 16\n   # 6 7 8 9 10 => 40 + 1 = 41\n   # 16 * 41 = 656\n\n   seq = lambda{|x,y| x+y}\n   com = lambda{|x,y| x*y}\n\n   rdd = $sc.parallelize(1..10, 2)\n   rdd.aggregate(1, seq, com)\n   # => 656", "Return a new RDD that is reduced into num_partitions partitions.\n\n == Example:\n   rdd = $sc.parallelize(0..10, 3)\n   rdd.coalesce(2).glom.collect\n   # => [[0, 1, 2], [3, 4, 5, 6, 7, 8, 9, 10]]", "Return a shuffled RDD.\n\n == Example:\n   rdd = $sc.parallelize(0..10)\n   rdd.shuffle.collect\n   # => [3, 10, 6, 7, 8, 0, 4, 2, 9, 1, 5]", "Return a new RDD with different serializer. This method is useful during union\n and join operations.\n\n == Example:\n   rdd = $sc.parallelize([1, 2, 3], nil, serializer: \"marshal\")\n   rdd = rdd.map(lambda{|x| x.to_s})\n   rdd.reserialize(\"oj\").collect\n   # => [\"1\", \"2\", \"3\"]", "Return the intersection of this RDD and another one. The output will not contain\n any duplicate elements, even if the input RDDs did.\n\n == Example:\n   rdd1 = $sc.parallelize([1,2,3,4,5])\n   rdd2 = $sc.parallelize([1,4,5,6,7])\n   rdd1.intersection(rdd2).collect\n   # => [1, 4, 5]", "Return a copy of the RDD partitioned using the specified partitioner.\n\n == Example:\n   rdd = $sc.parallelize([\"1\",\"2\",\"3\",\"4\",\"5\"]).map(lambda {|x| [x, 1]})\n   rdd.partitionBy(2).glom.collect\n   # => [[[\"3\", 1], [\"4\", 1]], [[\"1\", 1], [\"2\", 1], [\"5\", 1]]]", "Return a fixed-size sampled subset of this RDD in an array\n\n == Examples:\n   rdd = $sc.parallelize(0..100)\n\n   rdd.take_sample(true, 10)\n   # => [90, 84, 74, 44, 27, 22, 72, 96, 80, 54]\n\n   rdd.take_sample(false, 10)\n   # => [5, 35, 30, 48, 22, 33, 40, 75, 42, 32]", "Group the values for each key in the RDD into a single sequence. Allows controlling the\n partitioning of the resulting key-value pair RDD by passing a Partitioner.\n\n Note: If you are grouping in order to perform an aggregation (such as a sum or average)\n over each key, using reduce_by_key or combine_by_key will provide much better performance.\n\n == Example:\n   rdd = $sc.parallelize([[\"a\", 1], [\"a\", 2], [\"b\", 3]])\n   rdd.group_by_key.collect\n   # => [[\"a\", [1, 2]], [\"b\", [3]]]", "Aggregate the values of each key, using given combine functions and a neutral zero value.\n\n == Example:\n   def combine(x,y)\n     x+y\n   end\n\n   def merge(x,y)\n     x*y\n   end\n\n   rdd = $sc.parallelize([[\"a\", 1], [\"b\", 2], [\"a\", 3], [\"a\", 4], [\"c\", 5]], 2)\n   rdd.aggregate_by_key(1, method(:combine), method(:merge))\n   # => [[\"b\", 3], [\"a\", 16], [\"c\", 6]]", "For each key k in `this` or `other`, return a resulting RDD that contains a tuple with the\n list of values for that key in `this` as well as `other`.\n\n == Example:\n   rdd1 = $sc.parallelize([[\"a\", 1], [\"a\", 2], [\"b\", 3]])\n   rdd2 = $sc.parallelize([[\"a\", 4], [\"a\", 5], [\"b\", 6]])\n   rdd3 = $sc.parallelize([[\"a\", 7], [\"a\", 8], [\"b\", 9]])\n   rdd1.cogroup(rdd2, rdd3).collect\n   # => [[\"a\", [1, 2, 4, 5, 7, 8]], [\"b\", [3, 6, 9]]]", "Return an RDD with the elements from self that are not in other.\n\n == Example:\n   rdd1 = $sc.parallelize([[\"a\", 1], [\"a\", 2], [\"b\", 3], [\"c\", 4]])\n   rdd2 = $sc.parallelize([[\"a\", 2], [\"c\", 6]])\n   rdd1.subtract(rdd2).collect\n   # => [[\"a\", 1], [\"b\", 3], [\"c\", 4]]", "Sorts this RDD by the given key_function\n\n This is a different implementation than spark. Sort by doesn't use\n key_by method first. It can be slower but take less memory and\n you can always use map.sort_by_key\n\n == Example:\n   rdd = $sc.parallelize([\"aaaaaaa\", \"cc\", \"b\", \"eeee\", \"ddd\"])\n\n   rdd.sort_by.collect\n   # => [\"aaaaaaa\", \"b\", \"cc\", \"ddd\", \"eeee\"]\n\n   rdd.sort_by(lambda{|x| x.size}).collect\n   # => [\"b\", \"cc\", \"ddd\", \"eeee\", \"aaaaaaa\"]", "This is base method for reduce operation. Is used by reduce, fold and aggregation.\n Only difference is that fold has zero value.", "For using a different combine_by_key\n\n == Used for:\n * combine_by_key\n * fold_by_key (with zero value)", "Disable all Spark log", "Create an Accumulator with the given initial value, using a given\n accum_param helper object to define how to add values of the\n data type if provided.\n\n == Example:\n   accum = $sc.accumulator(7)\n\n   rdd = $sc.parallelize(0..5, 4)\n   rdd = rdd.bind(accum: accum)\n   rdd = rdd.map_partitions(lambda{|_| accum.add(1) })\n   rdd = rdd.collect\n\n   accum.value\n   # => 11", "Distribute a local Ruby collection to form an RDD\n Direct method can be slow so be careful, this method update data inplace\n\n == Parameters:\n data:: Range or Array\n num_slices:: number of slice\n serializer:: custom serializer (default: serializer based on configuration)\n\n == Examples:\n   $sc.parallelize([\"1\", \"2\", \"3\"]).map(lambda{|x| x.to_i}).collect\n   #=> [1, 2, 3]\n\n   $sc.parallelize(1..3).map(:to_s).collect\n   #=> [\"1\", \"2\", \"3\"]", "Executes the given partition function f on the specified set of partitions,\n returning the result as an array of elements.\n\n If partitions is not specified, this will run over all partitions.\n\n == Example:\n   rdd = $sc.parallelize(0..10, 5)\n   $sc.run_job(rdd, lambda{|x| x.to_s}, [0,2])\n   # => [\"[0, 1]\", \"[4, 5]\"]", "Execute the given command on specific set of partitions.", "min of our values", "This method intends to inject the error inside the context of the use case,\n so we can identify the use case from it was raised", "Installs schema_evolution_manager. Automatically upgrades schema_evolution_manager.", "executes a simple sql command.", "Returns a list of AttributeValues from the file itself,\n including all defaults set by SEM. AttributeValues are defined\n in comments in the file.", "For each sql script that needs to be applied to this database,\n yields a pair of |filename, fullpath| in proper order\n\n db = Db.new(host, user, name)\n scripts = Scripts.new(db)\n scripts.each_pending do |filename, path|\n    puts filename\n end", "True if this script has already been applied to the db. False\n otherwise.", "Inserts a record to indiciate that we have loaded the specified file.", "Fetch the list of scripts that have already been applied to this\n database.", "Generates the actual contents of the install file", "read text data from bz2 compressed file by 1 megabyte", "This was moved to private because users should just use sanitize for any content", "Convert this static file to a Page", "crawl apple system status page\n @param country [String] country code. (e.g. jp, ca, fr. default. us)\n @param title   [String] If specified, narrow the service title\n @return [Hash]\n @example response format\n   {\n     title: ,\n     services: [\n       { title: , description: , status:  }\n     ]\n   }", "Create request object ot provided uri and instantiate list deserializer.\n Request uri and deserialize response to response object with account info and transactions list.\n\n == Parameters:\n args::\n   Parts of uri\n\n == Returns:\n   List insatnce with account info and transactions list", "Converts Rails flash message type to Bootstrap flash message type\n\n @param flash_type [String,Symbol] the flash message type\n @return [String] flash message type", "wait up to 15 minutes", "Add it method to the DSL.\n\n @api public\n\n @example It must eql \"FOO\"\n   it { MUST equal 'FOO' }\n\n @param spec [Proc] A spec to compare against the computed actual value.\n\n @return [Array] List of results.", "Add on method to the DSL.\n\n @api public\n\n @example On +2, it must equal 44.\n   on(:+, 2) do\n     it { MUST equal 44 }\n   end\n\n @param method_name [Symbol] The identifier of a method.\n @param args        [Array]  A list of arguments.\n @param block       [Proc]   A spec to compare against the computed value.\n\n @return [Array] List of results.", "Add context method to the DSL, to build an isolated scope.\n\n @api public\n\n @example Context when logged in.\n   context 'when logged in' do\n     it { MUST equal 200 }\n   end\n\n @param block [Proc] A block of specs to test in isolation.\n\n @return [Array] List of results.", "Watch for an event, identified by its class' identifier. If a callback method is provided, then it will call that\n method on the caller of +watch+ when the event happens. Otherwise, it will run the callback block.\n\n @param identifier [Symbol] the event's identifier\n @param callback_method [Symbol] one option for adding a callback--the method on the object to call when the\n   event fires\n @param params [Hash] any parameters related to the registration of a watcher\n @param callback [Block] the other option for adding a callback--the block you wish to be executed when the event\n   fires\n @return [Proc] the block that will run when the event fires", "Render the Liquid content\n\n @return [String] the rendered content", "Frontend resource permalink.\n\n Same as `frontend_page_path` except it prints out nested resources in a\n nice way.\n\n Example\n   <%= frontend_resource_path('foo/bar') %> #=> /foo/bar\n   <%= frontend_resource_path(@page) %> #=> /foo/bar\n\n @return [String] frontend resource permalink", "Does a GET request to the url with the params\n\n @param url [String] the relative path in the Seoshop API\n @param params [Hash] the url params that should be passed in the request", "Does a POST request to the url with the params\n\n @param url [String] the relative path in the Seoshop API\n @param params [Hash] the body of the request", "Does a PUT request to the url with the params\n\n @param url [String] the relative path in the Seoshop API\n @param params [Hash] the body of the request", "Render Liquid content\n\n @param template [String] the content\n @param local_assigns [Hash] the local assigned variables\n @return [String] the rendered content", "Pushes a value onto the parse stack. Returns the Lexer.", "Start the lexical analysis.", "Called when the lexer encounters a new BibTeX object.", "Creates a new instance. If a hash is given, the entry is populated accordingly.", "Sets the Entry's key. If the Entry is currently registered with a\n Bibliography, re-registers the Entry with the new key; note that this\n may change the key value if another Entry is already regsitered with\n the same key.\n\n Returns the new key.", "Returns the field value referenced by the passed-in name.\n For example, this will return the 'title' value for 'booktitle' if a\n corresponding alias is defined.", "Returns a sorted list of the Entry's field names. If a +filter+ is passed\n as argument, returns all field names that are also defined by the filter.\n If the +filter+ is empty, returns all field names.\n\n If the second optional argument is true (default) and the Entry contains\n a cross-reference, the list will include all inherited fields.", "Returns a sorted list of all field names referenced by this Entry's cross-reference.", "Renames the given field names unless a field with the new name already\n exists.", "Returns false if the entry is one of the standard entry types and does not have\n definitions of all the required fields for that type.", "Creates the entry's digest based on the passed-in filters.\n\n The digest contains the type and all key-value pairs based\n on the passed in filter.\n\n If a block is given, the computed digest will be passed to\n the block for post-processing (the entry itself will be passed\n as the second parameter).\n\n @see #field_names\n\n @param [<Symbol>] the field names to use\n @return [String] the digest string", "Called when the element was added to a bibliography.", "Registers this Entry in the associated Bibliographies entries hash.\n This method may change the Entry's key, if another entry is already\n registered with the current key.\n\n Returns the key or nil if the Entry is not associated with a Bibliography.", "Parses all name values of the entry. Tries to replace and join the\n value prior to parsing.", "In-place variant of @see #convert", "Returns a default key for this entry.", "Creates a new bibliography.", "Adds a new element, or a list of new elements to the bibliography.\n Returns the Bibliography for chainability.", "Saves the bibliography to a file at the given path. Returns the bibliography.", "Deletes an object, or a list of objects from the bibliography.\n If a list of objects is to be deleted, you can either supply the list\n of objects or use a query or block to define the list.\n\n Returns the object (or the list of objects) that were deleted; nil\n if the object was not part of the bibliography.", "This method combines all names in the bibliography that look identical\n when using initials as first names and then tries to extend the first\n names for all names in each group to the longest available form.\n Returns the bibliography.\n\n If your bibliography contains the names 'Poe, Edgar A.', 'Poe, E.A.',\n and 'Poe, E. A.' calling this method would convert all three names to\n 'Poe, Edgar A.'.", "Returns true if the element matches the given query.", "Set the name tokens to the values defined in the passed-in hash.", "Sets the name's first name to the passed-in name if the last name equals\n for_last and the current first name has the same initials as with_first.", "Renames the tokens according to the passed-in attributes if all of the\n conditions match or if the given block returns true.", "check if the assertion is a truthy value, if so create a new pass result,\n otherwise create a new fail result with the desc and what failed msg.\n all other assertion helpers use this one in the end", "adds a Pass result to the end of the test's results\n does not break test execution", "adds a Fail result to the end of the test's results\n break test execution if assert is configured to halt on failures", "Identical to enqueue_at but takes number_of_seconds_from_now\n instead of a timestamp.", "Given a string, returns a Ruby object.", "Given a camel cased word, returns the constant it represents\n\n constantize('JobName') # => JobName", "Set the atom.\n @param value [String, Atom] Either a string representing an Atom, or an\n Atom\n @api public", "Set the prefix.\n @param value [String, Prefix] Either a string representing a Prefix, or\n a Prefix", "The base units this term is derived from\n @return [Array] An array of Unitwise::Term\n @api public", "Multiply or divide a term\n @api private", "String representation for the instance.\n @param mode [symbol] The attribute to for stringification\n @return [String]\n @api public", "Set the atom's scale. It can be set as a Scale or a Functional\n @return [Unitwise::Functional, Unitwise::Scale]\n @api public", "A basic validator for atoms. It checks for the bare minimum properties\n and that it's scalar and magnitude can be resolved. Note that this method\n requires the units it depends on to already exist, so it is not used\n when loading the initial data from UCUM.\n @return [true] returns true if the atom is valid\n @raise [Unitwise::DefinitionError]", "A representation of a unit based on the atoms it's derived from.\n @return [SignedMultiset]\n @api public", "A string representation of a unit based on the atoms it's derived from\n @return [String]\n @api public", "Create a new unit. You can send an expression or a collection of terms\n @param input [String, Unit, [Term]] A string expression, a unit, or a\n collection of tems.\n @api public\n The collection of terms used by this unit.\n @return [Array]\n @api public", "Build a string representation of this unit by it's terms.\n @param mode [Symbol] The mode to use to stringify the atoms\n (:primary_code, :names, :secondary_code).\n @return [String]\n @api public", "Get a scalar value for this unit.\n @param magnitude [Numeric] An optional magnitude on this unit's scale.\n @return [Numeric] A scalar value on a linear scale\n @api public", "Raise this unit to a numeric power.\n @param other [Numeric]\n @return [Unitwise::Unit]\n @api public", "Multiply or divide units\n @api private", "Create a new Measurement\n @param value [Numeric] The scalar value for the measurement\n @param unit  [String, Measurement::Unit] Either a string expression, or a\n Measurement::Unit\n @example\n   Unitwise::Measurement.new(20, 'm/s')\n @api public\n Convert this measurement to a compatible unit.\n @param other_unit [String, Measurement::Unit] Either a string expression\n or a Measurement::Unit\n @example\n   measurement1.convert_to('foot')\n   measurement2.convert_to('kilogram')\n @api public", "Raise a measurement to a numeric power.\n @param number [Numeric]\n @example\n   measurement ** 2\n @api public", "Round the measurement value. Delegates to the value's class.\n @return [Integer, Float]\n @api public", "Will attempt to convert to a unit by method name.\n @example\n   measurement.to_foot # => <Unitwise::Measurement 4 foot>\n @api semipublic", "Determine value of the unit after conversion to another unit\n @api private", "Add or subtract other unit\n @api private", "Multiply or divide other unit\n @api private", "Get a scalar value for this scale.\n @param magnitude [Numeric] An optional magnitude on this scale.\n @return [Numeric] A scalar value on a linear scale\n @api public", "Get a magnitude based on a linear scale value. Only used by scales with\n special atoms in it's hierarchy.\n @param scalar [Numeric] A linear scalar value\n @return [Numeric] The equivalent magnitude on this scale\n @api public", "Convert to a simple string representing the scale.\n @api public", "Evaluates an JavaScript expression\n @param [String] str The JavaScript string\n @param [String] file The file name\n @param [Integer] lineno The line number", "Creates an component. Either data or path must be specified.\n @param [String] data the QML file data.\n @param [#to_s] path the QML file path.\n @return QML::Component", "Initializes the Signal.\n @param [Array<#to_sym>, nil] params the parameter names (the signal will be variadic if nil).\n Calls every connected procedure with given arguments.\n Raises an ArgumentError when the arity is wrong.\n @param args the arguments.", "Notifies the list views that items are about to be and were moved.\n @param [Range<Integer>] range the index range of the item being moved.\n @param [Integer] destination the first index of the items after moved.\n @yield the block that actually do moving operation of the items.\n @return the result of given block.\n @see http://qt-project.org/doc/qt-5/qabstractitemmodel.html#beginMoveRows QAbstractItemModel::beginMoveRows\n @see http://qt-project.org/doc/qt-5/qabstractitemmodel.html#endMoveRows QAbstractItemModel::endMoveRows\n @see #inserting\n @see #removing", "Notifies the list views that items are about to be and were inserted.\n @param [Range<Integer>] range the index range of the items after inserted.\n @yield the block that actually do insertion of the items.\n @return the result of give block.\n @example\n   inserting(index ... index + items.size) do\n     @array.insert(index, *items)\n   end\n @see http://qt-project.org/doc/qt-5/qabstractitemmodel.html#beginInsertRows QAbstractItemModel::beginInsertRows\n @see http://qt-project.org/doc/qt-5/qabstractitemmodel.html#endInsertRows QAbstractItemModel::endInsertRows\n @see #removing\n @see #moving", "Notifies the list views that items are about to be and were removed.\n @param [Range<Integer>] range the index range of the items before removed.\n @yield the block that actually do removal of the items.\n @return the result of give block.\n @see http://qt-project.org/doc/qt-5/qabstractitemmodel.html#beginRemoveRows QAbstractItemModel::beginRemoveRows\n @see http://qt-project.org/doc/qt-5/qabstractitemmodel.html#endRemoveRows QAbstractItemModel::endRemoveRows\n @see #inserting\n @see #moving", "Inserts items.\n @param [Integer] index\n @return [self]", "Gets or sets a JS property, or call it as a method if it is a function.", "convert \"flat\" coords in scanline number & pos in scanline", "save image to file", "unpack zlib,\n on errors keep going and try to return maximum possible data", "modifies this image", "returns new deinterlaced image if deinterlaced\n OR returns self if no need to deinterlace", "convert to ANSI color name", "change bit depth, return new Color", "Op! op! op! Op!! Oppan Gangnam Style!!", "Returns a response with a parsed body", "converts a camel_cased string to a underscore string\n subs spaces with underscores, strips whitespace\n Same way ActiveSupport does string.underscore", "Returns list of tags applied to reader", "Returns Quorum's search results.\n\n This method should be used to gather Resque worker results, or user\n supplied query params.", "Create new Job and build associations.", "Create directories per tarball and return tarball file name\n minus the file extension.", "Extracts and concatenates files from tarballs.", "Execute makeblastdb on an extracted dataset.", "Builds a Blast database from parse_blast_db_data.", "Write to log file and exit if exit_status is present.", "Make sure an algorithm is selected.", "parameters required when invoked by test_unit", "Create a unique hash plus timestamp.", "Write input sequence to file. Pass the raw input data through seqret\n to ensure FASTA format.", "I18n flash helper. Set flash message based on key.", "Virtual attribute setter.", "Inspired by ActiveSupport's implementation", "Executes a SQL statement against the Crate HTTP REST endpoint.\n @param [String] sql statement to execute\n @param [Array] args Array of values used for parameter substitution\n @param [Array] bulk_args List of lists containing records to be processed\n @param [Hash] http_options Net::HTTP options (open_timeout, read_timeout)\n @return [ResultSet]", "Upload a File to a blob table\n @param [String] table\n @param [String] digest SHA1 hexdigest\n @param [Boolean] data Can be any payload object that can be sent via HTTP, e.g. STRING, FILE", "Create a transaction between apps and Janus for request without handle\n\n @param [Hash] options\n   Give a session number for use another session in Janus\n\n @example Get Janus session\n   @rrj.start_transaction_admin do |transaction|\n     response = transaction.publish_message('admin:sessions').sessions\n   end\n\n @since 2.0.0", "By default, the CoffeeScriptFilter converts inputs\n with the extension +.coffee+ to +.js+.\n\n @param [Hash] options options to pass to the CoffeeScript\n   compiler.\n @param [Proc] block the output name generator block\n The body of the filter. Compile each input file into\n a CoffeeScript compiled output file.\n\n @param [Array] inputs an Array of FileWrapper objects.\n @param [FileWrapper] output a FileWrapper object", "Return a new instance of RubyRabbitmqJanus.\n\n @example Create a instance to this gem\n   @rrj = RubyRabbitmqJanus::RRJ.new\n   => #<RubyRabbitmqJanus::RRJ:0x007 @session=123>\n Start a transaction with Janus. Request use session_id information.\n\n @param [Boolean] exclusive Choose if message is storage in exclusive queue\n @param [Hash] options\n   Give a session number for use another session in Janus\n\n @example Get Janus information\n   @rrj.start_transaction do |transaction|\n     response = transaction.publish_message('base::info').to_hash\n   end\n\n @since 2.0.0", "Create an instance of this filter.\n\n Possible options:\n module_id_generator: provide a Proc to convert an input to a\n                      module identifier (AMD only)\n Other options are passed along to the RubyES6ModuleTranspiler and then to\n  the node transpiler. See https://github.com/square/es6-module-transpiler\n  for more info.\n\n @param [Hash] options options (see above)\n @param [Proc] block the output name generator block\n The body of the filter. Compile each input file into\n a ES6 Module Transpiled output file.\n\n @param [Array] inputs an Array of FileWrapper objects.\n @param [FileWrapper] output a FileWrapper object", "Create a transaction between apps and janus with a handle\n\n @since 2.1.0", "Default method using for sending a block of code", "Render a WebDAV multistatus response with a single \"response\" element.\n This is primarily intended vor responding to single resource errors.\n\n Arguments:\n   options:\n     - href: the requested resource URL, usually request.url\n     - status: the response status, something like :unprocessable_entity or 204.\n     - error: an Error description, if any.", "A block dups all it's children and the translations", "Understands the arguments as the list of enum values\n  The argument value can be\n    - a `string` of enum values joined by a comma\n    - an enum constant\n    - a `symbol` which resolves to the enum constant\n    - an `integer` as the index of the enum class\n  If you have just 1 value, you do not need to enclose it in an `Array`", "Get the current count for the number of times requests were not able to\n connect to a given database host", "Returns an array containing the data from the nodes in the list", "Delete the provided statements from the triplestore\n @param [RDF::Enumerable] statements to delete from the triplestore\n @return [Boolean] true if the delete was successful", "Returns statements matching the subject\n @param [String] subject url\n @return [RDF::Enumerable] RDF statements", "Create a new namespace on the triplestore\n @param [String] namespace to be built\n @return [String] URI for the new namespace", "Store the graph in the triplestore cache\n\n @param [RDF::Graph] graph\n @return [RDF::Graph]\n @raise [Exception] if client fails to store the graph", "Delete the graph from the triplestore cache\n\n @param [String] rdf_url\n @return [Boolean]", "Fetch the graph from the triplestore cache\n\n @private\n @param [String] url\n @return [RDF::Graph] if the graph is found in the cache\n @return [nil] if the graph was not in the cache", "Fetch the graph from the source URL, and cache it for future use\n\n @private\n @param [String] url\n @return [RDF::Graph] if a graph is found\n @raise [Exception] if fetching the graph failed", "Get statements from the server\n @param [String] subject url\n @raise [TriplestoreAdapter::TriplestoreException] if the provider doesn't implement this method", "This error has to be raised at runtime because, when the class body\n is being executed, the parser methods won't be available unless\n they are defined above the column definitions in the class body", "Find an executable in a platform independent way\n\n @param [String] command\n   the command to search for\n @param [Array[String]] paths\n   the paths to look through\n\n @example\n   which('ruby')                 # => '/usr/local/bin/ruby'\n   which('/usr/local/bin/ruby')  # => '/usr/local/bin/ruby'\n   which('foo')                  # => nil\n\n @example\n   which('ruby', paths: ['/usr/locale/bin', '/usr/bin', '/bin'])\n\n @return [String, nil]\n   the absolute path to executable if found, `nil` otherwise\n\n @api public", "Find default system paths\n\n @param [String] path\n   the path to search through\n\n @example\n   search_paths(\"/usr/local/bin:/bin\")\n   # => ['/bin']\n\n @return [Array[String]]\n   the array of paths to search\n\n @api private", "All possible file extensions\n\n @example\n   extensions('.exe;cmd;.bat')\n   # => ['.exe','.bat']\n\n @param [String] path_ext\n   a string of semicolon separated filename extensions\n\n @return [Array[String]]\n   an array with valid file extensions\n\n @api private", "Determines if filename is an executable file\n\n @example Basic usage\n   executable_file?('/usr/bin/less') # => true\n\n @example Executable in directory\n   executable_file?('less', '/usr/bin') # => true\n   executable_file?('less', '/usr') # => false\n\n @param [String] filename\n   the path to file\n @param [String] dir\n   the directory within which to search for filename\n\n @return [Boolean]\n\n @api private", "Check if command itself has executable extension\n\n @param [String] filename\n   the path to executable file\n\n @example\n   file_with_exec_ext?(\"file.bat\")\n   # => true\n\n @return [Boolean]\n\n @api private", "redundant!! preprocess this out of here!", "returns any words in the query that appeared as input to their original case", "for example, \"1st friday\", uses self as the reference month", "returns a new date object", "add_ methods return new ZDate object, they DO NOT modify self", "sub_ methods return new ZDate object, they do not modify self.", "Gets the absolute difference in days between self and date_to_compare, order is not important.", "difference in months FROM self TO date2, for instance, if self is oct 1 and date2 is nov 14, will return 1\n if self is nov 14 and date2 is oct 1, will return -1", "Modifies self.\n bumps self to first day of next month", "this can very easily be cleaned up", "Zip all given files into a zip and send it with `send_data`\n\n @param active_storages [ActiveStorage::Attached::Many] files to save\n @param filename [ActiveStorage::Attached::Many] files to save", "Initialise a new Checker instance with an API access token and commit URL.\n\n @param options [Hash] Options which should take the form:\n {\n   :access_token => \"<Your 40 char GitHub API token>\",\n   :commit_url   => \"https://github.com/user/repo/commit/sha\"\n }\n\n @return [ContributionChecker::Checker] Contribution checker initialised\n for an authenticated user and a specific commit\n Checks whether the commit is counted as a contribution for the\n authenticated user.\n\n @return [Hash] The return value takes the following form:\n {\n   :contribution => true,\n   :and_criteria => {\n     :commit_email_is_not_generic => true,\n     :commit_in_valid_branch      => true,\n     :repo_not_a_fork             => true,\n     :commit_email_linked_to_user => true,\n     :commit_email                => \"me@foo.com\",\n     :default_branch              => \"master\"\n   },\n   :or_criteria => {\n     :user_has_starred_repo               => false,\n     :user_can_push_to_repo               => false,\n     :user_is_repo_org_member             => true,\n     :user_has_fork_of_repo               => false,\n     :user_has_opened_issue_or_pr_in_repo => false\n   }\n }", "Parses the commit URL provided.\n\n @return [Array] URL parts: nwo, sha", "Checks whether the authenticated user has forked the repository in which\n the commit exists.\n\n @return [Boolean]", "Sets an input change handler callback function. This is called when a digital input on the PhidgetEncoder board has changed.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     en.on_input_change do |device, input, state, obj|\n       print \"Digital Input  #{input.index}, changed to #{state}\\n\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Calculates crop geometry. The given vector is scaled\n to match the image size, since DynamicImage performs\n cropping before resizing.\n\n ==== Example\n\n   image = Image.find(params[:id]) # 320x200 image\n   sizing = DynamicImage::ImageSizing.new(image)\n\n   sizing.crop_geometry(Vector2d(100, 100))\n   # => [Vector2d(200, 200), Vector2d(60, 0)]\n\n Returns a tuple with crop size and crop start vectors.", "Adjusts +fit_size+ to fit the image dimensions.\n Any dimension set to zero will be ignored.\n\n ==== Options\n\n * <tt>:crop</tt> - Don't keep aspect ratio. This will allow\n   the image to be cropped to the requested size.\n * <tt>:upscale</tt> - Don't limit to the size of the image.\n   Images smaller than the given size will be scaled up.\n\n ==== Examples\n\n   image = Image.find(params[:id]) # 320x200 image\n   sizing = DynamicImage::ImageSizing.new(image)\n\n   sizing.fit(Vector2d(0, 100))\n   # => Vector2d(160.0, 100.0)\n\n   sizing.fit(Vector2d(500, 500))\n   # => Vector2d(320.0, 200.0)\n\n   sizing.fit(Vector2d(500, 500), crop: true)\n   # => Vector2d(200.0, 200.0)\n\n   sizing.fit(Vector2d(500, 500), upscale: true)\n   # => Vector2d(500.0, 312.5)", "Clamps the rectangle defined by +start+ and +size+\n to fit inside 0, 0 and +max_size+. It is assumed\n that +size+ will always be smaller than +max_size+.\n\n Returns the start vector.", "Sets an count handler callback function. This is called when ticks are counted on an frequency counter input, or when the timeout expires\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     fc.on_count do |device, input, time, count, obj|\n       puts \"Channel  #{input.index}:  #{count} pulses in #{time} microseconds\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Create a pointer for this Device handle .. must be called before open or anything else.\n Called automatically when objects are instantiated in block form.", "Closes and frees a Phidget. This should be called before closing your application or things may not shut down cleanly.\n\n @return [Boolean] returns true or raises an error", "Sets an attach handler callback function. This is called when the Phidget is plugged into the system, and is ready for use.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     ifkit.on_attach do |device, obj|\n       puts \"InterfaceKit attached #{device.attributes.inspect}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a detach handler callback function. This is called when the Phidget is physically detached from the system, and is no longer available.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     ifkit.on_detach do |device, obj|\n       puts \"InterfaceKit detached #{device.attributes.inspect}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets an error handler callback function. This is called when an asynchronous error occurs. This is generally used for network errors, and device hardware error messages.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     ifkit.on_error do |device, obj, code, description|\n       puts \"Error - code #{code}, description #{description}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a server connect handler callback function. This is called for network opened Phidgets when a connection to the PhidgetWebService has been established.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     ifkit.on_server_connect do |device, obj|\n       puts \"Server connect #{device.attributes.inspect}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a sleep handler callback function. This is called when the MacOS X is entering sleep mode.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     ifkit.on_sleep do |obj|\n       puts \"System sleeping\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error\n @note Used only in Mac OS X", "Sets a wake callback function. This is called when the MacOS X is waking up from sleep mode.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     ifkit.on_wake do |obj|\n       puts \"System waking up\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error\n @note Used only in Mac OS X", "Declares an image resource.\n\n   image_resources :avatars", "Sets an attach handler callback function. This is called when a Phidget is plugged into the system.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     manager.on_attach do |device_ptr, obj|\n       puts \"Attaching #{Phidgets::Common.name(device_ptr)}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a detach handler callback function. This is called when a Phidget is unplugged from the system.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     manager.on_detach do |device_ptr, obj|\n       puts \"Detaching #{Phidgets::Common.name(device_ptr)}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a server connect handler callback function. This is used for opening the PhidgetManager remotely, and is called when a connection to the server has been made.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     manager.on_server_connect do |obj|\n        puts 'Connected'\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a server disconnect handler callback function. This is used for opening the PhidgetManager remotely, and is called when a connection to the server has been lost\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     manager.on_server_disconnect do |obj|\n       puts 'Disconnected'\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a error handler callback function. This is called when an asynchronous error occurs.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     manager.on_error do |obj|\n       puts \"Error (#{code}): #{reason}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Allow everything fun to be injected from the outside while defaulting to normal implementations.\n Do the things!", "Get one workflow with a specified name.\n @param [String] name Name of the workflow\n @return [String] the JSON document of the requested workflow", "Get a list of executions for the given workflow GUID\n @param [String] workflow_id Workflow GUID\n @return [Hash] workflow executions, keyed by execution ID", "Submit the given workflow for execution\n @param [String] id Workflow GUID for the workflow we want to execute\n @param [String] parameter_json JSON document of input parameters\n @return [String] Execution ID", "Initialize a Specification\n\n @param [Hash{Symbol => Type}] type_handlers\n   a map of parameter names to their type handlers\n Validate and translate client parameters to their Pinboard values\n\n @param [Hash{Symbol => Object}] arguments\n   parameter names associated with their values\n\n @return [Hash{Symbol => Object}]\n   parameter names associated with translations to their Pinboard values", "Create an execution log object\n @param [String] log_json JSON document as string\n @return [VcoWorkflows::WorkflowExecutionLog]\n rubocop:disable MethodLength, LineLength\n Stringify the log\n @return [String]", "Sets the board current limit for all LEDs, or raises an error. Not supported on all PhidgetLEDs.\n @param [Phidgets::FFI::LEDCurrentLimit] new_current_limit new current limit\n @return [Phidgets::FFI::LEDCurrentLimit] returns the board current limit, or raises an error.", "Sets the voltage level for all LEDs, or raises an error. Not supported on all PhidgetLEDs.\n @param [Phidgets::FFI::LEDVoltage] new_voltage new voltage\n @return [Phidgets::FFI::LEDVoltage] returns the voltage level, or raises an error.", "Sets a velocity change handler callback function. This is called when a stepper velocity changes.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     st.on_velocity_change do |device, stepper, velocity, obj|\n       puts \"Stepper #{stepper.index}'s velocity has changed to #{velocity}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets an acceleration change handler callback function. This is called when the acceleration of an axis changes by more than the set sensitivity.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     acc.on_acceleration_change do |device, axis, acceleration, obj|\n       puts \"Axis #{axis.index}'s acceleration changed to #{acceleration}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Crops and resizes the image. Normalization is performed as well.\n\n ==== Example\n\n   processed = DynamicImage::ProcessedImage.new(image)\n   image_data = processed.cropped_and_resized(Vector2d.new(200, 200))\n\n Returns a binary string.", "Normalizes the image.\n\n * Applies EXIF rotation\n * CMYK images are converted to sRGB\n * Strips metadata\n * Optimizes GIFs\n * Performs format conversion if the requested format is different\n\n ==== Example\n\n   processed = DynamicImage::ProcessedImage.new(image, :jpeg)\n   jpg_data = processed.normalized\n\n Returns a binary string.", "load config file and merge up with the config tree.\n it will not work when the config_path is nil or the file is missed", "This will return arguments as object methods.", "The attributes of a PhidgetMotorControl", "Sets a current change handler callback function. This is called when the current consumed by a motor changes.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     mc.on_current_change do |device, motor, current|\n       puts \"Motor #{motor.index}'s current changed to #{current}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a Back EMF update handler callback function. This is called at a steady rate of 16ms, when BackEMF sensing is enabled.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     mc.on_back_emf_update do |device, motor, voltage|\n       puts \"Motor #{motor.index}'s back EMF is #{voltage}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a position update handler callback function. This event provides data about how many ticks have occured since the last update event. It is called at a steady rate of 8ms.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     mc.on_position_update do |device, encoder, position|\n       puts \"Encoder #{encoder.index}'s position is #{position}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a sensor update handler callback function. This is called at a steady rate of 8ms.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     mc.on_sensor_update do |device, sensor, value|\n       puts \"Analog Sensor #{sensor.index}'s value is #{value}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Returns the ratiometric state of the board\n\n @return [Boolean] returns the ratiometric state or raises an error", "pretty-prints a representation this JSI to the given printer\n @return [void]", "assigns a subscript, taking care of memoization and unwrapping a JSI if given.\n @param subscript [Object] the bit between the [ and ]\n @param value [JSI::Base, Object] the value to be assigned", "Sets an output change handler callback function. This is called when a digital output on the PhidgetRFID board has changed.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     rfid.on_output_change do |device, output, state, obj|\n       print \"Digital Output  #{output.index}, changed to #{state}\\n\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a tag handler callback function. This is called when a new tag is seen by the reader. The event is only fired one time for a new tag, so the tag has to be removed and then replaced before another tag gained event will fire.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     rfid.on_tag do |device, tag, obj|\n       puts \"Tag #{tag} detected\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a tag lost handler callback function. This is called when a tag is removed from the reader\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     rfid.on_tag_lost do |device, tag, obj|\n       puts \"Tag #{tag} removed\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Returns the antenna state of the Phidget.\n\n @return [Boolean] returns the ratiometric state or raises an error", "Returns the LED state.\n\n @return [Boolean] returns the LED state or raises an error", "Returns the value indicating whether or not a tag is on the reader.\n\n @return [Boolean] returns a value indicating whether or not a tag is on the reader, or raises an error", "Writes to a tag.\n\n @param [String] tag Tag data to write. See product manual for formatting.\n @param [Phidgets::FFI::RFIDTagProtocol] protocol Tag Protocol to use.\n @param [Boolean] lock Lock the tag from further writes\n @return [Boolean] returns true or raises an error", "Sets correction paramaters for the magnetometer triad. This is for filtering out hard and soft iron offsets, and scaling the output to match the local field strength. These parameters can be obtained from the compass calibration program provided by Phidgets Inc.\n @param [Integer] new_mag_field local magnetic field strength\n @param [Integer] new_offset0 axis 0 offset correction\n @param [Integer] new_offset1 axis 1 offset correction\n @param [Integer] new_offset2 axis 2 offset correction\n @param [Integer] new_gain0 axis 0 gain correction.\n @param [Integer] new_gain1 axis 1 gain correction.\n @param [Integer] new_gain2 axis 2 gain correction.\n @param [Integer] new_t0 non-orthogonality correction factor 0\n @param [Integer] new_t1 non-orthogonality correction factor 1\n @param [Integer] new_t2 non-orthogonality correction factor 2\n @param [Integer] new_t3 non-orthogonality correction factor 3\n @param [Integer] new_t4 non-orthogonality correction factor 4\n @param [Integer] new_t5 non-orthogonality correction factor 5\n @return [Boolean] returns true if successful, or raises an error.", "Opens a PhidgetDictionary over the WebService.\n If you are not programming with the block method, you will have to call this explicitly.\n This is called automatically if you are programming with the block method.\n\n <b>Usage:</b>\n\n Open a PhidgetDictionary using an address, port, and an optional password.\n  options = {:address => 'localhost', :port => 5001, :password => nil}\n  dict.open(options)\n\n Open a PhidgetDictionary using a server id, and an optional password.\n  options = {:server_id => 'localhost', :password => nil}\n  dict.open(options)\n @return [Boolean] returns true or raises an error", "Removes a set of keys from the dictionary\n\n @return [Boolean] returns true or raises an error", "Sets a server connect handler callback function. This is called when a connection to the server has been made.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     dict.on_connect do |obj|\n       puts 'Connected'\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a server disconnect handler callback function. This is called when a connection to the server has been lost.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     dict.on_disconnect do |obj|\n       puts 'Disconnected'\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Adds a key listener to an opened dictionary. Note that this should only be called after the connection has been made - unlike all other events.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     dict.on_change do |obj, key, val, reason|\n       puts \"Every key: #{key} => #{val}-- #{reason}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Removes a key listener\n @param [String] pattern pattern\n @return [Boolean] returns true or raises an error", "Return fetched date\n @param key [String]\n @return [String]", "Perform an action request against the Pinboard API\n\n @param [String] path\n   the path to fetch from, relative to from the base Pinboard API URL\n\n @param [Hash] params\n   query parameters to append to the URL\n\n @return [Hash] the response parsed from the JSON\n\n @raise [RateLimitError] if the response is rate-limited\n @raise [ResultError] if the result code isn't \"done\"\n\n @api private\n @see https://pinboard.in/api/#errors", "Perform a REST POST operation against the specified endpoint with the\n given data body\n\n @param [String] endpoint REST endpoint to use\n @param [String] body JSON data body to post\n @param [Hash] headers Optional headers to use in request\n @return [String] JSON response body", "Sets a raw data handler callback function. This is called whenever a new IR data is available.  Data is in the form of an array of microsecond pulse values. This can be used if the user wishes to do their own data decoding, or for codes that the PhidgetIR cannot automatically recognize.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n   ir.on_raw_data do |device, raw_data, data_length, obj|\n\t    puts \"Raw data: #{raw_data}, length: #{data_length}\"\n   end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a code handler callback function. This is called whenever a new code is recognized.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n   ir.on_code do |device, data, data_length, bit_count, repeat, obj|\n\t    puts \"Code #{data} received, length: #{data_length}, bit count: #{bit_count}, repeat: #{repeat}\"\n   end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a learn handler callback function. This is called when a new code has been learned. This generally requires the button to be held down for a second or two.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n   ir.on_learn do |device, data, data_length, code_info, obj|\n     puts \"Code #{data} learnt\"\n   end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Transmits a code\n @param [Array<String>] data data to send\n @param [IR_code_info] code_info code info structure specifying the attributes of the code to send. Anything that is not set is set to default.\n @return [Boolean] returns true if the code was successfully transmitted, or raises an error.", "Transmits raw data as a series of pulses and spaces.\n @param [Array] data data to send\n @param [Integer] length length of the data array\n @param [Integer] carrier_frequency carrier frequency in Hz. Leave as 0 for default\n @param [Integer] duty_cycle duty cycle(10-50). Leave as 0 for default\n @param [Integer] gap_time gap time in us. This guarantees a gap time(no transmitting) after the data is sent, but can be set to 0\n @return [Boolean] returns true if the raw data was successfully transmitted, or raises an error.", "Gets the last code that was received.\n @return [Array<String>] returns the last code, or raises an error.\n @return [Integer] returns the data length, or raises an error.\n @return [Object] returns the bit count, or raises an error.", "Gets the last code that was learned.\n @return [Array<String>] returns the last learned code, or raises an error.\n @return [Integer] returns the data length, or raises an error.\n @return [IR_code_info] returns the code info structure for the learned code, or raises an error.", "Publish a message to the designated exchange.\n\n @param [String] exname The exchange name\n @param [String] message Message body to be sent\n @param [Hash] opts Options with the message.\n    :key => 'keyname'\n @return [void]\n\n @example Want to broadcast the data to all bound queues:\n  publish_to('topic exchange', 'data', :key=>'*')\n @example Want to send the data to the specific queue(s):\n  publish_to('exchange name', 'group.1', 'data')", "Get an array of the names of all the required input parameters\n @return [Hash] Hash of WorkflowParameter input parameters which\n   are required for this workflow", "Get the parameter object named. If a value is provided, set the value\n and return the parameter object.\n\n To get a parameter value, use parameter(parameter_name).value\n\n @param [String] parameter_name Name of the parameter to get\n @param [Object, nil] parameter_value Optional value for parameter.\n @return [VcoWorkflows::WorkflowParameter] The resulting WorkflowParameter", "Execute this workflow\n @param [VcoWorkflows::WorkflowService] workflow_service\n @return [String] Workflow Execution ID", "Return logs for the given execution\n @param [String] execution_id optional execution id to get logs for\n @return [VcoWorkflows::WorkflowExecutionLog]", "Convert the input parameters to a JSON document\n @return [String]", "Verify that all mandatory input parameters have values", "Return the IP address assigned to default gw interface", "Initialize a Notes\n\n @param [Client] client\n   client to communicate with the Pinboard API\n\n @api private\n List of summaries of the user's notes\n\n @example\n   summaries = notes.list\n\n @return [Array<NoteSummary>]\n\n @api public\n\n @see https://pinboard.in/api/#notes_list", "Fetch one or more bookmarks\n\n @example\n   bookmarks = posts.get(tag: ['one', 'two', 'three'])\n\n @param [Hash] options\n   options to filter the results by\n @option options [Array<String>] :tag\n   up to three tags to filter by\n @option options [Time] :dt\n   which day the results were bookmarked\n @option options [String] :url\n   the URL for this bookmark\n @option options [Boolean] :meta\n   if true, include the change detection signature in the results\n\n @return [Array<Post>]\n\n @api public\n\n @see https://pinboard.in/api/#posts_get", "List the most recent bookmarks\n\n @example\n   bookmarks = posts.recent(tag: ['one', 'two', 'three'], count: 25)\n\n @param [Hash] options\n   options to filter the results by\n @option options [Array<String>] :tag\n   up to three tags to filter by\n @option options [Integer] :count\n   the number of results to return\n\n @return [Array<Post>]\n\n @api public\n\n @see https://pinboard.in/api/#posts_recent", "List all bookmarks\n\n @example\n   posts.all(todt: yesterday, meta: true, tag: ['one', 'two', 'three'])\n\n @param [Hash] options\n   options to filter the results by\n @option options [Array<String>] :tag\n   up to three tags to filter by\n @option options [Array<String>] :start\n   an offset value\n @option options [Array<String>] :results\n   number of results to return\n @option options [Time] :fromdt\n   limit results to those created after this time\n @option options [Time] :todt\n   limit results to those created before this time\n @option options [Boolean] :meta\n   if true, include the change detection signature in the results\n\n @return [Array<Post>]\n\n @api public\n\n @see https://pinboard.in/api/#posts_all", "List popular and recommended tags for a URL\n\n @example\n   suggestion = posts.suggest(url)\n\n @param [String] url\n   URL to fetch suggested tags for\n\n Returns a Hash with two entries, :popular is a list of popular tags,\n :recommended is a list of recommended tags.\n\n @return [Array<Suggestion>]\n\n @api public\n\n @see https://pinboard.in/api/#posts_suggest", "List dates with the number of bookmarks created on each\n\n @example\n   dates = posts.dates(tag: ['one', 'two', 'three'])\n\n @param [Hash] options\n   options to filter the results by\n @option options [Array<String>] :tag\n   up to three tags to filter by\n\n @return [Hash{Date => Integer}]\n   dates on which bookmarks were created associated with the number of\n   bookmarks created on that date\n\n @api public\n\n @see https://pinboard.in/api/#posts_dates", "Create Post objects from posts response\n\n @return [Array<Post>]\n\n @api private", "Create Hash of dates to counts from dates response\n\n @return [Hash{Date => Integer}]\n\n @api private", "Sets a position change handler callback function. This is called when a the servo position has changed.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     servo.on_position_change do |motor, position, obj|\n       puts \"Moving servo #{motor.index} to #{position}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets an position fix status change handler callback function. This is called when the position fix status changes.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     gps.on_position_fix_status_change do |device, fix_status, obj|\n       puts \"Position fix status changed to: #{fix_status}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets position change handler callback function. This is called when the latitude, longitude, or altitude changes.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     gps.on_position_change do |device, lat, long, alt, obj|\n       puts \"Latitude: #{lat} degrees, longitude: #{long} degrees, altitude: #{alt} m\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "Sets a temperature change handler callback function. This is called when when the temperature has changed atleast by the sensitivity value that has been set.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     temp.on_temperature_change do |device, input, temperature, obj|\n       puts \"Input #{input.index}'s temperature changed to #{temperature}\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "USed to check if auth is done properly before making calls", "Issue request and get response", "Initialize a Tags\n\n @param [Client] client\n   client to communicate with the Pinboard API\n\n @api private\n List tags with their counts\n\n @example\n   tag_counts = tags.get\n\n @return [Hash{String => Integer}]\n   tags associated with the number of times they have been used\n\n @api public\n\n @see https://pinboard.in/api/#tags_get", "Delete a tag\n\n @example\n   tags.delete(tag)\n\n @param [String] tag\n   the tag to delete\n\n @return [self]\n\n @api public\n\n @see https://pinboard.in/api/#tags_delete", "Rename a tag\n\n @example\n   tags.rename(old, new)\n\n @param [String] old\n   the tag to be renamed\n @param [String] new\n   the new name for the tag\n\n @return [self]\n\n @api public\n\n @see https://pinboard.in/api/#tags_rename", "Change privileges of the process\n to the specified user and group.", "Return a JSON document for this object", "Sets a sensor change handler callback function. This is called when a sensor on the PhidgetInterfaceKit has changed by at least the sensitivity value that has been set for this input.\n\n @param [String] obj Object to pass to the callback function. This is optional.\n @param [Proc] Block When the callback is executed, the device and object are yielded to this block.\n @example\n     ifkit.on_sensor_change do |device, input, value, obj|\n       print \"Analog Input  #{input.index}, changed to #{value}\\n\"\n     end\n As this runs in it's own thread, be sure that all errors are properly handled or the thread will halt and not fire any more.\n @return [Boolean] returns true or raises an error", "downloads a given file into a specified filename.\n If block is given returns download progress", "Returns an HTML image tag for the record. If no size is given, it will\n render at the original size.\n\n ==== Options\n * <tt>:alt</tt>: If no alt text is given, it will default to the\n   filename of the uploaded image.\n\n See +dynamic_image_url+ for info on how to size and cropping. Options\n supported by +polymorphic_url+ will be passed to the router. Any other\n options will be added as HTML attributes.\n\n ==== Examples\n\n   image = Image.find(params[:id])\n   dynamic_image_tag(image)\n   # => <img alt=\"My file\" height=\"200\" src=\"...\" width=\"320\" />\n   dynamic_image_tag(image, size: \"100x100\", alt=\"Avatar\")\n   # => <img alt=\"Avatar\" height=\"62\" src=\"...\" width=\"100\" />", "This method should be called each time a user performs an\n action while authenticated with this session.", "Sets the cookie on the associated controller.", "Check the security of the session to ensure it can be used.", "Mark this session as invalid", "Note that we have just seen the user enter their password.", "Mark this request as two factor authoritsed", "Revert back to the parent session", "Lints the globbed markdown files. Will fail if `proselint` cannot be installed correctly.\n Generates a `markdown` list of warnings for the prose in a corpus of .markdown and .md files.\n\n @param   [String] files\n          A globbed string which should return the files that you want to lint, defaults to nil.\n          if nil, modified and added files from the diff will be used.\n @return  [void]", "Creates a temporary proselint settings file\n @return  void", "Sets up some instance variables on new instance.\n\n pdf - the pdf this page belongs to\n index - the index of the page in the array of pages\n options - A Hash of options.\n           :pdftotext_path - The String path of where to find the pdftotext\n                             binary to use when extracting text\n                             (default: \"pdftotext\").\n\n Extracts the selected page and turns it into an image.\n Tested on png and jpeg.\n\n path - String of the path to save to\n options - Hash of options to customize the saving of the image\n           (ie: width, density, and quality)\n\n For example:\n\n   pdf[1].save(/path/to/save/image.png)\n   # => true\n\n Returns a File.", "Find the .app folder which contains both the \"embedded.mobileprovision\"\n  and \"Info.plist\" files.", "Load a captcha raw content encoded in base64 from options.\n\n @param [Hash] options Options hash.\n @option options [String]  :url    URL of the image to be decoded.\n @option options [String]  :path   File path of the image to be decoded.\n @option options [File]    :file   File instance with image to be decoded.\n @option options [String]  :raw    Binary content of the image to be decoded.\n @option options [String]  :raw64  Binary content encoded in base64 of the image to be decoded.\n\n @return [String] The binary image base64 encoded.", "Retrieve information from an uploaded captcha.\n\n @param [Integer] captcha_id Numeric ID of the captcha.\n\n @return [DeathByCaptcha::Captcha] The captcha object.", "Perform a Socket communication with the DeathByCaptcha API.\n\n @param [String] action  API method name.\n @param [Hash]   payload Data to be exchanged in the communication.\n\n @return [Hash] Response from the DeathByCaptcha API.", "Create a new socket connection with DeathByCaptcha API.\n This method is necessary because Ruby 1.9.7 doesn't support connection\n timeout and only Ruby 2.2.0 fixes a bug with unsafe sockets threads.\n\n In Ruby >= 2.2.0, this could be implemented as simply as:\n ::Socket.tcp(HOST, PORTS.sample, connect_timeout: 0)", "Perform an HTTP request to the DeathByCaptcha API.\n\n @param [String] action  API method name.\n @param [Symbol] method  HTTP method (:get, :post, :post_multipart).\n @param [Hash]   payload Data to be sent through the HTTP request.\n\n @return [Hash] Response from the DeathByCaptcha API.", "Create Message from Info Entered", "Put Togther Messange", "Sends input to the slave process STDIN.\n\n Returns immediately.", "Gets the pending output of the process.\n\n The pending output is read in an non blocking way by chunks, in the size\n of +chunk_len+. By default, +chunk_len+ is 49152 bytes.\n\n Returns +nil+, if there is no pending output at the moment. Otherwise,\n returns the output that hasn't been read since the last invocation.\n\n Raises Errno:EIO on closed output stream. This can happen if the\n underlying process exits.", "Flatten a hash containing nested hashes and arrays to a non-nested array\n of key-value pairs.\n\n Examples:\n\n   flatten_params(a: 'b')\n   # => [['a', 'b']]\n\n   flatten_params(a: ['b', 'c'])\n   # => [['a[]', 'b'], ['a[]', 'c']]\n\n   flatten_params(a: {b: 'c'})\n   # => [['a[b]', 'c']]\n\n @param [Hash] obj the hash to flatten\n @return [Array] an array of key-value pairs (arrays of two strings)", "Format a Time object according to ISO 8601, and convert to UTC.\n\n @param [Time] time the time object to format\n @return [String] the ISO-formatted time", "Recursively ISO format all time and date values.\n\n @param [Hash] obj the object containing date or time objects\n @return [Hash] the object with ISO-formatted time stings", "Fetch and return a single page.", "Fetch and yield each page of results.", "Generate the OAuth authorize url\n\n @param [Hash] options parameters to be included in the url.\n   +:redirect_uri+ is required.\n @return [String] the authorize url", "Exchange the authorization code for an access token\n\n @param [String] auth_code to exchange for the access_token\n @return [String] the access_token required to make API calls to resources", "Set the client's access token\n\n @param [String] token a string with format <code>\"#{token}\"</code>\n   (as returned by {#access_token})", "Pull the merchant id out of the access scope", "Send a request to the GoCardless API servers\n\n @param [Symbol] method the HTTP method to use (e.g. +:get+, +:post+)\n @param [String] path the path fragment of the URL\n @option [Hash] opts query string parameters", "Prepare a Hash of parameters for signing. Presence of required\n parameters is checked and the others are discarded.\n\n @param [Hash] params the parameters to be prepared for signing\n @return [Hash] the prepared parameters", "Generate the URL for creating a limit of type +type+, including the\n provided params, nonce, timestamp and signature\n\n @param [Symbol] type the limit type (+:subscription+, etc)\n @param [Hash] params the bill parameters\n @return [String] the generated URL", "The chain contains the return values of the executed callbacks.\n\n Example:\n\n   class Person\n     define_hook :before_eating\n\n     before_eating :wash_hands\n     before_eating :locate_food\n     before_eating :sit_down\n\n     def wash_hands; :washed_hands; end\n     def locate_food; :located_food; false; end\n     def sit_down; :sat_down; end\n   end\n\n   result = person.run_hook(:before_eating)\n   result.chain #=> [:washed_hands, false, :sat_down]\n\n If <tt>:halts_on_falsey</tt> is enabled:\n\n   class Person\n     define_hook :before_eating, :halts_on_falsey => true\n     # ...\n   end\n\n   result = person.run_hook(:before_eating)\n   result.chain #=> [:washed_hands]", "Check if command can be run\n\n @return [Boolean]\n\n @api public", "removes the spy from the records\n @param spy [Constant]\n @return [self]", "set what object and method the spy should watch\n @param object\n @param method_name <Symbol>\n @param singleton_method <Boolean> spy on the singleton method or the normal method\n hooks the method into the object and stashes original method if it exists\n @param [Hash] opts what do do when hooking into a method\n @option opts [Boolean] force (false) if set to true will hook the method even if it doesn't exist\n @option opts [Symbol<:public, :protected, :private>] visibility overrides visibility with whatever method is given\n @return [self]", "unhooks method from object\n @return [self]", "Tells the object to yield one or more args to a block when the message is received.\n @return [self]", "tells the spy to call the original method\n @return [self]", "check if the method was called with the exact arguments\n @param args Arguments that should have been sent to the method\n @return [Boolean]", "invoke that the method has been called. You really shouldn't use this\n method.", "Record that a spy was initialized and hooked\n @param spy [Subroutine, Constant, Double]\n @return [spy]", "stashes the original constant then overwrites it with nil\n @param opts [Hash{force => false}] set :force => true if you want it to ignore if the constant exists\n @return [self]", "restores the original value of the constant or unsets it if it was unset\n @return [self]", "returns the original class method if the current method is a mock_method\n @param method_name [Symbol, String]\n @return [Method]", "adds two methods to the screen object - one to set text in a text field,\n another to retrieve text from a text field.\n\n @example\n   text_field(:first_name, 23,45,20)\n   # will generate 'first_name', 'first_name=' method\n\n @param  [String] the name used for the generated methods\n @param [FixedNum] row number of the location\n @param [FixedNum] column number of the location\n @param [FixedNum] length of the text field\n @param [true|false] editable is by default true", "This method will populate all matched screen text fields from the\n Hash passed as an argument.  The way it find an element is by\n matching the Hash key to the name you provided when declaring\n the text field on your screen.\n\n @example\n   class ExampleScreen\n     include TE3270\n\n     text_field(:username, 1, 2, 20)\n   end\n\n   ...\n\n   @emulator = TE3270::emulator_for :quick3270\n   example_screen = ExampleScreen.new(@emulator)\n   example_screen.populate_screen_with :username => 'a name'\n\n @param [Hash] hsh the data to use to populate this screen.", "Returns the number of the specific +frame_type+.", "Appends the frames in the other Frames into the tail of self.\n It is destructive like Array does.", "Returns the new Frames as a +times+ times repeated concatenation\n of the original Frames.", "Returns the Frame object at the given index or\n returns new Frames object that sliced with the given index and length\n or with the Range.\n Just like Array.", "Returns one Frame object at the given index.", "Appends the given Frame into the tail of self.", "Inserts the given Frame objects into the given index.", "Mutates keyframes into deltaframes at given range, or all.", "Glitches each frame data.\n It is a convenient method to iterate each frame.\n\n The argument +target+ takes symbols listed below:\n [<tt>:keyframe</tt> or <tt>:iframe</tt>]   select video key frames (aka I-frame)\n [<tt>:deltaframe</tt> or <tt>:pframe</tt>] select video delta frames (difference frames)\n [<tt>:videoframe</tt>] select both of keyframe and deltaframe\n [<tt>:audioframe</tt>] select audio frames\n [<tt>:all</tt>]        select all frames\n\n It also requires a block. In the block, you take the frame data\n as a String parameter.\n To modify the data, simply return a modified data.\n Without a block it returns Enumerator, with a block it returns +self+.", "Do glitch with index.", "Check if it has keyframes.", "Swaps the frames with other Frames data.", "Check if file is binary\n\n @param [String, Pathname] relative_path\n   the path to file to check\n\n @example\n   binary?('Gemfile') # => false\n\n @example\n   binary?('image.jpg') # => true\n\n @return [Boolean]\n   Returns `true` if the file is binary, `false` otherwise\n\n @api public", "Create checksum for a file, io or string objects\n\n @param [File, IO, String, Pathname] source\n   the source to generate checksum for\n @param [String] mode\n @param [Hash[Symbol]] options\n @option options [String] :noop\n   No operation\n\n @example\n   checksum_file('/path/to/file')\n\n @example\n   checksum_file('Some string content', 'md5')\n\n @return [String]\n   the generated hex value\n\n @api public", "Change file permissions\n\n @param [String, Pathname] relative_path\n @param [Integer,String] permisssions\n @param [Hash[Symbol]] options\n @option options [Symbol] :noop\n @option options [Symbol] :verbose\n @option options [Symbol] :force\n\n @example\n   chmod('Gemfile', 0755)\n\n @example\n   chmod('Gemilfe', TTY::File::U_R | TTY::File::U_W)\n\n @example\n   chmod('Gemfile', 'u+x,g+x')\n\n @api public", "Create directory structure\n\n @param [String, Pathname, Hash] destination\n   the path or data structure describing directory tree\n\n @example\n   create_directory('/path/to/dir')\n\n @example\n   tree =\n     'app' => [\n       'README.md',\n       ['Gemfile', \"gem 'tty-file'\"],\n       'lib' => [\n         'cli.rb',\n         ['file_utils.rb', \"require 'tty-file'\"]\n       ]\n       'spec' => []\n     ]\n\n   create_directory(tree)\n\n @return [void]\n\n @api public", "Create new file if doesn't exist\n\n @param [String, Pathname] relative_path\n @param [String|nil] content\n   the content to add to file\n @param [Hash] options\n @option options [Symbol] :force\n   forces ovewrite if conflict present\n\n @example\n   create_file('doc/README.md', '# Title header')\n\n @example\n   create_file 'doc/README.md' do\n     '# Title Header'\n   end\n\n @api public", "Copy file from the relative source to the relative\n destination running it through ERB.\n\n @example\n   copy_file 'templates/test.rb', 'app/test.rb'\n\n @example\n   vars = OpenStruct.new\n   vars[:name] = 'foo'\n   copy_file 'templates/%name%.rb', 'app/%name%.rb', context: vars\n\n @param [String, Pathname] source_path\n @param [Hash] options\n @option options [Symbol] :context\n   the binding to use for the template\n @option options [Symbol] :preserve\n   If true, the owner, group, permissions and modified time\n   are preserved on the copied file, defaults to false.\n @option options [Symbol] :noop\n   If true do not execute the action.\n @option options [Symbol] :verbose\n   If true log the action status to stdout\n\n @api public", "Copy file metadata\n\n @param [String] src_path\n   the source file path\n @param [String] dest_path\n   the destination file path\n\n @api public", "Copy directory recursively from source to destination path\n\n Any files names wrapped within % sign will be expanded by\n executing corresponding method and inserting its value.\n Assuming the following directory structure:\n\n  app/\n    %name%.rb\n    command.rb.erb\n    README.md\n\n  Invoking:\n    copy_directory(\"app\", \"new_app\")\n  The following directory structure should be created where\n  name resolves to 'cli' value:\n\n  new_app/\n    cli.rb\n    command.rb\n    README\n\n @param [String, Pathname] source_path\n @param [Hash[Symbol]] options\n @option options [Symbol] :preserve\n   If true, the owner, group, permissions and modified time\n   are preserved on the copied file, defaults to false.\n @option options [Symbol] :recursive\n   If false, copies only top level files, defaults to true.\n @option options [Symbol] :exclude\n   A regex that specifies files to ignore when copying.\n\n @example\n   copy_directory(\"app\", \"new_app\", recursive: false)\n   copy_directory(\"app\", \"new_app\", exclude: /docs/)\n\n @api public", "Diff files line by line\n\n @param [String, Pathname] path_a\n @param [String, Pathname] path_b\n @param [Hash[Symbol]] options\n @option options [Symbol] :format\n   the diffining output format\n @option options [Symbol] :context_lines\n   the number of extra lines for the context\n @option options [Symbol] :threshold\n   maximum file size in bytes\n\n @example\n   diff(file_a, file_b, format: :old)\n\n @api public", "Download the content from a given address and\n save at the given relative destination. If block\n is provided in place of destination, the content of\n of the uri is yielded.\n\n @param [String, Pathname] uri\n   the URI address\n @param [String, Pathname] dest\n   the relative path to save\n @param [Hash[Symbol]] options\n @param options [Symbol] :limit\n   the limit of redirects\n\n @example\n   download_file(\"https://gist.github.com/4701967\",\n                 \"doc/benchmarks\")\n\n @example\n   download_file(\"https://gist.github.com/4701967\") do |content|\n     content.gsub(\"\\n\", \" \")\n   end\n\n @api public", "Prepend to a file\n\n @param [String, Pathname] relative_path\n @param [Array[String]] content\n   the content to preped to file\n\n @example\n   prepend_to_file('Gemfile', \"gem 'tty'\")\n\n @example\n   prepend_to_file('Gemfile') do\n     \"gem 'tty'\"\n   end\n\n @api public", "Append to a file\n\n @param [String, Pathname] relative_path\n @param [Array[String]] content\n   the content to append to file\n\n @example\n   append_to_file('Gemfile', \"gem 'tty'\")\n\n @example\n   append_to_file('Gemfile') do\n     \"gem 'tty'\"\n   end\n\n @api public", "Safely append to file checking if content is not already present\n\n @api public", "Remove a file or a directory at specified relative path.\n\n @param [String, Pathname] relative_path\n @param [Hash[:Symbol]] options\n @option options [Symbol] :noop\n   pretend removing file\n @option options [Symbol] :force\n   remove file ignoring errors\n @option options [Symbol] :verbose\n   log status\n @option options [Symbol] :secure\n   for secure removing\n\n @example\n   remove_file 'doc/README.md'\n\n @api public", "Provide the last number of lines from a file\n\n @param [String, Pathname] relative_path\n   the relative path to a file\n\n @param [Integer] num_lines\n   the number of lines to return from file\n\n @example\n   tail_file 'filename'\n   # =>  ['line 19', 'line20', ... ]\n\n @example\n   tail_file 'filename', 15\n   # =>  ['line 19', 'line20', ... ]\n\n @return [Array[String]]\n\n @api public", "Log file operation\n\n @api private", "If content is not a path to a file, create a\n tempfile and open it instead.\n\n @param [String] object\n   a path to file or content\n\n @api private", "Loads the lazy relationships.\n\n **This method should only be called internally.**", "Restore a snapshot. This will restore this snapshot's virtual machine\n to the state that this snapshot represents. This method will block while\n the restore occurs.\n\n If a block is given to the function, it will be yielded with a progress\n object which can be used to track the progress of the operation.", "Destroy a snapshot. This will physically remove the snapshot. Once this\n method is called, there is no undo. If this snapshot is a parent of other\n snapshots, the differencing image of this snapshot will be merged with\n the child snapshots so no data is lost. This process can sometimes take\n some time. This method will block while this process occurs.\n\n If a block is given to the function, it will be yielded with a progress\n object which can be used to track the progress of the operation.", "Validates the virtual machine", "Returns the root snapshot of this virtual machine. This root snapshot\n can be used to traverse the tree of snapshots.\n\n @return [Snapshot]", "Find a snapshot by name or UUID. This allows you to find a snapshot by a given\n name, rather than having to resort to traversing the entire tree structure\n manually.", "Opens a direct session with the machine this VM represents and yields\n the session object to a block. Many of the VirtualBox's settings can only\n be modified with an open session on a machine. An open session is similar\n to a write-lock. Once the session is completed, it must be closed, which\n this method does as well.", "Exports a virtual machine. The virtual machine will be exported\n to the specified OVF file name. This directory will also have the\n `mf` file which contains the file checksums and also the virtual\n drives of the machine.\n\n Export also supports an additional options hash which can contain\n information that will be embedded with the virtual machine. View\n below for more information on the available options.\n\n This method will block until the export is complete, which takes about\n 60 to 90 seconds on my 2.2 GHz 2009 model MacBook Pro.\n\n If a block is given to the method, then it will be yielded with the\n progress of the operation.\n\n @param [String] filename The file (not directory) to save the exported\n   OVF file. This directory will also receive the checksum file and\n   virtual disks.", "Take a snapshot of the current state of the machine. This method can be\n called while the VM is running and also while it is powered off. This\n method will block while the snapshot is being taken.\n\n If a block is given to this method, it will yield with a progress\n object which can be used to get the progress of the operation.\n\n @param [String] name Name of the snapshot.\n @param [String] description Description of the snapshot.", "Loads the boot order for this virtual machine. This method should\n never be called directly. Instead, use the `boot_order` attribute\n to read and modify the boot order.", "Sets the boot order for this virtual machine. This method should\n never be called directly. Instead, modify the `boot_order` array.", "Initializes this Appliance instance from a path to an OVF file. This sets\n up the relationships and so on.\n\n @param [String] path Path to the OVF file.", "Adds a VM to the appliance", "Saves extra data. This method does the same thing for both new\n and existing extra data, since virtualbox will overwrite old data or\n create it if it doesn't exist.\n\n @param [Boolean] raise_errors If true, {Exceptions::CommandFailedException}\n   will be raised if the command failed.\n @return [Boolean] True if command was successful, false otherwise.", "Initializes the attributes of an existing NAT engine.", "Gets the DHCP server associated with the network interface. Only\n host only network interfaces have dhcp servers. If a DHCP server\n doesn't exist for this network interface, one will be created.", "Gets the VMs which have an adapter which is attached to this\n network interface.", "Sets up the static IPV4 configuration for the host only network\n interface. This allows the caller to set the IPV4 address of the\n interface as well as the netmask.", "Removes the DHCP server.", "Returns the host network associated with this DHCP server, if it\n exists.", "Saves or creates a shared folder.", "Relationship callback when added to a collection. This is automatically\n called by any relationship collection when this object is added.", "Destroys the shared folder. This doesn't actually delete the folder\n from the host system. Instead, it simply removes the mapping to the\n virtual machine, meaning it will no longer be possible to mount it\n from within the virtual machine.", "Returns the errors for a model.", "Validates the model and relationships.", "Saves the model attributes and relationships.\n\n The method can be passed any arbitrary arguments, which are\n implementation specific (see {VM#save}, which does this).", "Retrieves the device for the forwarded port. This tries to \"do the\n right thing\" depending on the first NIC of the VM parent by either\n setting the forwarded port type to \"pcnet\" or \"e1000.\" If the device\n was already set manually, this method will simply return that value\n instead.\n\n @return [String] Device type for the forwarded port", "Applies a function to every snapshot.", "Validates a hard drive for the minimum attributes required to\n create or save.", "Clone hard drive, possibly also converting formats. All formats\n supported by your local VirtualBox installation are supported\n here. If no format is specified, the systems default will be used.\n\n @param [String] outputfile The output file. This can be a full path\n   or just a filename. If its just a filename, it will be placed in\n   the default hard drives directory. Should not be present already.\n @param [String] format The format to convert to. If not present, the\n   systems default will be used.\n @return [HardDrive] The new, cloned hard drive, or nil on failure.\n Creates a new hard drive.\n\n **This method should NEVER be called. Call {#save} instead.**\n\n @return [Boolean] True if command was successful, false otherwise.", "Saves the hard drive object. If the hard drive is new,\n this will create a new hard drive. Otherwise, it will\n save any other details about the existing hard drive.\n\n Currently, **saving existing hard drives does nothing**.\n This is a limitation of VirtualBox, rather than the library itself.\n\n @return [Boolean] True if command was successful, false otherwise.", "Initializes the attributes of an existing shared folder.", "Gets the host interface object associated with the class if it\n exists.", "Gets the bridged interface object associated with the class if it\n exists.", "Opens a session, yields the adapter and then saves the machine at\n the end", "Add some html code to the body tag ready for testing. This will\n be added before each test, then removed after each test. It is\n convenient for adding html setup quickly. The code is wrapped\n inside a div, which is directly inside the body element.\n\n     describe \"DOM feature\" do\n       html <<-HTML\n         <div id=\"foo\"></div>\n       HTML\n\n       it \"foo should exist\" do\n         Document[\"#foo\"]\n       end\n     end\n\n @param [String] html_string html content to add", "Returns true if this is an output script wrapped in a versioned pushdata for segwit softfork.", "Returns `true` if this script may be a valid OpenAssets marker.\n Only checks the prefix and minimal length, does not validate the content.\n Use this method to quickly filter out non-asset transactions.", "Returns a dummy script matching this script on the input with\n the same size as an intended signature script.\n Only a few standard script types are supported.\n Set `strict` to false to allow imprecise guess for P2SH script.\n Returns nil if could not determine a matching script.", "Appends a pushdata opcode with the most compact encoding.\n Optional opcode may be equal to OP_PUSHDATA1, OP_PUSHDATA2, or OP_PUSHDATA4.\n ArgumentError is raised if opcode does not represent a given data length.", "Removes all occurences of opcode. Typically it's OP_CODESEPARATOR.", "Removes all occurences of a given pushdata.", "Removes chunks matching subscript byte-for-byte and returns a new script instance with subscript removed.\n So if pushdata items are encoded differently, they won't match.\n Consensus-critical code.", "Returns total length read", "Converts binary string into its Base58 representation.\n If string is empty returns an empty string.\n If string is nil raises ArgumentError", "Converts binary string into its Base58 representation.\n If string is empty returns an empty string.\n If string is nil raises ArgumentError.", "Helper to compute total fee for a given transaction.\n Simulates signatures to estimate final size.", "Returns formatted string for an amount in satoshis.", "Returns amount of satoshis parsed from a formatted string according to style attribute.", "Returns a list of asset transactions remaining to verify.\n Returns an empty array if verification succeeded and there is nothing more to verify.\n Returns `nil` if verification failed.", "Attempts to verify issues. Fetches parent transactions to determine AssetID.\n Returns `true` if verified all issue outputs.\n Returns `false` if previous tx defining AssetID is not found.", "Converts 32-bit compact representation to a 256-bit integer.\n int32 -> bigint", "Converts target integer to a binary 32-byte hash.\n bigint -> hash256", "For manual testing", "Returns OP_1NEGATE, OP_0 .. OP_16 for ints from -1 to 16.\n Returns OP_INVALIDOPCODE for other ints.", "Begins recording of series of messages and returns all recorded events.\n If there is no record block on any level, messages are not accumulated,\n but only last_message is updated.\n Returns a list of all recorded messages.", "Adds a diagnostic message.\n Use it to record warnings and reasons for errors.\n Do not use when the input is nil - code that have produced that nil\n could have already recorded a specific message for that.", "Converts binary string as a private key to a WIF Base58 format.", "Transforms M 17-byte binary strings into original secret 16-byte binary string.\n Each share string must be well-formed.", "Adds an issuance of some assets.\n If `script` is specified, it is used to create an intermediate base transaction.\n If `output` is specified, it must be a valid spendable output with `transaction_id` and `index`.\n   It can be regular TransactionOutput or verified AssetTransactionOutput.\n `amount` must be > 0 - number of units to be issued", "Adds a normal payment output. Typically used for transfer", "Returns `false` if failed to execute the opcode.", "Initializes transaction input with its attributes. Every attribute has a valid default value.", "Initializes transaction with its attributes. Every attribute has a valid default value.", "Adds another input to the transaction.", "Converts hexadecimal string to a binary data string.", "Returns a pair of private key, public key", "extract private key from uncompressed DER format", "Returns data from bignum", "read_varint\n Encodes integer and returns its binary varint representation.", "Encodes integer and returns its binary varint representation.\n If data is given, appends to a data.\n If stream is given, writes to a stream.", "Returns the binary representation of the var-length string.", "Writes variable-length string to a data buffer or IO stream.\n If data is given, appends to a data.\n If stream is given, writes to a stream.\n Returns the binary representation of the var-length string.", "Reads varint length prefix, then calls the block appropriate number of times to read the items.\n Returns an array of items.", "Encodes an unsigned integer using LEB128.", "Writes an unsigned integer encoded in LEB128 to a data buffer or a stream.\n Returns LEB128-encoded binary string.", "Finds all preferences, including defaults, for the current record.  If\n looking up custom group preferences, then this will include all default\n preferences within that particular group as well.\n\n == Examples\n\n A user with no stored values:\n\n   user = User.find(:first)\n   user.preferences\n   => {\"language\"=>\"English\", \"color\"=>nil}\n\n A user with stored values for a particular group:\n\n   user.preferred_color = 'red', :cars\n   user.preferences(:cars)\n   => {\"language=>\"English\", \"color\"=>\"red\"}", "Queries whether or not a value is present for the given preference.\n This is dependent on how the value is type-casted.\n\n == Examples\n\n   class User < ActiveRecord::Base\n     preference :color, :string, :default => 'red'\n   end\n\n   user = User.create\n   user.preferred(:color)              # => \"red\"\n   user.preferred?(:color)             # => true\n   user.preferred?(:color, 'cars')     # => true\n   user.preferred?(:color, Car.first)  # => true\n\n   user.write_preference(:color, nil)\n   user.preferred(:color)              # => nil\n   user.preferred?(:color)             # => false", "Gets the actual value stored for the given preference, or the default\n value if nothing is present.\n\n == Examples\n\n   class User < ActiveRecord::Base\n     preference :color, :string, :default => 'red'\n   end\n\n   user = User.create\n   user.preferred(:color)            # => \"red\"\n   user.preferred(:color, 'cars')    # => \"red\"\n   user.preferred(:color, Car.first) # => \"red\"\n\n   user.write_preference(:color, 'blue')\n   user.preferred(:color)            # => \"blue\"", "A map of the preferences that have changed in the current object.\n\n == Examples\n\n   user = User.find(:first)\n   user.preferred(:color)                      # => nil\n   user.preference_changes                     # => {}\n\n   user.write_preference(:color, 'red')\n   user.preference_changes                     # => {\"color\" => [nil, \"red\"]}\n   user.save\n   user.preference_changes                     # => {}\n\n   # Groups\n   user.preferred(:color, :car)                # => nil\n   user.preference_changes(:car)               # => {}\n   user.write_preference(:color, 'red', :car)\n   user.preference_changes(:car)               # => {\"color\" => [nil, \"red\"]}", "Gets the last saved value for the given preference", "Reverts any unsaved changes to the given preference", "Determines whether the old value is different from the new value for the\n given preference.  This will use the typecasted value to determine\n equality.", "Finds all stored preferences with the given attributes.  This will do a\n smart lookup by looking at the in-memory collection if it was eager-\n loaded.", "Retrieves an interface of the proxy object\n @param [String] intfname\n @return [ProxyObjectInterface]", "Defines a method on the interface from the Method descriptor _m_.", "Defines a signal or method based on the descriptor _m_.", "Defines a proxied method on the interface.", "Read a property.\n @param propname [String]", "Read all properties at once, as a hash.\n @return [Hash{String}]", "Connect to the bus and initialize the connection.", "Connect to a bus over tcp and initialize the connection.", "Connect to an abstract unix bus and initialize the connection.", "Add a parameter _val_ of type _type_ to the message.", "Marshall the message with its current set parameters and return\n it in a packet form.", "Unmarshall a packet contained in the buffer _buf_ and set the\n parameters of the message object according the data found in the\n buffer.\n @return [Array(Message,Integer)]\n   the detected message (self) and\n   the index pointer of the buffer where the message data ended.", "Make a new exception from ex, mark it as being caused by this message\n @api private", "Create a new unmarshaller for the given data _buffer_ and _endianness_.\n Unmarshall the buffer for a given _signature_ and length _len_.\n Return an array of unmarshalled objects", "Align the pointer index on a byte index of _a_, where a\n must be 1, 2, 4 or 8.", "Retrieve the next _nbytes_ number of bytes from the buffer.", "Read the string length and string itself from the buffer.\n Return the string.", "Read the signature length and signature itself from the buffer.\n Return the signature.", "Create a new marshaller, setting the current packet to the\n empty packet.\n Round _n_ up to the specified power of two, _a_", "Append the array type _type_ to the packet and allow for appending\n the child elements.", "Retrieves an object at the given _path_\n whose methods always return an array.\n @return [ProxyObject]", "Get the object node corresponding to the given _path_. if _create_ is\n true, the the nodes in the path are created if they do not already exist.", "Perform a recursive retrospection on the given current _node_\n on the given _path_.", "Create a new node with a given _name_.\n Return an XML string representation of the node.\n It is shallow, not recursing into subnodes", "Tell a bus to register itself on the glib main loop", "Attempt to request a service _name_.\n\n FIXME, NameRequestError cannot really be rescued as it will be raised\n when dispatching a later call. Rework the API to better match the spec.\n @return [Service]", "Set up a ProxyObject for the bus itself, since the bus is introspectable.\n @return [ProxyObject] that always returns an array\n   ({DBus::ApiOptions#proxy_method_returns_array})\n Returns the object.", "Asks bus to send us messages matching mr, and execute slot when\n received", "Send a hello messages to the bus to let it know we are here.", "Run the main loop. This is a blocking call!", "Performs the authentication.", "decode hex to plain", "Create a new authentication client.\n Start the authentication process.", "Try authentication using the next authenticator.", "Creates a new interface with a given _name_.\n Validates a service _name_.", "Helper method for defining a method _m_.", "Defines a method with name _id_ and a given _prototype_ in the\n interface.", "Add parameter types by parsing the given _prototype_.", "Return an XML string representation of the method interface elment.", "Add parameter types based on the given _prototype_.", "Return an XML string representation of the signal interface elment.", "Parses a match rule string _s_ and sets the filters on the object.", "Sets the match rule to filter for the given _signal_ and the\n given interface _intf_.", "Determines whether a message _msg_ matches the match rule.", "Button class generates all the methods related to different operations that can be performed on the button.", "end of button class.\n Checkbox class generates all the methods related to different operations that can be performed on the check box on the screen.", "Text class generates all the methods related to different operations that can be performed on the text object on the screen.", "text_field class generates all the methods related to different operations that can be performed on the text_field object on the screen.", "Image class generates all the methods related to different operations that can be performed on the image object on the screen.", "table class generates all the methods related to different operations that can be performed on the table object on the screen.", "This function change value convertible to Bag into actual Bag.\n This trick enable deeply using all Bag functionalities and also\n ensures at the same time a deeply preventive copy since a new\n instance is created for this nested structure.\n\n In addition, it also transforms array elements of type Hash into\n Bag instance also. This enable indifferent access inside arrays\n also.\n\n @param value The value to convert to bag if necessary\n @return The converted value", "Use the issues api so specify the creator", "Returns forecasts for a collection of arbitrary points.\n\n @param latitudes_longitudes_times [Array] Triplets of latitude, longitude and time. Example: ['42.7','-73.6',1325607100,'42.0','-73.0',1325607791]\n @param option [Hash] (Optional) Options to be passed to the Typhoeus::Request", "Returns a list of interesting storms happening right now.\n\n @param option [Hash] (Optional) Options to be passed to the Typhoeus::Request", "Create a new shell.\n\n @api public\n @param config [Hash] The config of the shell.\n @option config [String] :config ('~/.rib/config.rb')\n   The path to Rib config file.\n @option config [String] :name ('rib')\n   The name of the shell. Used for Rib application.\n @option config [String] :result_prompt ('=> ')\n @option config [String] :prompt ('>> ')\n @option config [Binding, Object] :binding (new_private_binding)\n   The context of the shell. Could be an Object.\n @option config [Array<String>] :exit ([nil])\n   The keywords to exit the shell. `nil` means EOF (ctrl+d).\n @option config [Fixnum] :line (1) The beginning of line number.\n @option config [String] :history_file ('~/.rib/config/history.rb')\n   (Only if {Rib::History} plugin is used) The path to history file.\n @option config [Fixnum] :history_size (500)\n   (Only if {Rib::History} plugin is used) Maximum numbers of history.\n @option config [Hash<Class, Symbol>] :color (...)\n   (Only if {Rib::Color} plugin is used) Data type colors mapping.\n @option config [String] :autoindent_spaces ('  ')\n   (Only if {Rib::Autoindent} plugin is used) The indented string.\n Loops shell until user exits", "`less -F` can't cat the output, so we need to detect by ourselves.\n `less -X` would mess up the buffers, so it's not desired, either.", "Adapted from Rackup", "Loads a config file at config_path and evals it in the context of the @app.", "Output of grammar and rules", "Output up to the user-defined setup actions", "Create a single transaction or multiple transactions\n Creates a single transaction or multiple transactions.  If you provide a body containing a 'transaction' object, a single transaction will be created and if you provide a body containing a 'transactions' array, multiple transactions will be created.\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param data The transaction or transactions to create.  To create a single transaction you can specify a value for the &#39;transaction&#39; object and to create multiple transactions you can specify an array of &#39;transactions&#39;.  It is expected that you will only provide a value for one of these objects.\n @param [Hash] opts the optional parameters\n @return [SaveTransactionsResponse]", "Single transaction\n Returns a single transaction\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param transaction_id The id of the transaction\n @param [Hash] opts the optional parameters\n @return [TransactionResponse]", "List transactions\n Returns budget transactions\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param [Hash] opts the optional parameters\n @option opts [Date] :since_date If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30).\n @option opts [String] :type If specified, only transactions of the specified type will be included. &#39;uncategorized&#39; and &#39;unapproved&#39; are currently supported.\n @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.\n @return [TransactionsResponse]", "List account transactions\n Returns all transactions for a specified account\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param account_id The id of the account\n @param [Hash] opts the optional parameters\n @option opts [Date] :since_date If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30).\n @option opts [String] :type If specified, only transactions of the specified type will be included. &#39;uncategorized&#39; and &#39;unapproved&#39; are currently supported.\n @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.\n @return [TransactionsResponse]", "List category transactions\n Returns all transactions for a specified category\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param category_id The id of the category\n @param [Hash] opts the optional parameters\n @option opts [Date] :since_date If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30).\n @option opts [String] :type If specified, only transactions of the specified type will be included. &#39;uncategorized&#39; and &#39;unapproved&#39; are currently supported.\n @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.\n @return [HybridTransactionsResponse]", "List payee transactions\n Returns all transactions for a specified payee\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param payee_id The id of the payee\n @param [Hash] opts the optional parameters\n @option opts [Date] :since_date If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30).\n @option opts [String] :type If specified, only transactions of the specified type will be included. &#39;uncategorized&#39; and &#39;unapproved&#39; are currently supported.\n @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.\n @return [HybridTransactionsResponse]", "Updates an existing transaction\n Updates a transaction\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param transaction_id The id of the transaction\n @param data The transaction to update\n @param [Hash] opts the optional parameters\n @return [TransactionResponse]", "Update multiple transactions\n Updates multiple transactions, by 'id' or 'import_id'.\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param data The transactions to update.  Optionally, transaction &#39;id&#39; value(s) can be specified as null and an &#39;import_id&#39; value can be provided which will allow transaction(s) to updated by their import_id.\n @param [Hash] opts the optional parameters\n @return [SaveTransactionsResponse]", "Single account\n Returns a single account\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param account_id The id of the account\n @param [Hash] opts the optional parameters\n @return [AccountResponse]", "Account list\n Returns all accounts\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param [Hash] opts the optional parameters\n @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.\n @return [AccountsResponse]", "Single budget month\n Returns a single budget month\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param month The budget month in ISO format (e.g. 2016-12-01) (\\&quot;current\\&quot; can also be used to specify the current calendar month (UTC))\n @param [Hash] opts the optional parameters\n @return [MonthDetailResponse]", "List budget months\n Returns all budget months\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param [Hash] opts the optional parameters\n @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.\n @return [MonthSummariesResponse]", "PGN to string.", "Returns the PGN rappresenting the game.\n @return [String]", "Single payee location\n Returns a single payee location\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param payee_location_id id of payee location\n @param [Hash] opts the optional parameters\n @return [PayeeLocationResponse]", "List payee locations\n Returns all payee locations\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param [Hash] opts the optional parameters\n @return [PayeeLocationsResponse]", "List locations for a payee\n Returns all payee locations for the specified payee\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param payee_id id of payee\n @param [Hash] opts the optional parameters\n @return [PayeeLocationsResponse]", "Update a category for a specific month\n Update a category for a specific month\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param month The budget month in ISO format (e.g. 2016-12-01) (\\&quot;current\\&quot; can also be used to specify the current calendar month (UTC))\n @param category_id The id of the category\n @param data The category to update\n @param [Hash] opts the optional parameters\n @return [CategoryResponse]", "Single budget\n Returns a single budget with all related entities.  This resource is effectively a full budget export.\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param [Hash] opts the optional parameters\n @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.\n @return [BudgetDetailResponse]", "Budget Settings\n Returns settings for a budget\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param [Hash] opts the optional parameters\n @return [BudgetSettingsResponse]", "Single scheduled transaction\n Returns a single scheduled transaction\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param scheduled_transaction_id The id of the scheduled transaction\n @param [Hash] opts the optional parameters\n @return [ScheduledTransactionResponse]", "List scheduled transactions\n Returns all scheduled transactions\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param [Hash] opts the optional parameters\n @return [ScheduledTransactionsResponse]", "Returns the next move calculated by Gnuchess.\n @return [String] Returns the short algebraic chess notation of the move.", "Single payee\n Returns single payee\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param payee_id The id of the payee\n @param [Hash] opts the optional parameters\n @return [PayeeResponse]", "List payees\n Returns all payees\n @param budget_id The id of the budget (\\&quot;last-used\\&quot; can also be used to specify the last used budget)\n @param [Hash] opts the optional parameters\n @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.\n @return [PayeesResponse]", "Defined to change uniqueness in Hash key\n Defined to change uniqueness in Hash key", "The block used in @table for new records", "Clear the database log and yield", "Compact the logfile to represent the in-memory state", "Open or reopen file", "Read new file content", "Return database dump as string", "Write data to output stream and advance @pos", "Block with file lock", "Open temporary file and pass it to the block", "Read database header from input stream\n @param [#read] input the input stream\n @return void", "Serialize record and return string\n @param [Array] record an array with [key, value] or [key] if the record is deleted\n @return [String] serialized record", "Deserialize records from buffer, and yield them.\n @param [String] buf the buffer to read from\n @yield [Array] blk deserialized record [key, value] or [key] if the record is deleted\n @return [Fixnum] number of records", "Dumps the URL query params into a URI query string.\n\n @return [String]\n   The URI query string.\n\n @since 1.0.0\n\n @api public", "Sets the query params of the URL.\n\n @param [String] query\n   The query string to parse.\n\n @return [String]\n   The given query string.\n\n @since 1.0.0\n\n @api public", "Builds a URI object from the URL.\n\n @return [URI::HTTP, URI::HTTPS]\n   The URI object created from the URL attributes.\n\n @since 1.0.0\n\n @api public", "Looks up all IP Addresses for the host name.\n\n @param [String] nameserver\n   The optional nameserver to query.\n\n @return [Array<IPAddress>]\n   The IP Addresses for the host name.\n\n @since 1.0.0\n\n @api public", "Adds an address to the campaign.\n\n @param [String] addr\n   The address that will be targeted.\n\n @return [Target]\n   The new target of the campaign.\n\n @raise [RuntimeError]\n   The given address could not be found.\n\n @since 1.0.0\n\n @api public", "Performs a reverse lookup on the IP address.\n\n @param [String] nameserver\n   Optional nameserver to query.\n\n @return [Array<HostName>]\n   The host-names associated with the IP Address.\n\n @since 1.0.0\n\n @api public", "Finds a cached script.\n\n @param [String] sub_path\n   The sub-path within the repository to search for.\n\n @return [Script::Path, nil]\n   The matching script path.\n\n @since 1.1.0\n\n @api private", "Updates the repository, reloads it's metadata and syncs the\n cached files of the repository.\n\n @yield [repo]\n   If a block is given, it will be passed after the repository has\n   been updated.\n\n @yieldparam [Repository] repo\n   The updated repository.\n\n @return [Repository]\n   The updated repository.\n\n @since 1.0.0\n\n @api private", "Deletes the contents of the repository.\n\n @yield [repo]\n   If a block is given, it will be passed the repository after it's\n   contents have been deleted.\n\n @yieldparam [Repository] repo\n   The deleted repository.\n\n @return [Repository]\n   The deleted repository.\n\n @since 1.0.0\n\n @api private", "Hashes the password.\n\n @param [Symbol, String] algorithm\n   The digest algorithm to use.\n\n @param [Hash] options\n   Additional options.\n\n @option options [String] :prepend_salt\n   The salt data to prepend to the password.\n\n @option options [String] :append_salt\n   The salt data to append to the password.\n\n @return [String]\n   The hex-digest of the hashed password.\n\n @raise [ArgumentError]\n   Unknown Digest algorithm.\n\n @example\n   pass = Password.new(:clear_text => 'secret')\n\n   pass.digest(:sha1)\n   # => \"e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4\"\n\n   pass.digest(:sha1, :prepend_salt => \"A\\x90\\x00\")\n   # => \"e2817656a48c49f24839ccf9295b389d8f985904\"\n\n   pass.digest(:sha1, :append_salt => \"BBBB\")\n   # => \"aa6ca21e446d425fc044bbb26e950a788444a5b8\"\n\n @since 1.0.0\n\n @api public", "Converts the MAC address to an Integer.\n\n @return [Integer]\n   The network representation of the MAC address.\n\n @since 1.0.0\n\n @api public", "Assign a path where plugins should be loaded from\n\n @param mixed path\n @param hash params\n @return void", "Initialize the dispatcher instance with a default timeout of 5s\n\n @return void\n\n Loop through all services and fire off the supported messages\n\n @param string method\n @return void", "message to slack\n\n @param [String] channel slack channel.\n   ex. #general\n @param [Hash] options Slack API Request Options\n  ex. https://api.slack.com/methods/chat.postMessage\n\n ex. message_to_slack(channel: '#general', options: {text: 'sample'})", "upload file to slack\n\n @param [String] channels slack channel\n   ex. #general, #hoge\n @param [Faraday::UploadIO] file upload file\n   ex. Faraday::UploadIO.new('/path/to/sample.jpg', 'image/jpg')\n @param [Hash] options", "Extract Multiple fields for record", "Performs the request, with mocking if requested", "Settings.defaults do |default|\n   default.server.host = 'host'\n   default.server.port = 80\n end", "Returns +true+ if +attribute+ is currently transitioning but not saved, otherwise +false+.\n\n You can specify origin and destination states using the +:from+ and +:to+\n options. If +attribute+ is an +ActiveRecord::Enum+, these may be\n specified as either symbol or their native enum value.\n\n  model = Model.new(status: :complete)\n  # => #<Model:0x007fa94844d088 @status=:complete>\n\n  model.status_transitioning?                            # => true\n  model.status_transitioning?(from: nil)                 # => true\n  model.status_transitioning?(to: :complete)             # => true\n  model.status_transitioning?(to: \"complete\")            # => true\n  model.status_transitioning?(from: nil, to: :complete)  # => true", "send a message now", "send a message asynchronously", "Add to the function_map by inspecting each service for the RPCs it provides.", "Build arguments to a func", "Request verification when the card is\n stored, using the merchant account id\n if one is provided", "For objects that have a relationship with termtaxonomies, this\n module can be mixed in and gives the ability to add a term\n directly to the model, rather than creating the relationship\n yourself. Used by Post and Link.", "Find an item based on it's id.", "Locks one UID from the pool, in a cross-process atomic manner\n @return [Integer]\n @raise [PoolTimeoutError] if no ID is available after retries", "Parses the output file and stores the values in the appropriate ivars\n @return [nil]", "Fuzzy search for a git repository by name\n Returns the full path to the repository.\n\n If name is nil return the pro base.", "prints a status list showing repos with\n unpushed commits or uncommitted changes", "returns a short status message for the repo", "Adds a shell function to the shell config files that\n allows easy directory changing.", "unserializes the cache file and returns\n the index object", "spins off a background process to update the cache file", "serialize the index to a cache file", "recursive walk in ruby", "Finds the base directory where repos are kept\n Checks the environment variable PRO_BASE and the\n file .proBase", "Sign the artifact and return the signature. Does not validation of the signature.\n\n false   Failure\n base64  Encoded signature", "Extract the signature from the manifest file and write it to file in native binary format.\n\n false     Unable to extract\n unsigned  Manifest shows that the artifact is not signed\n base64    Encoded signature", "Save the signature into the manifest file", "Extract & upload the public key to the s3 bucket for other users", "Install the public key. This is a potential avenue for exploit, if a\n machine is being built for the first time, it has no existing trust of\n the GPG key, other than transit encryption to the S3 bucket. To protect\n against attacks at the bootstrap time, you should pre-load your machine\n images with the public GPG key.\n\n For those users who trade off some security for convienence, we install\n the GPG public key for them direct from the S3 repo.", "Set WIP label to PR.\n @param   [Number] pr\n          A number of issue or pull request for set label.\n @return  [void]", "Set any labels to PR by this.\n @param   [Number] pr\n          A number of issue or pull request for set label.\n @param   [String] name\n          A new label name.\n @param   [String] color\n          A color, in hex, without the leading #. Default is \"fef2c0\"\n @return  [void]", "Delete label from repository.\n @param   [String] name\n          Delete label name.\n @return  [void]", "Remove label from PR.\n @param   [String] name\n          Remove label name.\n @return  [void]", "Extract the coverage results that is covered by `cov1` but not covered by `cov2`.", "Make the covearge result able to marshal.", "Save the coverage result to a file.", "Translate the result into LCOV info format.", "Register a hooking method for given methods.\n The hook method is executed after calling given methods.\n @param [Symbol] hooking method name\n @param [Array] hooked methods name array", "Get the next feed of the given feed.\n Return the first feed if no argument is passed.\n @param [Hatenablog::Feed] feed blog feed\n @return [Hatenablog::Feed] next blog feed", "Get a blog entry specified by its ID.\n @param [String] entry_id entry ID\n @return [Hatenablog::BlogEntry] entry", "Post a blog entry.\n @param [String] title entry title\n @param [String] content entry content\n @param [Array] categories entry categories\n @param [String] draft this entry is draft if 'yes', otherwise it is not draft\n @return [Hatenablog::BlogEntry] posted entry", "Update a blog entry specified by its ID.\n @param [String] entry_id updated entry ID\n @param [String] title entry title\n @param [String] content entry content\n @param [Array] categories entry categories\n @param [String] draft this entry is draft if 'yes', otherwise it is not draft\n @param [String] updated entry updated datetime (ISO 8601)\n @return [Hatenablog::BlogEntry] updated entry", "Build a entry XML from arguments.\n @param [String] title entry title\n @param [String] content entry content\n @param [Array] categories entry categories\n @param [String] draft this entry is draft if 'yes', otherwise it is not draft\n @param [String] updated entry updated datetime (ISO 8601)\n @param [String] author_name entry author name\n @return [String] XML string", "Ensures the arguments are primitives.", "Given a request, will parse it's path to find what it the apropriate\n controller to respond it.", "Hide field named +name+", "Declare a +CharField+ with text area widget", "Declare a +CharField+ with password widget", "Declare a +RegexField+", "Declare a +ChoiceField+ with +choices+", "Declare a +TypedChoiceField+ with +choices+", "Declare a +MultipleChoiceField+ with +choices+", "Declare a +ChoiceField+ using the +RadioSelect+ widget", "Declare a +MultipleChoiceField+ with the +CheckboxSelectMultiple+ widget", "Save the response body to a file\n\n === Example\n\n   client = Client.new\n   client.save 'out.json', 'some/to/resource', param: value", "Determins which part of the data is best suited to be displayed\n as CSV.\n\n - If the response contains one or more arrays, the first array will\n   be the CSV output\n - Otherwise, if the response was parsed to a ruby object, the response\n   itself will be used as a single-row CSV output.\n\n Override this if you want to have a different decision process.", "Make a call with HTTParty and return a payload object.", "Normalize the three input parameters", "all_synonyms view is quite slow therefore\n this implementation is overriden in OCI connection with faster native OCI method", "Initialize the connection.\n\n @example Initialize the connection.\n   Connection.new(\"localhost\", 27017, 5)\n\n @param [ String ] host The host to connect to.\n @param [ Integer ] post The server port.\n @param [ Integer ] timeout The connection timeout.\n @param [ Hash ] options Options for the connection.\n\n @option options [ Boolean ] :ssl Connect using SSL\n @since 1.0.0\n Read from the connection.\n\n @example Read from the connection.\n   connection.read\n\n @return [ Hash ] The returned document.\n\n @since 1.0.0", "Write to the connection.\n\n @example Write to the connection.\n   connection.write(data)\n\n @param [ Array<Message> ] operations The database operations.\n\n @return [ Integer ] The number of bytes written.\n\n @since 1.0.0", "Read data from the socket until we get back the number of bytes that we\n are expecting.\n\n @api private\n\n @example Read the number of bytes.\n   connection.read_data(socket, 36)\n\n @param [ TCPSocket ] socket The socket to read from.\n @param [ Integer ] length The number of bytes to read.\n\n @return [ String ] The read data.\n\n @since 1.2.9", "Execute a command against a database.\n\n @example Execute a command.\n   node.command(database, { ping: 1 })\n\n @param [ Database ] database The database to run the command on.\n @param [ Hash ] cmd The command to execute.\n @options [ Hash ] options The command options.\n\n @raise [ OperationFailure ] If the command failed.\n\n @return [ Hash ] The result of the command.\n\n @since 1.0.0", "Get the underlying connection for the node.\n\n @example Get the node's connection.\n   node.connection\n\n @return [ Connection ] The connection.\n\n @since 2.0.0", "Yields the block if a connection can be established, retrying when a\n connection error is raised.\n\n @example Ensure we are connection.\n   node.ensure_connected do\n     #...\n   end\n\n @raises [ ConnectionFailure ] When a connection cannot be established.\n\n @return [ nil ] nil.\n\n @since 1.0.0", "Execute a get more operation on the node.\n\n @example Execute a get more.\n   node.get_more(database, collection, 12345, -1)\n\n @param [ Database ] database The database to get more from.\n @param [ Collection ] collection The collection to get more from.\n @param [ Integer ] cursor_id The id of the cursor on the server.\n @param [ Integer ] limit The number of documents to limit.\n @raise [ CursorNotFound ] if the cursor has been killed\n\n @return [ Message ] The result of the operation.\n\n @since 1.0.0", "Get the hash identifier for the node.\n\n @example Get the hash identifier.\n   node.hash\n\n @return [ Integer ] The hash identifier.\n\n @since 1.0.0\n Creat the new node.\n\n @example Create the new node.\n   Node.new(\"127.0.0.1:27017\")\n\n @param [ String ] address The location of the server node.\n @param [ Hash ] options Additional options for the node (ssl)\n\n @since 1.0.0\n Insert documents into the database.\n\n @example Insert documents.\n   node.insert(database, collection, [{ name: \"Tool\" }])\n\n @param [ Database ] database The database to insert to.\n @param [ Collection ] collection The collection to insert to.\n @param [ Array<Hash> ] documents The documents to insert.\n\n @return [ Message ] The result of the operation.\n\n @since 1.0.0", "Processes the provided operation on this node, and will execute the\n callback when the operation is sent to the database.\n\n @example Process a read operation.\n   node.process(query) do |reply|\n     return reply.documents\n   end\n\n @param [ Message ] operation The database operation.\n @param [ Proc ] callback The callback to run on operation completion.\n\n @return [ Object ] The result of the callback.\n\n @since 1.0.0", "Execute a query on the node.\n\n @example Execute a query.\n   node.query(database, collection, { name: \"Tool\" })\n\n @param [ Database ] database The database to query from.\n @param [ Collection ] collection The collection to query from.\n @param [ Hash ] selector The query selector.\n @param [ Hash ] options The query options.\n\n @raise [ QueryFailure ] If the query had an error.\n\n @return [ Message ] The result of the operation.\n\n @since 1.0.0", "Refresh information about the node, such as it's status in the replica\n set and it's known peers.\n\n @example Refresh the node.\n   node.refresh\n\n @raise [ ConnectionFailure ] If the node cannot be reached.\n\n @raise [ ReplicaSetReconfigured ] If the node is no longer a primary node and\n   refresh was called within an +#ensure_primary+ block.\n\n @return [ nil ] nil.\n\n @since 1.0.0", "Execute a remove command for the provided selector.\n\n @example Remove documents.\n   node.remove(database, collection, { name: \"Tool\" })\n\n @param [ Database ] database The database to remove from.\n @param [ Collection ] collection The collection to remove from.\n @param [ Hash ] selector The query selector.\n @param [ Hash ] options The remove options.\n\n @return [ Message ] The result of the operation.\n\n @since 1.0.0", "Execute an update command for the provided selector.\n\n @example Update documents.\n   node.update(database, collection, { name: \"Tool\" }, { likes: 1000 })\n\n @param [ Database ] database The database to update.\n @param [ Collection ] collection The collection to update.\n @param [ Hash ] selector The query selector.\n @param [ Hash ] change The updates.\n @param [ Hash ] options The update options.\n\n @return [ Message ] The result of the operation.\n\n @since 1.0.0", "Connect the node on the underlying connection.\n\n @example Connect the node.\n   node.connect\n\n @raise [ Errors::ConnectionFailure ] If connection failed.\n\n @return [ true ] If the connection suceeded.\n\n @since 2.0.0", "Discover the additional nodes.\n\n @api private\n\n @example Discover the additional nodes.\n   node.discover([ \"127.0.0.1:27019\" ])\n\n @param [ Array<String> ] nodes The new nodes.\n\n @since 2.0.0", "Flush the node operations to the database.\n\n @api private\n\n @example Flush the operations.\n   node.flush([ command ])\n\n @param [ Array<Message> ] ops The operations to flush.\n\n @return [ Object ] The result of the operations.\n\n @since 2.0.0", "Start the mock replica set.", "Pick a node to be master, and mark the rest as secondary", "Returns the list of available nodes, refreshing 1) any nodes which were\n down and ready to be checked again and 2) any nodes whose information is\n out of date. Arbiter nodes are not returned.\n\n @example Get the available nodes.\n   cluster.nodes\n\n @return [ Array<Node> ] the list of available nodes.\n\n @since 1.0.0", "Refreshes information for each of the nodes provided. The node list\n defaults to the list of all known nodes.\n\n If a node is successfully refreshed, any newly discovered peers will also\n be refreshed.\n\n @example Refresh the nodes.\n   cluster.refresh\n\n @param [ Array<Node> ] nodes_to_refresh The nodes to refresh.\n\n @return [ Array<Node> ] the available nodes\n\n @since 1.0.0", "Yields the replica set's primary node to the provided block. This method\n will retry the block in case of connection errors or replica set\n reconfiguration.\n\n @example Yield the primary to the block.\n   cluster.with_primary do |node|\n     # ...\n   end\n\n @param [ Integer ] retries The number of times to retry.\n\n @raises [ ConnectionFailure ] When no primary node can be found\n\n @return [ Object ] The result of the yield.\n\n @since 1.0.0", "Yields a secondary node if available, otherwise the primary node. This\n method will retry the block in case of connection errors.\n\n @example Yield the secondary to the block.\n   cluster.with_secondary do |node|\n     # ...\n   end\n\n @param [ Integer ] retries The number of times to retry.\n\n @raises [ ConnectionFailure ] When no primary node can be found\n\n @return [ Object ] The result of the yield.\n\n @since 1.0.0", "Is the provided node refreshable? This is in the case where the refresh\n boundary has passed, or the node has been down longer than the down\n boundary.\n\n @api private\n\n @example Is the node refreshable?\n   cluster.refreshable?(node)\n\n @param [ Node ] node The Node to check.\n\n @since 2.0.0", "Refresh the peers based on the node's peers.\n\n @api private\n\n @example Refresh the peers.\n   cluster.refresh_peers(node)\n\n @param [ Node ] node The node to refresh the peers for.\n\n @since 1.0.0", "Iterate over the results of the query.\n\n @example Iterate over the results.\n   cursor.each do |doc|\n     #...\n   end\n\n @return [ Enumerator ] The cursor enum.\n\n @since 1.0.0", "Get more documents from the database for the cursor. Executes a get more\n command.\n\n @example Get more docs.\n   cursor.get_more\n\n @return [ Array<Hash> ] The next batch of documents.\n\n @since 1.0.0", "Load the documents from the database.\n\n @example Load the documents.\n   cursor.load_docs\n\n @return [ Array<Hash> ] The documents.\n\n @since 1.0.0", "Get the options provided in the URI.\n\n @example Get the options\n   uri.options\n\n @note The options provided in the URI string must match the MongoDB\n   specification.\n\n @return [ Hash ] Options hash usable by Moped\n\n @see http://docs.mongodb.org/manual/reference/connection-string/#connections-connection-options\n\n @since 1.3.0", "Get the uri as a Mongoid friendly configuration hash.\n\n @example Get the uri as a hash.\n   uri.to_hash\n\n @return [ Hash ] The uri as options.\n\n @since 1.3.0", "Run +command+ on the database.\n\n @example Run a command.\n   db.command(ismaster: 1)\n   # => { \"master\" => true, hosts: [] }\n\n @param [ Hash ] command The command to run.\n\n @return [ Hash ] the result of the command.\n\n @since 1.0.0", "Create an index unless it already exists.\n\n @example Without options\n   session[:users].indexes.create(name: 1)\n   session[:users].indexes[name: 1]\n   # => {\"v\"=>1, \"key\"=>{\"name\"=>1}, \"ns\"=>\"moped_test.users\", \"name\"=>\"name_1\" }\n\n @example With options\n   session[:users].indexes.create(\n     { location: \"2d\", name: 1 },\n     { unique: true, dropDups: true }\n   )\n   session[:users][location: \"2d\", name: 1]\n   {\"v\"=>1,\n     \"key\"=>{\"location\"=>\"2d\", \"name\"=>1},\n     \"unique\"=>true,\n     \"ns\"=>\"moped_test.users\",\n     \"dropDups\"=>true,\n     \"name\"=>\"location_2d_name_1\"}\n\n @param [ Hash ] key The index spec.\n @param [ Hash ] options The options for the index.\n\n @return [ Hash ] The index spec.\n\n @see http://www.mongodb.org/display/DOCS/Indexes#Indexes-CreationOptions\n\n @since 1.0.0", "Drop an index, or all indexes.\n\n @example Drop all indexes\n   session[:users].indexes.count # => 3\n   # Does not drop the _id index\n   session[:users].indexes.drop\n   session[:users].indexes.count # => 1\n\n @example Drop a particular index\n   session[:users].indexes.drop(name: 1)\n   session[:users].indexes[name: 1] # => nil\n\n @param [ Hash ] key The index's key.\n\n @return [ Boolean ] Whether the indexes were dropped.\n\n @since 1.0.0", "Initialize a new database session.\n\n @example Initialize a new session.\n   Session.new([ \"localhost:27017\" ])\n\n @param [ Array ] seeds An array of host:port pairs.\n @param [ Hash ] options The options for the session.\n\n @see Above options validations for allowed values in the options hash.\n\n @since 1.0.0\n Create a new session with +options+ and use new socket connections.\n\n @example Change safe mode\n   session.with(write: { w: 2 })[:people].insert(name: \"Joe\")\n\n @example Change safe mode with block\n   session.with(write: { w: 2 }) do |session|\n     session[:people].insert(name: \"Joe\")\n   end\n\n @example Temporarily change database\n   session.with(database: \"admin\") do |admin|\n     admin.command ismaster: 1\n   end\n\n @example Copy between databases\n   session.use \"moped\"\n   session.with(database: \"backup\") do |backup|\n     session[:people].each do |person|\n       backup[:people].insert person\n     end\n   end\n\n @param [ Hash ] options The options.\n\n @return [ Session ] The new session.\n\n @see #with\n\n @since 1.0.0\n\n @yieldparam [ Session ] session The new session.", "Create a new session with +options+ reusing existing connections.\n\n @example Change safe mode\n   session.with(write: { w: 2 })[:people].insert(name: \"Joe\")\n\n @example Change safe mode with block\n   session.with(write: { w: 2 }) do |session|\n     session[:people].insert(name: \"Joe\")\n   end\n\n @example Temporarily change database\n   session.with(database: \"admin\") do |admin|\n     admin.command ismaster: 1\n   end\n\n @example Copy between databases\n   session.use \"moped\"\n   session.with(database: \"backup\") do |backup|\n     session[:people].each do |person|\n       backup[:people].insert person\n     end\n   end\n\n @param [ Hash ] options The session options.\n\n @return [ Session, Object ] The new session, or the value returned\n   by the block if provided.\n\n @since 1.0.0\n\n @yieldparam [ Session ] session The new session.", "Instantiate the new address.\n\n @example Instantiate the address.\n   Moped::Address.new(\"localhost:27017\")\n\n @param [ String ] address The host:port pair as a string.\n\n @since 2.0.0\n Resolve the address for the provided node. If the address cannot be\n resolved the node will be flagged as down.\n\n @example Resolve the address.\n   address.resolve(node)\n\n @param [ Node ] node The node to resolve for.\n\n @return [ String ] The resolved address.\n\n @since 2.0.0", "Apply authentication credentials.\n\n @example Apply the authentication credentials.\n   node.apply_credentials({ \"moped_test\" => [ \"user\", \"pass\" ]})\n\n @param [ Hash ] credentials The authentication credentials in the form:\n   { database_name: [ user, password ]}\n\n @return [ Object ] The authenticated object.\n\n @since 2.0.0", "Login the user to the provided database with the supplied password.\n\n @example Login the user to the database.\n   node.login(\"moped_test\", \"user\", \"pass\")\n\n @param [ String ] database The database name.\n @param [ String ] username The username.\n @param [ String ] password The password.\n\n @raise [ Errors::AuthenticationFailure ] If the login failed.\n\n @return [ Array ] The username and password.\n\n @since 2.0.0", "Logout the user from the provided database.\n\n @example Logout from the provided database.\n   node.logout(\"moped_test\")\n\n @param [ String ] database The database name.\n\n @return [ Array ] The username and password.\n\n @since 2.0.0", "Execute the provided block on the cluster and retry if the execution\n fails.\n\n @api private\n\n @example Execute with retry.\n   preference.with_retry(cluster) do\n     cluster.with_primary do |node|\n       node.refresh\n     end\n   end\n\n @param [ Cluster ] cluster The cluster.\n @param [ Integer ] retries The number of times to retry.\n\n @return [ Object ] The result of the block.\n\n @since 2.0.0", "Drop the collection.\n\n @example Drop the collection.\n   collection.drop\n\n @return [ Hash ] The command information.\n\n @since 1.0.0", "Rename the collection\n\n @example Rename the collection to 'foo'\n   collection.rename('foo')\n\n @return [ Hash ] The command information.\n\n @since 2.0.0", "Initialize the new collection.\n\n @example Initialize the collection.\n   Collection.new(database, :artists)\n\n @param [ Database ] database The collection's database.\n @param [ String, Symbol] name The collection name.\n\n @since 1.0.0\n Insert one or more documents into the collection.\n\n @example Insert a single document.\n   db[:people].insert(name: \"John\")\n\n @example Insert multiple documents in batch.\n   db[:people].insert([{name: \"John\"}, {name: \"Joe\"}])\n\n @param [ Hash, Array<Hash> ] documents The document(s) to insert.\n @param [ Array ] flags The flags, valid values are :continue_on_error.\n\n @option options [Array] :continue_on_error Whether to continue on error.\n\n @return [ nil ] nil.\n\n @since 1.0.0", "Get the count of matching documents in the query.\n\n @example Get the count.\n   db[:people].find.count\n\n @return [ Integer ] The number of documents that match the selector.\n\n @since 1.0.0", "Get the distinct values in the collection for the provided key.\n\n @example Get the distinct values.\n   db[:people].find.distinct(:name)\n\n @param [ Symbol, String ] key The name of the field.\n\n @return [ Array<Object ] The distinct values.\n\n @since 1.0.0", "Explain the current query.\n\n @example Explain the query.\n   db[:people].find.explain\n\n @return [ Hash ] The explain document.\n\n @since 1.0.0", "Get the first matching document.\n\n @example Get the first matching document.\n   db[:people].find.first\n\n @return [ Hash ] The first document that matches the selector.\n\n @since 1.0.0", "Remove a single document matching the query's selector.\n\n @example Remove a single document.\n   db[:people].find(name: \"John\").remove\n\n @return [ Hash, nil ] If in safe mode the last error result.\n\n @since 1.0.0", "Update a single document matching the query's selector.\n\n @example Update the first matching document.\n   db[:people].find(_id: 1).update(name: \"John\")\n\n @param [ Hash ] change The changes to make to the document\n @param [ Array ] flags An array of operation flags. Valid values are:\n   +:multi+ and +:upsert+\n\n @return [ Hash, nil ] If in safe mode the last error result.\n\n @since 1.0.0", "Get the corresponding write concern for the provided value. If the value\n is unverified we get that concern, otherwise we get propagate.\n\n @example Get the appropriate write concern.\n   Moped::WriteConcern.get(w: 3)\n\n @param [ Symbol, String, Hash ] The value to use to get the concern.\n\n @return [ Unverified, Propagate ] The appropriate write concern.\n\n @since 2.0.0", "send instrumentation requests\n\n @example\n   instrument \"com.example/android.test.InstrumentationTestRunner\"\n   # will run all of the tests within the 'com.example' package using the 'android.test.InstrumentationTestRunner'\n\n @example\n   instrument \"com.example/android.test.InstrumentationTestRunner\", :class => \"com.example.test.SomeTestClass\"\n\n   # will execute all of the tests within 'com.example.test.SomeTestClass'\n\n @param [String] runner indicates the package/runner to instrument\n @param [Hash] collection of key/value pairs to be sent as arguments to the instrumentation runner", "Initializes the instance by setting the relevant parameters\n Actually builds the find parameters hash that should be used in the search_for\n named scope.", "Return the SQL operator to use given an operator symbol and field definition.\n\n By default, it will simply look up the correct SQL operator in the SQL_OPERATORS\n hash, but this can be overridden by a database adapter.", "Validate the key name is in the set and translate the value to the set value.", "Creates a link that alternates between ascending and descending.\n\n Examples:\n\n   sort :username\n   sort :created_at, as: \"Created\"\n   sort :created_at, default: \"DESC\"\n\n * <tt>field</tt> - the name of the named scope. This helper will prepend this value with \"ascend_by_\" and \"descend_by_\"\n\n This helper accepts the following options:\n\n * <tt>:as</tt> - the text used in the link, defaults to whatever is passed to `field`\n * <tt>:default</tt> - default sorting order, DESC or ASC\n * <tt>:html_options</tt> - is a hash of HTML options for the anchor tag\n * <tt>:url_options</tt> - is a hash of URL parameters, defaulting to `params`, to preserve the current URL\n   parameters.\n\n On Rails 5 or higher, parameter whitelisting prevents any parameter being used in a link by\n default, so `params.permit(..)` should be passed for `url_options` for all known and\n permitted URL parameters, e.g.\n\n   sort :username, url_options: params.permit(:search)", "Initializes the instance by setting the relevant parameters\n Test the validity of the current query and suggest possible completion", "parse the query and return the complete options", "suggest all searchable field names.\n in relations suggest only the long format relation.field.", "this method completes the keys list in a key-value schema in the format table.keyName", "date value completer", "complete values in a key-value schema", "This method complete infix operators by field type", "Export the scoped_search method fo defining the search options.\n This method will create a definition instance for the class if it does not yet exist,\n or if a parent definition exists then it will create a new one inheriting it,\n and use the object as block argument and return value.", "this method is used by the syntax auto completer to suggest operators.", "Returns a list of appropriate fields to search in given a search keyword and operator.", "Try to parse a string as a datetime.\n Supported formats are Today, Yesterday, Sunday, '1 day ago', '2 hours ago', '3 months ago', '4 weeks from now', 'Jan 23, 2004'\n And many more formats that are documented in Ruby DateTime API Doc.", "Returns a reflection for a given klass and name", "Registers the search_for named scope within the class that is used for searching.", "Creates a new instance of the Service class\n\n @param [String] service_uri the root URI of the OData service\n @param [Hash] options the options to pass to the service\n @option options [String] :username for http basic auth\n @option options [String] :password for http basic auth\n @option options [Object] :verify_ssl false if no verification, otherwise mode (OpenSSL::SSL::VERIFY_PEER is default)\n @option options [Hash] :rest_options a hash of rest-client options that will be passed to all OData::Resource.new calls\n @option options [Hash] :additional_params a hash of query string params that will be passed on all calls\n @option options [Boolean, true] :eager_partial true if queries should consume partial feeds until the feed is complete, false if explicit calls to next must be performed\n Handles the dynamic `AddTo<EntityName>` methods as well as the collections on the service", "Queues an object for deletion.  To actually remove it from the server, you must call save_changes as well.\n\n @param [Object] obj the object to mark for deletion\n\n @raise [NotSupportedError] if the `obj` isn't a tracked entity", "Overridden to identify methods handled by method_missing", "Lazy loads a navigation property on a model\n\n @param [Object] obj the object to fill\n @param [String] nav_prop the navigation property to fill\n\n @raise [NotSupportedError] if the `obj` isn't a tracked entity\n @raise [ArgumentError] if the `nav_prop` isn't a valid navigation property", "Adds a child object to a parent object's collection\n\n @param [Object] parent the parent object\n @param [String] nav_prop the name of the navigation property to add the child to\n @param [Object] child the child object\n @raise [NotSupportedError] if the `parent` isn't a tracked entity\n @raise [ArgumentError] if the `nav_prop` isn't a valid navigation property\n @raise [NotSupportedError] if the `child` isn't a tracked entity", "Constructs a QueryBuilder instance for a collection using the arguments provided.\n\n @param [String] name the name of the collection\n @param [Hash] additional_parameters the additional parameters\n @param [Array] args the arguments to use for query", "Build the classes required by the metadata", "Parses the function imports and fills the @function_imports collection", "Converts the EDMX model type to the local model type", "Builds the metadata need for each property for things like feed customizations and navigation properties", "Handle parsing of OData Atom result and return an array of Entry classes", "Handles errors from the OData service", "Similar to +collect_properties+, but handles the navigation properties", "Helper to loop through a result and create an instance for each entity in the results", "Converts an XML Entry into a class", "Tests for and extracts the next href of a partial", "Handle link results", "Used to link a child object to its parent and vice-versa after a add_link operation", "Helper method for complex_type_to_class", "Field Converters\n Handles parsing datetimes from a string", "Parses a value into the proper type based on an xml property element", "Parses a value into the proper type based on a specified return type", "Method Missing Handlers\n Executes an import function", "return a newly selected model with the navigation properties expanded", "Creates a new instance of the ClassBuilder class\n\n @param [String] klass_name the name/type of the class to create\n @param [Array] methods the accessor methods to add to the class\n @param [Array] nav_props the accessor methods to add for navigation properties\n @param [Service] context the service context that this entity belongs to\n @param [String, nil] namespace optional namespace to create the classes in\n Returns a dynamically generated class definition based on the constructor parameters", "Used to return links instead of actual objects\n\n @param [String] navigation_property the NavigationProperty name to retrieve the links for\n\n @raise [NotSupportedError] if count has already been called on the query\n\n @example\n   svc.Categories(1).links(\"Products\")\n   product_links = svc.execute # => returns URIs for the products under the Category with an ID of 1", "Used to return a count of objects instead of the objects themselves\n\n @raise [NotSupportedError] if links has already been called on the query\n\n @example\n   svc.Products\n   svc.count\n   product_count = svc.execute", "Used to customize the properties that are returned for \"ad-hoc\" queries\n\n @param [Array<String>] properties to return\n\n @example\n   svc.Products.select('Price', 'Rating')", "Sanitizes Ruby objects into Strava-compatible string values.\n\n @param parameters a hash of parameters.\n\n Returns a hash in which values that are arrays of non-enumerable values\n         (Strings, Symbols, Numbers, etc.) are turned into comma-separated strings.", "Fetch list of photos from a specific activity, only if it is your activity\n\n See {https://strava.github.io/api/v3/activity_photos/} for full details\n\n @param id activity id\n @param args any additional arguments\n @param options (see #get_object)\n @param block post processing code block\n\n @return an array of photo objects. Both Strava and Instagram photos will be returned", "Fetch information about a stream for a specific activity\n\n See {https://strava.github.io/api/v3/streams/#activity} for full details\n\n @param id activity id\n @param args any additional arguments\n @param options (see #get_object)\n @param block post processing code block\n\n @return an array of unordered stream objects", "Fetch information about a subset of the activity streams that correspond to that effort\n\n See {https://strava.github.io/api/v3/streams/#effort} for full details\n\n @param id effort id\n @param args any additional arguments\n @param options (see #get_object)\n @param block post processing code block\n\n @return an array of unordered stream objects", "Fetch information about a stream for a specific segment\n\n See {https://strava.github.io/api/v3/streams/#segment} for full details\n\n @param id segment id\n @param args any additional arguments\n @param options (see #get_object)\n @param block post processing code block\n\n @return an array of unordered stream objects", "set value to defined state\n set value with timestamp, either Apple or UNIX", "get timestamp, either UNIX or Apple timestamp", "create a new array CFType\n convert to XML", "Create new CFDictonary type.\n convert to XML", "Read a binary plist file", "Convert CFPropertyList to binary format; since we have to count our objects we simply unique CFDictionary and CFArray", "read a binary int value", "read a binary real value", "read a binary date value", "Read a binary data value", "Read a binary string value", "Read a unicode string value, coded as UTF-16BE", "Read an binary array value, including contained objects", "Read a dictionary value, including contained objects", "Read an object type byte, decode it and delegate to the correct\n reader function", "Uniques and transforms a string value to binary format and adds it to the object table", "Codes an integer to binary format", "Converts a numeric value to binary and adds it to the object table", "Convert array to binary format and add it to the object table", "Convert dictionary to binary format and add it to the object table", "Creates new connection object.\n\n ==== Options\n * <tt>:access_key_id</tt> - Access key id (REQUIRED)\n * <tt>:secret_access_key</tt> - Secret access key (REQUIRED)\n * <tt>:use_ssl</tt> - Use https or http protocol (false by\n   default)\n * <tt>:debug</tt> - Display debug information on the STDOUT\n   (false by default)\n * <tt>:timeout</tt> - Timeout to use by the Net::HTTP object\n   (60 by default)\n * <tt>:proxy</tt> - Hash for Net::HTTP Proxy settings\n   { :host => \"proxy.mydomain.com\", :port => \"80, :user => \"user_a\", :password => \"secret\" }\n * <tt>:chunk_size</tt> - Size of a chunk when streaming\n   (1048576 (1 MiB) by default)\n Makes request with given HTTP method, sets missing parameters,\n adds signature to request header and returns response object\n (Net::HTTPResponse)\n\n ==== Parameters\n * <tt>method</tt> - HTTP Method symbol, can be <tt>:get</tt>,\n   <tt>:put</tt>, <tt>:delete</tt>\n\n ==== Options:\n * <tt>:host</tt> - Hostname to connecto to, defaults\n   to <tt>s3.amazonaws.com</tt>\n * <tt>:path</tt> - path to send request to (REQUIRED)\n * <tt>:body</tt> - Request body, only meaningful for\n   <tt>:put</tt> request\n * <tt>:params</tt> - Parameters to add to query string for\n   request, can be String or Hash\n * <tt>:headers</tt> - Hash of headers fields to add to request\n   header\n\n ==== Returns\n Net::HTTPResponse object -- response from the server", "Parse acl response and return hash with grantee and their permissions", "Returns a temporary url to the object that expires on the\n timestamp given. Defaults to one hour expire time.", "Saves the newly built bucket.\n\n ==== Options\n * <tt>:location</tt> - location of the bucket\n   (<tt>:eu</tt> or <tt>us</tt>)\n * Any other options are passed through to\n   Connection#request", "Gets a Translation for a String\n\n Implementation Example:\n\n   WebTranslateIt::Connection.new('secret_api_token') do\n     string = WebTranslateIt::String.find(1234)\n     puts string.translation_for(\"fr\") #=> A Translation object\n   end", "Fetch a language file.\n By default it will make a conditional GET Request, using the `If-Modified-Since` tag.\n You can force the method to re-download your file by passing `true` as a second argument\n\n Example of implementation:\n\n   configuration = WebTranslateIt::Configuration.new\n   file = configuration.files.first\n   file.fetch # the first time, will return the content of the language file with a status 200 OK\n   file.fetch # returns nothing, with a status 304 Not Modified\n   file.fetch(true) # force to re-download the file, will return the content of the file with a 200 OK", "Update a language file to Web Translate It by performing a PUT Request.\n\n Example of implementation:\n\n   configuration = WebTranslateIt::Configuration.new\n   locale = configuration.locales.first\n   file = configuration.files.first\n   file.upload # should respond the HTTP code 202 Accepted\n\n Note that the request might or might not eventually be acted upon, as it might be disallowed when processing\n actually takes place. This is due to the fact that language file imports are handled by background processing.", "Create a master language file to Web Translate It by performing a POST Request.\n\n Example of implementation:\n\n   configuration = WebTranslateIt::Configuration.new\n   file = TranslationFile.new(nil, file_path, nil, configuration.api_key)\n   file.create # should respond the HTTP code 201 Created\n\n Note that the request might or might not eventually be acted upon, as it might be disallowed when processing\n actually takes place. This is due to the fact that language file imports are handled by background processing.", "Delete a master language file from Web Translate It by performing a DELETE Request.", "Enables a default option for all emails.\n See documentation for details.\n\n Supported options:\n * :opentrack\n * :clicktrack\n * :ganalytics\n * :gravatar\n * :subscriptiontrack\n * :footer\n * :spamcheck", "Implementation for clear. Steps through each bin, removing all nodes.", "Initializes table, using the size recorded in +size_control+.", "If table is too small and not already resizing, creates next table and\n transfers bins. Rechecks occupancy after a transfer to see if another\n resize is already needed because resizings are lagging additions.", "Splits a normal bin with list headed by e into lo and hi parts; installs in given table.", "list the available environments", "Validate a request object from Rack.\n Return a boolean.\n\n @param [Rack::Request::Env] request a Rack HTTP Request\n @return [Boolean] is the request valid?", "Prevent replays of requests by checking that they are timely.\n\n @param [String] raw_body the raw body of our https request\n @raise [AlexaVerifier::InvalidRequestError] raised when the timestamp is not timely, or is not set", "Check that our request is valid.\n\n @param [String] signature_certificate_url the url for our signing certificate\n @param [Rack::Request::Env] request the request object\n @param [String] raw_body the raw body of our https request", "Check that our request was signed by a given public key.\n\n @param [OpenSSL::PKey::PKey] certificate_public_key the public key we are checking\n @param [Rack::Request::Env] request the request object we are checking\n @param [String] raw_body the raw body of our https request\n @raise [AlexaVerifier::InvalidRequestError] raised if our signature does not match the certificate provided", "this method gets called before a scenario or scenario outline\n we dispatch to our own more specific methods", "this method gets called after a scenario or scenario outline\n we dispatch to our own more specific methods", "this method is called before a scenario outline row OR step data table row", "this method is called after a scenario outline row OR step data table row", "Renders the tab stack using the current builder.\n\n Returns the String HTML content.", "Return the content of the file at the +key+.", "Return the partial content in the byte +range+ of the file at the +key+.", "Returns a signed, temporary URL that a direct upload file can be PUT to on the +key+.\n The URL will be valid for the amount of seconds specified in +expires_in+.\n You must also provide the +content_type+, +content_length+, and +checksum+ of the file\n that will be uploaded. All these attributes will be validated by the service upon upload.", "Parse JSON Response", "Parse XML Response", "Push a value onto the Kafka topic passed to this +Producer+\n\n @param [Object] value A single object to push\n @param [Hash] opts to pass to push method\n @option opts [String] :topic The topic to push messages to\n                       :partition_key The string to partition by\n\n @return [Hermann::Result] A future-like object which will store the\n   result from the broker", "Tick the underlying librdkafka reacter and clean up any unreaped but\n reapable children results\n\n @param [FixNum] timeout Seconds to block on the internal reactor\n @return [FixNum] Number of +Hermann::Result+ children reaped", "Perform the actual reactor tick\n @raises [StandardError] in case of underlying failures in librdkafka", "Non-standard method to change the content type of an existing object", "Creates a connection per standard JMS 1.1 techniques from the Oracle AQ JMS Interface", "Obtain a session from the pool and pass it to the supplied block\n The session is automatically returned to the pool once the block completes\n\n In the event a JMS Exception is thrown the session will be closed and removed\n from the pool to prevent re-using sessions that are no longer valid", "Obtain a session from the pool and create a MessageConsumer.\n Pass both into the supplied block.\n Once the block is complete the consumer is closed and the session is\n returned to the pool.\n\n Parameters:\n   queue_name: [String] Name of the Queue to return\n               [Symbol] Create temporary queue\n                  Mandatory unless :topic_name is supplied\n     Or,\n   topic_name: [String] Name of the Topic to write to or subscribe to\n               [Symbol] Create temporary topic\n                  Mandatory unless :queue_name is supplied\n     Or,\n   destination: [javaxJms::Destination] Destination to use\n\n   selector:   Filter which messages should be returned from the queue\n                  Default: All messages\n   no_local:   Determine whether messages published by its own connection\n                  should be delivered to it\n                  Default: false\n\n Example\n   session_pool.consumer(queue_name: 'MyQueue') do |session, consumer|\n     message = consumer.receive(timeout)\n     puts message.data if message\n   end", "Obtain a session from the pool and create a MessageProducer.\n Pass both into the supplied block.\n Once the block is complete the producer is closed and the session is\n returned to the pool.\n\n Parameters:\n   queue_name: [String] Name of the Queue to return\n               [Symbol] Create temporary queue\n                  Mandatory unless :topic_name is supplied\n     Or,\n   topic_name: [String] Name of the Topic to write to or subscribe to\n               [Symbol] Create temporary topic\n                  Mandatory unless :queue_name is supplied\n     Or,\n   destination: [javaxJms::Destination] Destination to use\n\n Example\n   session_pool.producer(queue_name: 'ExampleQueue') do |session, producer|\n     producer.send(session.message(\"Hello World\"))\n   end", "Load the required jar files for this JMS Provider and\n load JRuby extensions for those classes\n\n Rather than copying the JMS jar files into the JRuby lib, load them\n on demand. JRuby JMS extensions are only loaded once the jar files have been\n loaded.\n\n Can be called multiple times if required, although it would not be performant\n to do so regularly.\n\n Parameter: jar_list is an Array of the path and filenames to jar files\n                     to load for this JMS Provider\n\n Returns nil", "Create a session over this connection.\n It is recommended to create separate sessions for each thread\n If a block of code is passed in, it will be called and then the session is automatically\n closed on completion of the code block\n\n Parameters:\n  transacted: [true|false]\n      Determines whether transactions are supported within this session.\n      I.e. Whether commit or rollback can be called\n      Default: false\n      Note: :options below are ignored if this value is set to :true\n\n  options: any of the JMS::Session constants:\n     Note: :options are ignored if transacted: true\n     JMS::Session::AUTO_ACKNOWLEDGE\n        With this acknowledgment mode, the session automatically acknowledges\n        a client's receipt of a message either when the session has successfully\n        returned from a call to receive or when the message listener the session has\n        called to process the message successfully returns.\n     JMS::Session::CLIENT_ACKNOWLEDGE\n        With this acknowledgment mode, the client acknowledges a consumed\n        message by calling the message's acknowledge method.\n     JMS::Session::DUPS_OK_ACKNOWLEDGE\n        This acknowledgment mode instructs the session to lazily acknowledge\n        the delivery of messages.\n     JMS::Session::SESSION_TRANSACTED\n        This value is returned from the method getAcknowledgeMode if the\n        session is transacted.\n     Default: JMS::Session::AUTO_ACKNOWLEDGE", "Create a session over this connection.\n It is recommended to create separate sessions for each thread\n\n Note: Remember to call close on the returned session when it is no longer\n       needed. Rather use JMS::Connection#session with a block whenever\n       possible\n\n Parameters:\n  transacted: true or false\n      Determines whether transactions are supported within this session.\n      I.e. Whether commit or rollback can be called\n      Default: false\n      Note: :options below are ignored if this value is set to :true\n\n  options: any of the JMS::Session constants:\n     Note: :options are ignored if transacted: true\n     JMS::Session::AUTO_ACKNOWLEDGE\n        With this acknowledgment mode, the session automatically acknowledges\n        a client's receipt of a message either when the session has successfully\n        returned from a call to receive or when the message listener the session has\n        called to process the message successfully returns.\n     JMS::Session::CLIENT_ACKNOWLEDGE\n        With this acknowledgment mode, the client acknowledges a consumed\n        message by calling the message's acknowledge method.\n     JMS::Session::DUPS_OK_ACKNOWLEDGE\n        This acknowledgment mode instructs the session to lazily acknowledge\n        the delivery of messages.\n     JMS::Session::SESSION_TRANSACTED\n        This value is returned from the method getAcknowledgeMode if the\n        session is transacted.\n     Default: JMS::Session::AUTO_ACKNOWLEDGE", "Receive messages in a separate thread when they arrive\n\n Allows messages to be received Asynchronously in a separate thread.\n This method will return to the caller before messages are processed.\n It is then the callers responsibility to keep the program active so that messages\n can then be processed.\n\n Session Parameters:\n  transacted: true or false\n      Determines whether transactions are supported within this session.\n      I.e. Whether commit or rollback can be called\n      Default: false\n      Note: :options below are ignored if this value is set to :true\n\n  options: any of the JMS::Session constants:\n     Note: :options are ignored if transacted: true\n     JMS::Session::AUTO_ACKNOWLEDGE\n        With this acknowledgment mode, the session automatically acknowledges\n        a client's receipt of a message either when the session has successfully\n        returned from a call to receive or when the message listener the session has\n        called to process the message successfully returns.\n     JMS::Session::CLIENT_ACKNOWLEDGE\n        With this acknowledgment mode, the client acknowledges a consumed\n        message by calling the message's acknowledge method.\n     JMS::Session::DUPS_OK_ACKNOWLEDGE\n        This acknowledgment mode instructs the session to lazily acknowledge\n        the delivery of messages.\n     JMS::Session::SESSION_TRANSACTED\n        This value is returned from the method getAcknowledgeMode if the\n        session is transacted.\n     Default: JMS::Session::AUTO_ACKNOWLEDGE\n\n   :session_count : Number of sessions to create, each with their own consumer which\n                    in turn will call the supplied code block.\n                    Note: The supplied block must be thread safe since it will be called\n                          by several threads at the same time.\n                          I.e. Don't change instance variables etc. without the\n                          necessary semaphores etc.\n                    Default: 1\n\n Consumer Parameters:\n   queue_name: String: Name of the Queue to return\n                  Symbol: temporary: Create temporary queue\n                  Mandatory unless :topic_name is supplied\n     Or,\n   topic_name: String: Name of the Topic to write to or subscribe to\n                  Symbol: temporary: Create temporary topic\n                  Mandatory unless :queue_name is supplied\n     Or,\n   destination:Explicit javaxJms::Destination to use\n\n   selector:   Filter which messages should be returned from the queue\n                  Default: All messages\n\n   no_local:   Determine whether messages published by its own connection\n                  should be delivered to the supplied block\n                  Default: false\n\n   :statistics Capture statistics on how many messages have been read\n      true  : This method will capture statistics on the number of messages received\n              and the time it took to process them.\n              The timer starts when each() is called and finishes when either the last message was received,\n              or when Destination::statistics is called. In this case MessageConsumer::statistics\n              can be called several times during processing without affecting the end time.\n              Also, the start time and message count is not reset until MessageConsumer::each\n              is called again with statistics: true\n\n Usage: For transacted sessions the block supplied must return either true or false:\n          true => The session is committed\n          false => The session is rolled back\n          Any Exception => The session is rolled back\n\n Note: Separately invoke Connection#on_exception so that connection failures can be handled\n       since on_message will Not be called if the connection is lost", "Return Statistics gathered for this listener", "override with command line arguments and yield the block in case the option isn't set", "resolve symbols, with hashes introducing new lexical symbols", "resolve a symbol to its value, and then resolve that value", "search for a symbol introduced in the lexical context", "helper for following a path of values in a hash", "parse a manifest and merge with its inherited manifests", "deep hash merge", "Filters an array of objects by a given hash. The keys of\n the hash must be methods implemented by the objects. The\n values of the hash are compared to the values the object\n returns when calling the methods.\n\n @param filter [Hash] the filters that should be applied\n @return [Array] the filtered array.", "Reloads the device information\n\n @return [void]", "Reloads the device until the given block returns true\n\n @return [void]", "Disables the keyboard helpers\n\n @return [void]", "Sets the device language\n\n @return [void]", "Gives the total number of elements connected to this parent.\n\n This count includes all the elements contained in any possible child elements.\n\n @return [Integer] The total number of child elements connected to this parent", "Deletes the specified element from this parent.\n\n @param [String, Integer] tag_or_index a ruby-dicom tag string or item index\n @param [Hash] options the options used for deleting the element\n option options [Boolean] :no_follow when true, the method does not update the parent attribute of the child that is deleted\n @example Delete an Element from a DObject instance\n   dcm.delete(\"0008,0090\")\n @example Delete Item 1 from a Sequence\n   dcm[\"3006,0020\"].delete(1)", "Deletes all elements of the specified group from this parent.\n\n @param [String] group_string a group string (the first 4 characters of a tag string)\n @example Delete the File Meta Group of a DICOM object\n   dcm.delete_group(\"0002\")", "Re-encodes the binary data strings of all child Element instances.\n This also includes all the elements contained in any possible child elements.\n\n @note This method is only intended for internal library use, but for technical reasons\n   (the fact that is called between instances of different classes), can't be made private.\n @param [Boolean] old_endian the previous endianness of the elements/DObject instance (used for decoding values from binary)", "Returns an array of all child elements that belongs to the specified group.\n\n @param [String] group_string a group string (the first 4 characters of a tag string)\n @return [Array<Element, Item, Sequence>] the matching child elements (an empty array if no children matches)", "Gathers the desired information from the selected data elements and\n processes this information to make a text output which is nicely formatted.\n\n @note This method is only intended for internal library use, but for technical reasons\n   (the fact that is called between instances of different classes), can't be made private.\n   The method is used by the print() method to construct its text output.\n\n @param [Integer] index the index which is given to the first child of this parent\n @param [Integer] max_digits the maximum number of digits in the index of an element (in reality the number of digits of the last element)\n @param [Integer] max_name the maximum number of characters in the name of any element to be printed\n @param [Integer] max_length the maximum number of digits in the length of an element\n @param [Integer] max_generations the maximum number of generations of children for this parent\n @param [Integer] visualization an array of string symbols which visualizes the tree structure that the children of this particular parent belongs to (for no visualization, an empty array is passed)\n @param [Hash] options the options to use when processing the print information\n @option options [Integer] :value_max if a value max length is specified, the element values which exceeds this are trimmed\n @return [Array] a text array and an index of the last element", "Finds and returns the maximum character lengths of name and length which occurs for any child element,\n as well as the maximum number of generations of elements.\n\n @note This method is only intended for internal library use, but for technical reasons\n   (the fact that is called between instances of different classes), can't be made private.\n   The method is used by the print() method to achieve a proper format in its output.", "Handles missing methods, which in our case is intended to be dynamic\n method names matching DICOM elements in the dictionary.\n\n When a dynamic method name is matched against a DICOM element, this method:\n * Returns the element if the method name suggests an element retrieval, and the element exists.\n * Returns nil if the method name suggests an element retrieval, but the element doesn't exist.\n * Returns a boolean, if the method name suggests a query (?), based on whether the matched element exists or not.\n * When the method name suggests assignment (=), an element is created with the supplied arguments, or if the argument is nil, the element is deleted.\n\n * When a dynamic method name is not matched against a DICOM element, and the method is not defined by the parent, a NoMethodError is raised.\n\n @param [Symbol] sym a method name", "Prints all child elementals of this particular parent.\n Information such as tag, parent-child relationship, name, vr, length and value is\n gathered for each element and processed to produce a nicely formatted output.\n\n @param [Hash] options the options to use for handling the printout\n option options [Integer] :value_max if a value max length is specified, the element values which exceeds this are trimmed\n option options [String] :file if a file path is specified, the output is printed to this file instead of being printed to the screen\n @return [Array<String>] an array of formatted element string lines\n @example Print a DObject instance to screen\n   dcm.print\n @example Print the DObject to the screen, but specify a 25 character value cutoff to produce better-looking results\n   dcm.print(:value_max => 25)\n @example Print to a text file the elements that belong to a specific Sequence\n   dcm[\"3006,0020\"].print(:file => \"dicom.txt\")", "Builds a nested hash containing all children of this parent.\n\n Keys are determined by the key_representation attribute, and data element values are used as values.\n * For private elements, the tag is used for key instead of the key representation, as private tags lacks names.\n * For child-less parents, the key_representation attribute is used as value.\n\n @return [Hash] a nested hash containing key & value pairs of all children", "Gives the value of a specific Element child of this parent.\n\n * Only Element instances have values. Parent elements like Sequence and Item have no value themselves.\n * If the specified tag is that of a parent element, an exception is raised.\n\n @param [String] tag a tag string which identifies the child Element\n @return [String, Integer, Float, NilClass] an element value (or nil, if no element is matched)\n @example Get the patient's name value\n   name = dcm.value(\"0010,0010\")\n @example Get the Frame of Reference UID from the first item in the Referenced Frame of Reference Sequence\n   uid = dcm[\"3006,0010\"][0].value(\"0020,0052\")", "Checks the given key argument and logs a warning if an obviously\n incorrect key argument is used.\n\n @param [String, Integer] tag_or_index the tag string or item index indentifying a given elemental\n @param [Symbol] method a representation of the method calling this method", "Creates a Link instance, which is used by both DClient and DServer to handle network communication.\n\n === Parameters\n\n * <tt>options</tt> -- A hash of parameters.\n\n === Options\n\n * <tt>:ae</tt> -- String. The name of the client (application entity).\n * <tt>:file_handler</tt> -- A customized FileHandler class to use instead of the default FileHandler.\n * <tt>:host_ae</tt> -- String. The name of the server (application entity).\n * <tt>:max_package_size</tt> -- Integer. The maximum allowed size of network packages (in bytes).\n * <tt>:timeout</tt> -- Integer. The maximum period to wait for an answer before aborting the communication.\n\n Waits for an SCU to issue a release request, and answers it by launching the handle_release method.\n If invalid or no message is received, the connection is closed.", "Builds the binary string which is sent as the association request.\n\n === Parameters\n\n * <tt>presentation_contexts</tt> -- A hash containing abstract_syntaxes, presentation context ids and transfer syntaxes.\n * <tt>user_info</tt> -- A user information items array.", "Builds the binary string which is sent as a command fragment.\n\n === Parameters\n\n * <tt>pdu</tt> -- The command fragment's PDU string.\n * <tt>context</tt> -- Presentation context ID byte (references a presentation context from the association).\n * <tt>flags</tt> -- The flag string, which identifies if this is the last command fragment or not.\n * <tt>command_elements</tt> -- An array of command elements.", "Builds the binary string which is sent as a data fragment.\n\n === Notes\n\n * The style of encoding will depend on whether we have an implicit or explicit transfer syntax.\n\n === Parameters\n\n * <tt>data_elements</tt> -- An array of data elements.\n * <tt>presentation_context_id</tt> -- Presentation context ID byte (references a presentation context from the association).", "Builds the binary string which makes up a C-STORE data fragment.\n\n === Parameters\n\n * <tt>pdu</tt> -- The data fragment's PDU string.\n * <tt>context</tt> -- Presentation context ID byte (references a presentation context from the association).\n * <tt>flags</tt> -- The flag string, which identifies if this is the last data fragment or not.\n * <tt>body</tt> -- A pre-encoded binary string (typicall a segment of a DICOM file to be transmitted).", "Delegates an incoming message to its appropriate interpreter method, based on its pdu type.\n Returns the interpreted information hash.\n\n === Parameters\n\n * <tt>message</tt> -- The binary message string.\n * <tt>pdu</tt> -- The PDU string of the message.\n * <tt>file</tt> -- A boolean used to inform whether an incoming data fragment is part of a DICOM file reception or not.", "Processes incoming command & data fragments for the DServer.\n Returns a success boolean and an array of status messages.\n\n === Notes\n\n The incoming traffic will in most cases be: A C-STORE-RQ (command fragment) followed by a bunch of data fragments.\n However, it may also be a C-ECHO-RQ command fragment, which is used to test connections.\n\n === Parameters\n\n * <tt>path</tt> -- The path used to save incoming DICOM files.\n\n--\n FIXME: The code which handles incoming data isnt quite satisfactory. It would probably be wise to rewrite it at some stage to clean up\n the code somewhat. Probably a better handling of command requests (and their corresponding data fragments) would be a good idea.", "Handles the command fragment response.\n\n === Notes\n\n This is usually a C-STORE-RSP which follows the (successful) reception of a DICOM file, but may also\n be a C-ECHO-RSP in response to an echo request.", "Decodes the header of an incoming message, analyzes its real length versus expected length, and handles any\n deviations to make sure that message strings are split up appropriately before they are being forwarded to interpretation.\n Returns an array of information hashes.\n\n === Parameters\n\n * <tt>message</tt> -- The binary message string.\n * <tt>file</tt> -- A boolean used to inform whether an incoming data fragment is part of a DICOM file reception or not.\n\n--\n FIXME: This method is rather complex and doesnt feature the best readability. A rewrite that is able to simplify it would be lovely.", "Decodes the message received when the remote node wishes to abort the session.\n Returns the processed information hash.\n\n === Parameters\n\n * <tt>message</tt> -- The binary message string.", "Decodes the association reject message and extracts the error reasons given.\n Returns the processed information hash.\n\n === Parameters\n\n * <tt>message</tt> -- The binary message string.", "Decodes the message received in the release request and calls the handle_release method.\n Returns the processed information hash.\n\n === Parameters\n\n * <tt>message</tt> -- The binary message string.", "Decodes the message received in the release response and closes the connection.\n Returns the processed information hash.\n\n === Parameters\n\n * <tt>message</tt> -- The binary message string.", "Handles the reception of multiple incoming transmissions.\n Returns an array of interpreted message information hashes.\n\n === Parameters\n\n * <tt>file</tt> -- A boolean used to inform whether an incoming data fragment is part of a DICOM file reception or not.", "Handles the reception of a single, expected incoming transmission and returns the interpreted, received data.", "Processes the value of the reason byte received in the association abort, and prints an explanation of the error.\n\n === Parameters\n\n * <tt>reason</tt> -- String. Reason code for an error that has occured.", "Processes the value of the result byte received in the association response.\n Prints an explanation if an error is indicated.\n\n === Notes\n\n A value other than 0 indicates an error.\n\n === Parameters\n\n * <tt>result</tt> -- Integer. The result code from an association response.", "Handles an incoming network transmission.\n Returns the binary string data received.\n\n === Notes\n\n If a minimum length has been specified, and a message is received which is shorter than this length,\n the method will keep listening for more incoming network packets to append.\n\n === Parameters\n\n * <tt>min_length</tt> -- Integer. The minimum possible length of a valid incoming transmission.", "Receives the data from an incoming network transmission.\n Returns the binary string data received.", "Set instance variables related to a transfer syntax.\n\n === Parameters\n\n * <tt>syntax</tt> -- A transfer syntax string.", "Sets the binary string that the Item will contain.\n\n @param [String] new_bin a binary string of encoded data\n @example Insert a custom jpeg in the (encapsulated) pixel data element (in it's first pixel data item)\n   dcm['7FE0,0010'][1].children.first.bin = jpeg_binary_string", "Creates image objects from one or more compressed, binary string blobs.\n\n @param [Array<String>, String] blobs binary string blob(s) containing compressed pixel data\n @return [Array<MagickImage>, FalseClass] - an array of images, or false (if decompression failed)", "Creates an image object from a binary string blob.\n\n @param [String] blob binary string blob containing pixel data\n @param [Integer] columns the number of columns\n @param [Integer] rows the number of rows\n @param [Integer] depth the bit depth of the encoded pixel data\n @param [String] photometry a code describing the photometry of the pixel data (e.g. 'MONOCHROME1' or 'COLOR')\n @return [MagickImage] a Magick image object", "Get the latitude and longitude for a certain place, resolved via Google\n maps api. This hash can be used in `set_location`.\n\n @example\n  cal.coordinates_for_place('The little mermaid, Copenhagen')\n  # => {:latitude => 55.6760968, :longitude => 12.5683371}\n\n @return [Hash] Latitude and longitude for the given place\n @raise [RuntimeError] If the place cannot be found", "Anonymizes the given DObject or array of DICOM objects with the settings\n of this Anonymizer instance.\n\n @param [DObject, Array<DObject>] dicom single or multiple DICOM objects\n @return [Array<DObject>] an array of the anonymized DICOM objects", "Specifies that the given tag is to be completely deleted\n from the anonymized DICOM objects.\n\n @param [String] tag a data element tag\n @example Completely delete the Patient's Name tag from the DICOM files\n   a.delete_tag('0010,0010')", "Sets the anonymization settings for the specified tag. If the tag is already present in the list\n of tags to be anonymized, its settings are updated, and if not, a new tag entry is created.\n\n @param [String] tag a data element tag\n @param [Hash] options the anonymization settings for the specified tag\n @option options [String, Integer, Float] :value the replacement value to be used when anonymizing this data element. Defaults to the pre-existing value and '' for new tags.\n @option options [String, Integer, Float] :enum specifies if enumeration is to be used for this tag. Defaults to the pre-existing value and false for new tags.\n @example Set the anonymization settings of the Patient's Name tag\n   a.set_tag('0010,0010', :value => 'MrAnonymous', :enum => true)", "Gives the value which will be used when anonymizing this tag.\n\n @note If enumeration is selected for a string type tag, a number will be\n   appended in addition to the string that is returned here.\n\n @param [String] tag a data element tag\n @return [String, Integer, Float, NilClass] the replacement value for the specified tag, or nil if the tag is not matched", "Performs anonymization on a DICOM object.\n\n @param [DObject] dcm a DICOM object", "Performs anonymization of a DICOM file.\n\n @param [String] file a DICOM file path", "Determines a default value to use for anonymizing the given tag.\n\n @param [String] tag a data element tag\n @return [String, Integer, Float] the default replacement value for a given tag", "Creates a write path for the given DICOM object, based on the object's\n original file path and the write_path attribute.\n\n @param [DObject] dcm a DICOM object\n @return [String] the destination directory path", "Handles the enumeration for the given data element tag.\n If its value has been encountered before, its corresponding enumerated\n replacement value is retrieved, and if a new original value is encountered,\n a new enumerated replacement value is found by increasing an index by 1.\n\n @param [String, Integer, Float] original the original value of the tag to be anonymized\n @param [Integer] j the index of this tag in the tag-related instance arrays\n @return [String, Integer, Float] the replacement value which is used for the anonymization of the tag", "Replaces the UIDs of the given DICOM object.\n\n @note Empty UIDs are ignored (we don't generate new UIDs for these).\n @note If AuditTrail is set, the relationship between old and new UIDs are preserved,\n   and the relations between files in a study/series should remain valid.\n @param [Array<DObject, Item>] parents dicom parent objects who's child elements will be investigated", "Sets up some default information variables that are used by the Anonymizer.", "Writes a DICOM object to file.\n\n @param [DObject] dcm a DICOM object", "Sets the value of the Element instance.\n\n In addition to updating the value attribute, the specified value is encoded to binary\n and used to update the Element's bin and length attributes too.\n\n @note The specified value must be of a type that is compatible with the Element's value representation (vr).\n @param [String, Integer, Float, Array] new_value a formatted value that is assigned to the element", "Attach the current Calabash run-loop to a console.\n\n @example\n  You have encountered a failing cucumber Scenario.\n  You open the console and want to start investigating the cause of the failure.\n\n  Use\n\n  > console_attach\n\n  to connect to the current run-loop so you can perform gestures.\n\n @param [Symbol] uia_strategy Optionally specify the uia strategy, which\n   can be one of :shared_element, :preferences, :host.  If you don't\n   know which to choose, don't specify one and calabash will try deduce\n   the correct strategy to use based on the environment variables used\n   when starting the console.\n\n @return [Hash] The hash will contain the current device, the path to the\n   current application, and the run-loop strategy.\n\n @raise [RuntimeError] If the app is not running.", "Performs a `pan` between two elements.\n @see Calabash::Gestures#pan_between\n @!visibility private", "Performs a `flick` between two elements.\n @!visibility private", "Evaluate javascript in a Web View. On iOS, an implicit return is\n inserted, on Android an explicit return is needed.\n\n @example\n  # iOS\n  cal.evaluate_javascript_in(\"UIWebView\", \"2+2\")\n\n  # Android\n  cal.evaluate_javascript_in(\"WebView\", \"return 2+2\")\n\n @example\n  # iOS\n  cal.evaluate_javascript_in(\"WKWebView\",\n         \"document.body.style.backgroundColor = 'red';\")\n\n  # Android\n  cal.evaluate_javascript_in(\"XWalkContent\",\n         \"document.body.style.backgroundColor = 'red';\")\n\n @note No error will be raised if the javascript given is invalid, or\n  throws an exception.\n\n @param [String, Hash, Calabash::Query] query Query that matches the\n  webview\n @param [String] javascript The javascript to evaluate\n\n @raise ViewNotFoundError If no views are found matching `query`", "Waits for a keyboard to appear.\n\n @see Calabash::Wait.default_options\n\n @param [Number] timeout How long to wait for the keyboard.\n @raise [Calabash::Wait::TimeoutError] Raises error if no keyboard\n  appears.", "Waits for the keyboard to disappear.\n\n @see Calabash::Wait.default_options\n\n @param [Number] timeout How log to wait for the keyboard to disappear.\n @raise [Calabash::Wait::TimeoutError] Raises error if any keyboard is\n  visible after the `timeout`.", "Queries a service class provider for series that match the specified criteria.\n\n === Instance level attributes for this query:\n\n * '0008,0060' (Modality)\n * '0020,000E' (Series Instance UID)\n * '0020,0011' (Series Number)\n\n In addition to the above listed attributes, a number of \"optional\" attributes\n may be specified. For a general list of optional object instance level attributes,\n please refer to the DICOM standard, PS3.4 C.6.1.1.4, Table C.6-3.\n\n @note Caution: Calling this method without parameters will instruct your PACS\n   to return info on ALL series in the database!\n @param [Hash] query_params the query parameters to use\n @option query_params [String] 'GGGG,EEEE' a tag and value pair to be used in the query\n\n @example Find all series belonging to the given study\n   node.find_series('0020,000D' => '1.2.840.1145.342')", "Moves a single image to a DICOM server.\n\n This DICOM node must be a third party (i.e. not the client instance you\n are requesting the move with!).\n\n === Instance level attributes for this procedure:\n\n * '0008,0018' (SOP Instance UID)\n * '0008,0052' (Query/Retrieve Level)\n * '0020,000D' (Study Instance UID)\n * '0020,000E' (Series Instance UID)\n\n @param [String] destination the AE title of the DICOM server which will receive the file\n @param [Hash] options the options to use for moving the DICOM object\n @option options [String] 'GGGG,EEEE' a tag and value pair to be used for the procedure\n\n @example Move an image from e.q. a PACS to another SCP on the network\n   node.move_image('SOME_SERVER', '0008,0018' => sop_uid, '0020,000D' => study_uid, '0020,000E' => series_uid)", "Move an entire study to a DICOM server.\n\n This DICOM node must be a third party (i.e. not the client instance you\n are requesting the move with!).\n\n === Instance level attributes for this procedure:\n\n * '0008,0052' (Query/Retrieve Level)\n * '0010,0020' (Patient ID)\n * '0020,000D' (Study Instance UID)\n\n @param [String] destination the AE title of the DICOM server which will receive the files\n @param [Hash] options the options to use for moving the DICOM objects\n @option options [String] 'GGGG,EEEE' a tag and value pair to be used for the procedure\n\n @example Move an entire study from e.q. a PACS to another SCP on the network\n   node.move_study('SOME_SERVER', '0010,0020' => pat_id, '0020,000D' => study_uid)", "Returns an array of supported transfer syntaxes for the specified transfer syntax.\n For compressed transfer syntaxes, we currently do not support reencoding these to other syntaxes.", "Opens a TCP session with the server, and handles the association request as well as the response.", "Handles the release request along with the response, as well as closing the TCP connection.", "Loads one or more DICOM files.\n Returns an array of DObject instances, an array of unique abstract syntaxes found among the files, a status boolean and a message string.\n\n === Parameters\n\n * <tt>files_or_objects</tt> -- A single file path or an array of paths, or a DObject or an array of DObject instances.", "Handles the communication involved in a DICOM C-ECHO.\n Build the necessary strings and send the command and data element that makes up the echo request.\n Listens for and interpretes the incoming echo response.", "Handles the communication involved in a DICOM C-GET.\n Builds and sends command & data fragment, then receives the incoming file data.\n\n--\n FIXME: This method has never actually been tested, since it is difficult to find a host that accepts a c-get-rq.", "Handles the communication involved in DICOM C-STORE.\n For each file, builds and sends command fragment, then builds and sends the data fragments that\n conveys the information from the selected DICOM file.", "Processes the presentation contexts that are received in the association response\n to extract the transfer syntaxes which have been accepted for the various abstract syntaxes.\n\n === Parameters\n\n * <tt>presentation_contexts</tt> -- An array where each index contains a presentation context hash.", "Processes the array of information hashes that was returned from the interaction with the SCP\n and transfers it to the instance variables where command and data results are stored.", "Creates the presentation context used for the non-file-transmission association requests..", "Sets the data_elements instance array with the given options.", "Reloads all required files that have git changes", "Outputs all calabash methods", "Outputs a calabash method", "Outputs all calabash iOS methods", "Outputs all calabash Android methods", "Outputs all visible elements as a tree.", "Turn on debug logging.", "Turn off debug logging.", "Decodes a section of the instance string.\n The instance index is offset in accordance with the length read.\n\n @note If multiple numbers are decoded, these are returned in an array.\n @param [Integer] length the string length to be decoded\n @param [String] type the type (vr) of data to decode\n @return [String, Integer, Float, Array] the formatted (decoded) data", "Decodes 4 bytes of the instance string and formats it as a ruby-dicom tag string.\n\n @return [String, NilClass] a formatted tag string ('GGGG,EEEE'), or nil (e.g. if at end of string)", "Encodes a given value to a binary string.\n\n @param [String, Integer, Float, Array] value a formatted value (String, Integer, etc..) or an array of numbers\n @param [String] type the type (vr) of data to encode\n @return [String] an encoded binary string", "Appends a string with trailling spaces to achieve a target length, and encodes it to a binary string.\n\n @param [String] string a string to be padded\n @param [Integer] target_length the target length of the string\n @return [String] an encoded binary string", "Encodes a value, and if the the resulting binary string has an\n odd length, appends a proper padding byte to make it even length.\n\n @param [String, Integer, Float, Array] value a formatted value (String, Integer, etc..) or an array of numbers\n @param [String] vr the value representation of data to encode\n @return [String] the encoded binary string", "Invoke a method in your application.\n\n This is an escape hatch for calling an arbitrary hook inside\n (the test build) of your app.  Commonly used to \"go around\" the UI for\n speed purposes or reset the app to a good known state.\n\n For iOS this method calls a method on the app's AppDelegate object.\n\n For Android this method tries to invoke a method on the current Activity\n instance. If the method is not defined in the current activity, Calabash\n tries to invoke the method on the current Application instance.\n\n @note The Android implementation accepts any number of arguments, of any\n  type including null (Ruby nil). The iOS implementation does not accept\n  more than one argument, of the type NSString (Ruby String) or\n  NSDictionary (Ruby Hash).\n\n\n ### For iOS\n\n You must create a method on you app delegate of the form:\n\n     - (NSString *) calabashBackdoor:(NSString *)aIgnorable;\n\n or if you want to pass parameters\n\n     - (NSString *) calabashBackdoor:(NSDictionary *)params;\n\n ### For Android\n\n You must create a public method in your current Activity or Application.\n\n     public <return type> calabashBackdoor(String param1, int param2)\n\n @example\n   # iOS\n   backdoor('calabashBackdoor:', '')\n\n @example\n   # iOS\n   backdoor('calabashBackdoor:', {example:'param'})\n\n @example\n   # Android\n   backdoor('calabashBackdoor', 'first argument', 2)\n\n @param [String] name The selector/method name.\n @param [Object] arguments A comma separated list of arguments to be\n  passed to the backdoor selector/method.\n @return [Object] the result of performing the selector/method with the\n  arguments (serialized)", "Creates a DServer instance.\n\n @note To customize logging behaviour, refer to the Logging module documentation.\n\n @param [Integer] port the network port to be used\n @param [Hash] options the options to use for the DICOM server\n @option options [String] :file_handler a customized FileHandler class to use instead of the default FileHandler\n @option options [String] :host the hostname that the TCPServer binds to (defaults to '0.0.0.0')\n @option options [String] :host_ae the name of the server (application entity)\n @option options [String] :max_package_size the maximum allowed size of network packages (in bytes)\n @option options [String] :timeout the number of seconds the server will wait on an answer from a client before aborting the communication\n\n @example Create a server using default settings\n   s = DICOM::DServer.new\n @example Create a server with a specific host name and a custom buildt file handler\n   require_relative 'my_file_handler'\n   server = DICOM::DServer.new(104, :host_ae => \"RUBY_SERVER\", :file_handler => DICOM::MyFileHandler)\n\n Adds an abstract syntax to the list of abstract syntaxes that the server will accept.\n\n @param [String] uid an abstract syntax UID", "Adds a transfer syntax to the list of transfer syntaxes that the server will accept.\n\n @param [String] uid a transfer syntax UID", "Prints the list of accepted abstract syntaxes to the screen.", "Waits for `query` to match one or more views.\n\n @example\n  cal.wait_for_view({marked: 'mark'})\n\n @example\n  cal.wait_for_view({marked: 'login'},\n                  timeout_message: \"Did not see login button\")\n\n @example\n  text = cal.wait_for_view(\"myview\")['text']\n\n @see Calabash::Wait#wait_for for optional parameters\n\n @param [String, Hash, Calabash::Query] query Query to match view\n @return [Hash] The first view matching `query`.\n @raise [ViewNotFoundError] If `query` do not match at least one view.", "Waits for all `queries` to simultaneously match at least one view.\n\n @example\n  cal.wait_for_views({id: 'foo'}, {id: 'bar'})\n\n @see Calabash::Wait#wait_for for optional parameters\n\n @param [String, Hash, Calabash::Query] queries List of queries or a\n  query.\n @return The returned value is undefined\n @raise [ViewNotFoundError] If `queries` do not all match at least one\n  view.", "Waits for `query` not to match any views\n\n @example\n  cal.wait_for_no_view({marked: 'mark'})\n\n @example\n  cal.wait_for_no_view({marked: 'login'},\n                  timeout_message: \"Login button did not disappear\")\n\n @see Calabash::Wait#wait_for for optional parameters\n\n @param [String, Hash, Calabash::Query] query Query to match view\n @raise [ViewFoundError] If `query` do not match at least one view.", "Waits for all `queries` to simultaneously match no views\n\n @example\n  cal.wait_for_no_views({id: 'foo'}, {id: 'bar'})\n\n @see Calabash::Wait#wait_for for optional parameters\n\n @param [String, Hash, Calabash::Query] queries List of queries or a\n  query.\n @raise [ViewNotFoundError] If `queries` do not all match at least one\n  view.", "Does the given `query` match at least one view?\n\n @param [String, Hash, Calabash::Query] query Query to match view\n @return [Boolean] Returns true if the `query` matches at least one view\n @raise [ArgumentError] If given an invalid `query`", "Does the given `queries` all match at least one view?\n\n @param [String, Hash, Calabash::Query] queries List of queries or a\n  query\n @return [Boolean] Returns true if the `queries` all match at least one\n  view\n @raise [ArgumentError] If given an invalid list of queries", "Expect `query` to match at least one view. Raise an exception if it does\n not.\n\n @param [String, Hash, Calabash::Query] query Query to match a view\n @raise [ArgumentError] If given an invalid `query`\n @raise [ViewNotFoundError] If `query` does not match at least one view", "Expect `queries` to each match at least one view. Raise an exception if\n they do not.\n\n @param [String, Hash, Calabash::Query] queries List of queries or a\n  query.\n @raise [ArgumentError] If given an invalid list of queries\n @raise [ViewNotFoundError] If `queries` do not all match at least one\n   view.", "Expect `query` to match no views. Raise an exception if it does.\n\n @param [String, Hash, Calabash::Query] query Query to match a view\n @raise [ArgumentError] If given an invalid `query`\n @raise [ViewFoundError] If `query` matches any views.", "Expect `queries` to each match no views. Raise an exception if they do.\n\n @param [String, Hash, Calabash::Query] queries List of queries or a\n  query.\n @raise [ArgumentError] If given an invalid list of queries\n @raise [ViewFoundError] If one of `queries` matched any views", "Waits for a view containing `text`.\n\n @see Calabash::Wait#wait_for_view\n\n @param text [String] Text to look for\n @return [Object] The view matched by the text query", "Waits for no views containing `text`.\n\n @see Calabash::Wait#wait_for_view\n\n @param text [String] Text to look for\n @return [Object] The view matched by the text query", "Creates a new AuditTrail instance.\n\n Adds a tag record to the log.\n\n @param [String] tag the tag string (e.q. '0010,0010')\n @param [String, Integer, Float] original the original value (e.q. 'John Doe')\n @param [String, Integer, Float] replacement the replacement value (e.q. 'Patient1')", "Retrieves the original value used for the given combination of tag & replacement value.\n\n @param [String] tag the tag string (e.q. '0010,0010')\n @param [String, Integer, Float] replacement the replacement value (e.q. 'Patient1')\n @return [String, Integer, Float] the original value of the given tag", "Retrieves the replacement value used for the given combination of tag & original value.\n\n @param [String] tag the tag string (e.q. '0010,0010')\n @param [String, Integer, Float] original the original value (e.q. 'John Doe')\n @return [String, Integer, Float] the replacement value of the given tag", "Encodes the DICOM object into a series of binary string segments with a specified maximum length.\n\n Returns the encoded binary strings in an array.\n\n @param [Integer] max_size the maximum allowed size of the binary data strings to be encoded\n @param [String] transfer_syntax the transfer syntax string to be used when encoding the DICOM object to string segments. When this method is used for making network packets, the transfer_syntax is not part of the object, and thus needs to be specified.\n @return [Array<String>] the encoded DICOM strings\n @example Encode the DObject to strings of max length 2^14 bytes\n   encoded_strings = dcm.encode_segments(16384)", "Gathers key information about the DObject as well as some system data, and prints this information to the screen.\n This information includes properties like encoding, byte order, modality and various image properties.\n\n @return [Array<String>] strings describing the properties of the DICOM object", "Changes the transfer syntax Element of the DObject instance, and performs re-encoding of all\n numerical values if a switch of endianness is implied.\n\n @note This method does not change the compressed state of the pixel data element. Changing\n the transfer syntax between an uncompressed and compressed state will NOT change the pixel\n data accordingly (this must be taken care of manually).\n\n @param [String] new_syntax the new transfer syntax string to be applied to the DObject", "Writes the DICOM object to file.\n\n @note The goal of the Ruby DICOM library is to yield maximum conformance with the DICOM\n standard when outputting DICOM files. Therefore, when encoding the DICOM file, manipulation\n of items such as the meta group, group lengths and header signature may occur. Therefore,\n the file that is written may not be an exact bitwise copy of the file that was read, even if no\n DObject manipulation has been done by the user.\n\n @param [String] file_name the path of the DICOM file which is to be written to disk\n @param [Hash] options the options to use for writing the DICOM file\n @option options [Boolean] :ignore_meta if true, no manipulation of the DICOM object's meta group will be performed before the DObject is written to file\n @option options [Boolean] :include_empty_parents if true, childless parents (sequences & items) are written to the DICOM file\n @example Encode a DICOM file from a DObject\n   dcm.write('C:/dicom/test.dcm')", "Determines the length of the meta group in the DObject instance.\n\n @return [Integer] the length of the file meta group string", "Creates an Element with the given arguments and connects it to self.\n\n @param [String] tag an element tag\n @param [String, Integer, Float, Array, NilClass] value an element value\n @param [Hash] options any options used for creating the element (see Element.new documentation)", "Creates a Sequence with the given arguments and connects it to self.\n\n @param [String] tag a sequence tag\n @param [Hash] options any options used for creating the sequence (see Sequence.new documentation)", "Checks if colored pixel data is present.\n\n @return [Boolean] true if the object contains colored pixels, and false if not", "Unpacks pixel values from a binary pixel string. The decode is performed\n using values defined in the image related elements of the DObject instance.\n\n @param [String] bin a binary string containing the pixels to be decoded\n @param [Stream] stream a Stream instance to be used for decoding the pixels (optional)\n @return [Array<Integer>] decoded pixel values", "Packs a pixel value array to a binary pixel string. The encoding is performed\n using values defined in the image related elements of the DObject instance.\n\n @param [Array<Integer>] pixels an array containing the pixel values to be encoded\n @param [Stream] stream a Stream instance to be used for encoding the pixels (optional)\n @return [String] encoded pixel string", "Extracts an array of image objects, created from the encoded pixel data using\n the image related elements in the DICOM object.\n\n @note Creates an array of image objects in accordance with the selected image processor. Available processors are :rmagick and :mini_magick.\n\n @param [Hash] options the options to use for extracting the images\n @option options [Integer] :frame makes the method return an array containing only the image object corresponding to the specified frame number\n @option options [TrueClass, Array<Integer>] :level if true, window leveling is performed using default values from the DICOM object, or if an array ([center, width]) is specified, these custom values are used instead\n @option options [Boolean] :narray if true, forces the use of NArray for the pixel remap process (for faster execution)\n @option options [Boolean] :remap if true, the returned pixel values are remapped to presentation values\n @return [Array<MagickImage, NilClass>] an array of image objects, alternatively an empty array (if no image present or image decode failed)\n\n @example Retrieve the pixel data as RMagick image objects\n   images = dcm.images\n @example Retrieve the pixel data as RMagick image objects, remapped to presentation values (but without any leveling)\n   images = dcm.images(:remap => true)\n @example Retrieve the pixel data as RMagick image objects, remapped to presentation values and leveled using the default center/width values in the DICOM object\n   images = dcm.images(:level => true)\n @example Retrieve the pixel data as RMagick image objects, remapped to presentation values, leveled with the specified center/width values and using numerical array for the rescaling (~twice as fast)\n   images = dcm.images(:level => [-200,1000], :narray => true)", "Dumps the binary content of the Pixel Data element to the specified file.\n\n If the DICOM object contains multi-fragment pixel data, each fragment\n will be dumped to separate files (e.q. 'fragment-0.dat', 'fragment-1.dat').\n\n @param [String] file a string which specifies the file path to use when dumping the pixel data\n @example Dumping the pixel data to a file\n   dcm.image_to_file(\"exported_image.dat\")", "Extracts the Pixel Data values in an ordinary Ruby Array.\n Returns nil if no pixel data is present, and false if it fails to retrieve pixel data which is present.\n\n The returned array does not carry the dimensions of the pixel data:\n It is put in a one dimensional Array (vector).\n\n @param [Hash] options the options to use for extracting the pixel data\n @option options [TrueClass, Array<Integer>] :level if true, window leveling is performed using default values from the DICOM object, or if an array ([center, width]) is specified, these custom values are used instead\n @option options [Boolean] :narray if true, forces the use of NArray for the pixel remap process (for faster execution)\n @option options [Boolean] :remap if true, the returned pixel values are remapped to presentation values\n @return [Array, NilClass, FalseClass] an Array of pixel values, alternatively nil (if no image present) or false (if image decode failed)\n\n @example Simply retrieve the pixel data\n   pixels = dcm.pixels\n @example Retrieve the pixel data remapped to presentation values according to window center/width settings\n   pixels = dcm.pixels(:remap => true)\n @example Retrieve the remapped pixel data while using numerical array (~twice as fast)\n   pixels = dcm.pixels(:remap => true, :narray => true)", "Performs a run length decoding on the input stream.\n\n @note For details on RLE encoding, refer to the DICOM standard, PS3.5, Section 8.2.2 as well as Annex G.\n\n @param [Integer] cols number of colums of the encoded image\n @param [Integer] rows number of rows of the encoded image\n @param [Integer] string the encoded pixel string\n @return [Array<Integer>] the decoded pixel values", "Converts original pixel data values to presentation values.\n\n @param [Array<Integer>] pixel_data an array of pixel values (integers)\n @param [Integer] min_allowed the minimum value allowed in the pixel data\n @param [Integer] max_allowed the maximum value allowed in the pixel data\n @param [Boolean, Array<Integer>] level if true, window leveling is performed using default values from the DICOM object, or if an array ([center, width]) is specified, these custom values are used instead\n @return [Array<Integer>] presentation values", "Converts original pixel data values to presentation values, using the efficient NArray library.\n\n @note If a Ruby Array is supplied, the method returns a one-dimensional NArray object (i.e. no columns & rows).\n @note If a NArray is supplied, the NArray is returned with its original dimensions.\n\n @param [Array<Integer>, NArray] pixel_data pixel values\n @param [Integer] min_allowed the minimum value allowed in the pixel data\n @param [Integer] max_allowed the maximum value allowed in the pixel data\n @param [Boolean, Array<Integer>] level if true, window leveling is performed using default values from the DICOM object, or if an array ([center, width]) is specified, these custom values are used instead\n @return [Array<Integer>, NArray] presentation values", "Creates an image object from the specified pixel value array, performing\n presentation value processing if requested.\n\n @note Definitions for Window Center and Width can be found in the DICOM standard, PS 3.3 C.11.2.1.2\n\n @param [Array<Integer>] pixel_data an array of pixel values\n @param [Integer] columns the number of columns in the pixel data\n @param [Integer] rows the number of rows in the pixel data\n @param [Hash] options the options to use for reading the image\n @option options [Boolean] :remap if true, pixel values are remapped to presentation values (using intercept and slope values from the DICOM object)\n @option options [Boolean, Array<Integer>] :level if true, window leveling is performed using default values from the DICOM object, or if an array ([center, width]) is specified, these custom values are used instead\n @option options [Boolean] :narray if true, forces the use of NArray for the pixel remap process (for faster execution)\n @return [MagickImage] the extracted image object", "Collects the window level values needed to convert the original pixel\n values to presentation values.\n\n @note If some of these values are missing in the DObject instance,\n   default values are used instead for intercept and slope, while center\n   and width are set to nil. No errors are raised.\n @return [Array<Integer, NilClass>] center, width, intercept and slope", "Transfers a pre-encoded binary string to the pixel data element, either by\n overwriting the existing element value, or creating a new \"Pixel Data\" element.\n\n @param [String] bin a binary string containing encoded pixel data", "Loads data from an encoded DICOM string and creates\n items and elements which are linked to this instance.\n\n @param [String] bin an encoded binary string containing DICOM information\n @param [String] syntax the transfer syntax to use when decoding the DICOM string\n @param [Boolean] switched indicating whether the transfer syntax 'switch' has occured in the data stream of this object", "Checks whether the given tag is a duplicate of an existing tag with this parent.\n\n @param [String] tag the tag of the candidate duplicate elemental\n @param [String] elemental the duplicate elemental type (e.g. Sequence, Element)", "Checks for the official DICOM header signature.\n\n @return [Boolean] true if the proper signature is present, false if not, and nil if the string was shorter then the length of the DICOM signature", "Handles the process of reading a data element from the DICOM string, and\n creating an element object from the parsed data.\n\n @return [Boolean] nil if end of string has been reached (in an expected way), false if the element parse failed, and true if an element was parsed successfully", "Builds a DICOM object by parsing an encoded DICOM string.\n\n @param [String] string a binary DICOM string to be parsed\n @param [Boolean] signature if true (default), the parsing algorithm will look for the DICOM header signature\n @param [Hash] options the options to use for parsing the DICOM string\n @option options [Boolean] :overwrite for the rare case of a DICOM file containing duplicate elements, setting this as true instructs the parsing algorithm to overwrite the original element with duplicates\n @option options [String] :syntax if a syntax string is specified, the parsing algorithm is forced to use this transfer syntax when decoding the string", "Adds an encoded string to the output stream, while keeping track of the\n accumulated size of the output stream, splitting it up as necessary, and\n transferring the encoded string fragments to an array.\n\n @param [String] string a pre-encoded string", "Toggles the status for enclosed pixel data.\n\n @param [Element, Item, Sequence] element a data element", "Writes DICOM content to a series of size-limited binary strings, which is returned in an array.\n This is typically used in preparation of transmitting DICOM objects through network connections.\n\n @param [Integer] max_size the maximum segment string length\n @param [Hash] options the options to use for encoding the DICOM strings\n @option options [String] :syntax the transfer syntax used for the encoding settings of the post-meta part of the DICOM string\n @return [Array<String>] the encoded DICOM strings", "Splits a pre-encoded string in parts and adds it to the segments instance\n array.\n\n @param [String] string a pre-encoded string", "Encodes and writes a single data element.\n\n @param [Element, Item, Sequence] element a data element", "Encodes and writes an Item or Sequence delimiter.\n\n @param [Item, Sequence] element a parent element", "Handles the encoding of DICOM information to string as well as writing it to file.\n\n @param [Hash] options the options to use for encoding the DICOM string\n @option options [String] :file_name the path & name of the DICOM file which is to be written to disk\n @option options [Boolean] :signature if true, the 128 byte preamble and 'DICM' signature is prepended to the encoded string\n @option options [String] :syntax the transfer syntax used for the encoding settings of the post-meta part of the DICOM string", "Returns a Stream instance which can be used for encoding a value to binary.\n\n @note Retrieves the Stream instance of the top parent DObject instance.\n   If this fails, a new Stream instance is created (with little endian encoding assumed).", "Creates a DLibrary instance.\n\n Adds a custom DictionaryElement to the ruby-dicom element dictionary.\n\n @param [DictionaryElement] element the custom dictionary element to be added", "Adds a custom dictionary file to the ruby-dicom element dictionary.\n\n @note The format of the dictionary is a tab-separated text file with 5 columns:\n   * Tag, Name, VR, VM & Retired status\n   * For samples check out ruby-dicom's element dictionaries in the git repository\n @param [String] file the path to the dictionary file to be added", "Adds a custom dictionary file to the ruby-dicom uid dictionary.\n\n @note The format of the dictionary is a tab-separated text file with 4 columns:\n   * Value, Name, Type & Retired status\n   * For samples check out ruby-dicom's uid dictionaries in the git repository\n @param [String] file the path to the dictionary file to be added", "Gives the name corresponding to the specified element string value.\n\n @param [String] value an element tag, element name or an element's method name\n @return [String, NilClass] the matched element name, or nil if no match is made", "Gives the tag corresponding to the specified element string value.\n\n @param [String] value an element tag, element name or an element's method name\n @return [String, NilClass] the matched element tag, or nil if no match is made", "Identifies the DictionaryElement that corresponds to the given tag.\n\n @note If a given tag doesn't return a dictionary match, a new DictionaryElement is created.\n   * For private tags, a name 'Private' and VR 'UN' is assigned\n   * For unknown tags, a name 'Unknown' and VR 'UN' is assigned\n @param [String] tag the tag of the element\n @return [DictionaryElement] a corresponding DictionaryElement", "Extracts, and returns, all transfer syntaxes and SOP Classes from the dictionary.\n\n @return [Array<Hash, Hash>] transfer syntax and sop class hashes, each with uid as key and name as value", "Gives the tag that matches the supplied data element name, by searching the element dictionary.\n\n @param [String] name a data element name\n @return [String, NilClass] the corresponding element tag, or nil if no match is made", "Matches a tag against the possible range tag candidates, and if no match\n is found, returns a dictionary element representing an unknown tag.\n\n @param [String] tag the element tag\n @return [DictionaryElement] a matched range element or an unknown element", "Create a new `PoolManager` instance with persistent storage.\n\n @param path [String, Pathname] the location at which to persist the state\n   of `AutoNetwork` pools.\n Looks up the pool associated with the provider for a given machine and\n sets up a transaction where the state of the pool can be safely inspected\n or modified. If a pool does not exist for the machine provider, one will\n automatically be created.\n\n @param machine [Vagrant::Machine]\n @param read_only [Boolean] whether to create a read_only transaction.\n @yieldparam pool [AutoNetwork::Pool]", "Fetch all private networks that are tagged for auto networking\n\n @param machine [Vagrant::Machine]\n\n @return [Array(Symbol, Hash)] All auto_networks", "Create a new Pool object that manages a range of IP addresses.\n\n @param network_range [String] The network address range to use as the\n   address pool.\n Allocate an IP address for the given machine. If a machine already has an\n IP address allocated, then return that.\n\n @param machine [Vagrant::Machine]\n @return [IPAddr] the IP address assigned to the machine.\n @raise [PoolExhaustedError] if no allocatable addresses remain in the\n   range managed by the pool.", "Look up the address assigned to a given machine.\n\n @param machine [Vagrant::Machine]\n @return [IPAddr] the IP address assigned to the machine.\n @return [nil] if the machine has no address assigned.", "Set the default pool to a new IP range.\n\n @param pool [String]\n @raise [InvalidSettingErrror] if an IPAddr object cannot be initialized\n   from the value of pool.\n @return [void]", "Creates collection classes and methods for elements.\n @param [Array<Symbol>] elements for which to create collection classes\n   and methods.", "status of all projections received so far", "todo - check support for portfolio item fields", "check for an alias of a type - eg userstory => hierarchicalrequirement\nyou can add to @rally_alias_types as desired", "expecting idstring to have \"FormattedID|DE45\" or the objectID or a ref itself", "An attempt to be rally_rest_api user friendly -\n you can get a field the old way with an underscored field name or the upcase name", "Acknowledge message.\n\n @param [Integer] delivery_tag Delivery tag to acknowledge\n @param [Boolean] multiple (false) Should all unacknowledged messages up to this be acknowleded as well?\n\n @return nil\n @api public", "Unacknowledge message.\n\n @param [Integer] delivery_tag Delivery tag to acknowledge\n @param [Boolean] multiple (false) Should all unacknowledged messages up to this be rejected as well?\n @param [Boolean] requeue  (false) Should this message be requeued instead of dropping it?\n\n @return nil\n @api public", "Rejects a message. A rejected message can be requeued or\n dropped by RabbitMQ.\n\n @param [Integer] delivery_tag Delivery tag to reject\n @param [Boolean] requeue      Should this message be requeued instead of dropping it?\n\n @return nil\n @api public", "Bind this queue to an exchange\n\n @param [BunnyMock::Exchange,String] exchange Exchange to bind to\n @param [Hash] opts Binding properties\n\n @option opts [String] :routing_key Custom routing key\n\n @api public", "Unbind this queue from an exchange\n\n @param [BunnyMock::Exchange,String] exchange Exchange to unbind from\n @param [Hash] opts Binding properties\n\n @option opts [String] :routing_key Custom routing key\n\n @api public", "Get oldest message in queue\n\n @return [Hash] Message data\n @api public", "Bind this exchange to another exchange\n\n @param [BunnyMock::Exchange,String] exchange Exchange to bind to\n @param [Hash] opts Binding properties\n\n @option opts [String] :routing_key Custom routing key\n\n @return [BunnyMock::Exchange] self\n @api public", "Unbind this exchange from another exchange\n\n @param [BunnyMock::Exchange,String] exchange Exchange to unbind from\n @param [Hash] opts Binding properties\n\n @option opts [String] :routing_key Custom routing key\n\n @return [BunnyMock::Exchange] self\n @api public", "Check if a queue is bound to this exchange\n\n @param [BunnyMock::Queue,String] exchange_or_queue Exchange or queue to check\n @param [Hash] opts Binding properties\n\n @option opts [String] :routing_key Custom routing key\n\n @return [Boolean] true if the given queue or exchange matching options is bound to this exchange, false otherwise\n @api public", "Move cursor relative to its current position\n\n @param [Integer] x\n @param [Integer] y\n\n @api public", "Clear a number of lines\n\n @param [Integer] n\n   the number of lines to clear\n @param [Symbol] :direction\n   the direction to clear, default :up\n\n @api public", "transform move to jkf", "transform teban-fugou-from to jkf", "exchange sente gote", "transfrom fugou to jkf", "match space one or more", "transfrom forks to jkf", "transform initialboard to jkf", "lines to jkf", "return empty board jkf", "Extracts the operations from this single transaction,\n setting the source account on the extracted operations.\n\n Useful for merging transactions.\n\n @return [Array<Operation>] the operations", "send_amount returns the actual amount paid for the corresponding\n PathPaymentOp to this result.", "Checks to ensure that every signature for the envelope is\n a valid signature of one of the provided `key_pairs`\n\n NOTE: this does not do any authorization checks, which requires access to\n the current ledger state.\n\n @param *key_pairs [Array<Stellar::KeyPair>] The key pairs to check the envelopes signatures against\n\n @return [Boolean] true if all signatures are from the provided key_pairs and validly sign the tx's hash", "this is a convenience method to configure exchanges, queues, messages and handlers\n with a common set of options. allows one to call all register methods without the\n register_ prefix. returns self. if the passed in block has no parameters, the block\n will be evaluated in the context of the client configurator.\n\n Example: (block with config argument)\n  client = Beetle.client.new.configure :exchange => :foobar do |config|\n    config.queue :q1, :key => \"foo\"\n    config.queue :q2, :key => \"bar\"\n    config.message :foo\n    config.message :bar\n    config.handler :q1 { puts \"got foo\"}\n    config.handler :q2 { puts \"got bar\"}\n  end\n\n Example: (block without config argument)\n  client = Beetle.client.new.configure :exchange => :foobar do\n    queue :q1, :key => \"foo\"\n    queue :q2, :key => \"bar\"\n    message :foo\n    message :bar\n    handler :q1 { puts \"got foo\"}\n    handler :q2 { puts \"got bar\"}\n  end", "sends the given message to one of the configured servers and returns the result of running the associated handler.\n\n unexpected behavior can ensue if the message gets routed to more than one recipient, so be careful.", "traces queues without consuming them. useful for debugging message flow.", "evaluate the ruby files matching the given +glob+ pattern in the context of the client instance.", "extracts various values from the AMQP header properties", "have we already seen this message? if not, set the status to \"incomplete\" and store\n the message exipration timestamp in the deduplication store.", "process this message and do not allow any exception to escape to the caller", "ack the message for rabbit. deletes all keys associated with this message in the\n deduplication store if we are sure this is the last message with the given msg_id.", "list of exceptions potentially raised by bunny\n these need to be lazy, because qrack exceptions are only defined after a connection has been established", "retry dead servers after ignoring them for 10.seconds\n if all servers are dead, retry the one which has been dead for the longest time", "performs redis operations by yielding a passed in block, waiting for a new master to\n show up on the network if the operation throws an exception. if a new master doesn't\n appear after the configured timeout interval, we raise an exception.", "extract redis master from file content and return the server for our system", "close all connections. this assumes the reactor is running", "Creates a new key pair for each new DigitalOcean compute resource\n After creating the key, it uploads it to DigitalOcean", "Remove any attributes with nil values in a saved query hash. The API will\n already assume missing attributes are nil", "If a connection already exists yield it to the block. If no connection\n exists checkout a connection, yield it to the block, and checkin the\n connection when finished.", "Return any checked-out connections back to the pool by threads that\n are no longer alive.", "Merges attributes provided as an argument to initialize\n with attributes from the module.fields array.  Skips any\n fields that aren't in the module.fields array\n\n BUG: SugarCRM likes to return fields you don't ask for and\n aren't fields on a module (i.e. modified_user_name).  This\n royally screws up our typecasting code, so we handle it here.", "Wrapper for invoking save on modified_attributes\n sets the id if it's a new record", "Looks up an association by object, link_field, or method.\n Raises an exception if not found", "Returns the records from the associated module or returns the cached copy if we've already\n loaded it.  Force a reload of the records with reload=true\n\n  {\"email_addresses\"=>\n    {\"name\"=>\"email_addresses\",\n     \"module\"=>\"EmailAddress\",\n     \"bean_name\"=>\"EmailAddress\",\n     \"relationship\"=>\"users_email_addresses\",\n     \"type\"=>\"link\"},", "Updates an association cache entry if it's been initialized", "creates a new instance of an AssociationCollection\n Owner is the parent object, and association is the target", "Removes a record from the collection, uses the id of the record as a test for inclusion.", "Add +records+ to this association, saving any unsaved records before adding them.\n Returns +self+ so method calls may be chained.\n Be sure to call save on the association to commit any association changes", "delegate undefined methods to the @collection array\n E.g. contact.cases should behave like an array and allow `length`, `size`, `each`, etc.", "Pushes collection changes to SugarCRM, and updates the state of the collection", "Loads related records for the given association", "Returns an instance of class for the provided module name", "Send a request to the Sugar Instance", "Re-uses this session and namespace if the user wants to connect with different credentials", "load all the monkey patch extension files in the provided folder", "Creates a new instance of an Association\n Returns true if the association includes an attribute that matches\n the provided string", "Attempts to determine the class of the target in the association", "Defines methods for accessing the association target on the owner class.\n If the link_field name includes the owner class name, it is stripped before\n creating the method.  If this occurs, we also create an alias to the stripped\n method using the full link_field name.", "Generates the association proxy method for related module", "Determines if the provided string is plural or singular\n Plurality == Cardinality", "A tiny helper for converting reserved characters for html encoding", "Returns the fields associated with the module", "Returns the required fields", "Deregisters the module", "Un-typecasts the attribute - false becomes \"0\", 5234 becomes \"5234\", etc.", "Saves the current object, checks that required fields are present.\n returns true or false", "Checks to see if we have all the neccessary attributes", "Compares the class of the attribute with the class or classes provided in the class array\n returns true if they match, otherwise adds an entry to the @errors collection, and returns false", "Add an error to the hash", "Tries to instantiate and return an object with the values\n populated from the response", "Returns the attribute type for a given attribute", "Attempts to typecast each attribute based on the module field type", "Find nodes matching 'capybara-ng-match' attributes using ids\n\n @return nodes matching ids", "Get or set selector to find ng-app for current capybara test session\n\n TIP: try using '[ng-app]', which will find ng-app as attribute anywhere.\n\n @param root_selector if nil then return current value without change\n @return test specific selector to find ng-app,\n by default global ::Angular.root_selector is used.", "Node for nth binding match\n\n @param opt\n - :row\n - :exact\n - :root_selector\n - :wait\n @return nth node", "All nodes matching binding\n\n @param opt\n - :exact\n - :root_selector\n - :wait\n @return [node, ...]", "Node for nth model match\n\n @param opt\n - :row\n - :root_selector\n - :wait\n @return nth node", "Does option exist\n\n @param opt\n - :root_selector\n - :wait\n @return true | false", "Node for nth option\n\n @param opt\n - :row\n - :root_selector\n - :wait\n @return nth node", "Node for nth repeater row\n\n @param opt\n - :row\n - :root_selector\n - :wait\n @return nth node", "Node for column binding value in row\n\n @param opt\n - :row\n - :root_selector\n - :wait\n @return nth node", "Node for column binding value in all rows\n\n @param opt\n - :root_selector\n - :wait\n @return [node, ...]", "Load arbitrary data from a string into the Image object.\n\n Format must be a ZBar::Format constant. See the ZBar documentation\n for what formats are supported, and how the data should be formatted.\n\n Most everyone should use one of the <tt>Image.from_*</tt> methods instead.", "Ask ZBar to convert this image to a new format, returning a new Image.\n\n Not all conversions are possible: for example, if ZBar was built without\n JPEG support, it cannot convert JPEGs into anything else.", "Transforms a nested hash into meta property keys.", "convenience method that parses a response into json AND makes sure there are no errors", "This command prepares a statistical summary of the data in one or\n two columns of a file.", "a normal element\n maybe text\n maybe node", "wrap node with markdown", "define custom node processor", "Converts the extracted callout markers for the specified line.\n\n @param line_num [Integer] the line number (1-based).\n @return [String] converted callout markers for the _line_num_,\n   or an empty string if there are no callouts for that line.", "Formats tokens on the specified line into HTML.\n\n @param tokens [Array<Rouge::Token>] tokens on the line.\n @param line_nums [Integer] the line number (1-based).\n @yield [String] gives formatted content.", "Renders a pretty plain-text table.", "Aligns the cells and the footer of a column.\n\n    table = Text::Table.new :rows => [%w(a bb), %w(aa bbb), %w(aaa b)]\n    puts table\n\n    #    +-----+-----+\n    #    | a   | bb  |\n    #    | aa  | bbb |\n    #    | aaa | b   |\n    #    +-----+-----+\n\n    table.align_column 2, :right\n\n    #    +-----+-----+\n    #    | a   |  bb |\n    #    | aa  | bbb |\n    #    | aaa |   b |\n    #    +-----+-----+\n\n  Note that headers, spanned cells and cells with explicit alignments are not affected by <tt>align_column</tt>.", "Restores the extracted passthroughs by reinserting them into the\n placeholder positions.\n\n @param text [String] the text into which to restore the passthroughs.\n @return [String] a copy of the *text* with restored passthroughs.", "Write an element with the given name, content and attributes. If\n there is no content and no block is given, a self-closing element is\n created. Provide an empty string as content to create an empty,\n non-self-closing element.", "Extracts the content of the package to the course repository. This will be\n done automatically when opening a package so this method will rarely be\n used. If the +dry_run+ option was set to +true+ when the package was\n opened nothing will happen. This behavior can be overridden with the\n +force+ parameter.", "Computes the absolute path to a file in an extracted package given its\n relative path. The argument +relative+ can be used to get the path\n relative to the course repository.\n\n Ex.\n    <tt>pkg.path => '/var/lms/courses/MyCourse/'</tt>\n    <tt>pkg.course_repository => '/var/lms/courses/'</tt>\n    <tt>path_to('images/myimg.jpg') => '/var/lms/courses/MyCourse/images/myimg.jpg'</tt>\n    <tt>path_to('images/myimg.jpg', true) => 'MyCourse/images/myimg.jpg'</tt>", "Creates a new SwaggerBuilder\n @param raw_hash [Hash] Swagger API definition\n @param module_name [String] name of the constant you want built\n @param options [Hash] Swagger API options. It will be used to build the\n   [Configuration]. Supports the `:host` value for now.\n Dynamically creates a new resource on top of `Svelte::Service` with the\n name `module_name`, based on the Swagger API description provided\n in `raw_hash`\n @return [Module] the module built", "Creates typed Ruby objects from JSON definitions. These definitions are\n found in the Swagger JSON spec as a top-level key, \"definitions\".\n @param json [Hash] hash of a swagger models definition\n @return [Hash] A hash of model names to models created", "OAuth 2.0 for server-side web applications\n\n The server-side flow for web applications with servers that can securely store persistent information\n\n   client = Googl::OAuth2.server(\"client_id\", \"client_secret\", \"redirect_uri\")", "Decode an unpadded URL-safe Base64 string\n\n @param string [String] URL-safe Base64 string to be decoded (sans '=' padding)\n @return [String] decoded string", "Creates a new Path.\n @param path [String] path i.e. `'/store/inventory'`\n @param operations [Hash] path operations\n Path operations\n @return [Array<Operation>] list of operations for the path", "Creates an `entity` in your Harvest account.\n\n @param entity [Harvesting::Models::Base] A new record in your Harvest account\n @return [Harvesting::Models::Base] A subclass of `Harvesting::Models::Base` updated with the response from Harvest", "It removes an `entity` from your Harvest account.\n\n @param entity [Harvesting::Models::Base] A record to be removed from your Harvest account\n @return [Hash]\n @raise [UnprocessableRequest] When HTTP response is not 200 OK", "Performs a GET request and returned the parsed JSON as a Hash.\n\n @param path [String] path to be combined with `DEFAULT_HOST`\n @param opts [Hash] key/values will get passed as HTTP (GET) parameters\n @return [Hash]", "Given a set of items, each with a weight and a value, determines\n the maximum profit you can have while keeping the overall weight\n smaller than the capacity of the knapsack.\n\n @param items [Array<Array>] An array of pairs (weight, profit) representing the items\n @param capacity [Integer] The capacity of the knapsack\n @param algorithm [:memoize, :dynamic] The algorithm used to solve this, defaults to :dynamic", "prev_sib returns the network immediately preceding this one or nil if this network is 0.0.0.0.", "summ creates a summary address from this IPv4Net and another.\n It returns nil if the two networks are incapable of being summarized.", "contains returns true if the IPv6Net contains the IPv6", "bytes returns a list containing each byte of the EUI64 as a String.", "Set a value for a composite key and overrides any existing keys.\n Keys are case-insensitive\n\n @api public", "Set a value for a composite key if not present already\n\n @param [Array[String|Symbol]] keys\n   the keys to set value for\n\n @api public", "Bind a key to ENV variable\n\n @example\n   set_from_env(:host)\n   set_from_env(:foo, :bar) { 'HOST' }\n\n @param [Array[String]] keys\n   the keys to bind to ENV variables\n\n @api public", "Fetch value under a composite key\n\n @param [Array[String|Symbol]] keys\n   the keys to get value at\n @param [Object] default\n\n @api public", "Append values to an already existing nested key\n\n @param [Array[String|Symbol]] values\n   the values to append\n\n @api public", "Remove a set of values from a nested key\n\n @param [Array[String|Symbol]] keys\n   the keys for a value removal\n\n @api public", "Define an alias to a nested key\n\n @example\n   alias_setting(:foo, to: :bar)\n\n @param [Array[String]] keys\n   the alias key\n\n @api public", "Register a validation rule for a nested key\n\n @param [Array[String]] keys\n   a deep nested keys\n @param [Proc] validator\n   the logic to use to validate given nested key\n\n @api public", "Find and read a configuration file.\n\n If the file doesn't exist or if there is an error loading it\n the TTY::Config::ReadError will be raised.\n\n @param [String] file\n   the path to the configuration file to be read\n\n @param [String] format\n   the format to read configuration in\n\n @raise [TTY::Config::ReadError]\n\n @api public", "Write current configuration to a file.\n\n @param [String] file\n   the path to a file\n\n @api public", "Ensure that value is set either through parameter or block\n\n @api private", "Check if key passes all registered validations for a key\n\n @param [String] key\n @param [Object] value\n\n @api private", "Set value under deeply nested keys\n\n The scan starts with the top level key and follows\n a sequence of keys. In case where intermediate keys do\n not exist, a new hash is created.\n\n @param [Hash] settings\n\n @param [Array[Object]]\n   the keys to nest\n\n @api private", "Fetch value under deeply nested keys with indiffernt key access\n\n @param [Hash] settings\n\n @param [Array[Object]] keys\n\n @api private", "Marshal data hash into a configuration file content\n\n @return [String]\n\n @api private", "Save the certificate and key", "Retrieves the count of the table\n @param [List of Hash/String] where Filter conditions\n @return [Fixnum] Count of the records.", "Inserts a record into the table with the given hash.\n Skip insertion when duplicate record is found.\n @note This is not SQL standard. Only works if the database supports insert ignore syntax.\n @param [Hash] data_hash Column values in Hash\n @return [Fixnum] Number of affected records", "Replaces a record in the table with the new one with the same unique key.\n @note This is not SQL standard. Only works if the database supports replace syntax.\n @param [Hash] data_hash Column values in Hash\n @return [Fixnum] Number of affected records", "Deletes records matching given condtion\n @param [List of Hash/String] where Delete filters\n @return [Fixnum] Number of affected records", "Returns a new TableWrapper object which can be used to execute a select\n statement for the table selecting only the specified fields.\n If a block is given, executes the select statement and yields each row to the block.\n @param [*String/*Symbol] fields List of fields to select\n @return [JDBCHelper::TableWrapper]\n @since 0.4.0", "Returns a new TableWrapper object which can be used to execute a select\n statement for the table with the specified filter conditions.\n If a block is given, executes the select statement and yields each row to the block.\n @param [List of Hash/String] conditions Filter conditions\n @return [JDBCHelper::TableWrapper]\n @since 0.4.0", "Returns a new TableWrapper object which can be used to execute a select\n statement for the table with the given sorting criteria.\n If a block is given, executes the select statement and yields each row to the block.\n @param [*String/*Symbol] criteria Sorting criteria\n @return [JDBCHelper::TableWrapper]\n @since 0.4.0", "Returns a new TableWrapper object with default values, which will be applied to\n the subsequent inserts and updates.\n @param [Hash] data_hash Default values\n @return [JDBCHelper::TableWrapper]\n @since 0.4.5", "Returns a new TableWrapper object with the given fetch size.\n If a block is given, executes the select statement and yields each row to the block.\n @param [Fixnum] fsz Fetch size\n @return [JDBCHelper::TableWrapper]\n @since 0.7.7", "Executes a select SQL for the table and returns an Enumerable object,\n or yields each row if block is given.\n @return [JDBCHelper::Connection::ResultSet]\n @since 0.4.0", "Clear batched operations.\n @param [*Symbol] types Types of batched operations to clear.\n   If not given, :insert, :update and :delete.\n @return [nil]", "Closes the prepared statements\n @since 0.5.0", "Returns the result of the function call with the given parameters", "Executes the procedure and returns the values of INOUT & OUT parameters in Hash\n @return [Hash]", "Internal - unpacks a string of big endian, 64 bit integers\n\n bytes - an array of ints\n\n Returns the original byte sequence as a string", "Executes the given code block as a transaction. Returns true if the transaction is committed.\n A transaction object is passed to the block, which only has commit and rollback methods.\n The execution breaks out of the code block when either of the methods is called.\n @yield [JDBCHelper::Connection::Transaction] Responds to commit and rollback.\n @return [Boolean] True if committed", "Executes an SQL and returns the count of the update rows or a ResultSet object\n depending on the type of the given statement.\n If a ResultSet is returned, it must be enumerated or closed.\n @param [String] qstr SQL string\n @return [Fixnum|ResultSet]", "Executes a select query.\n When a code block is given, each row of the result is passed to the block one by one.\n If not given, ResultSet is returned, which can be used to enumerate through the result set.\n ResultSet is closed automatically when all the rows in the result set is consumed.\n\n @example Nested querying\n   conn.query(\"SELECT a FROM T\") do | trow |\n     conn.query(\"SELECT * FROM U_#{trow.a}\").each_slice(10) do | urows |\n       # ...\n     end\n   end\n @param [String] qstr SQL string\n @yield [JDBCHelper::Connection::Row]\n @return [Array]", "Executes batched statements including prepared statements. No effect when no statement is added\n @return [Fixnum] Sum of all update counts", "Returns a table wrapper for the given table name\n @since 0.2.0\n @param [String/Symbol] table_name Name of the table to be wrapped\n @return [JDBCHelper::TableWrapper]", "Strip off nested attributes of associations before saving, or type-mismatch errors will occur", "Unzips the excel file to a temporary directory. The directory will be removed at the end of the parsing stage when invoked\n by initialize, otherwise at exit.\n @param [String] filename the name of the Excel file to be unpacked", "Parses sheet data by feeding the output of the Xlsheet SAX parser into the arrays representing the sheets.\n @param [Hash] options Options that affect the parser.", "Build the relationship between sheets and the XML files storing the comments\n to the actual sheet.", "Invokes the Sharedstrings helper class", "Parses the comments related to the actual sheet.\n @param [String] commentfile\n @return [Array] a collection of comments relative to the Excel sheet currently processed", "Replace the empty values of the mergegroup with cell values or nil.\n @param [Matrix] m the Sheet object\n @param [Integer] col Column of the actual cell\n @param [Integer] row Row of the actual cell\n @param [Cell] valuecell A Cell containing the value to be copied over the mergegroup\n @return [Matrix, Cell] the sheet and the new (empty) cell or nil.", "Convert excel-style date formats into ruby DateTime strftime format strings\n @param [String] formatcode an Excel number format string.\n @return [String] a DateTime::strftime format string.", "Get the cell's value and excel format string and return a string, a ruby Numeric or a DateTime object accordingly\n @return [Object] A ruby object that holds and represents the value stored in the cell. Conversion is based on cell formatting.\n @example Get the value of a cell:\n   c = w.sheets[0][\"B3\"] # => <Oxcelix::Cell:0x00000002a5b368 @xlcoords=\"A3\", @style=\"84\", @type=\"n\", @value=\"41155\", @numformat=14>\n   c.to_ru # => <DateTime: 2012-09-03T00:00:00+00:00 ((2456174j,0s,0n),+0s,2299161j)>", "Get the cell's value, convert it with to_ru and finally, format it based on the value's type.\n @return [String] Value gets formatted depending on its class. If it is a DateTime, the #DateTime.strftime method is used,\n if it holds a number, the #Kernel::sprintf is run.\n @example Get the formatted value of a cell:\n   c = w.sheets[0][\"B3\"] # => <Oxcelix::Cell:0x00000002a5b368 @xlcoords=\"A3\", @style=\"84\", @type=\"n\", @value=\"41155\", @numformat=14>\n   c.to_fmt # => \"3/9/2012\"", "The to_m method returns a simple Matrix object filled with the raw values of the original Sheet object.\n @return [Matrix] a collection of string values (the former #Cell::value)", "Build the body of the envelope\n\n @example\n   env.body do |b|\n     b.some 'data'\n   end", "Build the header of the envelope", "Init function with \"orta\", \"project\"\n Will do some magic to try and pull out a reasonable search query\n for an exception, then searches with that", "Queries for an specific search string", "Get a single type, or a NullType if the type doesn't exist", "SOAP fault, if any", "Searches for a query, with a UI delegate", "Generates a URL for the request", "Gets the search results", "Converts a GitHub search JSON into a InspectionReport", "The commenter's name for a Comment. When the Comment has a website, includes an html\n link containing their name. Otherwise, just shows the name as a String.\n\n comment - A {Blogit::Comment}\n\n Returns a String containing the commenter's name.", "Draws a directed graph of the machine for visualizing the various events,\n states, and their transitions.\n\n This requires both the Ruby graphviz gem and the graphviz library be\n installed on the system.\n\n Configuration options:\n * <tt>:name</tt> - The name of the file to write to (without the file extension).\n   Default is \"#{owner_class.name}_#{name}\"\n * <tt>:path</tt> - The path to write the graph file to.  Default is the\n   current directory (\".\").\n * <tt>:format</tt> - The image format to generate the graph in.\n   Default is \"png'.\n * <tt>:font</tt> - The name of the font to draw state names in.\n   Default is \"Arial\".\n * <tt>:orientation</tt> - The direction of the graph (\"portrait\" or\n   \"landscape\").  Default is \"portrait\".\n * <tt>:human_names</tt> - Whether to use human state / event names for\n   node labels on the graph instead of the internal name.  Default is false.", "Creates an HTML div with a default class value added\n\n default_class      - The CSS class name to add to the div\n content_or_options - The content to include in the div when not using a block. The\n                      options Hash when using a block\n options            - The options when not using a block\n block              - A block that returns HTML content to include in the div\n\n\n Returns an HTML safe String", "Creates new Pos instance\n @param [Hash] options options hash\n @return [Object] Pos object", "Creates new transaction\n @param [Hash] options options hash for new transaction\n @return [Object] Transaction object", "Generates form fields for specified transaction object", "Verifies signature of passed parameters from Payu request", "Create a custom request using a provided method and URL path\n @example Make a GET request to 'https://api.smartsheet.com/2.0/sheets/list'\n   client.request(method: :get, url_path: 'sheets/list')", "Create a custom request using a provided method, URL path, and file details\n @example Make a POST request to 'https://api.smartsheet.com/2.0/sheets/1/attachments' with a file\n   client.request_with_file(\n     method: :get,\n     url_path: 'sheets/1/attachments',\n     file: File.open('my-file.docx'),\n     file_length: 1000,\n     filename: 'my-uploaded-file.docx',\n     content_type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'\n   )", "Create a custom request using a provided method, URL path, and filepath details\n @example Make a POST request to 'https://api.smartsheet.com/2.0/sheets/1/attachments' with a file\n   client.request_with_file_from_path(\n     method: :get,\n     url_path: 'sheets/1/attachments',\n     path: './my-file.docx',\n     filename: 'my-uploaded-file.docx',\n     content_type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'\n   )", "Prints a list of plugins and details\n\n options - a Hash of options from the `list` command\n\n   Note: if options are empty, this will display a\n   list of plugin names, slugs, versions, and descriptions,\n   but no assets, i.e. 'minimal' info.", "Makes it easy for Ink plugins to copy README and CHANGELOG\n files to doc folder to be used as a documentation asset file\n\n Usage: In rakefile require 'octopress-ink'\n        then add task calling Octopress::Ink.copy_doc for each file", "Simulate a connection being established", "auth for private and presence", "Open a Ruby console with a connection to OneView", "Show environment variables for oneview-sdk-ruby", "Show resource details", "Make REST call to the OneView API", "Update resource by name", "Delete resource by name", "Delete resource defined in file", "Save resource details to file", "Check, import, or list OneView certs", "Subscribe to the OneView SCMB", "Get resource class from given string", "Select a subset of attributes from a given resource\n @param attributes [String, Array<Array<String>>] Comma-separated string or array of array of strings\n   The reason it's a nested array is to allow retrieval of nested keys.\n   For example, the following 2 attribute params will return the same result:\n     - [['key1'], ['key2', 'subKey3']]\n     - 'key1,key2.subKey3'\n @param data [Hash, OneviewSDK::Resource]\n @return [Hash] A Hash is returned. For example:\n   { 'key1' => 'val1', 'key2' => { 'subKey3' => 'val2' } }", "Select a subset of attributes from a given set of resources\n @param attributes [String, Array<Array<String>>] Comma-separated string or array of array of strings\n   The reason it's a nested array is to allow retrieval of nested keys.\n   For example, the following 2 attribute params will return the same result:\n     - [['key1'], ['key2', 'subKey3']]\n     - 'key1,key2.subKey3'\n @param data [Array<Hash>, Array<OneviewSDK::Resource>]\n @return [Array<Hash>] An Array of Hashes is returned. For example:\n   [\n     { 'resource_name1' => { 'key1' => 'val1', 'key2' => { 'subKey3' => 'val2' } } },\n     { 'resource_name2' => { 'key1' => 'val3', 'key2' => { 'subKey3' => 'val4' } } },\n   ]", "Get array of all resources of a specified type\n @param [String] type Resource type\n @param [Integer] api_ver API module version to fetch resources from\n @param [String] variant API module variant to fetch resource from\n @return [Array<Resource>] Results\n @example Get all Ethernet Networks\n   networks = @client.get_all('EthernetNetworks')\n   synergy_networks = @client.get_all('EthernetNetworks', 300, 'Synergy')\n @raise [TypeError] if the type is invalid", "Wait for a task to complete\n @param [String] task_uri\n @raise [OneviewSDK::TaskError] if the task resulted in an error or early termination.\n @return [Hash] if the task completed successfully, return the task details", "Get current api version from the OneView appliance", "Log in to OneView appliance and return the session token", "in seconds, 5 minutes\n Makes a restful API request to OneView\n @param [Symbol] type The rest method/type Options: [:get, :post, :delete, :patch, :put]\n @param [String] path The path for the request. Usually starts with \"/rest/\"\n @param [Hash] options The options for the request\n @option options [String] :body Hash to be converted into json and set as the request body\n @option options [String] :Content-Type ('application/json') Set to nil or :none to have this option removed\n @option options [Integer] :X-API-Version (client.api_version) API version to use for this request\n @option options [Integer] :auth (client.token) Authentication token to use for this request\n @param [Integer] api_ver The api version to use when interracting with this resource\n @param [Integer] redirect_limit Number of redirects it is allowed to follow\n @raise [OpenSSL::SSL::SSLError] if SSL validation of OneView instance's certificate failed\n @return [NetHTTPResponse] Response object", "Uploads a file to a specific uri\n @param [String] file_path\n @param [String] path The url path starting with \"/\"\n @param [Hash] options The options for the request. Default is {}.\n @option options [String] :body Hash to be converted into json and set as the request body\n @option options [String] :header Hash to be converted into json and set as the request header\n @option options [String] :file_name String that defines the new file name\n @param [Integer] timeout The number of seconds to wait for completing the request. Default is 300.\n @return [Hash] The parsed JSON body of response", "Download a file from a specific uri\n @param [String] path The url path starting with \"/\"\n @param [String] local_drive_path Path to save file downloaded\n @return [Boolean] if file was downloaded", "Handles the response from a rest call.\n   If an asynchronous task was started, this waits for it to complete.\n @param [HTTPResponse] response HTTP response\n @param [Boolean] wait_on_task Wait on task (or just return task details)\n @raise [OneviewSDK::OneViewError] if the request failed or a task did not complete successfully\n @return [Hash] The parsed JSON body", "Builds a http object using the data given", "Builds a request object using the data given", "This method handles the authorization, raises errors if authorization has failed.", "Check if a resource exists\n @note one of the UNIQUE_IDENTIFIERS, e.g. name or uri, must be specified in the resource\n @param [Hash] header The header options for the request (key-value pairs)\n @return [Boolean] Whether or not resource exists", "Merges the first hash data structure with the second\n @note both arguments should be a Ruby Hash object.\n       The second hash should have strings as a keys.\n       This method will change the second argument.\n @raise [StandardError] if the arguments, or one them, is not a Hash object", "Set the given hash of key-value pairs as resource data attributes\n @param [Hash, Resource] params The options for this resource (key-value pairs or resource object)\n @note All top-level keys will be converted to strings\n @return [Resource] self", "Set a resource attribute with the given value and call any validation method if necessary\n @param [String] key attribute name\n @param value value to assign to the given attribute\n @note Keys will be converted to strings", "Create the resource on OneView using the current data\n @note Calls the refresh method to set additional data\n @param [Hash] header The header options for the request (key-value pairs)\n @raise [OneviewSDK::IncompleteResource] if the client is not set\n @raise [StandardError] if the resource creation fails\n @return [Resource] self", "Delete the resource from OneView if it exists, then create it using the current data\n @note Calls refresh method to set additional data\n @param [Hash] header The header options for the request (key-value pairs)\n @raise [OneviewSDK::IncompleteResource] if the client is not set\n @raise [StandardError] if the resource creation fails\n @return [Resource] self", "Updates this object using the data that exists on OneView\n @note Will overwrite any data that differs from OneView\n @param [Hash] header The header options for the request (key-value pairs)\n @return [Resource] self", "Set data and save to OneView\n @param [Hash] attributes The attributes to add/change for this resource (key-value pairs)\n @param [Hash] header The header options for the request (key-value pairs)\n @raise [OneviewSDK::IncompleteResource] if the client or uri is not set\n @raise [StandardError] if the resource save fails\n @return [Resource] self", "Delete resource from OneView\n @param [Hash] header The header options for the request (key-value pairs)\n @return [true] if resource was deleted successfully", "Save resource to json or yaml file\n @param [String] file_path The full path to the file\n @param [Symbol] format The format. Options: [:json, :yml, :yaml]. Defaults to .json\n @note If a .yml or .yaml file extension is given in the file_path, the format will be set automatically\n @return [True] The Resource was saved successfully", "Recursive helper method for like?\n Allows comparison of nested hash structures", "Order amount should be equal to gross - discount", "This Helper creates form with all parameters added.\n\n  <% payment_form_for_payu 'YOUR_KEY', 'YOUR_SALT',\n       :txnid => @cart.id,\n       :amount => @cart.total_price,\n       :productinfo => 'Book',\n       :firstname => 'abc',\n       :email => 'abc@example.com',\n       :phone => '1234567890',\n       :surl => 'http://localhost:3000/payu_callback',\n       :furl => 'http://localhost:3000/payu_callback',\n       :html => { :id => 'payment-form' } %>", "render src as ERB", "read in filename and render it as ERB", "Loads a Pitcher object given a game id and a player id", "Returns an array of PitchingAppearance objects for all of the pitchers starts", "Returns an array of the atbats against this pitcher during this game", "Returns an array of pitches thrown by this pitcher during this game", "Loads the boxscore XML from the MLB gameday server and parses it using REXML", "Converts the boxscore into a formatted HTML representation.\n Relies on the boxscore.html.erb template for describing the layout", "Retrieves basic game data from the XML root element and sets in object", "Sets an array of hashes where each hash holds data for a pitcher whom appeared\n in the game.  Specify either home or away team pitchers.", "Sets an array of hashes where each hash holds data for a batter whom appeared\n in the game.  Specify either home or away team batters.", "Returns an array of all games for this team for the specified season", "Returns an array of all home games for this team for the specified season", "Returns an array of all away games for this team for the specified season", "Returns an array of the team's game objects for the date passed in.", "Returns an array of BattingAppearance containing the leadoff hitters for each game of the specified season.", "Returns an array of BattingAppearance of all hitters who have led off at least one game during the specified season", "Returns an array containing the cleanup hitters for each game of the specified season.\n The cleanup hitter is the 4th hitter in the batting order", "Returns an array of all pitchers who have started at least one game during the specified season", "Returns an array of all pitchers who have closed at least one game during the specified season", "Returns a count of the number of quality starts for this team for the specified year.", "Returns a game object representing the opening day game for this team for\n the season passed in.", "Returns a Roster object representing the opening day roster for this team\n for the specified year.", "Returns an array of game id's for the given date", "Initializes a Player object by reading the player data from the players.xml file for the player specified by game id and player id.", "Initializes pitcher info from data read from the masterscoreboard.xml file", "Returns the number of at bats over the entire season for this player", "Initialize a player object by reading data from the players.xml file", "Downloads all data files associated with the game specified by the game id passed in.", "Writes the gameday data to the file specified.\n Does not overwrite existing files.", "Setup a Game object from data read from the  master_scoreboard.xml file", "Sets the game status from data in the master_scoreboard.xml file", "Sets the away and home innings array containing scores by inning from data in the master_scoreboard.xml file", "Sets a list of players who had homeruns in this game from data in the master_scoreboard.xml file", "Returns an array of all pitchers for either the home team or the away team.\n The values in the returned array are PitchingAppearance instances", "Returns an array of pitches from this game for the pitcher identified by pid", "Returns an array of either home or away batters for this game\n home_or_away must be a string with value 'home' or 'away'\n The values in the returned array are BattingAppearance instances", "Returns the team abreviation of the winning team", "Returns an array of Inning objects that represent each inning of the game", "Returns an array of AtBat objects that represent each atbat of the game", "Initialize this instance from an XML element containing linescore data.", "Looks up the player record using the players.xml file for the player in this appearance", "loads an Inning object given a game id and an inning number", "type = home or away", "extracted and simplified from Devise", "player\n team\n game\n atbat\n pitch\n pitch type\n game type\n umpire", "This sideloads sshd after a container starts", "a puppet run may have changed the ssh config which would\n keep us out of the container.  This is a best effort to fix it.\n Optionally pass in a host object to to determine which ssh\n restart command we should try.", "return the existing container if we're not provisioning\n and docker_container_name is set", "Loads the players XML from the MLB gameday server and parses it using REXML", "Used to set game_id and home_or_away flag", "Update the game records to point to the first instance of the specific umpires\n originally new umpire records were being inserted for every game, which is what caused this problem", "Loads the eventLog XML from the MLB gameday server and parses it using REXML", "Sets the team names for the teams involved in this game", "Entry point for Rack", "this should always be running synchronously within this thread", "this should be running synchronously if @buffer_over_limit i.e. called from self.buffer\n else asynchronously through @task", "Run all the queries currently in the queue. This will return an array of\n results hashes.", "Query the Sphinx daemon - defaulting to all indices, but you can specify\n a specific one if you wish. The search parameter should be a string\n following Sphinx's expectations.\n\n The object returned from this method is a hash with the following keys:\n\n * :matches\n * :fields\n * :attributes\n * :attribute_names\n * :words\n * :total\n * :total_found\n * :time\n * :status\n * :warning (if appropriate)\n * :error (if appropriate)\n\n The key <tt>:matches</tt> returns an array of hashes - the actual search\n results. Each hash has the document id (<tt>:doc</tt>), the result\n weighting (<tt>:weight</tt>), and a hash of the attributes for the\n document (<tt>:attributes</tt>).\n\n The <tt>:fields</tt> and <tt>:attribute_names</tt> keys return list of\n fields and attributes for the documents. The key <tt>:attributes</tt>\n will return a hash of attribute name and type pairs, and <tt>:words</tt>\n returns a hash of hashes representing the words from the search, with the\n number of documents and hits for each, along the lines of:\n\n   results[:words][\"Pat\"] #=> {:docs => 12, :hits => 15}\n\n <tt>:total</tt>, <tt>:total_found</tt> and <tt>:time</tt> return the\n number of matches available, the total number of matches (which may be\n greater than the maximum available, depending on the number of matches\n and your sphinx configuration), and the time in milliseconds that the\n query took to run.\n\n <tt>:status</tt> is the error code for the query - and if there was a\n related warning, it will be under the <tt>:warning</tt> key. Fatal errors\n will be described under <tt>:error</tt>.", "Update attributes - first parameter is the relevant index, second is an\n array of attributes to be updated, and the third is a hash, where the\n keys are the document ids, and the values are arrays with the attribute\n values - in the same order as the second parameter.\n\n Example:\n\n   client.update('people', ['birthday'], {1 => [Time.at(1982, 20, 8).to_i]})", "Generation of the message to send to Sphinx for a search.", "Generation of the message to send to Sphinx for an excerpts request.", "Generation of the message to send to Sphinx to update attributes of a\n document.", "Generates the simple message to send to the daemon for a keywords request.", "Any validation errors that are present on the OpenAPI document\n\n @return [Validation::ErrorCollection]", "Used to register a reference with the underlying document and return a\n reference resolver to access the object referenced\n\n @param  [String]        given_reference   The reference as text\n @param  [NodeFactory]   factory           Factory class for the expected\n                                           eventual resource\n @param  [Context]       context           The context of the object\n                                           calling this reference\n @return [ReferenceResolver]", "Access the data in a source at a particular pointer\n\n @param  [Array] json_pointer  An array of segments of a JSON pointer\n @return [Object]", "Number of pages to display.\n\n @return [Array<Integer>]", "Mention potential reviewers.\n\n @param   [Integer] max_reviewers\n          Maximum number of people to ping in the PR message, default is 3.\n @param   [Array<String>] file_blacklist\n          Regexes of ignored files.\n @param   [Array<String>] user_blacklist\n          List of users that will never be mentioned.\n @return  [void]", "Pushes new nodes to the end of the list.\n\n == Parameters:\n node:: Any object, including +Node+ objects.\n\n == Returns:\n +self+ of +List+ object.", "Pushes new nodes on top of the list.\n\n == Parameters:\n node:: Any object, including +Node+ objects.\n\n == Returns:\n +self+ of +List+ object.", "Inserts after or before first matched node.data from the the list by passed block or value.\n\n == Returns:\n Inserted node data", "Inserts data after first matched node.data.\n\n == Returns:\n Inserted node", "Inserts data before first matched node.data.\n\n == Returns:\n Inserted node", "Removes first matched node.data from the the list by passed block or value.\n\n If +val+ is a +Node+, removes that node from the list. Behavior is\n undefined if +val+ is a +Node+ that's not a member of this list.\n\n == Returns:\n Deleted node's data", "Removes all matched data.data from the the list by passed block or value.\n\n == Returns:\n Array of deleted nodes", "Regenerate the session ID.\n\n :api: private", "Create a list of HtmlMethod objects for each method\n in the corresponding context object. If the @options.show_all\n variable is set (corresponding to the <tt>--all</tt> option,\n we include all methods, otherwise just the public ones.", "Given a sequence of source tokens, mark up the source code\n to make it look purty.", "Sends the mail using SMTP.", "Creates a new worker thread that loops over the work queue.\n\n :api: private\n Processes tasks in the Merb::Dispatcher.work_queue.\n\n :api: private", "Handles request routing and action dispatch.\n\n ==== Returns\n Array[Integer, Hash, #each]:: A Rack response\n\n :api: private", "Setup the controller and call the chosen action\n\n ==== Parameters\n klass<Merb::Controller>:: The controller class to dispatch to.\n action<Symbol>:: The action to dispatch.\n status<Integer>:: The status code to respond with.\n\n ==== Returns\n Array[Integer, Hash, #each]:: A Rack response\n\n :api: private", "Re-route the current request to the Exception controller if it is\n available, and try to render the exception nicely.\n\n You can handle exceptions by implementing actions for specific\n exceptions such as not_found or for entire classes of exceptions\n such as client_error. You can also implement handlers for\n exceptions outside the Merb exception hierarchy (e.g.\n StandardError is caught in standard_error).\n\n ==== Parameters\n exception<Object>::\n   The exception object that was created when trying to dispatch the\n   original controller.\n\n ==== Returns\n Array[Integer, Hash, #each]:: A Rack response\n\n :api: private", "Renders the block given as a parameter using chunked encoding.\n\n ==== Parameters\n &blk::\n   A block that, when called, will use send_chunks to send chunks of data\n   down to the server. The chunking will terminate once the block returns.\n\n ==== Examples\n   def stream\n     prefix = '<p>'\n     suffix = \"</p>\\r\\n\"\n     render_chunked do\n       IO.popen(\"cat /tmp/test.log\") do |io|\n         done = false\n         until done\n           sleep 0.3\n           line = io.gets.chomp\n\n           if line == 'EOF'\n             done = true\n           else\n             send_chunk(prefix + line + suffix)\n           end\n         end\n       end\n     end\n   end\n\n :api: public", "Renders the passed in string, then calls the block outside the mutex and\n after the string has been returned to the client.\n\n ==== Parameters\n str<String>:: A +String+ to return to the client.\n &blk:: A block that should get called once the string has been returned.\n\n ==== Returns\n Proc::\n   A block that Mongrel can call after returning the string to the user.\n\n :api: public", "Sends a file over HTTP.  When given a path to a file, it will set the\n right headers so that the static file is served directly.\n\n ==== Parameters\n file<String>:: Path to file to send to the client.\n opts<Hash>:: Options for sending the file (see below).\n\n ==== Options (opts)\n :disposition<String>::\n   The disposition of the file send. Defaults to \"attachment\".\n :filename<String>::\n   The name to use for the file. Defaults to the filename of file.\n :type<String>:: The content type.\n\n ==== Returns\n IO:: An I/O stream for the file.\n\n :api: public", "Send binary data over HTTP to the user as a file download. May set content type,\n apparent file name, and specify whether to show data inline or download as an attachment.\n\n ==== Parameters\n data<String>:: Path to file to send to the client.\n opts<Hash>:: Options for sending the data (see below).\n\n ==== Options (opts)\n :disposition<String>::\n   The disposition of the file send. Defaults to \"attachment\".\n :filename<String>::\n   The name to use for the file. Defaults to the filename of file.\n :type<String>:: The content type.\n\n :api: public", "Streams a file over HTTP.\n\n ==== Parameters\n opts<Hash>:: Options for the file streaming (see below).\n &stream::\n   A block that, when called, will return an object that responds to\n   +get_lines+ for streaming.\n\n ==== Options\n :disposition<String>::\n   The disposition of the file send. Defaults to \"attachment\".\n :type<String>:: The content type.\n :content_length<Numeric>:: The length of the content to send.\n :filename<String>:: The name to use for the streamed file.\n\n ==== Examples\n   stream_file({ :filename => file_name, :type => content_type,\n     :content_length => content_length }) do |response|\n     AWS::S3::S3Object.stream(user.folder_name + \"-\" + user_file.unique_id, bucket_name) do |chunk|\n       response.write chunk\n     end\n   end\n\n :api: public", "Sets a cookie to be included in the response.\n\n If you need to set a cookie, then use the +cookies+ hash.\n\n ==== Parameters\n name<~to_s>:: A name for the cookie.\n value<~to_s>:: A value for the cookie.\n expires<~gmtime:~strftime, Hash>:: An expiration time for the cookie, or a hash of cookie options.\n\n :api: public", "Process a redirect url with options, appending messages onto the url as query params\n\n ==== Parameter\n url<String>:: the url being redirected to\n\n ==== Options (opts)\n :message<Hash>::\n   A hash of key/value strings to be passed along within the redirect query params.\n :notice<String>::\n   A shortcut to passing :message => {:notice => \"...\"}\n :error<String>::\n   A shortcut to passing :message => {:error => \"...\"}\n :success<String>::\n   A shortcut to passing :message => {:success => \"...\"}\n\n ==== Returns\n String:: the new url with messages attached\n\n :api: private", "Calls a filter chain.\n\n ==== Parameters\n filter_set<Array[Filter]>::\n   A set of filters in the form [[:filter, rule], [:filter, rule]]\n\n ==== Returns\n Symbol:: :filter_chain_completed.\n\n ==== Notes\n Filter rules can be Symbols, Strings, or Procs.\n\n Symbols or Strings::\n   Call the method represented by the +Symbol+ or +String+.\n Procs::\n   Execute the +Proc+, in the context of the controller (self will be the\n   controller)\n\n :api: private", "Returns the absolute url including the passed protocol and host.\n\n This uses the same arguments as the url method, with added requirements\n of protocol and host options.\n\n :api: public", "Calls the capture method for the selected template engine.\n\n ==== Parameters\n *args:: Arguments to pass to the block.\n &block:: The block to call.\n\n ==== Returns\n String:: The output of a template block or the return value of a non-template block converted to a string.\n\n :api: public", "if you need to handle the render yourself for some reason, you can call\n this method directly. It sends notifications without any rendering logic.\n Note though that if you are sending lots of notifications this could\n delay sending a response back to the user so try to avoid using it\n where possible.", "Creates directory for cached files unless it exists.\n File caching does not support expiration time.", "Reads cached template from disk if it exists.", "Writes cached template to disk, creating cache directory\n if it does not exist.", "Fetches cached data by key if it exists. If it does not,\n uses passed block to get new cached value and writes it\n using given key.", "Reads file content. Access to the file\n uses file locking.", "Writes file content. Access to the file\n uses file locking.", "persists the data so that it can be retrieved by the key & parameters.\n returns nil if it is unable to persist the data.\n returns true if successful.", "persists the data to all context stores.\n returns nil if none of the stores were able to persist the data.\n returns true if at least one write was successful.", "tries to read the data from the store.  If that fails, it calls\n the block parameter and persists the result.  If it cannot be fetched,\n the block call is returned.", "deletes the entry for the key & parameter from the store.", "This method will store the user provided into the session\n and set the user as the currently logged in user\n @return <User Class>|NilClass", "The workhorse of the framework.  The authentiate! method is where\n the work is done.  authenticate! will try each strategy in order\n either passed in, or in the default_strategy_order.\n\n If a strategy returns some kind of user object, this will be stored\n in the session, otherwise a Merb::Controller::Unauthenticated exception is raised\n\n @params Merb::Request, [List,Of,Strategies, optional_options_hash]\n\n Pass in a list of strategy objects to have this list take precedence over the normal defaults\n\n Use an options hash to provide an error message to be passed into the exception.\n\n @return user object of the verified user.  An exception is raised if no user is found", "Generate any necessary headers.\n\n ==== Returns\n Hash:: The headers to set, or an empty array if no cookies are set.\n\n :api: private", "Reads key from the cache.", "Writes data to the cache using key, parameters and conditions.", "Helper method to filter out duplicate files.\n\n ==== Parameters\n options<Hash>:: Options to pass to include tag methods.", "Deletes any sessions that have reached their maximum validity.\n\n :api: private", "Create the raw cookie string; includes an HMAC keyed message digest.\n\n ==== Returns\n String:: Cookie value.\n\n ==== Raises\n CookieOverflow:: More than 4K of data put into session.\n\n ==== Notes\n Session data is converted to a Hash first, since a container might\n choose to marshal it, which would make it persist\n attributes like 'needs_new_cookie', which it shouldn't.\n\n :api: private", "Securely compare two digests using a constant time algorithm.\n This avoids leaking information about the calculated HMAC\n\n Based on code by Michael Koziarski <michael@koziarski.com>\n http://github.com/rails/rails/commit/674f780d59a5a7ec0301755d43a7b277a3ad2978\n\n ==== Parameters\n a, b<~to_s>:: digests to compare.\n\n ==== Returns\n Boolean:: Do the digests validate?", "Unmarshal cookie data to a hash and verify its integrity.\n\n ==== Parameters\n cookie<~to_s>:: The cookie to unmarshal.\n\n ==== Raises\n TamperedWithCookie:: The digests don't match.\n\n ==== Returns\n Hash:: The stored session data.\n\n :api: private", "Returns the controller object for initialization and dispatching the\n request.\n\n ==== Returns\n Class:: The controller class matching the routed request,\n   e.g. Posts.\n\n :api: private", "Parameters passed in the body of the request. Ajax calls from\n prototype.js and other libraries pass content this way.\n\n ==== Returns\n Hash:: The parameters passed in the body.\n\n :api: private", "This is the main method to use as a before filter.  You can call it with options\n and strategies to use.  It will check if a user is logged in, and failing that\n will run through either specified.\n\n @params all are optional.  A list of strategies, optionally followed by a\n options hash.\n\n If used with no options, or only the hash, the default strategies will be used\n see Authentictaion.default_strategy_order.\n\n If a list of strategies is passed in, the default strategies are ignored, and\n the passed in strategies are used in order until either one is found, or all fail.\n\n A failed login will result in an Unauthenticated exception being raised.\n\n Use the :message key in the options hash to pass in a failure message to the\n exception.\n\n === Example\n\n    class MyController < Application\n      before :ensure_authenticated, :with => [OpenID,FormPassword, :message => \"Failz!\"]\n       #... <snip>\n    end", "Issues a callback.", "Sets the content type of the current response to a value based on\n a passed in key. The Content-Type header will be set to the first\n registered header for the mime-type.\n\n ==== Parameters\n type<Symbol>:: The content type.\n\n ==== Raises\n ArgumentError:: type is not in the list of registered mime-types.\n\n ==== Returns\n Symbol:: The content-type that was passed in.\n\n :api: plugin", "Allows you to render various types of things into the text and HTML parts\n of an email If you include just text, the email will be sent as\n plain-text. If you include HTML, the email will be sent as a multi-part\n email.\n\n ==== Parameters\n options<~to_s, Hash>::\n   Options for rendering the email or an action name. See examples below\n   for usage.\n\n ==== Examples\n There are a lot of ways to use render_mail, but it works similarly to the\n default Merb render method.\n\n First of all, you'll need to store email files in your\n app/mailers/views directory. They should be under a directory that\n matches the name of your mailer (e.g. TestMailer's views would be stored\n under test_mailer).\n\n The files themselves should be named action_name.mime_type.extension. For\n example, an erb template that should be the HTML part of the email, and\n rendered from the \"foo\" action would be named foo.html.erb.\n\n The only mime-types currently supported are \"html\" and \"text\", which\n correspond to text/html and text/plain respectively. All template systems\n supported by your app are available to MailController, and the extensions\n are the same as they are throughout the rest of Merb.\n\n render_mail can take any of the following option patterns:\n\n   render_mail\n\n will attempt to render the current action. If the current action is\n \"foo\", this is identical to render_mail :foo.\n\n   render_mail :foo\n\n checks for foo.html.ext and foo.text.ext and applies them as appropriate.\n\n   render_mail :action => {:html => :foo, :text => :bar}\n\n checks for foo.html.ext and bar.text.ext in the view directory of the\n current controller and adds them to the mail object if found\n\n   render_mail :template => {:html => \"foo/bar\", :text => \"foo/baz\"}\n\n checks for bar.html.ext and baz.text.ext in the foo directory and adds\n them to the mail object if found.\n\n   render_mail :html => :foo, :text => :bar\n\n the same as render_mail :action => {html => :foo, :text => :bar }\n\n   render_mail :html => \"FOO\", :text => \"BAR\"\n\n adds the text \"FOO\" as the html part of the email and the text \"BAR\" as\n the text part of the email. The difference between the last two examples\n is that symbols represent actions to render, while string represent the\n literal text to render. Note that you can use regular render methods\n instead of literal strings here, like:\n\n   render_mail :html => render(:action => :foo)\n\n but you're probably better off just using render_mail :action at that\n point.\n\n You can also mix and match:\n\n   render_mail :action => {:html => :foo}, :text => \"BAR\"\n\n which would be identical to:\n\n   render_mail :html => :foo, :text => \"BAR\"", "Check status report, say lgtm if no violations\n Generates a `markdown` of a lgtm image.\n\n @param  [String] image_url lgtm image url\n @param  [Boolean] https_image_only https image only if true\n\n @return  [void]", "Loop through the MARC records in the XML document", "will accept parse events until a record has been built up", "validate_response is response validating\n\n @param [Net::HTTPxxx] response Net::HTTP responses\n @raise ::Lgtm::Errors::UnexpectedError\n @return [void]", "Rebuild the HashWithChecksumAttribute with the current\n values of the fields Array", "Provides a backwards compatible means to access the FieldMap.\n No argument returns the FieldMap array in entirety.  Providing\n a string, array or range of tags will return an array of fields\n in the order they appear in the record.", "Initialize the file uploader\n\n @param space_id [String] The Space UUID\n @param file [File] The complete path for file\n @param attributes [Hash] Attributes as a Hash\n Create a file upload\n\n @return [Sawyer::Resource] File upload response.", "Initialize a Request\n\n @param http_method [Symbol] HTTP verb as sysmbol\n @param endpoint [String] The relative API endpoint\n @param data [Hash] Attributes / Options as a Hash\n @return [Ribose::Request]\n\n Make a HTTP Request\n\n @param options [Hash] Additonal options hash\n @return [Sawyer::Resource]", "Turn the variable field and subfields into a hash for MARC-in-JSON", "Resolve function level caching!", "Call the transaction\n\n Once transaction is called it will call the first step and its result\n will be passed to the second step and so on.\n\n @example\n   my_container = {\n     add_one: -> i { i + 1 },\n     add_two: -> j { j + 2 }\n   }\n\n   transaction = Transflow(container: my_container) {\n     step(:one, with: :add_one) { step(:two, with: :add_two) }\n   }\n\n   transaction.call(1) # 4\n\n @param [Object] input The input for the first step\n\n @param [Hash] options The curry-args map, optional\n\n @return [Object]\n\n @raises TransactionFailedError\n\n @api public", "create a name table", "apply some simple regexps to clean up surnames", "Creates a new Hexdump dumper.\n\n @param [Hash] options\n   Additional options.\n\n @option options [Integer] :width (16)\n   The number of bytes to dump for each line.\n\n @option options [Integer] :endian (:little)\n   The endianness that the bytes are organized in. Supported endianness\n   include `:little` and `:big`.\n\n @option options [Integer] :word_size (1)\n   The number of bytes within a word.\n\n @option options [Symbol, Integer] :base (:hexadecimal)\n   The base to print bytes in. Supported bases include, `:hexadecimal`,\n   `:hex`, `16, `:decimal`, `:dec`, `10, `:octal`, `:oct`, `8`,\n   `:binary`, `:bin` and `2`.\n\n @option options [Boolean] :ascii (false)\n   Print ascii characters when possible.\n\n @raise [ArgumentError]\n   The values for `:base` or `:endian` were unknown.\n\n @since 0.2.0\n\n\n Iterates over every word within the data.\n\n @param [#each_byte] data\n   The data containing bytes.\n\n @yield [word]\n   The given block will be passed each word within the data.\n\n @yieldparam [Integer]\n   An unpacked word from the data.\n\n @return [Enumerator]\n   If no block is given, an Enumerator will be returned.\n\n @raise [ArgumentError]\n   The given data does not define the `#each_byte` method.\n\n @since 0.2.0", "Iterates over the hexdump.\n\n @param [#each_byte] data\n   The data to be hexdumped.\n\n @yield [index,numeric,printable]\n   The given block will be passed the hexdump break-down of each\n   segment.\n\n @yieldparam [Integer] index\n   The index of the hexdumped segment.\n\n @yieldparam [Array<String>] numeric\n   The numeric representation of the segment.\n\n @yieldparam [Array<String>] printable\n   The printable representation of the segment.\n\n @return [Enumerator]\n   If no block is given, an Enumerator will be returned.\n\n @since 0.2.0", "Dumps the hexdump.\n\n @param [#each_byte] data\n   The data to be hexdumped.\n\n @param [#<<] output\n   The output to dump the hexdump to.\n\n @return [nil]\n\n @raise [ArgumentError]\n   The output value does not support the `#<<` method.\n\n @since 0.2.0", "Converts a word into a printable String.\n\n @param [Integer] word\n   The word to convert.\n\n @return [String]\n   The printable representation of the word.\n\n @since 0.2.0", "This sets the renderer's \"editable\" property to true, and makes it save\n  the edited value to the model.  When a user edits a row in the ListView\n  the value isn't automatically saved by Gtk.  This method groups both actions\n  together, so setting edit_save=true, allows both editing and saving of\n  the field.\n\n  Also, you can use VR::ListView and VR::TreeView's convenience methods to\n  envoke call this method:\n\n   NAME = 0\n   ADDR = 1\n   @view.set_attr([NAME, ADDR], :edit_save => true)  #sets model_col = 0, 1\n   @view.set_edit_save( 0 => true, 1 => false)\n\n  is_editable = boolean", "FileTreeView creates a TreeView of files with folders and icons.\n Often you should subclass this class for a particular use.\n @param [String] root Root folder of the tree\n @param [String] icon_path Path to a folder where icons are stored.  See VR::IconHash\n @param [String] glob Glob designating the files to be included.  Google: \"ruby glob\" for more.\n @param [Proc] validate_block Block that limits files and folders to include. When block returns true file is includud. (false = excluded)\n Refresh the file tree, optionally with a new root folder, and optionally opening an array of folders.\n @param [Hash] flags You can change the root and/or  open an array of folders.\n @option flags [String] :root Path to root folder to open\n @option flags [Array] :open_folders A list of folders to open, possibly from #get_open_folders.\n    Default: the currently open folders, so the tree doesn't collapse when refreshed.", "Opens a list of folders.\n @param [Array] folder_paths Array of Strings of folder names to expand, possibly from the #get_open_folders method.", "Adds a file to the tree under a given parent iter.\n @param [String] filename Full path to file to add.", "generate a name using the supplied parameter hash\n\n * +params+ - A hash of parameters\n\n ==== Params\n * +:type+ - :male, :female, :surname\n * +:frequency+ -  :common, :rare, :all\n * +:min_freq+ - raw frequency values to specify a precise range\n * +:max_freq+ - raw frequency values to specify a precise range", "randomly sort a result set according to the data adapter class", "query the db for a name", "Get the list of most popular videos based on view count.\n @note The number of videos returned is potentially very large, so it's recommended that you specify a `:limit`.\n @example\n   Twitch.videos.top\n @example\n   Twitch.videos.top(:period => :month, :game => 'Super Meat Boy')\n @example\n   Twitch.videos.top(:period => :all, :limit => 10)\n @example\n   Twitch.videos.top(:period => :all) do |video|\n     next if video.view_count < 10000\n     puts video.url\n   end\n @param options [Hash] Filter criteria.\n @option options [Symbol] :period (:week) Return videos only in this time period. Valid values are `:week`, `:month`, `:all`.\n @option options [String] :game (nil) Return videos only for this game.\n @option options [Fixnum] :limit (nil) Limit on the number of results returned.\n @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.\n @yield Optional. If a block is given, each top video is yielded.\n @yieldparam [Video] video Current video.\n @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/videos.md#get-videostop GET /videos/top\n @raise [ArgumentError] If `:period` is not one of `:week`, `:month`, or `:all`.\n @return [Array<Video>] Top videos, if no block is given.\n @return [nil] If a block is given.", "Get the videos for a channel, most recently created first.\n @example\n   v = Twitch.videos.for_channel('dreamhacktv')\n @example\n   v = Twitch.videos.for_channel('dreamhacktv', :type => :highlights, :limit => 10)\n @example\n   Twitch.videos.for_channel('dreamhacktv') do |video|\n     next if video.view_count < 10000\n     puts video.url\n   end\n @param options [Hash] Filter criteria.\n @option options [Symbol] :type (:highlights) The type of videos to return. Valid values are `:broadcasts`, `:highlights`.\n @option options [Fixnum] :limit (nil) Limit on the number of results returned.\n @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.\n @yield Optional. If a block is given, each video is yielded.\n @yieldparam [Video] video Current video.\n @see Channel#videos Channel#videos\n @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/videos.md#get-channelschannelvideos GET /channels/:channel/videos\n @raise [ArgumentError] If `:type` is not one of `:broadcasts` or `:highlights`.\n @return [Array<Video>] Videos for the channel, if no block is given.\n @return [nil] If a block is given.", "Get the channels the user is currently following.\n @example\n   user.following(:limit => 10)\n @example\n   user.following do |channel|\n     next if channel.game_name !~ /starcraft/i\n     puts channel.display_name\n   end\n @param options [Hash] Filter criteria.\n @option options [Fixnum] :limit (nil) Limit on the number of results returned.\n @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.\n @yield Optional. If a block is given, each followed channel is yielded.\n @yieldparam [Channel] channel Current channel.\n @see #following?\n @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/follows.md#get-usersuserfollowschannels GET /users/:user/follows/channels\n @return [Array<Channel>] Channels the user is currently following, if no block is given.\n @return [nil] If a block is given.", "Copies test fixtures to a temporary directory\n If file is nil, copies the entire augeas_fixtures directory\n If file is a hash, it copies the \"value\" from augeas_fixtures\n   to each \"key\" path", "Runs a particular resource via a catalog and stores logs in the caller's\n supplied array", "Get the users following this channel.\n @note The number of followers is potentially very large, so it's recommended that you specify a `:limit`.\n @example\n   channel.followers(:limit => 20)\n @example\n   channel.followers do |follower|\n     puts follower.display_name\n   end\n @param options [Hash] Filter criteria.\n @option options [Fixnum] :limit (nil) Limit on the number of results returned.\n @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.\n @yield Optional. If a block is given, each follower is yielded.\n @yieldparam [User] follower Current follower.\n @see User\n @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/channels.md#get-channelschannelfollows GET /channels/:channel/follows\n @return [Array<User>] Users following this channel, if no block is given.\n @return [nil] If a block is given.", "Get a list of games with names similar to the specified name.\n @example\n   Twitch.games.find(:name => 'diablo')\n @example\n   Twitch.games.find(:name => 'starcraft', :live => true)\n @example\n   Twitch.games.find(:name => 'starcraft') do |suggestion|\n     next if suggestion.name =~ /heart of the swarm/i\n     puts suggestion.name\n   end\n @param options [Hash] Search criteria.\n @option options [String] :name Game name search term. This can be a partial name, e.g. `\"league\"`.\n @option options [Boolean] :live (false) If `true`, only returns games that are currently live on at least one channel.\n @option options [Fixnum] :limit (nil) Limit on the number of results returned.\n @yield Optional. If a block is given, each game suggestion is yielded.\n @yieldparam [GameSuggestion] suggestion Current game suggestion.\n @see GameSuggestion GameSuggestion\n @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/search.md#get-searchgames GET /search/games\n @raise [ArgumentError] If `:name` is not specified.\n @return [Array<GameSuggestion>] Games matching the criteria, if no block is given.\n @return [nil] If a block is given.", "Run the resource a second time, against the output dir from the first\n\n @return [Puppet::Transaction] repeated transaction", "Get all currently live streams sorted by descending viewer count.\n @example\n   Twitch.streams.all\n @example\n   Twitch.streams.all(:offset => 100, :limit => 10)\n @example\n   Twitch.streams.all do |stream|\n     next if stream.viewer_count < 1000\n     puts stream.url\n   end\n @param options [Hash] Limit criteria.\n @option options [Fixnum] :limit (nil) Limit on the number of results returned.\n @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.\n @yield Optional. If a block is given, each stream is yielded.\n @yieldparam [Stream] stream Current stream.\n @see #get\n @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/streams.md#get-streams GET /streams\n @return [Array<Stream>] Currently live streams, sorted by descending viewer count, if no block is given.\n @return [nil] If a block is given.", "Get streams for a specific game, for a set of channels, or by other criteria, sorted by descending viewer count.\n @example\n   Twitch.streams.find(:game => 'League of Legends', :limit => 50)\n @example\n   Twitch.streams.find(:channel => ['fgtvlive', 'incontroltv', 'destiny'])\n @example\n   Twitch.streams.find(:game => 'Diablo III', :channel => ['nl_kripp', 'protech'])\n @example\n   Twitch.streams.find(:game => 'League of Legends') do |stream|\n     next if stream.viewer_count < 1000\n     puts stream.url\n   end\n @param options [Hash] Search criteria.\n @option options [String, Game, #name] :game Only return streams currently streaming the specified game.\n @option options [Array<String, Channel, #name>] :channel Only return streams for these channels.\n   If a channel is not currently streaming, it is omitted. You must specify an array of channels\n   or channel names. If you want to find the stream for a single channel, see {Streams#get}.\n @option options [Boolean] :embeddable (nil) If `true`, limit the streams to those that can be embedded. If `false` or `nil`, do not limit.\n @option options [Boolean] :hls (nil) If `true`, limit the streams to those using HLS (HTTP Live Streaming). If `false` or `nil`, do not limit.\n @option options [Fixnum] :limit (nil) Limit on the number of results returned.\n @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.\n @yield Optional. If a block is given, each stream found is yielded.\n @yieldparam [Stream] stream Current stream.\n @see #get\n @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/streams.md#get-streams GET /streams\n @raise [ArgumentError] If `options` does not specify a search criteria (`:game`, `:channel`, `:embeddable`, or `:hls`).\n @raise [ArgumentError] If `:channel` is not an array.\n @return [Array<Stream>] Streams matching the specified criteria, sorted by\n   descending viewer count, if no block is given.\n @return [nil] If a block is given.", "android build stuff to follow..", "ios build stuff to follow..", "Creates a group readable and writeable attributes that can be set\n by a URI query parameter sharing the same name, a property of a URI or\n a default value. The value of this attribute will be transformed by\n invoking the given block, if one has been provided. If the attributes\n created by this method are assigned an `Array`, only the first element\n will be used as their value.", "Creates a group readable and writeable attributes that can be set\n by a URI query parameter sharing the same name, a property of a URI or\n a default value. The value of this attribute will be transformed by\n invoking the given block, if one has been provided. If the attributes\n created by this method are assigned a value that is not an `Array`, the\n value will be wrapped in an array.", "Creates readable and writeable attributes that are automatically\n converted into integers.", "Allows method-like access to the hash using camelcase field names.", "Returns the users blocked by this user\n\n @return [Layer::RelationProxy] the users the user blocks\n @!macro platform-api", "Returns the identity object for this user\n\n @return [Layer::RelationProxy] identity object\n @!macro platform-api", "Returns the conversations messages\n\n @return [Layer::RelationProxy] the conversation's messages\n @!macro various-apis", "Allows creating and finding of the conversation's rich content\n\n @return [Layer::RelationProxy] the conversation's rich content\n @!macro platform-api", "Deletes the conversation, removing it from the user's devices by default\n\n @param options [Hash] the options for the delete request (REST API only: `leave: true/false`, `mode: all_participants/my_devices`)\n @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error", "Executes the runner based on options\n @runner.execute\n @runner.execute { ... }", "Stops a daemonized process", "Returns running for the daemonized process\n self.daemon_running?", "Process the pack file exchange protocol.\n\n @param [String] pack_type the type of pack exchange to perform.\n @param [#read] io_in a readable, IO-like object providing client input\n   data.\n @param [#write] io_out a writable, IO-like object sending output data to\n   the client.\n @param [Hash] opts options to pass to the Git adapter's #handle_pack\n   method.\n @option opts [Boolean] :advertise_refs (false)", "Runs the Git utilty with the given subcommand.\n\n @param [String] cmd the Git subcommand to invoke.\n @param [Array<String>] args additional arguments for the command.\n @param [#read, nil] io_in a readable, IO-like source of data to write to\n   the Git command.\n @param [#write, nil] io_out a writable, IO-like sink for output produced\n   by the Git command.\n @param [String, nil] dir a directory to switch to before invoking the Git\n   command.", "Routes requests to appropriate handlers.  Performs request path cleanup\n and several sanity checks prior to attempting to handle the request.\n\n @return a Rack response object.", "Processes pack file exchange requests for both push and pull.  Ensures\n that the request is allowed and properly formatted.\n\n @param [String] pack_type the type of pack exchange to perform per the\n   request.\n\n @return a Rack response object.", "Processes requests for the list of refs for the requested repository.\n\n This works for both Smart HTTP clients and basic ones.  For basic clients,\n the Git adapter is used to update the +info/refs+ file which is then\n served to the clients.  For Smart HTTP clients, the more efficient pack\n file exchange mechanism is used.\n\n @return a Rack response object.", "Produces a Rack response that wraps the output from the Git adapter.\n\n A 404 response is produced if _streamer_ is +nil+.  Otherwise a 200\n response is produced with _streamer_ as the response body.\n\n @param [FileStreamer,IOStreamer] streamer a provider of content for the\n   response body.\n @param [String] content_type the MIME type of the content.\n @param [Hash] headers additional headers to include in the response.\n\n @return a Rack response object.", "Opens a tunnel for the pack file exchange protocol between the client and\n the Git adapter.\n\n @param [Hash] headers headers to provide in the Rack response.\n @param [#read] io_in a readable, IO-like object providing client input\n   data.\n @param [Hash] opts options to pass to the Git adapter's #handle_pack\n   method.\n\n @return a Rack response object.", "Determines whether or not _path_ is an acceptable URI.\n\n @param [String] path the path part of the request URI.\n\n @return [Boolean] +true+ if the requested path is considered invalid;\n   otherwise, +false+.", "The search endpoint has a slightly different url structure", "Report checkstyle warnings\n\n @return   [void]", "Report checkstyle warnings by XML text\n\n @return   [void]", "Create a new instance of this rack middleware.\n\n @param app Rack application that can be called.\n Perform the device type detection and call the inner Rack application.\n\n @param env Rack environment.\n @return rack response `[status, headers, body]`", "Create a new Session instance.\n\n <b>Initialize with a config file</b>\n\n  Aviator::Session.new(:config_file => 'path/to/aviator.yml', :environment => :production)\n\n In the above example, the config file must have the following form:\n\n  production:\n    provider: openstack\n    auth_service:\n      name: identity\n      host_uri: 'http://my.openstackenv.org:5000'\n      request: create_token\n      validator: list_tenants\n      api_version: v2\n    auth_credentials:\n      username: myusername\n      password: mypassword\n      tenant_name: myproject\n\n <b>SIDENOTE:</b> For more information about the <tt>validator</tt> member, see Session#validate.\n\n Once the session has been instantiated, you may authenticate against the\n provider as follows:\n\n  session.authenticate\n\n The members you put under <tt>auth_credentials</tt> will depend on the request\n class you declare under <tt>auth_service:request</tt> and what parameters it\n accepts. To know more about a request class and its parameters, you can use\n the CLI tool <tt>aviator describe</tt> or view the request definition file directly.\n\n If writing the <tt>auth_credentials</tt> in the config file is not acceptable,\n you may omit it and just supply the credentials at runtime. For example:\n\n  session.authenticate do |params|\n    params.username    = ARGV[0]\n    params.password    = ARGV[1]\n    params.tenant_name = ARGV[2]\n  end\n\n See Session#authenticate for more info.\n\n Note that while the example config file above only has one environment (production),\n you can declare an arbitrary number of environments in your config file. Shifting\n between environments is as simple as changing the <tt>:environment</tt> to refer to that.\n\n\n <b>Initialize with an in-memory hash</b>\n\n You can create an in-memory hash with a structure similar to the config file but without\n the environment name. For example:\n\n  configuration = {\n    :provider => 'openstack',\n    :auth_service => {\n      :name      => 'identity',\n      :host_uri  => 'http://devstack:5000/v2.0',\n      :request   => 'create_token',\n      :validator => 'list_tenants'\n    }\n  }\n\n Supply this to the initializer using the <tt>:config</tt> option. For example:\n\n  Aviator::Session.new(:config => configuration)\n\n\n <b>Initialize with a session dump</b>\n\n You can create a new Session instance using a dump from another instance. For example:\n\n  session_dump = session1.dump\n  session2 = Aviator::Session.new(:session_dump => session_dump)\n\n However, Session.load is cleaner and recommended over this method.\n\n\n <b>Optionally supply a log file</b>\n\n In all forms above, you may optionally add a <tt>:log_file</tt> option to make\n Aviator write all HTTP calls to the given path. For example:\n\n  Aviator::Session.new(:config_file => 'path/to/aviator.yml', :environment => :production, :log_file => 'path/to/log')\n\n\n Authenticates against the backend provider using the auth_service request class\n declared in the session's configuration. Please see Session.new for more information\n on declaring the request class to use for authentication.\n\n <b>Request params block</b>\n\n If the auth_service request class accepts parameters, you may supply that\n as a block and it will be directly passed to the request. For example:\n\n  session = Aviator::Session.new(:config => config)\n  session.authenticate do |params|\n    params.username    = username\n    params.password    = password\n    params.tenant_name = project\n  end\n\n If your configuration happens to have an <tt>auth_credentials</tt> in it, those\n will be overridden by this block.\n\n <b>Treat parameters as a hash</b>\n\n You can also treat the params struct like a hash with the attribute\n names as the keys. For example, we can rewrite the above as:\n\n  session = Aviator::Session.new(:config => config)\n  session.authenticate do |params|\n    params[:username]    = username\n    params[:password]    = password\n    params[:tenant_name] = project\n  end\n\n Keys can be symbols or strings.\n\n <b>Use a hash argument instead of a block</b>\n\n You may also provide request params as an argument instead of a block. This is\n especially useful if you want to mock Aviator as it's easier to specify ordinary\n argument expectations over blocks. Further rewriting the example above,\n we end up with:\n\n  session = Aviator::Session.new(:config => config)\n  session.authenticate :params => {\n    :username    => username,\n    :password    => password,\n    :tenant_name => project\n  }\n\n If both <tt>:params</tt> and a block are provided, the <tt>:params</tt>\n values will be used and the block ignored.\n\n <b>Success requirements</b>\n\n Expects an HTTP status 200 or 201 response from the backend. Any other\n status is treated as a failure.", "Choose a random value from within the given range, optionally\n seeded by seed.", "Called every time a chunk of data is read from the connection once it has\n been opened and after the headers have been processed.", "URL and request components\n\n :filters => %w(miama lebron jesus)\n :oauth => {\n   :consumer_key    => [key],\n   :consumer_secret => [token],\n   :access_key      => [access key],\n   :access_secret   => [access secret]\n }", "Normalized query hash of escaped string keys and escaped string values\n nil values are skipped", "Add new file to Crowdin project.\n\n == Parameters\n\n files - Array of files that should be added to Crowdin project.\n file is a Hash { :dest, :source, :title, :export_pattern }\n * :dest - file name with path in Crowdin project (required)\n * :source - path for uploaded file (required)\n * :title - title in Crowdin UI (optional)\n * :export_pattern - Resulted file name (optional)\n\n Optional:\n * :branch - a branch name.\n   If the branch is not exists Crowdin will be return an error:\n     \"error\":{\n       \"code\":8,\n       \"message\":\"File was not found\"\n   }\n\n == Request\n\n POST https://api.crowdin.com/api/project/{project-identifier}/add-file?key={project-key}", "Upload fresh version of your localization file to Crowdin.\n\n == Parameters\n\n files - Array of files that should be updated in Crowdin project.\n file is a Hash { :dest, :source }\n * :dest - file name with path in Crowdin project (required)\n * :source - path for uploaded file (required)\n * :title - title in Crowdin UI (optional)\n * :export_pattern - Resulted file name (optional)\n\n Optional:\n * :branch - a branch name\n\n == Request\n\n POST https://api.crowdin.com/api/project/{project-identifier}/update-file?key={project-key}", "Upload existing translations to your Crowdin project.\n\n == Parameters\n\n files - Array of files that should be added to Crowdin project.\n file is a Hash { :dest, :source }\n   * :dest - file name with path in Crowdin project (required)\n   * :source - path for uploaded file (required)\n language - Target language. With a single call it's possible to upload translations for several\n   files but only into one of the languages. (required)\n\n Optional:\n * :import_duplicates (default: false)\n * :import_eq_suggestions (default: false)\n * :auto_approve_imported (default: false)\n * :branch - a branch name\n\n == Request\n\n POST https://api.crowdin.com/api/project/{project-identifier}/upload-translation?key={project-key}", "Create a new API object using the given parameters.\n\n @param [String] api_key the authentication API key can be found on the project settings page\n @param [String] project_id the project identifier.\n @param [String] account_key the account API Key\n @param [String] base_url the url of the Crowdin API", "Sets up the rack application.\n\n @param app [RackApp] is a rack app where\n   heartcheck is included.\n\n @return [void]\n Sets up the rack application.\n\n @param env [Hash] is an instance of Hash\n   that includes CGI-like headers.\n\n @return [Array] must be an array that contains\n   - The HTTP response code\n   - A Hash of headers\n   - The response body, which must respond to each", "Find a controller to espefic path\n   and call the index method\n\n @param req [Rack::Request] an instance of request\n\n @return [String] a response body", "Retrieve a paginator class appropriate for the +key+ in Redis.\n +key+ must be one of +list+ or +zset+, otherwise an exception\n will be raised.\n\n @params key [String] Redis key\n @params options [Hash] Options to be passed to the individual paginator class.\n\n @return Returns either a +RedisPagination::Paginator::ListPaginator+ or\n   a +RedisPagination::Paginator::SortedSetPaginator+ depending on the\n   type of +key+.", "Creates an instance of the middleware\n\n @param app [Heartcheck:App] the Rack app to wrap around\n @param ttl [Integer] the time to cache the results in seconds\n @param cache [Heartcheck::CachingApp::Cache] the cache instance to use\n   The cache will be created on first use if not supplied\n\n @return [#call] rack compatible middleware\n Invokes the middleware\n\n @param env [Hash] the rack request/environment\n @return [Array] a rack compatible response", "iterationless x registration", "Coordinates at which to place item numbers", "The set of letters marked on the response sheet. At this time, only the\n latin sequence 'A, B, C...' is supported.\n\n @return [Array] an array of arrays of 1-character strings; each element\n   contains the list of letters marked for the corresponding question.", "Sends a redirect header back to browser", "find the XY coordinates of the 4 registration marks,\n plus the stdev of the search area as quality control", "returns the centroid of the dark region within the given area\n in the XY coordinates of the entire image", "Log Request headers from Rack env", "Checks if given path is in exclude list\n\n If exact match fails then checks if the method class is in the exclude\n list.\n\n @param [String] path\n   document path\n\n @return [Boolean]\n   true if path is in the exclude list\n\n @api private", "Measure documents using given config\n\n @return [Yardstick::MeasurementSet]\n   a collection of measurements\n\n @api private", "Initializes new config\n\n @param [Hash] options\n   optional configuration\n\n @yieldparam [Yardstick::Config] config\n   the config object\n\n @return [Yardstick::Config]\n\n @api private\n Return config for given rule\n\n @param [Class] rule_class\n\n @return [RuleConfig]\n\n @api private", "Sets default options\n\n @param [Hash] options\n   optional configuration\n\n @return [undefined]\n\n @api private", "If files are small and both nodes have a comparator, we can call an extra\n provided block to verify equality. This allows", "Defines a statistic using a block that has access to all other defined statistics\n\n EXAMPLE:\n class MockModel < ActiveRecord::Base\n   define_statistic \"Basic Count\", :count => :all\n   define_statistic \"Basic Sum\", :sum => :all, :column_name => 'amount'\n   define_calculated_statistic \"Total Profit\"\n     defined_stats('Basic Sum') * defined_stats('Basic Count')\n   end", "Calculates all the statistics defined for this AR class and returns a hash with the values.\n There is an optional parameter that is a hash of all values you want to filter by.\n\n EXAMPLE:\n MockModel.statistics\n MockModel.statistics(:user_type => 'registered', :user_status => 'active')", "Add the keychain to the default searchlist", "Imports item from string or file to this keychain\n\n @param [IO, String] input IO object or String with raw data to import\n @param [Array <String>] app_list List of applications which will be\n permitted to access imported items\n @return [Array <SecKeychainItem>] List of imported keychain objects,\n each of which may be a SecCertificate, SecKey, or SecIdentity instance", "Returns the path at which the keychain is stored\n\n See https://developer.apple.com/library/mac/documentation/security/Reference/keychainservices/Reference/reference.html#//apple_ref/c/func/SecKeychainGetPath\n\n @return [String] path to the keychain file", "Unlocks the keychain\n\n @param [optional, String] password the password to unlock the keychain with. If no password is supplied the keychain will prompt the user for a password", "Fetches the password data associated with the item. This may cause the user to be asked for access\n @return [String] The password data, an ASCII_8BIT encoded string", "Attempts to update the keychain with any changes made to the item\n or saves a previously unpersisted item\n @param [optional, Hash] options extra options when saving the item\n @option options [Keychain::Keychain] :keychain when saving an unsaved item, they keychain to save it in\n @return [Keychain::Item] returns the item", "Perform a PROPFIND request\n\n Example:\n\n Basic propfind:\n\n   properties = propfind('/path/')\n\n Get ACL for resource:\n\n  properties = propfind('/path/', :acl)\n\n Custom propfind:\n\n  properties = propfind('/path/', '<?xml version=\"1.0\" encoding=\"utf-8\"?>...')\n\n See http://webdav.org/specs/rfc3744.html#rfc.section.5.9 for more on\n how to retrieve access control properties.", "Change the base URL for use in handling relative paths", "Get the content of a resource as a string\n\n If called with a block, yields each fragment of the\n entity body in turn as a string as it is read from\n the socket.  Note that in this case, the returned response\n object will *not* contain a (meaningful) body.", "Stores the content of a stream to a URL\n\n Example:\n File.open(file, \"r\") do |stream|\n   dav.put(url.path, stream, File.size(file))\n end", "Stores the content of a string to a URL\n\n Example:\n   dav.put(url.path, \"hello world\")", "Send a move request to the server.\n\n Example:\n   dav.move(original_path, new_path)", "Do a proppatch request to the server to\n update properties on resources or collections.\n\n Example:\n   dav.proppatch(uri.path,\n     \"<d:set><d:prop>\" +\n     \"<d:creationdate>#{new_date}</d:creationdate>\" +\n     \"</d:set></d:prop>\" +\n     )", "Send an unlock request to the server\n\n Example:\n   dav.unlock(uri.path, \"opaquelocktoken:eee47ade-09ac-626b-02f7-e354175d984e\")", "Returns true if resource exists on server.\n\n Example:\n   dav.exists?('https://www.example.com/collection/')  => true\n   dav.exists?('/collection/')  => true", "Returns the keychain the item is in\n\n @return [Keychain::Keychain]", "Releases the lock and sleeps timeout seconds if it is given and\n non-nil or forever.\n\n @return [Numeric]", "Insert +right+ into another ipc space.  The current task must\n have sufficient rights to insert the requested right.\n\n @param [MsgType] right\n\n @param [Hash] opts\n\n @option opts [Port,Integer] :ipc_space the space (task port) into which\n +right+ will be inserted; defaults to this port's ipc_space\n\n @option opts [Port,Integer] :port the name the port right should\n have in :ipc_space; defaults to the same name as this port", "Send +right+ on this Port to +remote_port+.  The current task\n must already have the requisite rights allowing it to send\n +right+.", "Create a new Port by receiving a port right message on this\n port.", "Create a new Semaphore.\n\n @param [Hash] opts\n\n @option opts [Integer] :value the initial value of the\n semaphore; defaults to 1\n\n @option opts [Integer] :task the Mach task that owns the\n semaphore (defaults to Mach.task_self)\n\n @options opts [Integer] :sync_policy the sync policy for this\n semaphore (defaults to SyncPolicy::FIFO)\n\n @options opts [Integer] :port existing port to wrap with a\n Semaphore object; otherwise a new semaphore is created\n\n @return [Integer] a semaphore port name\n Destroy a Semaphore.\n\n @param [Hash] opts\n\n @option opts [Integer] :task the Mach task that owns the\n semaphore (defaults to the owning task)", "Returns the suit of the card.\n\n @param glyph [Boolean] Optional setting to draw a unicode glyph in place\n of a word\n @return [String] The string (of glyph) representation of the card's suit", "Creates a new filter\n Returns whether or not the object has the target tags", "Creates a new filter\n Returns whether or not the content matches the pattern", "Creates a new filter\n Not a part of the public API. Subject to change at any time.\n Filters the input models so that only the desired ones are returned", "get DOI registration agency", "Domain search API", "Email Finder API", "replace DOI in XML if provided in options", "parse array of author strings into CSL format", "Get the address for a particular Node ID", "Adds a CollimatorSetup instance to this ControlPoint.\n\n @param [CollimatorSetup] coll a collimator setup instance to be associated with this control point", "Transfers the pixel data, as well as the related image properties and the\n DObject instance itself, to the image instance.\n\n @param [DICOM::DObject] dcm  an instance of a DICOM object\n @raise [ArgumentError] if the given dicom object doesn't have a projection image type modality", "Creates a new DICOM object with a set of basic attributes needed\n for a valid DICOM file of modality RTIMAGE.", "Calculates the dose that at least the specified\n percentage of the volume receives.\n\n @param [#to_f] percent a percentage (number in the range 0-100)\n @return [Float] the corresponding dose (in units of Gy)\n @example Calculate the near minimum dose (e.g. up to 2 % of the volume receives a dose less than this):\n   near_min = ptv_distribution.d(98)\n @example Calculate the near maximum dose (e.g. at most 2 % of the volume receives a dose higher than this):\n   near_max = ptv_distribution.d(2)", "Calculates the percentage of the volume that receives a dose higher than\n or equal to the specified dose.\n\n @param [#to_f] dose the dose threshold value to apply to the dose distribution (in units of Gy)\n @return [Float] the corresponding percentage\n @example Calculate the low dose spread (e.g. the percentage of the lung that receives a dose higher than 5 Gy):\n   coverage_low = lung_distribution.v(5)\n @example Calculate the high dose spread (e.g. the percentage of the lung that receives a dose higher than 20 Gy):\n   coverage_high = lung_distribution.v(20)", "Sets the width and height styles of the Stage.\n\n   state.size = [100, 200]\n   state.size = [\"50%\", \"100%\"] # consuming 50% of the width and 100% of the height of the screen", "Sets the location styles of the Stage.\n\n   stage.location = [500, 200]", "Pops up a simple modal dialog with the provided message.", "Adds an Image to this ImageSeries.\n\n @param [Image] image an image instance to be associated with this image series", "Adds a StructureSet to this ImageSeries.\n\n @param [Image] struct a structure set instance to be associated with this image series", "Analyses the images belonging to this ImageSeries to determine if there\n is any image with a geometry that matches the specified plane.\n\n @param [Plane] plane an image plane to be compared against the associated images\n @return [SliceImage, NilClass] the matched image (or nil if no image is matched)", "Sets the resolution of the associated images. The images will either be\n expanded or cropped depending on whether the specified resolution is\n bigger or smaller than the existing one.\n\n @param [Integer] columns the number of columns in the resized images\n @param [Integer] rows the number of rows in the resized images\n @param [Hash] options the options to use for changing the image resolution\n @option options [Float] :hor the side (in the horisontal image direction) at which to apply the crop/border operation (:left, :right or :even (default))\n @option options [Float] :ver the side (in the vertical image direction) at which to apply the crop/border operation (:bottom, :top or :even (default))", "Gives the StructureSet instance mathcing the specified UID.\n\n @overload struct(uid)\n   @param [String] uid the structure set SOP instance UID\n   @return [StructureSet, NilClass] the matched structure set (or nil if no structure set is matched)\n @overload struct\n   @return [StructureSet, NilClass] the first structure set of this instance (or nil if no child structure sets exists)", "Calculates the cartesian coordinate of the given pixel index pair.\n\n @param [Integer] i the image column index\n @param [Integer] j the image row index\n @return [Coordinate] the cartesian coordinate of the pixel", "Sets the cosines attribute.\n\n @param [Array<Float>] array the 6 directional cosines which describes the orientation of the image", "Creates a new SliceImage instance. The SOP Instance UID tag value is\n used to uniquely identify an image.\n\n @param [String] sop_uid the SOP Instance UID value\n @param [String] pos_slice the slice position of this image\n @param [Series] series the Series instance which this SliceImage is associated with\n @raise [ArgumentError] if the referenced series doesn't have a slice image type modality\n\n Creates a filled, binary NArray image ('segmented' image) based on the\n provided contour coordinates.\n\n @param [Array, NArray] coords_x the contour's x coordinates\n @param [Array, NArray] coords_y the contour's y coordinates\n @param [Array, NArray] coords_z the contour's z coordinates\n @return [BinImage] a filled, binary image\n @raise [ArgumentError] if any of the coordinate arrays have less than 3 elements", "Converts the Image instance to a DICOM object.\n\n @note This method uses the image's original DICOM object (if present),\n   and updates it with attributes from the image instance.\n @return [DICOM::DObject] the processed DICOM object", "Creates a ROI instance from the segmentation of this BinVolume.\n\n @param [StructureSet] struct the structure set instance which the created ROI will be associated with\n @param [Hash] options the options to use for creating the ROI\n @option options [String] :algorithm the ROI generation algorithm (defaults to 'STATIC')\n @option options [String] :name the ROI name (defaults to 'BinVolume')\n @option options [Integer] :number the ROI number (defaults to the first available ROI Number in the StructureSet)\n @option options [String] :interpreter the ROI interpreter (defaults to 'RTKIT')\n @option options [String] :type the ROI interpreted type (defaults to 'CONTROL')\n @return [ROI] the created ROI instance (including slice references from the associated binary images)", "Sets a new binary array for this BinImage instance.\n\n @param [NArray] image a binary two-dimensional array", "Creates an array of Contour instances from the segmentation of this BinImage.\n\n @param [Slice] slice the Slice instance which the created contours will be associated with\n @return [Array<Contour>] an array of contour instances (or an empty array if no contours are created)", "Creates a DICOM object from the BinImage instance. This is achieved by\n copying the elements of the DICOM object of the Image instance\n referenced by this BinImage, and replacing its pixel data with the\n NArray of this instance.\n\n @return [DICOM::DObject] the created DICOM object", "Creates a Slice instance from the segmentation of this BinImage.\n\n @param [ROI] roi the ROI instance which the created Slice will be associated with\n @return [Slice] the created slice instance (including contour references if the binary image is segmented)", "Determines a set of pixel indices which enclose the structure.\n\n @see This implementation uses Roman Khudeevs algorithm:\n   A New Flood-Fill Algorithm for Closed Contour.\n   https://docs.google.com/viewer?a=v&q=cache:UZ6bo7pXRoIJ:file.lw23.com/file1/01611214.pdf+flood+fill+from+contour+coordinate&hl=no&gl=no&pid=bl&srcid=ADGEEShV4gbKYYq8cDagjT7poT677cIL44K0QW8SR0ODanFy-CD1CHEQi2RvHF8MND7_PXPGYRJMJAcMJO-NEXkM-vU4iA2rNljVetbzuARWuHtKLJKMTNjd3vaDWrIeSU4rKLCVwvff&sig=AHIEtbSAnH6fp584c0_Krv298n-tgpNcJw&pli=1\n\n @return [Selection] the contour's indices", "This is a recursive method which extracts a contour, determines all pixels\n belonging to this contour, removes them from the binary image, then\n repeats collecting contours until there are no more pixels left.\n\n @return [Array<Selection>] an array of indices for all the contours derived from the segmented image", "Initializes a couple of instance variables containing directional information, which are used by the contour algorithm.\n\n The directional vectors of indices are used for extracting a vector of neighbour pixels from a 3*3 pixel array,\n where the resulting vector contains 7 neighbour pixels (the previous pixel is removed), in a clockwise order,\n where the first pixel is the neighbour pixel that is next to the previous pixel, following a clockwise rotation.", "Adds a DICOM object to the dataset, by adding it\n to an existing Patient, or creating a new Patient.\n\n @note To ensure a correct relationship between objects of different\n   modality, please add DICOM objects in the specific order: images,\n   structs, plans, doses, rtimages. Alternatively, use the class method\n   DataSet.load(objects), which handles this automatically.\n\n @param [DICOM::DObject] dcm a DICOM object to be added to this data set", "Adds a Frame to this DataSet.\n\n @param [Frame] frame a Frame object to be added to this data set", "Adds a Patient to this DataSet.\n\n @param [Patient] patient a Patient object to be added to this data set", "Prints the nested structure of patient - study - series - images that\n have been loaded in the DataSet instance.", "Prints the nested structure of the DataSet from a radiotherapy point of\n view, where the various series beneath the patient-study level is presented\n in a hiearchy of image series, structure set, rt plan, rt dose and rt image,\n in accordance with the object hiearchy used by RTKIT.", "A convienence method for managing the various parts of the\n tag binding stack.", "Returns the specificity for +tag_name+ at nesting defined\n by +nesting_parts+ as a number.", "Moves the coordinate according to the given offset vector.\n\n @param [Float] x the offset along the x axis (in units of mm)\n @param [Float] y the offset along the y axis (in units of mm)\n @param [Float] z the offset along the z axis (in units of mm)", "Register an item inside the cache if it does not yet exist\n If the item is not found inside the cache the block attached should return a valid reference", "Iterates over registered and alive items", "Clears all items from the cache\n If block is given, iterates over the cached items", "Finds an item by its ID", "Calculates the attentuation for a vector pair of hounsfield units and lengths.\n\n @param [NArray<Integer>] h_units a vector of Hounsfield units\n @param [NArray<Float>] lengths a vector of lengths (in units of mm)\n @return [Float] the calculated attenuation of a ray through the given medium", "Determines the attenuation coefficient to use, based on the given energy.", "Sets the timezone for the user. This can be done in a variety of ways.\n\n == Examples\n   user.timezone = :cst # the easiest way. CST, EST, MST, and PST are supported\n\n   user.timezone = 'america/chicago' # a little more verbose\n\n   user.timezone = 'Central Time (US & Canada)' # the most explicit way", "Calculates the biologically equivalent dose, BED. This is the theoretical\n limit of the equivalent dose delivered in small fractions, i.e. when\n complete repair takes place.\n\n @param [#to_f] d fraction dose\n @param [#to_f] alpha_beta the alpha/beta tissue factor to be used\n @return [Float] the biologically equivalent dose", "Performs ray tracing, where the ray's possible intersection of the\n associated voxel space is investigated for the ray's movement from\n its source coordinate to its target coordinate.\n\n The resulting density experienced by the ray through the voxel space\n is stored in the 'd' attribute. The indices of the voxel space\n intersected by the ray is stored in the 'indices' attribute (if the\n 'path' option has been set).", "Gives the minimum value among the directional fractions given, taking\n into account that some of them may be nil, negative, or even -INFINITY,\n and thus needs to be excluded before extracting the valid minimum value.\n\n @param [Array<Float, NilClass>] fractions a collection of alpha values\n @return [Float] the minimum value among the valid alphas", "Determines the alpha values for the first intersection after\n the ray has entered the voxel space.\n\n @return [Array<Float>] directional x, y and z alpha values", "Determines the voxel indices of the first intersection.\n\n @param [Float] axf a directional x alpha value for the ray's first intersection in voxel space\n @param [Float] ayf a directional y alpha value for the ray's first intersection in voxel space\n @param [Float] azf a directional z alpha value for the ray's first intersection in voxel space\n @return [Array<Integer>] voxel indices i, j and k of the first intersection", "Checks whether the given voxel indices describe an index\n that is within the associated voxel space.\n\n @param [Integer] i the first volume index (column)\n @param [Integer] j the second volume index (row)\n @param [Integer] k the third volume index (slice)\n @return [Boolean] true if within, and false if not", "Gives a sorted array of the directional fractions given, taking\n into account that some of them may be nil, negative, or even -INFINITY,\n and thus needs to be excluded before sorting.\n\n @param [Array<Float, NilClass>] fractions a collection of alpha values\n @return [Array<Float>] sorted (valid) alpha values", "Creates a new parser object initialized with a Context.\n Parses string for tags, expands them, and returns the result.", "Creates a new Series instance. The Series Instance UID string is used to\n uniquely identify a Series.\n\n @param [String] series_uid the Series Instance UID string\n @param [String] modality the modality string of the series (e.g. 'CT', 'RTSTRUCT')\n @param [Study] study the Study instance which this Series belongs to\n @param [Hash] options the options to use for creating the Series\n @option options [String] :class_uid the SOP class UID (DICOM tag '0008,0016')\n @option options [String] :date the series date (DICOM tag '0008,0021')\n @option options [String] :description the series description (DICOM tag '0008,103E')\n @option options [String] :time the series time (DICOM tag '0008,0031')\n\n Inserts general series, study and patient level attributes from this\n instance, as well as from the related study, patient and frame instances\n to a DICOM object.\n\n @param [DICOM::DObject] dcm a DICOM object typically belonging to an image instance of this series\n @return [DICOM::DObject] a DICOM object with the relevant attributes added", "Applies the STAPLE algorithm to the dataset to determine the true hidden\n segmentation as well as scoring the various segmentations.", "Reshapes the true segmentation vector to a volume which is comparable\n with the input volumes for the Staple instance. If volume reduction has\n been peformed, this must be taken into account.", "Sets the instance attributes used by the STAPLE algorithm.", "Ensures that the number of voxels are the same for all segmentation\n vectors going into the STAPLE analysis.\n\n raise [IndexError] if the vectors to be compared in the STAPLE analysis are of different lengths", "Creates a new Study instance. The Study Instance UID string is used to\n uniquely identify a study.\n\n @param [String] study_uid the Study Instance UID string\n @param [Patient] patient the Patient instance which this Study is associated with\n @param [Hash] options the options to use for creating the study\n @option options [String] :date the study date (DICOM tag '0008,0020')\n @option options [String] :description the study description (DICOM tag '0008,1030')\n @option options [String] :id the study ID (DICOM tag '0020,0010')\n @option options [String] :time the study time (DICOM tag '0008,0030')\n\n Registers a DICOM object to the study, and processes it to either create\n (and reference) a new series instance linked to this study, or\n registering it with an existing series.\n\n @param [DICOM::DObject] dcm a DICOM object", "Adds a Series to this Study.\n\n @param [Series] series a series instance to be associated with this study", "Shifts the indices of this selection by the specified number of columns\n and rows. Positive arguments increment the column and row indices.\n\n @note No out of bounds check is performed for indices that are shifted\n   past the image boundary!\n @param [Integer] delta_col the desired column shift\n @param [Integer] delta_row the desired row shift\n @return [Array] the shifted indices", "Shifts the indices of this selection by the specified number of columns.\n A positive argument increment the column indices.\n\n @note No out of bounds check is performed for indices that are shifted\n   past the image boundary.\n @param [Integer] delta the desired column shift\n @return [Array] the shifted indices", "Iterate across all available nodes", "Adds an Image to this CRSeries.\n\n @param [Image] image an image instance to be associated with this series", "Returns actors from multiple nodes", "Run the DCell application in the background", "Attempt to generate a unique node ID for this machine", "Find an call registered with a given name on this node", "List all registered actors on this node", "Send a ping message with a given timeout", "Graceful termination of the node", "Adds a Contour instance to this Slice.\n\n @param [Contour] contour a contour instance to be associated with this slice", "Creates a binary segmented image, from the contours defined for this\n slice, applied to the referenced Image instance.\n\n @param [Image] source_image the image on which the binary image will be applied (defaults to the referenced (anatomical) image, but may be e.g. a dose image)\n @return [BinImage] the derived binary image instance (with dimensions equal to that of the source image)", "Gives a Plane corresponding to this Slice geometry. The plane is\n calculated from coordinates belonging to this instance.\n\n @return [Plane] the derived plane\n @raise [RuntimeError] unless the required number of coordinates are present (at least 3)", "Creates a Structure Set ROI Sequence Item from the attributes of the Structure instance.\n\n @return [DICOM::Item] a structure set ROI sequence item", "Registers a DICOM object to the patient, by adding it to an existing\n Study, or creating a new Study.\n\n @param [DICOM::DObject] dcm a DICOM object", "Adds a Study to this Patient.\n\n @param [Study] study a study instance to be associated with this patient", "Plays a sound on the computers audio output.  The parameter is the filename of a .au sound file.\n This filename should relative to the root directory of the current Production, or an absolute path.", "Creates a new Producer to open the specified Production.", "Returns a Prop with the specified id.  Returns nil id the Prop doesn't exist in the Scene.", "Creates a Beam Limiting Device Position Sequence Item\n from the attributes of the CollimatorSetup.\n\n @return [DICOM::Item] the created DICOM item", "Adds a Slice instance to this ROI.\n\n @param [Slice] slice a slice instance to be associated with this ROI", "Creates Slice instances from the contour sequence items of the contour\n sequence, and connects these slices to this ROI instance.\n\n @param [DICOM::Sequence] contour_sequence a Contour Sequence", "Creates a DoseDistribution based on the delineation by this ROI in the\n specified RTDose series.\n\n @param [DoseVolume] dose_volume the dose volume to extract the dose distribution from (defaults to the sum of the dose volumes of the first RTDose of the first plan of the parent StructureSet)\n @raise [ArgumentError] if given a dose volume who's plan does not belong to this ROI's structure set", "Moves the ROI by applying the given offset vector to its coordinates.\n\n @param [Float] x the offset along the x axis (in units of mm)\n @param [Float] y the offset along the y axis (in units of mm)\n @param [Float] z the offset along the z axis (in units of mm)", "Specifies whether the pen will use anti-aliasing to draw smooth shapes or not.  Shapes will appear pixilated when\n smooth is set to false.", "Fills an oval specified by the bounding rectangle.  See draw_oval.", "Fills the provided pixel array with lines of a specified value, based on\n two vectors of column and row indices.\n\n @param [Array] column_indices an array (vector) of pixel column indices\n @param [Array] row_indices an array (vector) of pixel row indices\n @param [NArray] image a two-dimensional numerical pixel array\n @param [Integer] value the value used for marking pixel lines\n @raise if there are any discrepancies among the provided image parameters\n @return [NArray] a pixel array marked with lines", "Extracts pixels based on cartesian coordinate arrays.\n\n @note No interpolation is performed in the case of a given coordinate\n   being located between pixel indices. In these cases a basic nearest\n   neighbour algorithm is used.\n\n @param [NArray] x_coords a numerical array (vector) of pixel x coordinates\n @param [NArray] y_coords a numerical array (vector) of pixel y coordinates\n @param [NArray] z_coords a numerical array (vector) of pixel z coordinates\n @return [Array] the matched pixel values", "Replaces all pixels of a specific value that are contained by pixels of\n a different value.\n\n Uses an iterative, queue based flood fill algorithm. It seems that a\n recursive method is not suited for Ruby, due to its limited stack space\n (which is known to be a problem in general for scripting languages).\n\n @param [Integer] col the starting column index\n @param [Integer] row the starting row index\n @param [NArray] image a two-dimensional numerical pixel array\n @param [Integer] fill_value the value used for marking pixels\n @return [NArray] a marked pixel array", "A convenience method for printing image information.\n\n @deprecated NB! This has been used only for debugging, and will soon be removed.\n @param [NArray] narr a numerical array", "Creates a new DICOM object with a set of basic attributes needed\n for a valid DICOM image file.", "Creates a new DICOM object with a set of basic attributes needed\n for a valid DICOM file of slice type image modality.", "Adds a DoseVolume instance to this RTDose series.\n\n @param [DoseVolume] volume a dose volume instance to be associated with this RTDose", "Adds a Beam to this Plan.\n\n @param [Beam] beam a beam instance to be associated with this plan", "Adds a RTDose series to this Plan.\n\n @param [RTDose] rt_dose an RTDose instance to be associated with this plan", "Adds a RTImage Series to this Plan.\n\n @param [RTImage] rt_image an RTImage instance to be associated with this plan", "Adds a Collimator instance to this Beam.\n\n @param [Collimator] coll a collimator instance to be associated with this beam", "Adds a ControlPoint instance to this Beam.\n\n @param [ControlPoint] cp a control point instance to be associated with this beam", "Creates a Beam Sequence Item from the attributes of the Beam instance.\n\n @return [DICOM::Item] a beam sequence item", "Gives the ControlPoint instance mathcing the specified index.\n\n @overload control_point(index)\n   @param [String] index the control_point index\n   @return [ControlPoint, NilClass] the matched control_point (or nil if no control_point is matched)\n @overload control_point\n   @return [ControlPoint, NilClass] the first control_point of this instance (or nil if no child control points exists)", "Creates a Referenced Beam Sequence Item from the attributes of the Beam instance.\n\n @return [DICOM::Item] a referenced beam sequence item", "Creates a VoxelSpace instance from the image instances belonging\n to this image series.\n\n @return [VoxelSpace] the created VoxelSpace instance", "Updates the position that is registered for the image instance for this series.\n\n @param [Image] image an instance belonging to this image series\n @param [Float] new_pos a new slice position to be associated with the image instance", "Adds a Plan Series to this StructureSet.\n\n @param [Plan] plan a plan instance to be associated with this structure set", "Adds a POI instance to this StructureSet.\n\n @param [POI] poi a poi instance to be associated with this structure set", "Adds a Structure instance to this StructureSet.\n\n @param [ROI, POI] structure a Structure to be associated with this StructureSet", "Adds a ROI instance to this StructureSet.\n\n @param [ROI] roi a roi instance to be associated with this structure set", "Creates a ROI belonging to this StructureSet.\n\n @note The ROI is created without any Slice instances (these must be added\n after the ROI creation).\n\n @param [Frame] frame the Frame which the ROI is to be associated with\n @param [Hash] options the options to use for creating the ROI\n @option options [String] :algorithm the ROI generation algorithm (defaults to 'Automatic')\n @option options [String] :interpreter the ROI interpreter (defaults to 'RTKIT')\n @option options [String] :name the ROI name (defaults to 'RTKIT-VOLUME')\n @option options [String] :number the ROI number (defaults to the first available ROI number in the structure set)\n @option options [String] :type the ROI interpreted type (defaults to 'CONTROL')", "Removes a ROI or POI from the structure set.\n\n @param [ROI, POI, Integer] instance_or_number the ROI/POI instance or its identifying number", "Gives the names of the structure set's associated structures.\n\n @return [Array<String>] the names of the associated structures", "Gives the numbers of the structure set's associated structures.\n\n @return [Array<Integer>] the numbers of the associated structures", "Converts the structure set instance to a DICOM object.\n\n @note This method uses the original DICOM object of the structure set,\n   and updates it with attributes from the structure set instance.\n @return [DICOM::DObject] the processed DICOM object", "Loads the ROI Items contained in the structure set and creates ROI\n and POI instances, which are referenced to this structure set.", "Adds an Image to this Frame.\n\n @param [Image] image an image instance to be associated with this frame", "Adds an ImageSeries to this Frame.\n\n @param [ImageSeries, DoseVolume] series an image series instance to be associated with this frame", "Adds a Coordinate instance to this Contour.\n\n @param [Coordinate] coordinate a coordinate instance to be associated with this contour", "Extracts and transposes all coordinates of this contour, such that the\n coordinates are given in arrays of x, y and z coordinates.\n\n @return [Array] the coordinates of this contour, converted to x, y and z arrays", "Creates and connects Coordinate instances with this Contour instance\n by processing the value of the Contour Data element value.\n\n @param [String, NilClass] contour_data a string containing x,y,z coordinate triplets separated by '\\'", "Creates a Contour Sequence Item from the attributes of the Contour.\n\n @return [DICOM::Item] the created DICOM item", "Moves the coordinates of this contour according to the given offset\n vector.\n\n @param [Float] x the offset along the x axis (in units of mm)\n @param [Float] y the offset along the y axis (in units of mm)\n @param [Float] z the offset along the z axis (in units of mm)", "Handle incoming messages", "Decode incoming messages", "Wait for incoming 0MQ messages", "Parses a given string and returns an array of nodes.\n The nodes consist of strings and hashes that describe a Radius tag that was found.", "Adds a Stage to the Theater.  Raises an exception is the name of the Stage is duplicated.", "Ensures that a valid comparison between volumes can be done, by making\n sure that every volume has a BinImage for any image that is referenced\n among the BinVolumes. If some BinVolumes are missing one or more\n BinImages, empty BinImages will be created for these BinVolumes.\n\n @note The master volume (if present) is also processed by this method.", "Adds an Image to this Volume.\n\n @param [Image] image an image instance to be associated with this dose volume", "Returns an image instance matched by the given slice position.\n\n @param [Float] pos image slice position\n @return [Image, NilClass] the matched image (or nil if no image is matched)", "This method looks up in the configuration repository DB to see if the\n user has provided a value for the given setting. If not, the default\n value is returned.", "Create a hash with all issues where the keys correspond to the field passed\n as an argument.\n\n This is use by the plugins to check whether a given issue is already in\n the project.\n def all_issues_by_field(field)\n   # we don't memoize it because we want it to reflect recently added Issues\n   klass = class_for(:issue)\n\n   issues_map = klass.where(category_id: default_issue_category.id).map do |issue|\n     [issue.fields[field], issue]\n   end\n   Hash[issues_map]\n end\n Accesing the library by primary sorting key. Raise an exception unless\n the issue library cache has been initialized.", "Render the given content with the payload and info\n\n content -\n payload -\n info    -\n path    - (optional) the path to the file, for use in ex\n\n Returns the content, rendered by Liquid.", "Render layouts and place given content inside.\n\n content - the content to be placed in the layout\n\n\n Returns the content placed in the Liquid-rendered layouts", "Reset Site details.\n\n Returns nothing", "Load necessary libraries, plugins, converters, and generators.\n\n Returns nothing.", "Check that the destination dir isn't the source dir or a directory\n parent to the source dir.", "Run each of the Generators.\n\n Returns nothing.", "Render the site to the destination.\n\n Returns nothing.", "Initialize a new Page.\n\n site - The Site object.\n base - The String path to the source.\n dir  - The String path between the source and the file.\n name - The String filename of the file.\n The generated directory into which the page will be placed\n upon generation. This is derived from the permalink or, if\n permalink is absent, will be '/'\n\n Returns the String destination directory.", "Read the YAML frontmatter.\n\n base - The String path to the dir containing the file.\n name - The String filename of the file.\n opts - optional parameter to File.read, default at site configs\n\n Returns nothing.\n rubocop:disable Metrics/AbcSize", "Convert a Sass string into CSS output.\n\n input - The Sass String to convert.\n\n Returns the CSS formatted String.", "Convert a Scss string into CSS output.\n\n input - The Scss String to convert.\n\n Returns the CSS formatted String.", "Extract imgs urls from page\n\n @param [Spidr::Page] an Spidr::Page object\n @return [Array] Lists of urls", "Yields each Geometry in the GeometryCollection.", "Read the allowed documents into the collection's array of docs.\n\n Returns the sorted array of docs.", "Initializes activeadmin index as calendar", "Calling without a geom argument is equivalent to calling unary_union when\n using GEOS 3.3+ and is equivalent to calling union_cascaded in older\n versions.", "Checks the DE-9IM pattern against the geoms.", "Reads the contents of the effective robots.txt file\n @return [String] the contents of the effective robots.txt file", "Checks if a renderable object needs to be regenerated\n\n Returns a boolean.", "Read metadata from the metadata file, if no file is found,\n initialize with an empty hash\n\n Returns the read metadata.", "Checks if a given default setting scope matches the given path and type\n\n scope - the hash indicating the scope, as defined in _config.yml\n path - the path to check for\n type - the type (:post, :page or :draft) to check for\n\n Returns true if the scope applies to the given path and type", "DETAILS - Script Versions", "NEW - Script Versions", "POST - Script Versions", "Generates a metric name\n\n @param [String] queue\n @param [Class]  worker\n\n returns a String object", "DETAILED PROFILE - Script Authors", "NEW - Script Athors", "EDIT - Script Athors", "POST - Script Athors", "DELETE - Script Athors", "DETAILS - Script Listings", "POST - Script Listings", "Initialize a MantaClient instance.\n\n priv_key_data is data read directly from an SSH private key (i.e. RFC 4716\n format). The method can also accept several optional args: :connect_timeout,\n :send_timeout, :receive_timeout, :disable_ssl_verification and :attempts.\n The timeouts are in seconds, and :attempts determines the default number of\n attempts each method will make upon receiving recoverable errors.\n\n Will throw an exception if given a key whose format it doesn't understand.\n Uploads object data to Manta to the given path, along with a computed MD5\n hash.\n\n The path must start with /<user>/stor or /<user/public. Data can be any\n sequence of octets. The HTTP Content-Type stored on Manta can be set\n with an optional :content_type argument; the default is\n application/octet-stream. The number of distributed replicates of an object\n stored in Manta can be set with an optional :durability_level; the default\n is 2.\n\n Returns true along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Get an object from Manta at a given path, and checks it's uncorrupted.\n\n The path must start with /<user>/stor or /<user/public and point at an\n actual object, as well as output objects for jobs. :head => true can\n optionally be passed in to do a HEAD instead of a GET.\n\n Returns the retrieved data along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Deletes an object off Manta at a given path.\n\n The path must start with /<user>/stor or /<user/public and point at an\n actual object.\n\n Returns true along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Creates a directory on Manta at a given path.\n\n The path must start with /<user>/stor or /<user/public.\n\n Returns true along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Gets a lexicographically sorted directory listing on Manta at a given path,\n\n The path must start with /<user>/stor or /<user/public and point at an\n actual directory. :limit optionally changes the maximum number of entries;\n the default is 1000. If given :marker, an object name in the directory,\n returned directory entries will begin from that point. :head => true can\n optionally be passed in to do a HEAD instead of a GET.\n\n Returns an array of hash objects, each object representing a directory\n entry. Also returns the received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Finds all objects recursively under a given directory. Optionally, a regular\n expression can be specified and used to filter the results returned.", "Removes a directory from Manta at a given path.\n\n The path must start with /<user>/stor or /<user/public and point at an\n actual object.\n\n Returns true along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Creates a snaplink from one object in Manta at a given path to a different\n path.\n\n Both paths should start with /<user>/stor or /<user/public.\n\n Returns true along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Creates a job in Manta.\n\n The job must be a hash, containing at minimum a :phases key. See README.md\n or the Manta docs to see the format and options for setting up a job on\n Manta; this method effectively just converts the job hash to JSON and sends\n to the Manta service.\n\n Returns the path for the new job, along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Gets various information about a job in Manta at a given path.\n\n The path must start with /<user>/jobs/<job UUID> and point at an actual job.\n :head => true can optionally be passed in to do a HEAD instead of a GET.\n\n Returns a hash with job information, along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Gets errors that occured during the execution of a job in Manta at a given\n path.\n\n The path must start with /<user>/jobs/<job UUID> and point at an actual job.\n :head => true can optionally be passed in to do a HEAD instead of a GET.\n\n Returns an array of hashes, each hash containing information about an\n error; this information is best-effort by Manta, so it may not be complete.\n Also returns received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Cancels a running job in Manta at a given path.\n\n The path must start with /<user>/jobs/<job UUID> and point at an actual job.\n\n Returns true, along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Adds objects for a running job in Manta to process.\n\n The job_path must start with /<user>/jobs/<job UUID> and point at an actual\n running job. The obj_paths must be an array of paths, starting with\n /<user>/stor or /<user>/public, pointing at actual objects.\n\n Returns true, along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Inform Manta that no more objects will be added for processing by a job,\n and that the job should finish all phases and terminate.\n\n The job_path must start with /<user>/jobs/<job UUID> and point at an actual\n running job.\n\n Returns true, along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Get lists of Manta jobs.\n\n The state indicates which kind of jobs to return. :running is for jobs\n that are currently processing, :done and :all should be obvious. Be careful\n of the latter two if you've run a lot of jobs -- the list could be quite\n long.\n\n Returns an array of hashes, each hash containing some information about a\n job. Also returns received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Generates a signed URL which can be used by unauthenticated users to\n make a request to Manta at the given path. This is typically used to GET\n an object, or to make a CORS preflighted PUT request.\n\n expires is a Time object or integer representing time after epoch; this\n determines how long the signed URL will be valid for. The method is either a\n single HTTP method (:get, :put, :post, :delete, :options) or a list of such\n methods that the signed URL is allowed to be used for. The path must start\n with /<user>/stor. Lastly, the optional args is an array containing pairs of\n query args that will be appended at the end of the URL.\n\n The returned URL is signed, and can be used either over HTTP or HTTPS until\n it reaches the expiry date.", "Fetch lists of objects that have a given status.\n\n type takes one of three values (:in, :out, fail), path must start with\n /<user>/jobs/<job UUID> and point at an actual job.\n\n Returns an array of object paths, along with received HTTP headers.\n\n If there was an unrecoverable error, throws an exception. On connection or\n corruption errors, more attempts will be made; the number of attempts can\n be altered by passing in :attempts.", "Returns a full URL for a given path to a job.", "Creates headers to be given to the HTTP client and sent to the Manta\n service. The most important is the Authorization header, without which\n none of this class would work.", "Do some sanity checks and create CORS-related headers\n\n For more details, see http://www.w3.org/TR/cors/ and\n https://developer.mozilla.org/en-US/docs/HTTP/Access_control_CORS#Access-Control-Expose-Headers", "Given a chunk of data, creates an HTTP signature which the Manta service\n understands and uses for authentication.", "DETAILS - Script Author", "NEW - Script Author", "CREATE - Script Author", "DETAILS - Script Extension", "NEW - Script Extension", "CREATE - Script Extension", "DETAILS - Script Licences", "NEW - Script Licences", "POST - Script Licences", "Saves model\n Performs +insert+ or +update+ sql query\n Method doesn't perform sql query if model isn't modified\n\n @return [TrueClass, FalseClass]", "Creates arel insert manager\n\n @return [Arel::InsertManager]", "Creates arel update manager\n\n @return [Arel::UpdateManager]", "Adds multiple records to the index. Accepts an array of +records+.", "Removes +record+ from the index.", "Returns an array of IDs for records matching +query+.", "The record is unchanged for our purposes if all the fields are the same\n and the if_proc returns the same result for both.", "Fetches the memory usage information.\n @return [Vmstat::Memory] the memory data like free, used und total.\n @example\n   Vmstat.memory # => #<struct Vmstat::Memory ...>", "Fetches the information for all available network devices.\n @return [Array<Vmstat::NetworkInterface>] the network device information\n @example\n   Vmstat.network_interfaces # => [#<struct Vmstat::NetworkInterface ...>, ...]", "Fetches the current process cpu and memory data.\n @return [Vmstat::Task] the task data for the current process", "Fetches the boot time of the system.\n @return [Time] the boot time as regular time object.\n @example\n   Vmstat.boot_time # => 2012-10-09 18:42:37 +0200", "Opens a proc file system file handle and returns the handle in the\n passed block. Closes the file handle.\n @see File#open\n @param [Array<String>] names parts of the path to the procfs file\n @example\n   procfs_file(\"net\", \"dev\") { |file| }\n   procfs_file(\"stat\") { |file| }\n @yieldparam [IO] file the file handle\n @api private", "Creates a new SearchAtom with the combined records from self and other", "Creates a new SearchAtom with records in other removed from self.", "Returns at atom containing the records and positions of +self+ preceded by +former+\n \"former latter\" or \"big dog\" where \"big\" is the former and \"dog\" is the latter.", "Returns a hash of record_ids and weightings for each record in the\n atom.", "Marks a slot for elicitation.\n\n Options:\n  - skip_render: Lets you skip the rendering of the elicited slot's view.\n                 Helpful when you have the elication text already in the\n                 response and don't wanna override it.", "Takes a string array of atoms names\n return a hash of the relevant atoms.", "Takes atoms and adds or removes them from the index depending on the\n passed operation.", "Borrowed from Rails' ActiveSupport FileStore. Also under MIT licence.\n Lock a file for a block so only one process or thread can modify it at a time.", "Return device location from amazon.\n Makes an API to amazon alexa's device location service and returns the\n location hash", "Square distance from a point to a segment", "Declares a class as searchable.\n\n ====options:\n fields:: Names of fields to include in the index. Symbols pointing to\n          instance methods of your model may also be given here.\n index_file_depth:: Tuning value for the index partitioning. Larger\n                    values result in quicker searches, but slower\n                    indexing. Default is 3.\n min_word_size:: Sets the minimum length for a word in a query. Words\n                 shorter than this value are ignored in searches\n                 unless preceded by the '+' operator. Default is 3.\n index_file:: Sets the location for the index. By default this is\n              RAILS_ROOT/tmp/index. Specify as an array. The default, for\n              example, would be set as [Rails.root,'tmp','index].", "Adds the passed +record+ to the index. Index is built if it does not already exist. Clears the query cache.", "Updates the index.\n 1. Removes the previous version of the record from the index\n 2. Adds the new version to the index.", "Finds instances matching the terms passed in +query+. Terms are ANDed by\n default. Returns an array of model instances or, if +ids_only+ is\n true, an array of integer IDs.\n\n Keeps a cache of matched IDs for the current session to speed up\n multiple identical searches.\n\n ====find_options\n Same as ActiveRecord#find options hash. An :order key will override\n the relevance ranking\n\n ====options\n ids_only:: Method returns an array of integer IDs when set to true.\n no_query_cache:: Turns off the query cache when set to true. Useful for testing.", "Builds an index from scratch for the current model class.\n Does not run if the index already exists.", "If two records or record IDs have the same rank, sort them by ID.\n This prevents a different order being returned by different Rubies.", "session keys can be with dots. It is invalid keys for BSON", "this method is mandatory to implement a Resolver", "returns a path depending if its a partial or template", "Initializes a Poster instance to post messages with an incoming webhook URL.\n It also accepts an options hash. If no options are given then the poster uses the default\n configuration from Slack integration.\n\n ==== Examples\n\n   # Without options\n   Slack::Poster.new('https://hooks.slack.com/services/T044G6VBA//TCIzZQQd7IKhQzCKc6W310va')\n\n   # With options using a custom username and icon avatar\n   Slack::Poster.new('https://hooks.slack.com/services/T044G6VBA//TCIzZQQd7IKhQzCKc6W310va',\n     username: 'Ricardo',\n     icon_url: 'http://www.gravatar.com/avatar/92e00fd27c64c94d04140cef88039468.png')\n\n   # You can also use an emoji as avatar\n   Slack::Poster.new('https://hooks.slack.com/services/T044G6VBA//TCIzZQQd7IKhQzCKc6W310va',\n     username: 'Ricardo',\n     icon_emoji: 'ghost')\n Sends a message to Slack. The message can be either plain text or a Slack::Message object.\n\n ==== Examples\n\n   # Plain text message\n   poster.send_message('hello world')\n\n   # Using a message object\n   poster.send_message(Slack::Message.new(text: 'hello world'))\n\n You can have messages with attachments if you build your message with a Slack::Message object\n and add Slack::Attachment objects.", "try to serialyze data by each key and found invalid object", "Use retry alg from mongodb to gobble up connection failures during replica set master vote\n Defaults to a 10 second wait", "This is NOT an inexpensive operation. The purpose of this method is merely to get more information\n out of cell when one thinks the value returned is incorrect. It may have more value in development\n than in production.", "Get the String representation of this Cell's value.\n\n If this Cell is a formula you can pass a false to this method and\n get the formula instead of the String representation.", "adds mousemove event listener to main canvas", "adds keyboard event listeners to entire page", "Accepts a Fixnum or a String as the row_index\n\n row_index as Fixnum: returns the 0-based row\n\n row_index as String: assumes a cell reference within this sheet\n    if the value of the reference is non-nil the value is returned,\n    otherwise the referenced cell is returned", "Creates a new section with the given name and adds it to the document.\n\n You can optionally supply a block (as detailed in the documentation for\n Generator#gen) in order to add options to the section.\n\n ==== Parameters\n name<String>:: A name for the given section.", "Adds a new option to the current section.\n\n Can only be called as part of a section block, or after at least one\n section has been added to the document.\n\n ==== Parameters\n key<String>:: The key (name) for this option.\n value::       The option's value.\n opts<Hash>::  Extra options for the line (formatting, etc).\n\n ==== Raises\n IniParse::NoSectionError::\n   If no section has been added to the document yet.", "Adds a new comment line to the document.\n\n ==== Parameters\n comment<String>:: The text for the comment line.", "Wraps lines, setting default options for each.", "Expands the resultset into a collection of videos by fetching missing\n parts, eventually with an additional HTTP request.", "Tracks an event or goal on a page load\n\n e.g. writes\n ga.('send', 'event', 'Videos', 'Play', 'Gone With the Wind');", "Returns this document as a string suitable for saving to a file.", "Returns a has representation of the INI with multi-line options\n as an array", "Saves a copy of this Document to disk.\n\n If a path was supplied when the Document was initialized then nothing\n needs to be given to Document#save. If Document was not given a file\n path, or you wish to save the document elsewhere, supply a path when\n calling Document#save.\n\n ==== Parameters\n path<String>:: A path to which this document will be saved.\n\n ==== Raises\n IniParseError:: If your document couldn't be saved.", "reference can be a Fixnum, referring to the 0-based sheet or\n a String which is the sheet name or a cell reference.\n\n If a cell reference is passed the value of that cell is returned.\n\n If the reference refers to a contiguous range of cells an Array of values will be returned.\n\n If the reference refers to a multiple columns a Hash of values will be returned by column name.", "Creates a new Parser instance for parsing string +source+.\n\n ==== Parameters\n source<String>:: The source string.\n\n Parses the source string and returns the resulting data structure.\n\n ==== Returns\n IniParse::Document", "Set a +value+ identified by +key+.\n\n If a value with the given key already exists, the value will be replaced\n with the new one, with the new value taking the position of the old.", "Enumerates through the collection.\n\n By default #each does not yield blank and comment lines.\n\n ==== Parameters\n include_blank<Boolean>:: Include blank/comment lines?", "Removes the value identified by +key+.", "Appends a line to the collection.\n\n If you push an Option with a key already represented in the collection,\n the previous Option will not be overwritten, but treated as a duplicate.\n\n ==== Parameters\n line<IniParse::LineType::Line>:: The line to be added to this section.", "Return an array containing the keys for the lines added to this\n collection.", "A helper function to assure a value is an instance of time\n @param [Time, String, NilClass] arg The value to be asserted\n @param [Hash] opts Options for assertion\n @option opts [Symbol] :default a method that can be sent to Time if the argument is nil (:now for example)", "set language user translating from", "set language user translating to", "return translation ids that matches this search criteria", "add a category of this translation key", "updates the status of the translation key depending on the translations", "create default translation", "adds a translation key with its translation to a translation yaml hash\n send the hash and the language as parameters", "installs a setter and a getter for the attribute you want to typecast as exchange money\n @overload def money(*attributes, options={})\n   @param [Symbol] attributes The attributes you want to typecast as money.\n   @param [Hash] options Pass a hash as last argument as options\n   @option options [Symbol, Proc] :currency The currency to evaluate the money with. Can be a symbol or a proc\n   @option options [Symbol, Proc] :at The time at which the currency should be casted. All conversions of this currency will take place at this time\n @raise [NoCurrencyError] if no currency option is given or the currency evals to nil\n @example configure money with symbols, the currency option here will call the method currency in the object context\n   money :price, :currency => :currency, :time => :created_at\n @example configure money with a proc, the proc will be called with the object as an argument. This is equivalent to the example above\n   money :price, :currency => lambda {|o| o.currency}, :time => lambda{|o| o.created_at}", "Selects a date by simulating human interaction with the datepicker or filling the input field\n @param value [#to_date, String] any object that responds to `#to_date` or a parsable date string\n @param datepicker [:bootstrap, :simple] the datepicker to use (are supported: bootstrap or input field)\n @param format [String, nil] a valid date format used to format value\n @param from [String, nil] the path to input field (required if `xpath` is nil)\n @param xpath [String, nil] the xpath to input field (required if `from` is nil)\n @param args [Hash] extra args to find the input field", "Selects a date by filling the input field\n @param date_input the input field\n @param value [Date] the date to set\n @param format [String, nil] a valid date format used to format value", "Selects a date by simulating human interaction with the datepicker\n @param (see #select_simple_date)", "Alias method chain to instantiate the subclass from a symbol should it not be a class\n @return [NilClass, Class] The subclass or nil", "Asserts a given argument is a currency. Tries to match with a country code if the argument is not a currency\n @param [Symbol, String] arg The argument to assert\n @return [Symbol] The matching currency as a symbol", "Use this to instantiate a currency amount. For one, it is important that we use BigDecimal here so nothing gets lost because\n of floating point errors. For the other, This allows us to set the precision exactly according to the iso definition\n @param [BigDecimal, Fixed, Float, String] amount The amount of money you want to instantiate\n @param [String, Symbol] currency The currency you want to instantiate the money in\n @return [BigDecimal] The instantiated currency\n @example instantiate a currency from a string\n   Exchange::ISO.instantiate(\"4523\", \"usd\") #=> #<Bigdecimal 4523.00>\n @note Reinstantiation is not needed in case the amount is already a big decimal. In this case, the maximum precision is already given.", "Converts the currency to a string in ISO 4217 standardized format, either with or without the currency. This leaves you\n with no worries how to display the currency.\n @param [BigDecimal, Fixed, Float] amount The amount of currency you want to stringify\n @param [String, Symbol] currency The currency you want to stringify\n @param [Hash] opts The options for formatting\n @option opts [Boolean] :format The format to put the string out in: :amount for only the amount, :symbol for a string with a currency symbol\n @return [String] The formatted string\n @example Convert a currency to a string\n   Exchange::ISO.stringify(49.567, :usd) #=> \"USD 49.57\"\n @example Convert a currency without minor to a string\n   Exchange::ISO.stringif(45, :jpy) #=> \"JPY 45\"\n @example Convert a currency with a three decimal minor to a string\n   Exchange::ISO.stringif(34.34, :omr) #=> \"OMR 34.340\"\n @example Convert a currency to a string without the currency\n   Exchange::ISO.stringif(34.34, :omr, :amount_only => true) #=> \"34.340\"", "symbolizes keys and returns a new hash", "get a precision for a specified amount and a specified currency\n\n @params [Float, Integer] amount The amount to get the precision for\n @params [Symbol] currency the currency to get the precision for", "returns the translation a user has made for a certain key in a certain language", "gets how much complete translation of category is in a certain language", "Converts this instance of currency into another currency\n @return [Exchange::Money] An instance of Exchange::Money with the converted number and the converted currency\n @param [Symbol, String] other The currency to convert the number to\n @param [Hash] options An options hash\n @option [Time] :at The timestamp of the rate the conversion took place in\n @example convert to 'chf'\n   Exchange::Money.new(40,:usd).to(:chf)\n @example convert to 'sek' at a specific rate\n   Exchange::Money.new(40,:nok).to(:sek, :at => Time.gm(2012,2,2))", "Fallback to the next api defined in the api fallbacks. Changes the api for the given instance\n @return [Boolean] true if the fallback was successful, false if not\n @since 1.0\n @version 1.0", "Accept translation by changing its status and if there is an accepting translation\n make it pending", "make sure user has one translation per key per lang", "Can search for named routes directly in the main app, omitting\n the \"main_app.\" prefix", "exponential backoff handles rate limiting exceptions\n when querying tags on a workflow execution.", "Adds a speech to the object, also returns a outputspeech object.", "Incorporates reprompt in the SDK 2015-05", "Builds a response.\n Takes the version, response and should_end_session variables and builds a JSON object.", "We still don't know if all of the parameters in the request are required.\n Checking for the presence of intent on an IntentRequest.\n Takes a Hash object.", "Adds a slot from a name and a value.", "Performs the job immediately. The job is not sent to the queueing adapter\n and will block the execution until it's finished.\n\n   MyJob.new(*args).perform_now", "Apply the rate limiter if none of the exceptions apply and all the\n conditions are met.", "Clamp negative durations in case we're in a new rate-limiting window.", "Equeue the job to be performed by the queue adapter.\n\n ==== Options\n * <tt>:wait</tt> - Enqueues the job with the specified delay\n * <tt>:wait_until</tt> - Enqueues the job at the time specified\n * <tt>:queue</tt> - Enqueues the job on the specified queue\n\n ==== Examples\n\n    my_job_instance.enqueue\n    my_job_instance.enqueue wait: 5.minutes\n    my_job_instance.enqueue queue: :important\n    my_job_instance.enqueue wait_until: Date.tomorrow.midnight", "Create a match. Used by tournament systems.\n\n Specially handles byes, swapping home/away if required.\n\n @param home_team [team, nil]\n @param away_team [team, nil]\n @return [nil]\n @raise when both teams are +nil+", "Get a hash of the number of losses of each team. Used by tournament systems.\n\n @return [Hash{team => Number}] a mapping from teams to losses", "Strips out the answer_text when there is a valid option_id", "Convert RGB Color model to HSL Color model\n\n @param [Integer] red\n @param [Integer] green\n @param [Integer] blue\n @return [Array] hue, saturation, lightness\n   hue in the range [0,200],\n   saturation and lightness in the range [0, 100]", "Convert HSV Color model to RGB Color model\n\n @param [Integer] h\n @param [Integer] s\n @param [Integer] l\n @return [Array] red,green,blue color\n   red,green,blue in the range [0,255]", "This formats the template into packer format hash", "Extract attributes required for API calls about this object", "set pen color\n\n @param [Array<Integer>|Symbol|Integer] val color\n   When color is Array<Integer>, it means [R, G, B].\n   When color is Symbol, it means the color code; like :white, :black, etc...\n   When color is Integer, it means hue.", "change pen color\n\n @param [Integer] val color", "set pen shade\n\n @param Integer val shade", "Renders a helpful message with numbers of displayed vs. total entries.\n You can use this as a blueprint for your own, similar helpers.\n\n   <%= page_entries_info @posts %>\n   #-> Displaying posts 6 - 10 of 26 in total\n\n By default, the message will use the humanized class name of objects\n in collection: for instance, \"project types\" for ProjectType models.\n Override this to your liking with the <tt>:entry_name</tt> parameter:\n\n   <%= page_entries_info @posts, :entry_name => 'item' %>\n   #-> Displaying items 6 - 10 of 26 in total", "Process it! This method returns the complete HTML string which contains\n pagination links. Feel free to subclass LinkRenderer and change this\n method as you see fit.", "Returns the subset of +options+ this instance was initialized with that\n represent HTML attributes for the container element of pagination links.", "Collects link items for visible page numbers.", "Recursively merge into target hash by using stringified keys from the other one", "All Tax Codes in this group.", "Once a purchase has been made and payment has been authorized, this method must be called. A matching Lookup call must have been made before this is called.\n\n === Options\n * <tt>date_authorized</tt> - The date the transaction was authorized. Default is today.", "Marks any included cart items as returned.\n\n === Options\n [returned_date] The date the return occured. Default is today.", "Returns the width and height in a format suitable to be passed to Geometry.parse", "This will test whether you have defined your attachment correctly by\n checking for all the required fields exist after the definition of the\n attachment.", "Tests for validations on the presence of the attachment.", "Stubs the HTTP PUT for an attachment using S3 storage.\n\n @example\n   stub_paperclip_s3('user', 'avatar', 'png')", "Checks PR for JIRA keys and links them\n\n @param [Array] key\n         An array of JIRA project keys KEY-123, JIRA-125 etc.\n\n @param [String] url\n         The JIRA url hosted instance.\n\n @param [String] emoji\n         The emoji you want to display in the message.\n\n @param [Boolean] search_title\n         Option to search JIRA issues from PR title\n\n @param [Boolean] search_commits\n         Option to search JIRA issues from commit messages\n\n @param [Boolean] fail_on_warning\n         Option to fail danger if no JIRA issue found\n\n @param [Boolean] report_missing\n         Option to report if no JIRA issue was found\n\n @param [Boolean] skippable\n         Option to skip the report if 'no-jira' is provided on the PR title, description or commits\n\n @return [void]", "Performs the conversion of the +file+ into a thumbnail. Returns the Tempfile\n that contains the new image.", "Returns the command ImageMagick's +convert+ needs to transform the image\n into the thumbnail.", "Merge additional options and raw_options", "Merge additional options and raw_options, but don't overwrite existing", "Infer the MIME-type of the file from the extension.", "Creates a packet of code with the given privileges to execute later as many times as neccessary\n\n (see examples)\n\n Arguments\n\n :code             Mandatory argument of class String with the code to execute restricted in the sandbox\n :privileges       Optional argument of class Shikashi::Sandbox::Privileges to indicate the restrictions of the\n                   code executed in the sandbox. The default is an empty Privileges (absolutly no permission)\n                   Must be of class Privileges or passed as hash_key (:privileges => privileges)\n :source           Optional argument to indicate the \"source name\", (visible in the backtraces). Only can\n                   be specified as hash parameter\n :base_namespace   Alternate module to contain all classes and constants defined by the unprivileged code\n                   if not specified, by default, the base_namespace is created with the sandbox itself\n :no_base_namespace  Specify to do not use a base_namespace (default false, not recommended to change)\n :encoding           Specify the encoding of source (example: \"utf-8\"), the encoding also can be\n                     specified on header like a ruby normal source file\n\n NOTE: arguments are the same as for Sandbox#run method, except for timeout and binding which can be\n used when calling Shikashi::Sandbox::Packet#run\n\nExample:\n\n require \"rubygems\"\n require \"shikashi\"\n\n include Shikashi\n\n sandbox = Sandbox.new\n\n privileges = Privileges.allow_method(:print)\n\n # this is equivallent to sandbox.run('print \"hello world\\n\"')\n packet = sandbox.packet('print \"hello world\\n\"', privileges)\n packet.run", "Verify this address.\n\n Returns a verified TaxCloud::Address.", "Complete zip code.\n Returns a 9-digit Zip Code, when available.", "Supplies the hash of options that processors expect to receive as their second argument\n Arguments other than the standard geometry, format etc are just passed through from\n initialization and any procs are called here, just before post-processing.", "Creates an Attachment object. +name+ is the name of the attachment,\n +instance+ is the ActiveRecord object instance it's attached to, and\n +options+ is the same as the hash passed to +has_attached_file+.", "Returns the public URL of the attachment, with a given style. Note that\n this does not necessarily need to point to a file that your web server\n can access and can point to an action in your app, if you need fine\n grained security.  This is not recommended if you don't need the\n security, however, for performance reasons. Set use_timestamp to false\n if you want to stop the attachment update time appended to the url", "Sets the specified tags on all instances in the specified jobflow\n\n   emr.add_tags('j-123', [{:key => 'key1', :value => 'value1'}, {:key => 'key_only2'}])\n\n See http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_AddTags.html", "Provides details about the specified jobflow\n\n   emr.describe_cluster('j-123')\n\n http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_DescribeCluster.html", "Provides details about the specified step within an existing jobflow\n\n   emr.describe_step('j-123', 'step-456')\n\n http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_DescribeStep.html", "List the clusters given specified filtering\n\n   emr.list_clusters({\n     :states => ['status1', 'status2', ...],\n     :created_before => Time,                # Amazon times are in UTC\n     :created_after => Time,                 # Amazon times are in UTC\n     :marker => 'marker'                     # Retrieve from a prior call to list_clusters\n   })\n\n http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_ListClusters.html", "List the instance groups in the specified jobflow\n\n   emr.list_instance_groups('j-123')\n\n http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_ListInstanceGroups.html", "List the bootstrap actions in the specified jobflow\n\n   emr.list_bootstrap_actions('j-123')\n\n http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_ListBootstrapActions.html", "List the steps in a job flow given specified filtering\n\n   emr.list_steps('j-123', {\n     :types => ['MASTER', 'CORE', 'TASK'],\n     :step_ids => ['ID-1', 'ID-2']\n     :step_states => ['PENDING', 'RUNNING', ...]\n     :marker => 'marker'                         # Retrieve from a prior call to list_steps\n   })\n\n http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_ListSteps.html", "Remove the specified tags on all instances in the specified jobflow\n\n   emr.remove_tags('j-123', ['key1','key_only2'])\n\n See http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_RemoveTags.html", "Enabled or disable \"termination protection\" on the specified job flows.\n Termination protection prevents a job flow from being terminated by a\n user initiated action, although the job flow will still terminate\n naturally.\n\n Takes an [] of job flow IDs.\n\n   [\"j-1B4D1XP0C0A35\", \"j-1YG2MYL0HVYS5\", ...]", "Whether or not all IAM users in this account can access the job flows.\n\n Takes an [] of job flow IDs.\n\n   [\"j-1B4D1XP0C0A35\", \"j-1YG2MYL0HVYS5\", ...]\n\n http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_SetVisibleToAllUsers.html", "This method is used for the exporter to copy assets", "This hash is available to all templates, it will map common properties,\n content file results, as well as any \"magic\" hashes for file\n system contents", "This method ensures that multiline strings are run through markdown and smartypants", "return hex digest string of apk file\n @param [Symbol] type hash digest type(:sha1, sha256, :md5)\n @return [String] hex digest string\n @raise [ArgumentError] type is knknown type", "find and return zip entry with name\n @param [String] name file name in apk(fullpath)\n @return [Zip::ZipEntry] zip entry object\n @raise [NotFoundError] when 'name' doesn't exist in the apk", "find files which is matched with block condition\n @yield [name, data] find condition\n @yieldparam [String] name file name in apk\n @yieldparam [String] data file data in apk\n @yieldreturn [Array] Array of matched entry name\n @return [Array] Array of matched entry name\n @example\n   apk = Apk.new(path)\n   elf_files = apk.find  { |name, data|  data[0..3] == [0x7f, 0x45, 0x4c, 0x46] } # ELF magic number", "extract icon data from AndroidManifest and resource.\n @return [Hash{ String => String }] hash key is icon filename. value is image data\n @raise [NotFoundError]\n @since 0.6.0", "apk's signature information\n @return [Hash{ String => OpenSSL::PKCS7 } ] key: sign file path, value: signature\n @since 0.7.0", "certificate info which is used for signing\n @return [Hash{String => OpenSSL::X509::Certificate }] key: sign file path, value: first certficate in the sign file\n @since 0.7.0", "application version name\n @return [String]", "return xml as string format\n @param [Integer] indent size(bytes)\n @return [String] raw xml string", "parse attribute of a element", "For each stored exception, yield an HTMLValidationResult object to allow the user to\n call .accept! on the exception if it is OK.", "Returns a monad whose elements are the results of applying the given function to each element in this monad\n\n NOTE: normally aliased as +map+ when +Monad+ is mixed into a class", "Returns a monad whose elements are all those elements of this monad for which the given predicate returned true", "create a new HMAC instance\n\n @param [String] algorithm   The hashing-algorithm to use. See the openssl documentation for valid values.\n @param [Hash] default_opts  The default options for all calls that take opts\n\n @option default_opts [String]             :auth_scheme ('HMAC')   The name of the authorization scheme used in the Authorization header and to construct various header-names\n @option default_opts [String]             :auth_param ('auth')   The name of the authentication param to use for query based authentication\n @option default_opts [String]             :auth_header ('Authorization') The name of the authorization header to use\n @option default_opts [String]             :auth_header_format ('%{auth_scheme} %{signature}') The format of the authorization header. Will be interpolated with the given options and the signature.\n @option default_opts [String]             :nonce_header ('X-#{auth_scheme}-Nonce') The header name for the request nonce\n @option default_opts [String]             :alternate_date_header ('X-#{auth_scheme}-Date') The header name for the alternate date header\n @option default_opts [Bool]               :query_based (false) Whether to use query based authentication\n @option default_opts [Bool]               :use_alternate_date_header (false) Use the alternate date header instead of `Date`\n @option default_opts [Hash]               :extra_auth_params ({}) Additional parameters to inject in the auth parameter\n @option default_opts [Array<Symbol>]      :ignore_params ([]) Params to ignore for signing\n\n Generate the signature from a hash representation\n\n returns nil if no secret or an empty secret was given\n\n @param [Hash] params the parameters to create the representation with\n @option params [String] :secret The secret to generate the signature with\n @option params [String] :method The HTTP Verb of the request\n @option params [String] :date The date of the request as it was formatted in the request\n @option params [String] :nonce ('') The nonce given in the request\n @option params [String] :path The path portion of the request\n @option params [Hash]   :query ({}) The query parameters given in the request. Must not contain the auth param.\n @option params [Hash]   :headers ({}) All headers given in the request (optional and required)\n @option params [String]             :auth_scheme ('HMAC')   The name of the authorization scheme used in the Authorization header and to construct various header-names\n @option params [String]             :auth_param ('auth')   The name of the authentication param to use for query based authentication\n @option params [Hash]               :extra_auth_params ({}) Additional parameters to inject in the auth parameter\n @option params [Array<Symbol>]      :ignore_params ([]) Params to ignore for signing\n @option params [String]             :auth_header ('Authorization') The name of the authorization header to use\n @option params [String]             :auth_header_format ('%{auth_scheme} %{signature}') The format of the authorization header. Will be interpolated with the given options and the signature.\n @option params [String]             :nonce_header ('X-#{auth_scheme}-Nonce') The header name for the request nonce\n @option params [String]             :alternate_date_header ('X-#{auth_scheme}-Date') The header name for the alternate date header\n @option params [Bool]               :query_based (false) Whether to use query based authentication\n @option params [Bool]               :use_alternate_date_header (false) Use the alternate date header instead of `Date`\n\n @return [String] the signature", "convienience method to check the signature of a url with query-based authentication\n\n @param [String] url the url to test\n @param [String] secret the secret used to sign the url\n @param [Hash] opts Options controlling the singature generation\n\n @option opts [String]             :auth_param ('auth')   The name of the authentication param to use for query based authentication\n\n @return [Bool] true if the signature is valid", "generates the canonical representation for a given request\n\n @param [Hash] params the parameters to create the representation with\n @option params [String] :method The HTTP Verb of the request\n @option params [String] :date The date of the request as it was formatted in the request\n @option params [String] :nonce ('') The nonce given in the request\n @option params [String] :path The path portion of the request\n @option params [Hash]   :query ({}) The query parameters given in the request. Must not contain the auth param.\n @option params [Hash]   :headers ({}) All headers given in the request (optional and required)\n @option params [String] :auth_scheme ('HMAC')   The name of the authorization scheme used in the Authorization header and to construct various header-names\n @option params [String] :auth_param ('auth')   The name of the authentication param to use for query based authentication\n @option params [Hash]   :extra_auth_params ({}) Additional parameters to inject in the auth parameter\n @option params [Array<Symbol>]      :ignore_params ([]) Params to ignore for signing\n @option params [String] :auth_header ('Authorization') The name of the authorization header to use\n @option params [String] :auth_header_format ('%{auth_scheme} %{signature}') The format of the authorization header. Will be interpolated with the given options and the signature.\n @option params [String] :nonce_header ('X-#{auth_scheme}-Nonce') The header name for the request nonce\n @option params [String] :alternate_date_header ('X-#{auth_scheme}-Date') The header name for the alternate date header\n @option params [Bool]   :query_based (false) Whether to use query based authentication\n @option params [Bool]   :use_alternate_date_header (false) Use the alternate date header instead of `Date`\n\n @return [String] the canonical representation", "sign the given request\n\n @param [String] url     The url of the request\n @param [String] secret  The shared secret for the signature\n @param [Hash]   opts    Options for the signature generation\n\n @option opts [String]             :nonce ('')           The nonce to use in the signature\n @option opts [String, #strftime]  :date (Time.now)      The date to use in the signature\n @option opts [Hash]               :headers ({})         A list of optional headers to include in the signature\n @option opts [String,Symbol]      :method ('GET')       The HTTP method to use in the signature\n\n @option opts [String]             :auth_scheme ('HMAC')   The name of the authorization scheme used in the Authorization header and to construct various header-names\n @option opts [String]             :auth_param ('auth')   The name of the authentication param to use for query based authentication\n @option opts [Hash]               :extra_auth_params ({}) Additional parameters to inject in the auth parameter\n @option opts [Array<Symbol>]      :ignore_params ([]) Params to ignore for signing\n @option opts [String]             :auth_header ('Authorization') The name of the authorization header to use\n @option opts [String]             :auth_header_format ('%{auth_scheme} %{signature}') The format of the authorization header. Will be interpolated with the given options and the signature.\n @option opts [String]             :nonce_header ('X-#{auth_scheme}-Nonce') The header name for the request nonce\n @option opts [String]             :alternate_date_header ('X-#{auth_scheme}-Date') The header name for the alternate date header\n @option opts [Bool]               :query_based (false) Whether to use query based authentication\n @option opts [Bool]               :use_alternate_date_header (false) Use the alternate date header instead of `Date`", "convienience method to sign a url for use with query-based authentication\n\n @param [String] url the url to sign\n @param [String] secret the secret used to sign the url\n @param [Hash] opts Options controlling the singature generation\n\n @option opts [String] :auth_param ('auth')    The name of the authentication param to use for query based authentication\n @option opts [Hash]   :extra_auth_params ({}) Additional parameters to inject in the auth parameter\n\n @return [String] The signed url", "Multicasts discovery messages to advertise its root device, any embedded\n devices, and any services.", "Parses given JSON string to create new Report\n Returns Stacktrace of the report", "Returns Thread that likely caused the crash that produced this stack\n trace", "Returns contents if Some, or given value or result of given block or lambda if None", "applies the errors in error_object to self\n returns false so failure cases can end with this invocation", "if you want to use strong parameters or something in your form object you can do so here.\n by default we just slice the inputs to the defined fields", "Composes this partial function with a fallback partial function which\n gets applied where this partial function is not defined.\n @param [PartialFunction] other the fallback function\n @return [PartialFunction] a partial function which has as domain the union of the domains\n         of this partial function and +other+. The resulting partial function takes +x+ to +self.call(x)+\n         where +self+ is defined, and to +other.call(x)+ where it is not.", "Composes this partial function with a transformation function that\n gets applied to results of this partial function.\n @param  [Proc] func the transformation function\n @return [PartialFunction] a partial function with the same domain as this partial function, which maps\n         arguments +x+ to +func.call(self.call(x))+.", "basic request method", "intelegent guess for file or URL uploading", "Upload multiple files", "Upload from an URL", "Restores the original '.new' method of the including class\n @param klass [Class] the class that has included this module\n @return [void]", "Throttles the connection rate by sleeping for a duration\n  if the interval bewteen consecutive connections is less\n  than the allowed minimum. Only throttles when the API\n  is configured to use_request_throttling.\n @return [void]", "Appends the given class to the \"class\" HTMl attribute.\n\n @param cls [String, Symbol] the class to append", "Takes a binary representation of a token and signs if for a given\n account provider. Do not pass in a RecoveryToken object. The wrapping\n data structure is identical to the structure it's wrapping in format.\n\n token: the to_binary_s or binary representation of the recovery token\n context: an arbitrary object that is passed to lower level crypto operations\n options: the value to set in the options byte field of the recovery\n   token (defaults to 0x00)\n\n returns a Base64 encoded representation of the countersigned token\n and the signature over the token.", "Validate the token according to the processing instructions for the\n save-token endpoint.\n\n Returns a validated token", "Generates a binary token with an encrypted arbitrary data payload.\n\n data: value to encrypt in the token\n provider: the recovery provider/audience of the token\n context: arbitrary data passed on to underlying crypto operations\n options: the value to set for the options byte\n\n returns a [RecoveryToken, b64 encoded sealed_token] tuple", "Parses a countersigned_token and returns the nested recovery token\n WITHOUT verifying any signatures. This should only be used if no user\n context can be identified or if we're extracting issuer information.", "Validates the countersigned recovery token by verifying the signature\n of the countersigned token, parsing out the origin recovery token,\n verifying the signature on the recovery token, and finally decrypting\n the data in the origin recovery token.\n\n countersigned_token: our original recovery token wrapped in recovery\n token instance that is signed by the recovery provider.\n context: arbitrary data to be passed to Provider#unseal.\n\n returns a verified recovery token or raises\n an error if the token fails validation.", "Signs the provided token and joins the data with the signature.\n\n token: a RecoveryToken instance\n\n returns a base64 value for the binary token string and the signature\n of the token.", "Splits the payload by the token size, treats the remaining portion as\n the signature of the payload, and verifies the signature is valid for\n the given payload.\n\n token_and_signature: binary string consisting of [token_binary_str, signature].join\n keys - An array of public keys to use for signature verification.\n\n returns a RecoveryToken if the payload has been verified and\n deserializes correctly. Raises exceptions if any crypto fails.\n Raises an error if the token's version field is not valid.", "Retries an example.\n\n     include Rspec::Repeat\n\n     around do |example|\n       repeat example, 3\n     end\n\n Available options:\n\n - `wait` - seconds to wait between each retry\n - `verbose` - print messages if true\n - `exceptions` - if given, only retry exceptions from this list\n - `clear_let` - when false, don't clear `let`'s", "Delegate unknown messages to the settings object", "Add STDERR output from the command executed via SSH.", "Parse the options provided to the cache_records method and create the appropriate cache strategies.", "Explicitly invalidate one or more records\n @param: strategy: the id of the strategy to invalidate (defaults to +:id+)\n @param: value: the value to send to the invalidate method of the chosen strategy", "Determines whether to call the serial or parallel method, then calls it.", "Run the command on all boxes in parallel", "Run the command on all boxes in serial", "Redefines the quote method to add behaviour for when a Geometry is encountered", "Adds an index to a column.", "Return the value of uname in lowercase\n This is a temporary fix. We can use SysInfo for this, upload\n it, execute it directly, parse the output.", "Like batch, except it disables safe mode before executing the block.\n After executing the block, safe mode is returned back to whichever\n state it was previously in. In other words, this method won't enable\n safe mode if it was already disabled.", "Like batch, except it enables quiet mode before executing the block.\n After executing the block, quiet mode is returned back to whichever\n state it was previously in. In other words, this method won't enable\n quiet mode if it was already disabled.\n\n In quiet mode, the pre and post command hooks are not called. This\n is used internally when calling commands like +ls+ to check whether\n a file path exists (to prevent polluting the logs).", "Like batch, except it enables sudo mode before executing the block.\n If the user is already root, this has no effect. Otherwise all\n commands executed in the block will run via sudo.\n\n If no block is specified then sudo is called just like a regular\n command.", "Add the current environment variables to the beginning of +cmd+", "Execute a command over SSH\n\n * +args+ is a command name and list of arguments.\n The command name is the literal name of the command\n that will be executed in the remote shell. The arguments\n will be thoroughly escaped and passed to the command.\n\n     rbox = Rye::Box.new\n     rbox.ls :l, 'arg1', 'arg2'\n\n is equivalent to\n\n     $ ls -l 'arg1' 'arg2'\n\n This method will try to connect to the host automatically\n but if it fails it will raise a Rye::NotConnected exception.", "Retrieve the values for the given attribute from the where statements\n Returns nil if no the attribute is not present\n @param attribute: the attribute name\n @param type: the type to be retrieved, :integer or :string (defaults to :integer)", "Retrieve the single value for the given attribute from the where statements\n Returns nil if the attribute is not present, or if it contains multiple values\n @param attribute: the attribute name\n @param type: the type to be retrieved, :integer or :string (defaults to :integer)", "Append +newcontent+ to remote +filepath+. If the file doesn't exist\n it will be created. If +backup+ is specified, +filepath+ will be\n copied to +filepath-previous+ before appending.\n\n NOTE: Not recommended for large files. It downloads the contents.", "Write +newcontent+ to remote +filepath+. If the file exists\n it will be overwritten. If +backup+ is specified, +filepath+\n will be copied to +filepath-previous+ before appending.", "Parse a template and upload that as a file to remote_path.", "Does +path+ from the current working directory?", "instance method, that will setup a forward, and\n return the port used", "Open an SSH session with +@rye_host+. This called automatically\n when you the first comamnd is run if it's not already connected.\n Raises a Rye::NoHost exception if +@rye_host+ is not specified.\n Will attempt a password login up to 3 times if the initial\n authentication fails.\n * +reconnect+ Disconnect first if already connected. The default\n is true. When set to false, connect will do nothing if already\n connected.", "Cancel the port forward on all active local forwards", "Close the SSH session  with +@rye_host+. This is called\n automatically at exit if the connection is open.", "Grabs the next available port number and returns it.", "Retrieve the current versions for the given keys\n @param id_key_map is a map with {id => cache_key}\n @return a map with {id => current_version}\n version nil for all keys unknown to the version store", "Initialize a CLI.\n Run the CLI.\n @param args [Array] arguments.\n @return [Boolean] true if command runs successfully.", "Run OptionParser to parse arguments.", "Load all rewriters.", "List and print all available rewriters.", "Open one rewriter.", "Query and print available rewriters.", "Show and print one rewriter.", "Main access method to request data from the Jira API\n\n [Arguments]\n :method    (required)    http method type\n\n :options   (required)    request specific options", "After setting or changing layout, update the set of child hostgroups,\n adding groups for any roles not already represented, and removing others\n no longer needed.", "Updates a version\n\n [Arguments]\n :details     (required)    Details of the version to be updated", "returns the oauth_secret parameter or the file", "Configures the default handler. This can be overridden in\n the child class to provide additional error handling.", "Handles the response from the request", "Authenticates the login", "Logs out of the API", "Saves the current Issue but does not update itself.", "Get lint result regards the filtering option\n\n return [Hash]", "Send comment with danger's warn or fail method.\n\n @return [void]", "Updates a component\n\n [Arguments]\n :details     (required)    Details of the component to be updated", "Overrides the default method_missing check. This override is used in lazy\n loading to ensure that the requested field or method is truly unavailable.\n\n [Arguments]\n :meth     (system)\n\n :args     (system)\n\n :block    (system)", "Pass options to set the values", "Resets all attributes to default values", "Loads the provided YML file.\n\n Can provide either direct or relational path to the file.\n It is recommended to send a direct path due to dynamic\n loading and/or different file locations due to different deployment methods.\n\n [Direct Path] /usr/project/somepath_to_file/jira.yml\n\n [Relational Path] Rails.root.to_s + \"/config/jira.yml\"\n\n                   \"./config/jira.yml\"\n\n [Arguments]\n :yml_file    (required)    path to file to load\n\n :mode        (optional)    used to define environment type", "if subnet has IP suggesting enabled we also clear the IP that was suggested\n this IP will be used for another interface", "loop through the specs and register each class", "run `find_each` with progress", "run `find_in_batches` with progress", "Patches method_missing to include property accessors\n After the first method call, builds the accessor methods to get a speed\n boost", "Update a set of properties defined by the given properties hash", "Update an individual property on this resource", "Overide the function to set the cloud_id as the same as the scope", "Open the connection if it's currently closed.", "Perform a query and return a cursor for iterating over the results.\n @param [String] query the query you want to run\n @param [Hash] query_options the options to set user and configuration\n   except for :user, see TImpalaQueryOptions in ImpalaService.thrift\n @option query_options [String] :user the user runs the query\n @return [Cursor] a cursor for the result rows", "Add a resource to the stack and optionally set its attributes", "A string representation of the stack that's valid for CFN", "Slices up the given location into individual test cases.\n\n The location chosen for slicing can be a file or directory path. Optional filters can be provided in order to\n ignore certain kinds of test cases. See #known_filters for the available option types. Most options are either a\n string or regular expression, although arrays of the same can be given instead if more than one filter is desired.\n\n A block can be provided as a filter which can allow for maximal filtering flexibility. Note, however, that this\n exposes the underlying modeling objects and knowledge of how they work is then required to make good use of the\n filter.\n\n Finally, the test cases can be provided as a collection of file:line strings or as a collection of the object\n types used to represent test cases by the underlying modeling library.\n\n @param target [String] the location that will be sliced up\n @param filters [Hash] the filters that will be applied to the sliced test cases\n @param format [Symbol] the type of output: :file_line or :test_object", "Insert a new key and value at the suppplied index.\n\n Note that this is slightly different from Array#insert in that new\n entries must be added one at a time, i.e. insert(n, k, v, k, v...) is\n not supported.\n\n @param [Integer] index\n @param [Object] key\n @param [Object] value", "Delete any keys that are empty arrays", "Covert snake_case keys to camelCase", "Covert camelCase keys to snake_case", "THE MAGICAL Z SEGMENT", "Returns a new instance consisting of entries for which the block returns\n true. Not that an enumerator is not available for the OrderedHash'\n implementation", "Cast given account number to integer. Strips spaces and leading zeros\n from the bank account number.\n DTA relies on integers for checksums and field values.\n @param [String|Integer] number", "time redefines itself with a faster implementation, since it gets called a lot.", "initialize key if not set", "get key if exists, otherwise 0", "stick to one alternative for the entire browser session", "stick to one alternative until user deletes cookies or changes browser", "Initialise a Ruby AEM instance.\n\n @param conf configuration hash of the following configuration values:\n - username: username used to authenticate to AEM instance, default: 'admin'\n - password: password used to authenticate to AEM instance, default: 'admin'\n - protocol: AEM instance protocol (http or https), default: 'http'\n - host: AEM instance host name, default: 'localhost'\n - port: AEM instance port, default: 4502\n - timeout: connection timeout in seconds, default: 300 seconds\n - debug: if true, then additional debug messages will be included, default: false\n @return new RubyAem::Aem instance\n Set default configuration values and handle numeric/boolean String values", "Create a config property instance.\n\n @param name the property's name\n @param type the property's type, e.g. Boolean\n @param value the property's value, e.g. true\n @return new RubyAem::Resources::ConfigProperty instance", "Create a package instance.\n\n @param group_name the group name of the package, e.g. somepackagegroup\n @param package_name the name of the package, e.g. somepackage\n @param package_version the version of the package, e.g. 1.2.3\n @return new RubyAem::Resources::Package instance", "if date_hour is nil, create key for total\n otherwise, create key for hourly based", "the response for an unauthenticated request. the argument will be a hash with the key 'errors', whose\n value is a hash with string keys indicating attributes with errors, and values being arrays of strings\n indicating error messages on the attribute key.", "look mum, no cookies", "expects a session cookie, deletes it, will convert again", "creates a _converted cookie, prevents multiple conversions", "Iterate all tags.\n\n @note\n   This method assume the following methods already exist:\n     header\n     tag_start\n @yieldparam [ELFTools::Dynamic::Tag] tag\n @return [Enumerator<ELFTools::Dynamic::Tag>, Array<ELFTools::Dynamic::Tag>]\n   If block is not given, an enumerator will be returned.\n   Otherwise, return array of tags.", "Get the +n+-th tag.\n\n Tags are lazy loaded.\n @note\n   This method assume the following methods already exist:\n     header\n     tag_start\n @note\n   We cannot do bound checking of +n+ here since the only way to get size\n   of tags is calling +tags.size+.\n @param [Integer] n The index.\n @return [ELFTools::Dynamic::Tag] The desired tag.", "Return the BuildID of ELF.\n @return [String, nil]\n   BuildID in hex form will be returned.\n   +nil+ is returned if the .note.gnu.build-id section\n   is not found.\n @example\n   elf.build_id\n   #=> '73ab62cb7bc9959ce053c2b711322158708cdc07'", "Iterate all sections.\n\n All sections are lazy loading, the section\n only be created whenever accessing it.\n This method is useful for {#section_by_name}\n since not all sections need to be created.\n @yieldparam [ELFTools::Sections::Section] section A section.\n @yieldreturn [void]\n @return [Enumerator<ELFTools::Sections::Section>, Array<ELFTools::Sections::Section>]\n   As +Array#each+, if block is not given, a enumerator will be returned,\n   otherwise, the whole sections will be returned.", "Fetch all sections with specific type.\n\n The available types are listed in {ELFTools::Constants::PT}.\n This method accept giving block.\n @param [Integer, Symbol, String] type\n   The type needed, similar format as {#segment_by_type}.\n @yieldparam [ELFTools::Sections::Section] section A section in specific type.\n @yieldreturn [void]\n @return [Array<ELFTools::Sections::section>] The target sections.\n @example\n   elf = ELFTools::ELFFile.new(File.open('spec/files/amd64.elf'))\n   elf.sections_by_type(:rela)\n   #=> [#<ELFTools::Sections::RelocationSection:0x00563cd3219970>,\n   #    #<ELFTools::Sections::RelocationSection:0x00563cd3b89d70>]", "Iterate all segments.\n\n All segments are lazy loading, the segment\n only be created whenever accessing it.\n This method is useful for {#segment_by_type}\n since not all segments need to be created.\n @yieldparam [ELFTools::Segments::Segment] segment A segment.\n @yieldreturn [void]\n @return [Array<ELFTools::Segments::Segment>]\n   Whole segments will be returned.", "Fetch all segments with specific type.\n\n If you want to find only one segment,\n use {#segment_by_type} instead.\n This method accept giving block.\n @param [Integer, Symbol, String] type\n   The type needed, same format as {#segment_by_type}.\n @yieldparam [ELFTools::Segments::Segment] segment A segment in specific type.\n @yieldreturn [void]\n @return [Array<ELFTools::Segments::Segment>] The target segments.", "Get the offset related to file, given virtual memory address.\n\n This method should work no matter ELF is a PIE or not.\n This method refers from (actually equals to) binutils/readelf.c#offset_from_vma.\n @param [Integer] vma The virtual address to be queried.\n @return [Integer] Related file offset.\n @example\n   elf = ELFTools::ELFFile.new(File.open('/bin/cat'))\n   elf.offset_from_vma(0x401337)\n   #=> 4919 # 0x1337", "The patch status.\n @return [Hash{Integer => String}]", "Apply patches and save as +filename+.\n\n @param [String] filename\n @return [void]", "bad idea..", "Parses data.\n\n @param [HttpParser::Instance] inst\n   The state so far of the request / response being processed.\n\n @param [String] data\n   The data to parse against the instance specified.\n\n @return [Boolean]\n   Returns true if the data was parsed successfully.", "Initialise a client.\n\n @param apis a hash of Swagger AEM client's API instances\n @param spec ruby_aem specification\n @return new RubyAem::Client instance\n Make an API call using the relevant Swagger AEM API client.\n Clazz and action parameters are used to identify the action, API, and params\n from ruby_aem specification, alongside the response handlers.\n Call parameters are used to construct HTTP request parameters based on the\n specification.\n\n @param clazz the class name of the caller resource\n @param action the action of the API call\n @param call_params API call parameters\n @return RubyAem::Result", "Add optional param into params list.\n\n @param key optional param key\n @param value optional param value\n @param params combined list of required and optional parameters\n @param call_params API call parameters", "Handle a response based on status code and a given list of response specifications.\n If none of the response specifications contains the status code, a failure result\n will then be returned.\n\n @param response response containing HTTP status code, body, and headers\n @param responses_spec a list of response specifications as configured in conf/spec.yaml\n @param call_params API call parameters\n @return RubyAem::Result\n @raise RubyAem::Error when the response status code is unexpected", "Saves current evercookie value to session", "Renders png image with encoded evercookie value in it", "Renders page with etag header for evercookie js script", "Renders page with cache header for evercookie js script", "Iterate all notes in a note section or segment.\n\n Structure of notes are:\n   +---------------+\n   | Note 1 header |\n   +---------------+\n   |  Note 1 name  |\n   +---------------+\n   |  Note 1 desc  |\n   +---------------+\n   | Note 2 header |\n   +---------------+\n   |      ...      |\n   +---------------+\n\n @note\n   This method assume following methods exist:\n     stream\n     note_start\n     note_total_size\n @return [Enumerator<ELFTools::Note::Note>, Array<ELFTools::Note::Note>]\n   If block is not given, an enumerator will be returned.\n   Otherwise, return the array of notes.", "raise a nice error message for a method that needs to be implemented on a module of config methods", "Returns the error that occurred during processing.\n\n @return [StandarError]\n   Returns the error that occurred.", "do the thing", "signature base string for signing. section 3.4.1\n\n @return [String]", "section 3.4.1.2\n\n @return [String]", "section 3.4.1.3.2\n\n @return [String]", "section 3.4.1.3\n\n @return [Array<Array<String> (size 2)>]", "like CGI.parse but it keeps keys without any value. doesn't keep blank keys though.\n\n @return [Array<Array<String, nil> (size 2)>]", "reads the request body, be it String or IO\n\n @return [String] request body", "signature, with method RSA-SHA1. section 3.4.3\n\n @return [String]", "signature, with method HMAC-SHA1. section 3.4.2\n\n @return [String]", "runs bash in a subshell, returns list of\n commands that were run in the session", "Serverspec Type method for Bitlbee\n\n @example\n   describe bitlbee(6697, 'myuser', 'mypass') do\n     # tests here\n   end\n\n @api public\n\n @param port [Integer] the port to connect to\n @param nick [String] the nick to connect as\n @param password [String] the password for nick\n @param use_ssl [Boolean] whether to connect with SSL\n\n @return {Serverspec::Type::Bitlbee} instance", "adds all files in the specified directories,\n removes all files not in the specified directories,\n commits with message", "commits one single file", "reverts multiple directories' contents as per specified id", "renames git special files to 'disable' them", "3-way merges the git file at path with the one in new_path\n assuming they have a common ancestor at the specified id\n returns the conflict count", "returns the list of files changed from since_id\n including changes in the working tree and staging\n area", "archives version id of directory in destination_path", "maps verbosity options to log level", "override default option parsing to pass options to other commands", "generates a version of path relative to the current directory", "handles most fatal exceptions", "Generates a map of parent process and child processes. This method\n will currently only work on unix.", "Reads data from an IO object while it can, returning the data it reads.\n When it encounters a case when it can't read anymore, it returns the\n data.\n\n @return [String]", "Test whether this appears to be a working venv\n\n Tests performed:\n - venv_path/bin/pip executable by owner?\n - venv_path/bin/python executable by owner?\n - venv_path/bin/activate readable by owner?\n - 'export VIRTUAL_ENV' in venv_path/bin/activate?\n\n @example\n   describe virtualenv('/path/to/venv') do\n     it { should be_virtualenv }\n   end\n\n @api public\n @return [Boolean]", "runs an interactive executable in a subshell", "replaces content in path with new_content, commits using\n comment and 3-way merges new and old content with the previous\n version of file of the same kind, if it exists.\n returns the number of conflicts", "returns the name of the source archive file, if any", "Login to the Docker registry.", "When the correct version of Docker is installed, returns true. Otherwise,\n raises a VersionError.", "creates a minimal tetra project", "creates an executable in kit that will print its parameters\n in a test_out file for checking. Returns mocked executable\n full path", "returns a pom embedded in a jar file", "returns a pom from search.maven.org with a jar sha1 search", "returns a pom from search.maven.org with a heuristic name search", "returns a build script for this package", "setup aliases for adjusted versions of the packaging tools", "returns a hash that maps filenames that should be copied from TEMPLATE_PATH\n to the value directory", "adds a source archive at the project, both in original and unpacked forms", "ServerSpec Type wrapper for http_get\n\n @example\n   describe http_get(80, 'myhostname', '/') do\n     # tests here\n   end\n\n @param port [Int] the port to connect to HTTP over\n @param host_header [String] the value to set in the 'Host' HTTP request header\n @param path [String] the URI/path to request from the server\n @param timeout_sec [Int] how many seconds to allow request to run before timing out and setting @timed_out_status to True\n @param protocol [String] the protocol to connect to the server (default 'http', can be 'https')\n @param bypass_ssl_verify [Boolean] if true, SSL verification will be bypassed (useful for self-signed certificates)\n\n @api public\n @return [Serverspec::Type::Http_Get]", "generates content from an ERB template and an object binding", "Send log message with severity to Sumologic", "An improved version of Shellwords.shelljoin that doesn't escape a few\n things.\n\n @param cmd [Array<String>] Command array to join.\n @param whitelist [Array<Regexp>] Array of patterns to whitelist.\n @return [String]", "Convert the executable in a string or array command to an absolute path.\n\n @param cmd [String, Array<String>] Command to fix up.\n @param path [String, nil] Replacement $PATH for executable lookup.\n @return [String, Array<String>]", "Adds a new step to the workflow\n\n @param body [Class] the step body implementation class", "Map workflow instance data to a property on the step\n\n @param step_property [Symbol] the attribute on the step body class", "This method expects a base64 encoded cipher text and decrypts it.\n\n @param encrypted [String] Cipher text.\n\n @return [String] Plain text.", "Get logger for given tag", "These methods are included in all User instances", "Attempt to replace invalid UTF-8 bytes with valid ones. This method\n naively assumes if you have invalid UTF8 bytes, they are either Windows\n CP-1252 or ISO8859-1. In practice this isn't a bad assumption, but may not\n always work.\n\n Passing +true+ will forcibly tidy all bytes, assuming that the string's\n encoding is CP-1252 or ISO-8859-1.", "Wraps `setup` calls from within Rails' testing framework in `before`\n hooks.", "prepare the json config and generate the fields", "Parses server attributes from the server value. I couldn't manage to get treetop to do\n this.\n\n Types of server attributes to support:\n ipv4, boolean, string, integer, time (us, ms, s, m, h, d), url, source attributes\n\n BUG: If an attribute value matches an attribute name, the parser will assume that a new\n attribute value has started. I don't know how haproxy itself handles that situation.", "Converts attributes with no values to true, and combines everything else into space-\n separated strings.", "Parse the input string, one token at a time a contruct the call stack", "Scans the input string and identifies single language tokens", "Adds the specified argument to the command-line definition.\n\n @param arg [Argument] An Argument sub-class to be added to the command-\n   line definition.", "Add a positional argument to the set of arguments in this command-line\n argument definition.\n @see PositionalArgument#initialize", "Add a keyword argument to the set of arguments in this command-line\n argument definition.\n @see KeywordArgument#initialize", "Add a flag argument to the set of arguments in this command-line\n argument definition.\n @see FlagArgument#initialize", "Add a rest argument to the set of arguments in this command-line\n argument definition.\n @see RestArgument#initialize", "Validates the supplied +args+ Hash object, verifying that any argument\n set requirements have been satisfied. Returns an array of error\n messages for each set requirement that is not satisfied.\n\n @param args [Hash] a Hash containing the keys and values identified\n   by the parser.\n @return [Array] a list of errors for any argument requirements that\n   have not been satisfied.", "Generates a usage display string", "Generates a more detailed help screen.\n @param out [IO] an IO object on which the help information will be\n   output. Pass +nil+ if no output to any device is desired.\n @param width [Integer] the width at which to wrap text.\n @return [Array] An array of lines of text, containing the help text.", "Utility method for wrapping lines of +text+ at +width+ characters.\n\n @param text [String] a string of text that is to be wrapped to a\n   maximum width.\n @param width [Integer] the maximum length of each line of text.\n @return [Array] an Array of lines of text, each no longer than +width+\n   characters.", "Instantiates a new command-line parser, with the specified command-\n line definition. A Parser instance delegates unknown methods to the\n Definition, so its possible to work only with a Parser instance to\n both define and parse a command-line.\n\n @param [Definition] definition A Definition object that defines the\n   possible arguments that may appear in a command-line. If no definition\n   is supplied, an empty definition is created.\n Parse the specified Array[String] of +tokens+, or ARGV if +tokens+ is\n nil. Returns false if unable to parse successfully, or an OpenStruct\n with accessors for every defined argument. Arguments whose values are\n not specified will contain the agument default value, or nil if no\n default is specified.", "Process a single argument value", "allow accessing info values with dot notation", "similar to the original pruning but accounts for thread-based workers\n @see Resque::Worker#prune_dead_workers", "returns worker thread names that supposely belong to the current application", "so that we can later identify a \"live\" worker thread", "unregister a worked id globally", "Parse extra options for ngannotate", "test that the knife command exists", "Map a document to a model\n\n Sets the revision, key and all attributes on the model\n\n @param [Ashikawa::Core::Document] document\n @return [Model] the resulting model with the given Model class", "Map a model to a document\n\n This will include all embedded models\n\n @param [Model] model\n @return [Ashikawa::Core::Document] the resulting document", "Overrides the Rails initializer to load metal from TRUSTY_CMS_ROOT and from radiant extensions.", "Extends the Rails initializer to add locale paths from TRUSTY_CMS_ROOT and from radiant extensions.", "ensure run_list contents are listed previously.", "for now, just check that -E is legit", "validate individual node files", "manage all the provider logic", "check that the knife plugin is installed", "create the knife ssh chef-client search pattern", "check the metadata for versions and gather deps", "compare the list of cookbook deps with those specified", "Create the change log", "Executes an AQL query with bind parameters\n\n @see Query#perfom_query", "configure the individual nodes within the cluster", "Activates all enabled extensions and makes sure that any newly declared subclasses of Page are recognised.\n The admin UI and views have to be reinitialized each time to pick up changes and avoid duplicates.", "Checks if a optional _app.yaml partial already exists", "Document specific app.yaml configuration provided in yaml frontmatter", "Checks if a app.yaml already exists in the site source", "validate the item to be loaded", "Initialize a new coercer instance for the given type\n\n If a coercer class supports configuration it will receive it from the\n global configuration object\n\n @return [Coercer::Object]\n\n @api private", "A list of collections we will write to\n\n @return [Array<String>] A list of the collection names we will write to", "A transaction instance from the database\n\n return [Ashikawa::Core::Transaction] A raw transaction to execute the Transaction on the database\n @api private", "Decodes 16bit UTF-16 string into UTF-8 string", "Create a new Query\n\n @param [Ashikawa::Core::Collection] connection The collection to use to talk to the database\n @param [Class] mapper the class of the mapper to use\n Iterate over the result of the query\n\n This will execute the query you have build", "Performs the query against the database connection.\n\n This can be changed by subclasses to implement other types\n of queries, such as AQL queries.\n\n @param [Lambda] iterator To be called on each document returned from\n                 the database", "Creates and yeilds a new style object, then adds that style to the\n map's collection of styles, under the name passed in. Makes no effort\n to de-dupe style name collisions.\n @return [Mapnik::Style]", "Creates and yields a new layer object, then adds that layer to the map's\n collection of layers. If the srs is not provided in the initial call,\n it will need to be provided in the block.\n @return [Mapnik::Layer]", "Renders the map to a file. Returns true or false depending if the\n render was successful. The image type is inferred from the filename.\n @param [String] filename Should end in one of \"png\", \"jpg\", or \"tiff\" if format not specified\n @param [String] format Should be one of formats supported by Mapnik or nil (to be guessed from filename)\n @return [Boolean]", "This method returns the appropriate FileMaker object depending on the error code passed to it. It\n also accepts an optional message.", "Send a request to the Mondo API servers\n\n @param [Symbol] method the HTTP method to use (e.g. +:get+, +:post+)\n @param [String] path the path fragment of the URL\n @option [Hash] opts query string parameters, headers", "Performs a raw FileMaker action. You will generally not call this method directly, but it\n is exposed in case you need to do something \"under the hood.\"\n\n The +action+ parameter is any valid FileMaker web url action. For example, +-find+, +-finadny+ etc.\n\n The +args+ parameter is a hash of arguments to be included in the action url. It will be serialized\n and url-encoded appropriately.\n\n The +options+ parameter is a hash of RFM-specific options, which correspond to the more esoteric\n FileMaker URL parameters. They are exposed separately because they can also be passed into\n various methods on the Layout object, which is a much more typical way of sending an action to\n FileMaker.\n\n This method returns the Net::HTTP response object representing the response from FileMaker.\n\n For example, if you wanted to send a raw command to FileMaker to find the first 20 people in the\n \"Customers\" database whose first name is \"Bill\" you might do this:\n\n   response = myServer.connect(\n     '-find',\n     {\n       \"-db\" => \"Customers\",\n       \"-lay\" => \"Details\",\n       \"First Name\" => \"Bill\"\n     },\n     { :max_records => 20 }\n   )", "Returns locales availabile for this Copycopter project.\n @return [Array<String>] available locales", "Create the final archive.\n\n @return true if the command executes without a hitch.\n @raise CommandLineError if the exit code indicates an error.", "Uploads the given hash of blurbs as draft content.\n @param data [Hash] the blurbs to upload\n @raise [ConnectionError] if the connection fails", "Issues a deploy, marking all draft content as published for this project.\n @raise [ConnectionError] if the connection fails", "Map results to @nodes << Node.new()", "Decide how to ping", "Creates a bot per port on IP", "fast -> -sn -PA", "Yaml representation of all blurbs\n @return [String] yaml", "Waits until the first download has finished.", "More complicated validation run before request", "Finds the class representing the objects within the collection", "Removes the definition for the given cell", "Creates a new cell with the given name and generates shortcut\n accessors for the method.", "Creates one or more to columns in the header.  This will clear any\n pre-existing columns if it is being customized for the first time after\n it was initially created.", "Creates and returns the generated html for the header", "generate the parameters", "compute the signature of the parameters String", "calculate the signature", "Force subtitles to be UTF-8", "Initialize a collection member and save it\n\n @example\n   >> person.question_sets.create\n   => #<BlockScore::QuestionSet:0x3fc67a6007f4 JSON:{\n     \"object\": \"question_set\",\n     \"id\": \"55ef5d5b62386200030001b3\",\n     \"created_at\": 1441750363,\n     ...\n     }\n\n @param params [Hash] params\n\n @return new saved instance of {member_class}\n\n @api public", "Retrieve a collection member by its id\n\n @example usage\n   person.question_sets.retrieve('55ef5b4e3532630003000178')\n           => instance of QuestionSet\n\n @param id [String] resource id\n\n @return instance of {member_class} if found\n @raise [BlockScore::NotFoundError] otherwise\n\n @api public", "Check if `parent_id` is defined on `item`\n\n @param item [BlockScore::Base] any resource\n\n @return [Boolean]\n\n @api private", "Register a resource in collection\n\n @param item [BlockScore::Base] a resource\n\n @raise [BlockScore::Error] if no `parent_id`\n @return [BlockScore::Base] otherwise\n\n @api private", "Builds a row for an object in the table.\n\n The provided block should set the values for each cell in the row.", "Make descending order primary by occurency and secondary by value", "Builds the row's cells based on the order of the columns in the\n header.  If a cell cannot be found for a specific column, then a blank\n cell is rendered.", "Kill all instances.\n\n @param instances [Enumerable<Aws::EC2::Types::Instance>]\n @return [void]", "Destroy any volumes marked 'available', INCLUDING THOSE YOU DON'T OWN!  Use with care.", "Create EC2 instances for all hosts, tag them, and wait until\n they're running.  When a host provides a subnet_id, create the\n instance in that subnet, otherwise prefer a CONFIG subnet_id.\n If neither are set but there is a CONFIG subnet_ids list,\n attempt to create the host in each specified subnet, which might\n fail due to capacity constraints, for example.  Specifying both\n a CONFIG subnet_id and subnet_ids will provoke an error.\n\n @return [void]\n @api private", "Handles special checks needed for netdev platforms.\n\n @note if any host is an netdev one, these checks will happen once across all\n   of the hosts, and then we'll exit\n\n @return [void]\n @api private", "Add metadata tags to all instances\n\n @return [void]\n @api private", "Add correct security groups to hosts network_interface\n as during the create_instance stage it is too early in process\n to configure\n\n @return [void]\n @api private", "Populate the hosts IP address from the EC2 dns_name\n\n @return [void]\n @api private", "Enables root access for a host when username is not root\n\n @return [void]\n @api private", "Creates the KeyPair for this test run\n\n @param region [Aws::EC2::Region] region to create the key pair in\n @return [Aws::EC2::KeyPair] created key_pair\n @api private", "Deletes key pairs from all regions\n\n @param [String] keypair_name_filter if given, will get all keypairs that match\n   a simple {::String#start_with?} filter. If no filter is given, the basic key\n   name returned by {#key_name} will be used.\n\n @return nil\n @api private", "Gets the Beaker user's keypairs by region\n\n @param [String] name_filter if given, will get all keypairs that match\n   a simple {::String#start_with?} filter. If no filter is given, the basic key\n   name returned by {#key_name} will be used.\n\n @return [Hash{String=>Array[String]}] a hash of region name to\n   an array of the keypair names that match for the filter\n @api private", "Deletes a given key pair\n\n @param [Aws::EC2::Region] region the region the key belongs to\n @param [String] pair_name the name of the key to be deleted\n\n @api private", "Create a new key pair for a given Beaker run\n\n @param [Aws::EC2::Region] region the region the key pair will be imported into\n @param [String] pair_name the name of the key to be created\n\n @return [Aws::EC2::KeyPair] key pair created\n @raise [RuntimeError] raised if AWS keypair not created", "Return a reproducable security group identifier based on input ports\n\n @param ports [Array<Number>] array of port numbers\n @return [String] group identifier\n @api private", "Create a new ping enabled security group\n\n Accepts a region or VPC for group creation.\n\n @param region_or_vpc [Aws::EC2::Region, Aws::EC2::VPC] the AWS region or vpc control object\n @param sg_cidr_ips [Array<String>] CIDRs used for outbound security group rule\n @return [Aws::EC2::SecurityGroup] created security group\n @api private", "Create a new security group\n\n Accepts a region or VPC for group creation.\n\n @param region_or_vpc [Aws::EC2::Region, Aws::EC2::VPC] the AWS region or vpc control object\n @param ports [Array<Number>] an array of port numbers\n @param sg_cidr_ips [Array<String>] CIDRs used for outbound security group rule\n @return [Aws::EC2::SecurityGroup] created security group\n @api private", "Authorizes connections from certain CIDR to a range of ports\n\n @param cl [Aws::EC2::Client]\n @param sg_group [Aws::EC2::SecurityGroup] the AWS security group\n @param cidr_ip [String] CIDR used for outbound security group rule\n @param from_port [String] Starting Port number in the range\n @param to_port [String] Ending Port number in the range\n @return [void]\n @api private", "Return a hash containing the fog credentials for EC2\n\n @param dot_fog [String] dot fog path\n @return [Aws::Credentials] ec2 credentials\n @api private", "Returns only the results with the relative speed", "note that returning hash without symbolizing anything\n does not cause this to fail", "Start fcrepo and wait for it to become available", "Stop fcrepo and wait for it to finish exiting", "Check the status of a managed fcrepo service", "Clean up any files fcrepo_wrapper may have downloaded", "Clean up any files in the fcrepo instance dir", "extract a copy of fcrepo to instance_dir\n Does noting if fcrepo already exists at instance_dir\n @return [String] instance_dir Directory where fcrepo has been installed", "Instantiates a new Executable object.\n\n The 'param' argument is a named value hash. The following keys are\n significant:\n\n  :argv   - An array of cli arguments (default ARGV)\n  :opts    - executable/function options for use when running 'go'\n  :stdout, - IO redirection (mostly for unit tests)\n  :stderr,\n  :stdin\n\n\n The above keys are deleted from the 'param' hash and stored as instance\n variables with attr_accessors.  All other parameters are ignored.\n Wrapper for Kernel.exit() so we can unit test cli tools", "Implements numeric and hex range options via '-r' and '-x'\n\n Takes two arguments which are the @opts hash key names for\n first and last parameters.\n\n (Used commonly throughout several executables)", "Creates a transaction either using an authorisation, the responsive shared\n page, transparent redirect, or direct as the source of funds\n\n @param [Enums::PaymentMethod] payment_method Describes where the card details will be coming from for this transaction (Direct, Responsive Shared, Transparent Redirect etc)\n @param [Models::Transaction] transaction Request containing the transaction details\n @return [CreateTransactionResponse] CreateTransactionResponse", "Query a transaction by one of four properties transaction id, access\n code, invoice number, invoice reference\n\n @param [Enums::TransactionFilter] filter Filter definition for searching\n @return [QueryTransactionResponse]", "Refunds all or part of a transaction\n\n @param [Models::Refund] refund contains information to refund\n @return [RefundResponse]", "Creates a token customer to store card details in the secure eWAY Vault\n for charging later\n\n @param [Enums::PaymentMethod] payment_method Describes where the card details will be coming from for this transaction (Direct, Responsive Shared, Transparent Redirect etc).\n @param [Models::Customer] customer The customer's details\n @return [CreateCustomerResponse]", "Updates an existing token customer for the merchant in their eWAY account.\n\n @param [Enums::PaymentMethod] payment_method Describes where the card details will be coming from for this transaction (Direct, Responsive Shared, Transparent Redirect etc).\n @param [Models::Customer] customer The customer's details\n @return [CreateCustomerResponse]", "Returns the details of a Token Customer. This includes the masked card information\n for displaying in a UI\n\n @param [Integer] token_customer_id eWAY Token Customer ID to look up.\n @return [QueryCustomerResponse]", "Performs a search of settlements\n\n @param [SettlementSearch]\n @return [SettlementSearchResponse]", "Perform a transaction query with the given path\n\n @param [String] request the transaction identifier to query\n @param [String] request_path the path to use for the query\n @return [QueryTransactionResponse]", "Validates the Rapid API key, password and endpoint", "Converts an endpoint string to a URL", "Checks the Rapid endpoint url\n\n @param [String] web_url", "Execute a call to the WePay API.", "Make the HTTP request to the endpoint.", "Default values, INSANE. Must be refactored\n Maybe create a yaml or json file to import for default values", "here we do check for option values user supplied\n option values has to be declared at option_values.yml", "Select a particular episode\n\n @param [Fixnum, String] episode index number\n @return [Episode] episode with the index of number", "Convert a font file to a webfont kit\n\n @param [String] input_io Input IO. Examples: File.new(\"font.ttf\"), STDOUT\n\n @param [Hash] options Options\n\n @option options\n   [String]   :output_io\n   Output IO\n   Default is a File with the name like \"webfontkit-20130312-200144.zip\"\n\n @option options\n   [Hash]     :custom_options\n   Options that will bypass sanitization. Make sure you know what you do before trying it out.\n\n @option options [Array or String]  :formats\n   Allowed values are: \"ttf\", \"woff\", \"svg\", \"eotz\", \"eot\". Default is [\"ttf\",\"woff\",\"svg\",\"eotz\"]\n\n @option options\n   [String]   :mode\n   Generator mode: \"optimal\", \"basic\", \"expert\". Default is \"optimal\"\n\n @option options\n   [String]   :tt_instructor\n   Truetype hinting: \"default\", \"keep\"\n\n @option options\n   [Boolean]  :fix_vertical_metrics\n   Rendering option. Fix Vertical Metrics (Normalize across browsers). Default is true\n\n @option options\n   [Boolean]  :fix_gasp\n   Rendering option. Fix GASP Table (Better DirectWrite Rendering). Default is true\n\n @option options\n   [Boolean]  :remove_kerning\n   Rendering option. Remove Kerning (Strip kerning data). Default is false\n\n @option options\n   [Boolean]  :add_spaces\n   Fix missing glyphs option. Fix spaces. Default is true\n\n @option options\n   [Boolean]  :add_hyphens\n   Fix missing glyphs option. Fix hyphens. Default is true\n\n @option options\n   [String]   :fallback\n   X-height matching: \"none\", \"arial\", \"verdana\", \"trebuchet\", \"georgia\", \"times\", \"courier\", \"custom\"\n\n @option options\n   [String]   :fallback_custom\n   Custom x-height matching, in percents. Default is \"100%\". Only applies when :fallback is \"custom\"\n\n @option options\n   [Boolean]  :webonly\n   Disable desktop use. Default is false\n\n @option options\n   [String]   :options_subset\n   Subsetting options: \"basic\", \"advanced\", \"none\". Default is \"basic\"\n\n @option options\n   [Array]    :subset_range\n   Custom subsetting options. Only applies when :options_subset is \"advanced\".\n   Allowed values are: \"macroman\", \"lowercase\", \"uppercase\", \"numbers\", \"punctuation\", \"currency\",\n   \"typographics\", \"math\", \"altpunctuation\", \"accentedlower\", \"accentedupper\", \"diacriticals\",\n   \"albanian\", \"bosnian\", \"catalan\", \"croatian\", \"cyrillic\", \"czech\", \"danish\", \"dutch\", \"english\",\n   \"esperanto\", \"estonian\", \"faroese\", \"french\", \"german\", \"greek\", \"hebrew\", \"hungarian\", \"icelandic\",\n   \"italian\", \"latvian\", \"lithuanian\", \"malagasy\", \"maltese\", \"norwegian\", \"polish\", \"portuguese\",\n   \"romanian\", \"serbian\", \"slovak\", \"slovenian\", \"spanish\", \"swedish\", \"turkish\", \"ubasic\", \"ulatin1\",\n   \"ucurrency\", \"upunctuation\", \"ulatina\", \"ulatinb\", \"ulatinaddl\"\n\n @option options\n   [String]   :subset_custom\n   Single characters. Only applies when :options_subset is \"advanced\". Default is \"\"\n\n @option options\n   [String]   :subset_custom_range\n   Unicode Ranges. Only applies when :options_subset is \"advanced\".\n   Comma separated values. Can be single hex values and/or ranges separated with hyphens.\n   Example: \"0021-007E,00E7,00EB,00C7,00CB\"\n\n @option options\n   [Boolean]  :base64\n   CSS option. Base64 encode (Embed font in CSS). Default is false\n\n @option options\n   [Boolean]  :style_link\n   CSS option. Style link (Family support in CSS). Default is false\n\n @option options\n   [String]   :css_stylesheet\n   CSS Filename. Default is \"stylesheet.css\"\n\n @option options\n   [String]   :ot_features\n   OpenType Options. If the features are available, the generator will fold them into the font.\n   Allowed values: \"onum\", \"lnum\", \"tnum\", \"pnum\", \"zero\", \"ss01\", \"ss02\", \"ss03\", \"ss04\", \"ss05\"\n\n @option options\n   [String]   :filename_suffix\n   Filename suffix. Default is \"-webfont\"\n\n @option options\n   [String]   :emsquare\n   Em Square Value. In units of the em square. Default is 2048\n\n @option options\n   [String]   :spacing_adjustment\n   Adjust Glyph Spacing. In units of the em square. Default is 0\n\n @option options\n   [Boolean]  :agreement\n   Agreement option. The fonts You're uploading are legally eligible for web embedding. Default is true.\n\n @see http://www.fontsquirrel.com/tools/webfont-generator more info about parameters @ www.fontsquirrel.com\n @return [String]", "Plays a video that is in the library\n\n @param [String, Object] the key of the video that we want to play.  Or an\n   Object that responds to :key (see Episode#key) (see Movie#key)\n @param [String] no clue what this does, its the Plex Remote Command API though\n @param [String] no clue what this does, its the Plex Remote Command API though\n @param [String] no clue what this does, its the Plex Remote Command API though\n @return [True, nil] true if it worked, nil if something went wrong check\n   the console for the error message", "Take a screenshot of whats on the Plex Client\n\n @param [String, Fixnum] width of the screenshot\n @param [String, Fixnum] height of the screenshot\n @param [String, Fixnum] quality of the screenshot\n @return [True, nil] true if it worked, nil if something went wrong check\n   the console for the error message", "Select a particular season\n\n @param [Fixnum, String] season index number\n @return [Season] season with the index of number", "Selects the first season of this show that is on the Plex Server\n Does not select season 0\n\n @return [Season] season with the lowest index (but not 0)", "we do take intersection array of results\n returning from multiple options", "Executes a Gremlin command against the database.", "Processes a HTTP response.", "Composes message of an error raised if the HTTP response doesn't\n correspond with expectation.", "Returns the dialects used to parse the blocks associated with `symbols`, as\n previously installed by `define_tag_method`.", "rendering\n Renders `fn` to a `buffer`, optionally extending the current scope.\n\n `fn` can either be a String (immediately pushed on the buffer), a Proc (taken as a\n tag block to render further), or a Template (taken as a partial to render in the\n current scope).\n\n Is `scope` is specified, the current scope is first branched to use to new one in\n priority, then rendering applies and the newly created scope if then poped.\n\n Returns the buffer.", "Evaluates `expr` in the current scope. `expr` can be either\n\n * a Symbol or a String, taken as a dot expression to evaluate\n * a Proc or a Template, first rendered and then evaluated\n\n Evaluation is delegated to the scope (@see Scope#evaluate) and the result returned\n by this method.", "default security group", "Process the queue. Exits when there are no more entries to process at the current time.\n Returns the number of entries processed.\n\n If any errors are encountered while processing the queue, they will be logged with the errors so they can\n be fixed and tried again later. However, if Solr is refusing connections, the processing is stopped right\n away and a Sunspot::IndexQueue::SolrNotResponding exception is raised.", "Gets an attribute value that has to be presented.", "Gets a property with the given name.", "Checks if a given string is either 'nil' or empty string.", "Load custom helper methods from project", "Retrieve the attributes of an object\n\n @return [Hash]", "Checks existence of a given database.\n Client has not to be connected to see databases suitable to connect.", "Checks existence of a given class.", "Removes a class from the schema.", "Creates a new property in the schema.\n You need to create the class before.", "Around advice to meassure and print the method time.", "Defines a method on your class returning a constant.", "Defines a method on your class returning a parsed value", "Normalize and validate the URLs on the page for comparison", "Checks whether there are any missed entries in\n all Localizable.strings from PR's changeset\n files and prints out any found entries.\n\n @return  [void]", "A hash with keyes - Localizable.strings file and\n values - modified keys from file", "Retrieves a movie or show based on its title.\n\n @param title [String] The title of the movie or show.\n @param options [Hash] Options for the title, plot or year.\n @option options [Integer] :year The year of the movie.\n @option options [String] :plot 'short' (default), 'full'\n @option options [Integer] :season The season to retrieve.\n @option options [Integer] :episode The episode to retrieve. Requires the season parameter.\n @option options [Boolean] :tomatoes Include Rotten Tomatoes ratings.\n @return [Hash]\n @example\n   OMDB.title('Game of Thrones')", "Retrieves a movie or show based on its IMDb ID.\n\n @param imdb_id [String] The IMDb ID of the movie or show.\n @option options [Boolean] :tomatoes Include Rotten Tomatoes ratings.\n @return [Hash]\n @example\n   OMDB.id('tt0944947')", "Search for a movie by its title.\n\n @param title [String] The title of the movie or show to search for.\n @return [Array, Hash]\n @example\n   OMDB.find('Star Wars')", "Performs a method on all hash keys.\n\n @param value [Array, Hash, Object]\n @return [Array, Hash, Object]", "Build parameters for a request.\n\n @param options [Hash] The optional parameters.\n @return [Hash]", "Fakes an error thrown by the library into a response object with methods\n 'code' and 'body'.", "Gets Excon connection.", "Get request headers prepared with session ID and Basic Auth.", "Sets the default configuration for this object.\n @return [void]", "Read in cluster config and parse it", "Converte node para latex", "Get dependences for Project as notations\n\n @param [Array<String>] scopes valid options are compile,test,runtime", "Invoke a Maven goal\n\n @params [Array] Goals names", "Construct a new ovirt client class.\n mandatory parameters\n   username, password, api_entrypoint  - for example 'me@internal', 'secret', 'https://example.com/api'\n optional parameters\n   datacenter_id, cluster_id and filtered_api can be sent in this order for backward\n   compatibility, or as a hash in the 4th parameter.\n   datacenter_id - setting the datacenter at initialization will add a default scope to any subsequent call\n                   to the client to the specified datacenter.\n   cluster_id    - setting the cluster at initialization will add a default scope to any subsequent call\n                   to the client to the specified cluster.\n   filtered_api  - when set to false (default) will use ovirt administrator api, else it will use the user\n                   api mode.", "Set the register class for parameter passing to RAX.\n 0 is INTEGER, 1 is SSE, 2 is MEMORY.\n\n @param [Node] node", "Enables synced for ActiveRecord model.\n\n @param options [Hash] Configuration options for synced. They are inherited\n   by subclasses, but can be overwritten in the subclass.\n @option options [Symbol] strategy: synchronization strategy, one of :full, :updated_since, :check.\n   Defaults to :updated_since\n @option options [Symbol] id_key: attribute name under which\n   remote object's ID is stored, default is :synced_id.\n @option options [Boolean] only_updated: If true requests to API will take\n   advantage of updated_since param and fetch only created/changed/deleted\n   remote objects\n @option options [Symbol] data_key: attribute name under which remote\n   object's data is stored.\n @option options [Array|Hash] local_attributes: Array of attributes in the remote\n   object which will be mapped to local object attributes.\n @option options [Boolean|Symbol] remove: If it's true all local objects\n   within current scope which are not present in the remote array will be\n   destroyed.\n   If only_updated is enabled, ids of objects to be deleted will be taken\n   from the meta part. By default if cancel_at column is present, all\n   missing local objects will be canceled with cancel_all,\n   if it's missing, all will be destroyed with destroy_all.\n   You can also force method to remove local objects by passing it\n   to remove: :mark_as_missing.\n @option options [Array|Hash] globalized_attributes: A list of attributes\n   which will be mapped with their translations.\n @option options [Time|Proc] initial_sync_since: A point in time from which\n   objects will be synchronized on first synchronization.\n   Works only for partial (updated_since param) synchronizations.\n @option options [Array|Hash] delegate_attributes: Given attributes will be defined\n   on synchronized object and delegated to synced_data Hash\n @option options [Hash] query_params: Given attributes and their values\n   which will be passed to api client to perform search\n @option options [Boolean] auto_paginate: If true (default) will fetch and save all\n   records at once. If false will fetch and save records in batches.\n @option options transaction_per_page [Boolean]: If false (default) all fetched records\n   will be persisted within single transaction. If true the transaction will be per page\n   of fetched records\n @option options [Proc] handle_processed_objects_proc: Proc taking one argument (persisted remote objects).\n   Called after persisting remote objects (once in case of auto_paginate, after each batch\n   when paginating with block).\n @option options [Integer] tolerance: amount of seconds subtracted from last_request timestamp.\n   Used to ensure records are up to date in case request has been made in the middle of transaction.\n   Defaults to 0.", "Performs synchronization of given remote objects to local database.\n\n @param remote [Array] - Remote objects to be synchronized with local db. If\n   it's nil then synchronizer will make request on it's own.\n @param model_class [Class] - ActiveRecord model class to which remote objects\n   will be synchronized.\n @param scope [ActiveRecord::Base] - Within this object scope local objects\n   will be synchronized. By default it's model_class. Can be infered from active record association scope.\n @param remove [Boolean] - If it's true all local objects within\n   current scope which are not present in the remote array will be destroyed.\n   If only_updated is enabled, ids of objects to be deleted will be taken\n   from the meta part. By default if cancel_at column is present, all\n   missing local objects will be canceled with cancel_all,\n   if it's missing, all will be destroyed with destroy_all.\n   You can also force method to remove local objects by passing it\n   to remove: :mark_as_missing. This option can be defined in the model\n   and then overwritten in the synchronize method.\n @param auto_paginate [Boolean] - If true (default) will fetch and save all\n   records at once. If false will fetch and save records in batches.\n @param transaction_per_page [Boolean] - If false (default) all fetched records\n   will be persisted within single transaction. If true the transaction will be per page\n   of fetched records\n @param api [BookingSync::API::Client] - API client to be used for fetching\n   remote objects\n @example Synchronizing amenities\n\n   Amenity.synchronize(remote: [remote_amenity1, remote_amenity2])\n\n @example Synchronizing rentals within given website. This will\n   create/remove/update rentals only within website.\n   It requires relation website.rentals to exist.\n\n  website.rentals.synchronize(remote: remote_rentals)", "Reset last sync timestamp for given scope, this forces synced to sync\n all the records on the next sync. Useful for cases when you add\n a new column to be synced and you use updated since strategy for faster\n synchronization.", "Add remote repository\n\n @param [String] url of remote repo\n @param [String] username optional\n @param [String] password optioanl", "Set local Build Artifacts, that will be used in the Dependency Resolution\n\n @param [Array<Hash>] artifacts of Hashs with { notation => path } or { notation => { :path => path, :pom => pom_path }", "Add dependencies from a Maven POM\n\n @param [String] pom_path\n @param [Array<String>] scopes valid options are compile,test,runtime", "Set the dependencies\n\n The dependencies param takes an [Array] of mixed dependencies:\n  * [String] Artifact notation, such as groupId:artifactId:version, e.g. 'junit:junit:4.7'\n  * [Hash] of a single artifaction notation => scope - { 'junit:junit:4.7' => 'test' }\n  * [String] path to a local pom - 'lib/pom.xml'\n  * [Hash] of a single path to a local pom => scope - { 'lib/pom.xml' => ['compile','test'] }\n\n @param [Array] dependencies\n @see https://github.com/mguymon/naether/wiki/Notations", "Dependencies as a Graph of nested Hashes\n\n @return [Hash]", "Load dependencies to Classpath\n\n @return [Array] of loaded jars", "Convert notations to local paths of artifacts\n\n @param [Array<String>] notations\n @return [Array<String>] of paths to artifacts\n @see https://github.com/mguymon/naether/wiki/Notations", "Deploy artifact to remote repo url\n\n @param [String] notation\n @param [String] file_path to artifact to deploy\n @param [String] url to deploy to\n @param [Hash] opts\n @option opts [String] :pom_path path to pom.xml\n @option opts [String] :username for optional auth\n @option opts [String] :password for optional auth\n @option opts [String] :pub_key for optional auth\n @option opts [String] :pub_key_passphrase for optional auth", "Max of long\n @param [s]\n @return [Integer]", "On a Hash returns the same Hash\n On an Array returns a Hash with identical corresponding keys and values\n Used for mapping local - remote attributes", "Reads from a string as if the string is a content of input file.\n Convenient for evaluating small string snippet contaiing preprocessor macros.\n\n @param [String] buf", "Creates a new instance with given command line arguments and options\n Runs the command and renders barcode", "Initializes the option parser instance", "Parses the command line arguments", "Lists builtin and installed templates.", "Removes a previously installed template.\n\n @param [String] name\n   The name of the template to remove.", "Generates a new project.", "Enables a template, adding it to the generator.\n\n @param [Symbol, String] name\n   The name of the template to add.\n\n @since 0.4.0", "Disables a template in the generator.\n\n @param [Symbol, String] name\n   The name of the template.\n\n @since 0.4.0", "Enables templates.", "Initializes variables for the templates.", "Copies static files and renders templates in the template directories.", "Initializes the project repository and commits all files.\n\n @since 0.10.0", "Create a config file", "Produces a generated result from evaluating the grammar.\n\n @see Calyx::Result\n @overload generate_result(start_symbol)\n   @param [Symbol] start_symbol\n @overload generate_result(rules_map)\n   @param [Hash] rules_map\n @overload generate_result(start_symbol, rules_map)\n   @param [Symbol] start_symbol\n   @param [Hash] rules_map\n @return [Calyx::Result]", "Get all snapshots related to a service instance", "Get detail information for a single snapshot", "filter internal keys of a given snapshot object, return a new snapshot object in canonical format", "Generates an empty directory.\n\n @param [String] dest\n   The uninterpolated destination path.\n\n @return [String]\n   The destination path of the directory.\n\n @since 0.7.1", "Generates a file.\n\n @param [String] dest\n   The uninterpolated destination path.\n\n @param [String] file\n   The source file or template.\n\n @param [Hash] options\n   Additional options.\n\n @option options [Boolean] :template\n   Specifies that the file is a template, and should be rendered.\n\n @return [String]\n   The destination path of the file.\n\n @since 0.7.1", "convert quizzes to assessments", "convert question categories to question banks", "Executes +packer build+.\n\n Will execute multiple builds in parallel as defined in the template.\n The various artifacts created by the template will be outputted.\n\n @param [String,Packer::Template] template the Packer template\n @param [Hash] options\n @option options [Boolean] :force force a build to continue if artifacts\n   exist, deletes existing artifacts\n @option options [Array<String>] :except build all builds other than\n   these\n @option options [Array<String>] :only only build the given builds by\n   name\n @option options [Boolean] :parallel disable parallelization (on by\n   default)\n @option options [Hash] :vars variables for templates\n @option options [String] :var_file path to JSON file containing user\n   variables\n @option options [IO] :live_stream an IO object to stream packer output to\n   in addition to saving output in the output object.\n @return [Packer::Output::Build]", "Excutes +packer inspect+\n\n Inspects a template, parsing and outputting the components a template\n defines. This does not validate the contents of a template (other than\n basic syntax by necessity).\n\n @param [String,Packer::Template] template the Packer template\n @return [Packer::Output::Inspect]", "Executes +packer push+.\n\n Push the given template and supporting files to a Packer build service\n such as Atlas.\n\n If a build configuration for the given template does not exist, it will\n be created automatically. If the build configuration already exists, a\n new version will be created with this template and the supporting files.\n\n Additional configuration options (such as Atlas server URL and files to\n include) may be specified in the \"push\" section of the Packer template.\n Please see the online documentation about these configurables.\n\n @param [String,Packer::Template] template the Packer template\n @param [Hash] options\n @option options [String] :message a message to identify the purpose of\n   changes in this Packer template much like a VCS commit message\n @option options [String] :name the destination build in Atlas. This is\n   in a format \"username/name\".\n @option options [String] :token the access token to use when uploading\n @option options [Hash] :vars variables for templates\n @option options [String] :var_file path to JSON file containing user\n   variables\n @option options [IO] :live_stream an IO object to stream packer output to\n   in addition to saving output in the output object.\n @return [Packer::Output::Push]", "Executes +packer validate+\n\n Checks the template is valid by parsing the template and also checking\n the configuration with the various builders, provisioners, etc.\n\n If it is not valid, the errors will be shown and the command will exit\n with a non-zero exit status. If it is valid, it will exist with a zero\n exist status.\n\n @param [String,Packer::Template] template the Packer template\n @param [Hash] options\n @option options [Boolean] :syntax_only only check syntax. Do not verify\n   config of the template.\n @option options [Array<String>] :except validate all builds other than\n   these\n @option options [Array<String>] :only validate only these builds\n @option options [Hash] :vars variables for templates\n @option options [String] :var_file path to JSON file containing user\n @option options [IO] :live_stream an IO object to stream packer output to\n   in addition to saving output in the output object.\n   variables\n @return [Packer::Output::Validate]", "Update the name of given snapshot.\n This function is not protected by redis lock so a optimistic lock\n is applied to prevent concurrent update.", "Transforms an output string by delegating to the given output function.\n\n If a registered modifier method is not found, then delegate to the given\n string function.\n\n If an invalid modifier function is given, returns the raw input string.\n\n @param [Symbol] name\n @param [String] value\n @return [String]", "Loads meta info about the stored procedure.\n\n This action is not performed in the constructor to allow instances to\n be created before a database connection has been established.\n\n @return [Squirm::Procedure] The instance", "Invokes the procedure.", "Checks the number of values returned when looking up meta info about\n the procedure.\n @see #load\n @see #info_sql", "merges the given key points with the original points", "returns the interpolated value at the Numeric point specified, optionally\n using a given block as the blending function\n\n if no key points have been specified, the return value is +nil+\n\n if one key point has been specified, the return value is the value\n of that key point\n\n if the given point falls outside the interpolation key range (lower than\n the lowest key point or higher than the highest key point), the nearest\n point value is used; in other words, no extrapolation is performed\n\n otherwise, the interpolated value is calculated in accordance with the\n first of:\n\n   * the given block\n   * the stored blending function, :blend_with\n   * a call to :interpolate on a key value object", "recursively find all banks that belong to this one", "Guesses the module name for a word within a project name.\n\n @param [String] word\n   The word within a project name.\n\n @return [String]\n   The module name.\n\n @since 0.1.1", "Guesses the module names from a project name.\n\n @param [String] name\n   The name of the project.\n\n @return [Array<String>]\n   The module names for a project.", "Convert assets based on the file extension if converter is defined", "Bundle multiple assets into a single asset", "Write asset file to disk", "Generate html markup pointing to assets", "Initialize IP object\n\n == parameters:\n params::\n   Might contain address(hostname) and protocol, or just IP\n\n == Returns:\n self", "Common Cartridge doesn't have anywhere to put assignment meta data like this\n So add them as HTML meta fields in the HTML file", "Establishes a connection pool.\n @param [Hash] options The connection options\n @option options [String] :pool Use the given pool rather than Squirm's.\n @option options [Fixnum] :timeout The pool timeout.\n @option options [Fixnum] :pool_size The pool size.", "Executes the query and passes the result to the block you specify.", "Uses a connection for all database access inside the given block. If no\n connection is given, then one will be checked out from the pool for use\n inside the block, and then checked back in when the method returns.", "add +hash+ to manifest file.", "package files and manifest in +zipfile+. If +force+ is true, we'll try to delete the target +zipfile+ if it already exists.", "unpack the content to +path+ and return extraced file list.", "read manifest in a zip file", "Registers the given block as a string filter.\n\n @param [Symbol] name\n @yield [String]\n @yieldreturn [String]", "Defines a static rule in the grammar.\n\n @param [Symbol] name\n @param [Array] productions", "Defines a rule in the temporary evaluation context.\n\n @param [Symbol] name\n @param [Array] productions", "Expands the given symbol to its rule.\n\n @param [Symbol] symbol\n @return [Calyx::Rule]", "Applies the given modifier function to the given value to transform it.\n\n @param [Symbol] name\n @param [String] value\n @return [String]", "Expands a unique rule symbol by evaluating it and checking that it hasn't\n previously been selected.\n\n @param [Symbol] symbol", "Evaluates the grammar defined in this registry, combining it with rules\n from the passed in context.\n\n Produces a syntax tree of nested list nodes.\n\n @param [Symbol] start_symbol\n @param [Hash] rules_map\n @return [Array]", "Options for lock\n name       - The uuid of the lock\n timeout    - The time that waits to acquire the lock, default 20 seconds\n expiration - Lock expires in given seconds if not refreshed, default 10 seconds\n logger     - The logger..\n ttl        - The max time that a thread can acquire the lock, default 600 seconds. Lock raise +JOB_TIMEOUT+ error once the ttl is exceeded.", "Validate the incoming request", "workflow template\n Subclass implement execute method which returns true for a successful rollback", "enhance single method with callbacks", "For l..x rating questions", "Get a lazy enumerable for listing data from the API", "Do we need a static_roles! method? I think so!", "Sets new roles for the subject\n @param [Array<Symbol>] list of role names\n @return [true, false, Error] true if set ok, false if any roles were invalid, Error on some error", "Checks if the entry is untraslated\n\n @return [Boolean]", "Convert entry to a hash key value\n\n @return [Hash]", "Convert entry to a string\n\n @return [String]", "Builds hash with meaningful params only\n @return [Hash]", "Builds and signs request parameters\n @return [Hash]", "saves the role for the user in the data store", "saves the role for the role subject in the data store\n @param [Symbol] role name", "Converts confirmation data to hash", "Calculates signature for parameters", "Set the role of the subject to a new role\n @param  [Symbol] the role to set\n @return [true, false, Error] true if ok, false if not valid, Error on some error", "return an hex representation of a byte string", "Reverse the order of the nibbles in each byte.", "reverse the order of bytes in 16-bit words", "convert a byte string to separate fixed-width bit-fields as integers", "Calls block once for each record in the cursor, passing that\n record as a parameter.", "Maps hash yielding key-value pairs ordered by key", "Sometimes long lines are wrapped into new lines, this function\n join them back\n\n [['a', 'b'], ['c']] #=> [['a', 'bc']]", "Make a GET request to the SPOT API", "is a certain type of auto configuration enabled?", "Set the main field of the behavior", "more likely, strategy should be part of configuration options directly when Config object is created!", "Sets new rolegroups for the subject\n @param [Array<Symbol>] list of rolegroup names\n @return [true, false, Error] true if set ok, false if any rolegroups were invalid, Error on some error", "add new entries to po file\n\n @example\n   entry = {\n             translator_comment: 'comment',\n             reference: 'reference comment',\n             flag: 'fuzzy',\n             msgid: 'translatable string',\n             msgstr: 'translation'\n           }\n   add(entry)\n\n @param entry [Hash, Array] a hash of entry contents or an array of hashes\n @return [Po]", "Delete entry from po file\n\n @example\n\n   delete(entry)\n\n @param entry [Entry] to be deleted\n @return [Entry]", "Shows statistics and status of the provided file in percentage.\n\n @return [Hash] a hash of translated, untranslated and fuzzy percentages", "Saves the file to the provided path", "Locates an XSD file.\n\n @param filename [String] the XSD filename", "Implements execute interface.", "Implements output_for interface.", "Encapsulates the given executioner with child-process-modifying behavior\n based on options. Builds the executioner as a series of callbacks.\n\n @param [Proc] executioner to configure\n @param [Hash] options for execution\n\n @return [Proc] configured executioner", "Sets the given list of environment variables while\n executing the given block.\n\n === Parameters\n @param [Hash] variables to set\n\n === Yield\n @yield [] called with environment set\n\n === Return\n @return [TrueClass] always true", "Set both ctermbg and guibg simultaneously\n\n @param [String] color\n   the color to use\n\n @return [Vic::Highlight]\n   the updated highlight\n\n @api public", "Set both ctermfg and guifg simultaneously\n\n @param [String] color\n   the color to use\n\n @return [Vic::Highlight]\n   the updated highlight\n\n @api public", "Selcect valid styles from a list\n\n @param [Mixed] styles\n   the list of styles\n\n @return [Array,Symbol]\n   the list of valid styles or \"NONE\"\n\n @api private", "Load an HGNC table from IO\n @param fin [#gets, #each] Typically a File or IO\n @private", "In addition to normal retriever initialization, if the\n underlying repository has a credential we need to initialize a\n fresh SSHAgent and add the credential to it.", "Cleans anything that is currently untracked in the repo directory and\n any submodules. the idea is to prevent untracked items interfering with\n the normal behavior that would result if checkout were always to a clean\n directory. just switching between branches and updating submodules can\n leave untracked artifacts that affect behavior.", "Validates the given revision string to ensure it is safe and sane before\n attempting to use it.\n\n @param [::RightGit::Git::Repository] git_repo for validation\n @param [String] revision for validation\n\n @return [String] remote_name (for branch reset) or nil\n\n @raise [RetrieverError] on validation failure", "Temporarily disables checking the size of the repo_dir against the\n configured size limit. This permits performing git queries against a repo\n on disk that would normally exceed the size limit if it hadn't already\n been fully checked out in the past. If a repo has been scraped in the past\n and does not have any new commits, then it is acceptable even if it\n would exceed the current size limit.", "Temporarily disable SSH host-key checking for SSH clients invoked by Git, for the duration of the\n block that is passed to this method.\n\n @yield after disabling strict host key checking, yields to caller", "Utility for replacing a file temporarily within a scope and ensuring it is\n restored afterward.\n\n @param [String] filepath to replace\n @param [String] contents to substitute\n\n @yield after replacing file", "Fetches branch and tag information from remote origin.\n\n @param [Hash] options for fetch all\n @option options [TrueClass|FalseClass] :prune as true to prune dead branches\n\n @return [TrueClass] always true", "Generates a list of commits using the given 'git log' arguments.\n\n @param [String] revision to log or nil\n @param [Hash] options for log\n @option options [Integer] :skip as lines of most recent history to skip (Default = include most recent)\n @option options [Integer] :tail as max history of log\n @option options [TrueClass|FalseClass] :merges as true to exclude non-merge commits\n @option options [TrueClass|FalseClass] :no_merges as true to exclude merge commits\n @option options [TrueClass|FalseClass] :full_hashes as true show full hashes, false for (7-character) abbreviations\n\n @return [Array] list of commits", "Cleans everything and optionally cleans .gitignored files.\n\n @param [Hash] options for checkout\n @option options [TrueClass|FalseClass] :directories as true to clean untracked directories (but not untracked submodules)\n @option options [TrueClass|FalseClass] :gitignored as true to clean gitignored (untracked) files\n @option options [TrueClass|FalseClass] :submodules as true to clean untracked submodules (requires force)\n\n @return [TrueClass] always true", "Queries the recursive list of submodule paths for the current workspace.\n\n @param [Hash] options for submodules\n @option options [TrueClass|FalseClass] :recursive as true to recursively get submodule paths\n\n @return [Array] list of submodule paths or empty", "Updates submodules for the current workspace.\n\n @param [Hash] options for submodules\n @option options [TrueClass|FalseClass] :recursive as true to recursively update submodules\n\n @return [TrueClass] always true", "Determines the SHA referenced by the given revision. Raises on failure.\n\n @param [String] revision or nil for current SHA\n\n @return [String] SHA for revision", "msysgit on Windows exits zero even when checkout|reset|fetch fails so we\n need to scan the output for error or fatal messages. it does no harm to do\n the same on Linux even though the exit code works properly there.\n\n @param [String|Array] args to execute\n\n @return [TrueClass] always true", "Complete a scan for the given resource.\n\n === Parameters ===\n resource(RightScraper::Resources::Base):: resource to scan", "All done scanning this repository.", "Executes the 'metadata.rb' file from a cookbook. Because we don't want\n to evaluate arbitrary Ruby code, we need to sandbox it first.\n\n in order for knife metadata to succeed in the general case we need to\n copy some (but not all) of the cookbook directory AND its ancestors (if\n any) into the container. we will try and restrict copying to what might\n plausibly be referenced by 'metadata.rb' but this could be anything like\n a LICENSE, README, etc. the best heuristic seems to be to copy any file\n whose size is small (less than 128K) because 'metadata.rb' should not be\n executing binaries and should only consume text files of a reasonable\n size. if these restrictions cause a problem then the user is free to\n pre-knife his own 'metadata.json' file and check it into the repo.\n\n note the selection of the jailed cookbook dir is specific to the\n behavior of knife metadata. the cookbook name is defined when the\n 'metadata.rb' declares the name attribute, but the name attribute is\n optional. when no name attribute is declared, the metadata automagically\n uses the parent directory name. this works okay so long as the parent\n directory name is actually the cookbook name. in the case of a repo with\n 'metadata.rb' at the root (i.e. no checked-in parent directory) then the\n cookbook name is undefined. in this case, we want the cookbook name to\n be 'undefined' to remind the user to declare the name explicitly.\n\n === Returns\n @return [String] metadata JSON text", "copies files into jail. we no longer start a new container so this is only\n a local file copying operation. we still need files to appear in a\n writable directory location because knife will write to the directory.", "copies files out of jail by mapping of jail to free path.", "need to enumerate files relative to the cookbook directory because we\n have no idea what the metadata script will attempt to consume from the\n files available in its repository. it may even attempt to manipulate\n files in the system or go out to the network, which may or may not be\n allowed by the conditions of the jail.\n\n some cookbooks (for Windows, especially) will have large binaries\n included in the repository. we don't want to spend time copying these\n files into jail so limit the files that metadata can reference by size.\n presumably the jail would also be limiting disk space so it is important\n to avoid this source of failure.\n\n again, the user can work around these contraints by generating his own\n metadata and checking it into the repository.\n\n @return [Hash] path_map as map of source to destination file paths", "recursive part of generate_copy_in", "yields files in parent meeting size criteria.", "yields directories of parent.", "Attempts to update and then resorts to clean checkout for repository.", "Determines if total size of files in repo_dir has exceeded size limit.\n\n === Return\n @return [TrueClass|FalseClass] true if size limit exceeded", "marshal cookbook to hash", "Return a Branch object representing whichever branch is currently checked out, IF AND ONLY IF\n that branch is a member of the collection. If the current branch isn't part of the collection\n or HEAD refers to something other than a branch, return nil.\n\n @return [Branch] the current branch if any, nil otherwise", "Queries and filters on branches reachable from the given revision, if any.\n\n @param [String] revision for listing reachable merged branches\n\n @return [BranchCollection] merged branches", "Accessor that acts like either a Hash or Array accessor", "Dispatch to the underlying Array of Branch objects, allowing the branch collection to act a\n bit like an Array.\n\n If the dispatched-to method returns an Array, it is wrapped in another BranchCollection object\n before returning to the caller. This allows array-like method calls to be chained together\n without losing the BranchCollection-ness of the underlying object.", "Upload a file during scanning.\n\n === Block\n Return the data for this file.  We use a block because it may\n not always be necessary to read the data.\n\n === Parameters\n relative_position(String):: relative pathname for file from root of cookbook", "Convert the color value to a hexadecimal color\n\n @return [Symbol,String]\n   the color as either \"NONE\" or hexadecimal\n\n @api public", "Convert the color value to a cterm compatible color\n\n @return [Fixnum]\n   the color as either \"NONE\" or cterm color\n\n @api public", "Convert the color value to a standard hexadecimal value\n\n @example\n   Color.new('333').send(:to_standard_hex) # => '#333333'\n\n @return [String]\n   the color in standard hexadecimal format\n\n @api private", "ignoring additional info after revision", "Set row keys\n @param val [Array]", "Access an element\n @overload ele(row, col)\n   Get an element\n   @param row [String]\n   @param col [String]\n   @return [String]\n @overload ele(row, col, val)\n   Set an element\n   @param row [String]\n   @param col [String]\n   @param val [String]\n   @return [Table]", "Get an element\n @param row [String]\n @param col [String]\n @return [String]", "Set an element\n @param row [String]\n @param col [String]\n @param val [String]\n @return [Table]", "Access a row\n @overload row(row)\n   Get a row\n   @param row [String]\n   @return [Hash]\n @overload row(row, val)\n   Set a row\n   @param row [String]\n   @param val [Hash, Array]\n   @return [Table]", "Get a row\n @param row [String]\n @return [Hash]", "Set a row\n @param row [String]\n @param val [Hash, Array]\n @return [Table]", "Access a column\n @overload col(col)\n   Get a column\n   @param col [String]\n   @return [Hash]\n @overload col(col, val)\n   Set a column\n   @param col [String]\n   @param val [Hash, Array]\n   @return [Table]", "Get a column\n @param col [String]\n @return [Hash]", "Set a column\n @param col [String]\n @param val [Hash, Array]\n @return [Table]", "Iterate by row", "Iterate by col", "Try to rescue a gene symbol\n @param symbol [String] Gene symbol\n @param method [Symbol] :auto or :manual\n @param rehearsal [Boolean] When set to true, neither outputing warnings nor modifying rescue history\n @return [String] \"\" if rescue failed", "Record instead of inserting the data if in recording mode.", "Returns an array containing the known units which represent the physical\n quantity described by self\n\n If no argument is given, the array holds instances of Unit::Base (or\n subclasses) which represent each unit. Alternatively only the names or\n symbols of each unit can be returned by providing the appropriate unit\n attribute as a symbolized argument, e.g.\n\n   Dimensions.energy.units             #=> [ #<Quantify::Dimensions: .. >,\n                                             #<Quantify::Dimensions: .. >,\n                                             ... ]\n\n   Dimensions.mass.units :name         #=> [ 'kilogram', 'ounce',\n                                             'pound', ... ]\n\n   Dimensions.length.units :symbol     #=> [ 'm', 'ft', 'yd', ... ]", "Returns the SI unit for the physical quantity described by self.\n\n Plane/solid angle are special cases which are dimensionless units, and so\n are handled explicitly. Otherwise, the si base units for each of the base\n dimensions of self are indentified and the corresponding compound unit is\n derived. If this new unit is the same as a known (SI derived) unit, the\n known unit is returned.\n\n   Dimensions.energy.units                  #=> #<Quantify::Dimensions: .. >\n\n   Dimensions.energy.si_unit.name           #=> 'joule'\n\n   Dimensions.kinematic_viscosity.si_unit.name\n\n                                            #=> 'metre squared per second'", "Returns an array representing the base SI units for the physical quantity\n described by self\n\n If no argument is given, the array holds instances of Unit::Base (or\n subclasses) which represent each base unit. Alternatively only the names\n or symbols of each unit can be returned by providing the appropriate unit\n attribute as a symbolized argument, e.g.\n\n   Dimensions.energy.si_base_units       #=> [ #<Quantify::Unit: .. >,\n                                               #<Quantify::Unit: .. >,\n                                               ... ]\n\n   Dimensions.energy.si_base_units :name\n\n                                         #=> [ \"metre squared\",\n                                               \"per second squared\",\n                                               \"kilogram\"]    \n\n   Dimensions.force.units :symbol        #=> [ \"m\", \"s^-2\", \"kg\"]", "Method for initializing the base quantities of self.\n\n Where base quantities are already defined, the new indices are added to\n the existing ones. This represents the multiplication of base quantities\n (multiplication of similar quantities involves the addition of their\n powers).\n\n This method is therefore used in the multiplication of Dimensions objects,\n but also in divisions and raising of powers following other operations.", "Returns a string representation of the quantity, using the unit symbol", "Converts a quantity to the equivalent quantity using only SI units", "Add or update a forced highlight\n\n @example\n   scheme.highlight!(:Normal, fg: 'eee', bg: '333').force? # => true\n\n @param [Hash] attributes\n   the attributes to set or update\n\n @return [Vic::Highlight]\n   the highlight\n\n @api public", "Add highlight links to the colorscheme\n\n @example\n   scheme.link(:rubyInstanceVariable, :rubyClassVariable)\n\n @param [String,Symbol] from_groups\n   a list of groups to link from\n\n @param [String,Symbol] to_groups\n   the group to link to\n\n @return [Array]\n   the added links\n\n @api public", "Add forced highlight links to the colorscheme\n\n @example\n   scheme.link!(:rubyInstanceVariable, :rubyClassVariable)\n   link = scheme.links.find do |l|\n     l.from_group == :rubyInstanceVariable and l.to_group = :rubyClassVariable\n   end\n   link.force? # => true\n\n @param [String,Symbol] from_groups\n   a list of groups to link from\n\n @param [String,Symbol] to_groups\n   the group to link to\n\n @return [Array]\n   the added/updated links\n\n @api public", "Return the language\n\n If a name and a block is passed the language will be temporarily set to\n name inside the block.\n\n @example\n   scheme.language :ruby do |s|\n     s.hi(:InstanceVariable)\n     s.hi(:ClassVariable)\n   end\n   scheme.highlights.any? { |h| h.group == :rubyClassVarible } # => true\n\n @param [String,Symbol] name\n   the language to temporarily set if a block is given\n\n @yieldparam [Vic::Colorscheme]\n   the colorscheme\n\n @return [String,Symbol]\n   the language setting\n\n @api public", "Reads the existing generated 'metadata.json' or else fails.\n\n === Returns\n @return [String] metadata JSON text", "Create a layer from an edge tab and a node tab\n @param edge_tab [Table]\n @param node_tab [Table]\n Save the layer to disk\n @param path [String] path to output directory\n @param prefix [String]", "Initialize scrape destination directory\n\n === Options\n <tt>:kind</tt>:: Type of scraper that will traverse directory for resources, one of :cookbook or :workflow\n <tt>:basedir</tt>:: Local directory where files are retrieved and scraped, use temporary directory if nil\n <tt>:max_bytes</tt>:: Maximum number of bytes to read from remote repo, unlimited if nil\n <tt>:max_seconds</tt>:: Maximum number of seconds to spend reading from remote repo, unlimited if nil\n Scrapes and scans a given repository.\n\n @deprecated the newer methodology will perform these operations in stages\n controlled externally instead of calling this all-in-one method.\n\n === Parameters\n repo(Hash|RightScraper::Repositories::Base):: Repository to be scraped\n   Note: repo can either be a Hash or a RightScraper::Repositories::Base instance.\n         See the RightScraper::Repositories::Base class for valid Hash keys.\n\n === Block\n If a block is given, it will be called back with progress information\n the block should take four arguments:\n - first argument is one of <tt>:begin</tt>, <tt>:commit</tt>,\n   <tt>:abort</tt> which signifies what\n   the scraper is trying to do and where it is when it does it\n - second argument is a symbol describing the operation being performed\n   in an easy-to-match way\n - third argument is optional further explanation\n - fourth argument is the exception pending (only relevant for <tt>:abort</tt>)\n\n === Return\n true:: If scrape was successful\n false:: If scrape failed, call errors for information on failure\n\n === Raise\n 'Invalid repository type':: If repository type is not known", "Download tarball and unpack it", "Sets the values of +default_assigns+, +default_registers+ and +default_filters+ on a given\n renderer using the +liquid_assigns+, +liquid_registers+ and +liquid_filters+ methods, if\n they're defined.", "Create a new expection target\n\n @api private\n\n @param subject [Proc] The value which is compared with the expected value.\n rubocop:disable Style/MethodName\n rubocop:disable Naming/UncommunicativeMethodParamName\n @api public\n\n This word, or the terms \"REQUIRED\" or \"SHALL\", mean that the\n definition is an absolute requirement of the specification.\n\n @example _Absolute requirement_ definition\n   it { 'foo'.upcase }.MUST eql 'FOO'\n\n @param m [#matches?] The matcher.\n\n @return [Result::Fail, Result::Pass] Report if the spec pass or fail.", "This phrase, or the phrase \"SHALL NOT\", mean that the\n definition is an absolute prohibition of the specification.\n\n @example _Absolute prohibition_ definition\n   it { 'foo'.size }.MUST_NOT equal 42\n\n @param m [#matches?] The matcher.\n\n @return [Result::Fail, Result::Pass] Report if the spec pass or fail.", "This word, or the adjective \"RECOMMENDED\", mean that there\n may exist valid reasons in particular circumstances to ignore a\n particular item, but the full implications must be understood and\n carefully weighed before choosing a different course.\n\n @example _Recommended_ definition\n   it { 'foo'.valid_encoding? }.SHOULD equal true\n\n @param m [#matches?] The matcher.\n\n @return [Result::Fail, Result::Pass] Report if the spec pass or fail.", "This phrase, or the phrase \"NOT RECOMMENDED\" mean that\n there may exist valid reasons in particular circumstances when the\n particular behavior is acceptable or even useful, but the full\n implications should be understood and the case carefully weighed\n before implementing any behavior described with this label.\n\n @example _Not recommended_ definition\n   it { ''.blank? }.SHOULD_NOT raise_exception NoMethodError\n\n @param m [#matches?] The matcher.\n\n @return [Result::Fail, Result::Pass] Report if the spec pass or fail.", "Find the next cookbook, starting in dir.\n\n === Parameters\n dir(Dir):: directory to begin search in", "Search the directory stack looking for the next resource.", "Notice a file during scanning.\n\n === Block\n Return the data for this file.  We use a block because it may\n not always be necessary to read the data.\n\n === Parameters\n relative_position(String):: relative pathname for the file from the root of resource", "Create file layout from given array\n Strings in array correspond to files while Hashes correspond to folders\n File content is equal to filename\n\n === Parameters\n @param [String] path where layout should be created\n @param [Array] layout to be created\n\n === Return\n @return [Array] list of created file paths", "Extract array representing file layout for given directory\n\n === Parameters\n path(String):: Path to directory whose layout is to be retrieved\n layout(Array):: Array being updated with layout, same as return value, empty array by default\n ignore(Array):: Optional: Name of files or directories that should be ignored\n\n === Return\n layout(Array):: Corresponding layout as used by 'create_file_layout'", "Return true if this repository and +other+ represent the same\n repository including the same checkout tag.\n\n === Parameters\n other(Repositories::Base):: repository to compare with\n\n === Returns\n Boolean:: true iff this repository and +other+ are the same\n Return true if this repository and +other+ represent the same\n repository, excluding the checkout tag.\n\n === Parameters\n other(Repositories::Base):: repository to compare with\n\n === Returns\n Boolean:: true iff this repository and +other+ are the same", "Return a URI with the given username and password set.\n\n === Parameters\n uri(URI or String):: URI to add user identification to\n\n === Returns\n URI:: URI with username and password identification added", "checks the key against +@key_map+ if its set\n @param [Integer] ch character read by +Window+\n @return [0, :UNHANDLED] 0 if processed, :UNHANDLED if not processed so higher level can process", "setting up some keys\n This is currently an insertion key map, if you want a String named +@buffer+ updated.\n Expects buffer_changed and set_buffer to exist as well as +buffer()+.\n TODO add left and right arrow keys for changing insertion point. And other keys.\n XXX Why are we trying to duplicate a Field here ??", "handles a key, commandline", "might as well add more keys for paging.", "a default proc to requery data based on glob supplied and the pattern user enters", "specify command to requery data\ndef command &block\n@command = block\nend\nalias :command= :command\n signal that the data has changed and should be redisplayed\n with window resizing etc.", "signal that the user has added or deleted a char from the pattern\n and data should be requeried, etc", "key handler of Controlphandler which overrides KeyDispatcher since we need to\n intercept KEY_ENTER\n @param [Integer] ch is key read by window.\n WARNING: Please note that if this is used in +Viewer.view+, that +view+\n has already trapped CLOSE_KEY which is KEY_ENTER/13 for closing, so we won't get 13\n anywhere", "setting up some keys", "specific actions for directory listers\n currently for stepping into directory under cursor\n and going to parent dir.", "why the dash does it reduce height by one.", "provide data to List in the form of an Array or Variable or\n ListDataModel. This will create a default ListSelectionModel.\n\n CHANGE as on 2010-09-21 12:53:\n If explicit nil passed then dummy datamodel and selection model created\n From now on, constructor will call this, so this can always\n happen.\n\n NOTE: sometimes this can be added much after its painted.\n Do not expect this to be called from constructor, although that\n is the usual case. it can be dependent on some other list or tree.\n @param [Array, Variable, ListDataModel] data to populate list with\n @return [ListDataModel] just created or assigned", "gets string to search and calls data models find prev", "this method chops the data to length before giving it to the\n renderer, this can cause problems if the renderer does some\n processing. also, it pans the data horizontally giving the renderer\n a section of it.", "takes a block, this way anyone extending this klass can just pass a block to do his job\n This modifies the string", "Define actions that can be popped up by PromptMenu or other menubar\n Currently, only PromptMenu, but we can start contextually appending to Menubar or others", "repaint the scrollbar", "prints pine-like key labels", "prints a status line at bottom where mode's statuses et can be reflected", "creates a simple readonly table, that allows users to click on rows\n and also on the header. Header clicking is for column-sorting.", "This configures a stack or flow not the objects inside", "noinspection RubyArgCount,RubyResolve", "Sign in an user that already was authenticated. This helper is useful for logging\n users in after sign up.\n\n Examples:\n\n   sign_in :user, @user                      # sign_in(scope, resource)\n   sign_in @user                             # sign_in(resource)\n   sign_in @user, :event => :authentication  # sign_in(resource, options)", "Sign out a given user or scope. This helper is useful for signing out an user\n after deleting accounts.\n\n Examples:\n\n   sign_out :user     # sign_out(scope)\n   sign_out @user     # sign_out(resource)", "trying to wrap and insert", "wraps line sent in if longer than _maxlen\n Typically a line is sent in. We wrap and put a hard return at end.", "this is broken, delete_buffer could be a line or a string or array of lines", "FIXME - fire event not correct, not undo'ing correctly, check row and also slash r append", "set cursor on correct column", "this attempts to recursively insert into a row, seeing that any stuff exceeding is pushed down further.\n Yes, it should check for a para end and insert. Currently it could add to next para.", "add one char. careful, i shoved a string in yesterday.", "removes and returns last word in given line number, or nil if no whitespace", "tries to move up as many as possible\n should not be called if line ends in \"\\r\"", "def to_s this was just annoying in debugs", "Sets the given node as root and returns treemodel.\n Returns root if no argument given.\n Now we return root if already set\n Made node nillable so we can return root.\n\n @raise ArgumentError if setting a root after its set\n   or passing nil if its not been set.", "thanks to shoes, not sure how this will impact since widget has text.\n show default value as selected and fire handler for it\n This is called in repaint, so can raise an error if called on creation\n or before repaint. Just set @default_value, and let us handle the rest.\n Suggestions are welcome.", "convert a given node to row", "goes up to root of this node, and expands down to this node\n this is often required to make a specific node visible such\n as in a dir listing when current dir is deep in heirarchy.", "this expands all the children of a node, recursively\n we can't use multiplier concept here since we are doing a preorder enumeration\n we need to do a breadth first enumeration to use a multiplier", "sorts the model based on sort keys and reverse flags\n @sort_keys contains indices to sort on\n @reverse_flags is an array of booleans, true for reverse, nil or false for ascending", "toggle the sort order if given column offset is primary sort key\n Otherwise, insert as primary sort key, ascending.", "Takes the array of row data and formats it using column widths\n and returns an array which is used for printing\n\n return an array so caller can color columns if need be", "passes padded data for final printing or data row\n this allows user to do row related coloring without having to tamper\n with the headers or other internal workings. This will not be called\n if column specific colorign is in effect.\n @param text is an array of strings, in the order of actual printing with hidden cols removed", "check if we need to individually color columns or we can do the entire\n row in one shot", "retrieve the column info structure for the given offset. The offset\n pertains to the visible offset not actual offset in data model.\n These two differ when we move a column.\n @return ColumnInfo object containing width align color bgcolor attrib hidden", "calculate pad width based on widths of columns", "a column traversal has happened.\n FIXME needs to be looked into. is this consistent naming wise and are we using the correct object\n In old system it was TABLE_TRAVERSAL_EVENT", "size each column based on widths of this row of data.\n Only changed width if no width for that column", "size each column based on widths of this row of data.", "save the table as a file\n @param String name of output file. If nil, user is prompted\n Currently, tabs are used as delimiter, but this could be based on input\n separator, or prompted.", "delete a data row at index\n\n NOTE : This does not adjust for header_adjustment. So zero will refer to the header if there is one.\n   This is to keep consistent with textpad which does not know of header_adjustment and uses the actual\n   index. Usually, programmers will be dealing with +@current_index+", "set value at the cell at row and col\n @param int row\n @param int col\n @param String value\n @return self", "should all this move into table column model or somepn\n move a column from offset ix to offset newix", "called when ENTER is pressed.\n Takes into account if user is on header_row", "yields each column to caller method\n if yield returns true,  collects index of row into array and returns the array\n @returns array of indices which can be empty\n Value yielded can be fixnum or date etc", "calls the renderer for all rows of data giving them pad, lineno, and line data", "Reset or nullify all image configurations.", "Returns a boolean indicating whether the Image configurations are valid or not.", "Runs files through Pronto. Generates a `markdown` list of warnings.", "The returned path is quoted. If the argument is nil it returns an empty\n string.\n\n @param [#to_str,Nil] pathname\n        The path to return.\n @param [Pathname] relative_to", "Prints a message with a label.\n\n @param [String] label\n        The label to print.\n\n @param [#to_s] value\n        The value to print.\n\n @param [FixNum] justification\n        The justification of the label.", "Prints an info to the user. The info is always displayed.\n It respects the current indentation level only in verbose\n mode.\n\n Any title printed in the optional block is treated as a message.\n\n @param [String] message\n        The message to print.", "A title opposed to a section is always visible\n\n @param [String] title\n         The title to print\n\n @param [String] verbose_prefix\n         See #message\n\n @param [FixNum] relative_indentation\n         The indentation level relative to the current,\n         when the message is printed.", "Prints a verbose message taking an optional verbose prefix and\n a relative indentation valid for the UI action in the passed\n block.\n\n @todo Clean interface.", "what of by_name\n correct coordinates of comp esp if App has stacked them after this\n container\n It is best to use the simple stack feature. The rest could change at any time\n  and is quite arbitrary. Some folks may set absolute locations if container\n  is directly on a form, others may set relative locations if it is inside a\n  tabbed pane or other container. Thus, stacks are best", "Starts the match\n @param [Boolean] gui if false, runs headless match", "This method is called by run, and thus in most cases this is what is used.\n +run+ calls this without a block\n not sure, but user shuld be able to trap keystrokes if he wants\n but do i still call handle_key if he does, or give him total control.\n But loop is already called by framework", "if calling loop separately better to call this, since it will shut off ncurses\n and print error on screen.\n UNUSED", "displays help_text associated with field. 2011-10-15", "returns length of longest", "if partial command entered then returns matches", "This is the method that is called by all apps usually that define an App block", "process args, all widgets should call this", "supply a default print function. The user program need not call this. It may be overridden\n The idea of passing a component at this stage is that one footer can be created for several\n tables or text components, each will pass +self+ when calling print.\n @param comp : the calling textpad component (usually passed as +self+)", "Creating variables case of array, we still create the hash\n @param array or hash containing h w t and l", "destroy window, panel and any pads that were requested", "Widgets can get window to create a pad for them. This way when the window\n  is destroyed, it will delete all the pads. A widget wold not be able to do this.\n The destroy method of the widget will be called.", "prints the border for message boxes\n\n NOTE : FOR MESSAGEBOXES ONLY !!!!  Then why not move to messagebox FIXME", "prints a border around a widget, CLEARING the area.\n  If calling with a pad, you would typically use 0,0, h-1, w-1.\n  FIXME can this be moved to module Bordertitle ?", "print just the border, no cleanup\n+ Earlier, we would clean up. Now in some cases, i'd like\n+ to print border over what's been done.\n XXX this reduces 1 from width but not height !!! FIXME\n  FIXME can this be moved to module Bordertitle ?", "takes focus to last item", "take focus to the next component or item\n Called from DOWN, RIGHT or Tab", "take focus to prev component or item\n Called from LEFT, UP or Back Tab", "actually creates the action buttons", "combo edit box key handling\n removed UP and DOWN and bound it, so it can be unbound", "Field putc advances cursor when it gives a char so we override this", "field does not give char to non-editable fields so we override", "the sets the next match in the edit field", "this should be available to view also.", "place instance_vars of current or given object into a hash\n  and view in a treedialog.", "2011-09-25 V1.3.1", "recursive if given one not enabled goes to next enabled", "private\n returns length of longest item in array", "menu LEFT, RIGHT, DOWN, UP, ENTER\n item could be menuitem or another menu", "set the given menu index as the current or active menu\n  after closing the active menu.\n @param Integer index of menu to activate, starting 0", "menubar LEFT, RIGHT, DOWN", "updates existing label with a new one.\n @return true if updated, else false\n @example update \"C-x\", \"C-x\", \"Disable\"", "called by parent or form, otherwise its private", "leave the component we are on.\n This should be followed by all containers, so that the on_leave action\n of earlier comp can be displayed, such as dimming components selections", "Only for multiple mode.\n add an item to selection, if selection mode is multiple\n if item already selected, it is deselected, else selected\n typically bound to Ctrl-Space\n @example\n     bind_key(0) { add_to_selection }", "mod\n Applications may call this or just copy and modify\n\n bindings related to selection", "add a node to root passing a block optionally\n @param [String, TreeNode, Array, Hash] node/s to add\n @param [Boolean] allow children to be added\n @see TreeNode.add\n @return [TreeNode] node just added to root (NOT self)", "a quick method to undo deletes onto given row. More like paste", "for those quick cases when you wish to replace all the data\n and not have an event per row being generated", "add a node to this node, optionally passing a block for further adding\n add a node as child to existing node\n If node is not a TreeNode it will be converted to one.\n @param [TreeNode, Array, Hash] node/s to add\n @param [boolean] should children be allowed\n @return [TreeNode] node last added (*NOT* self)", "returns an array of user_objects for the current node\n starting from root, ending in the current one. The last node\n represents this node.\n @return [Array] Strings[]", "The basic output method for HighLine objects.\n\n The _statement_ parameter is processed as an ERb template, supporting\n embedded Ruby code.  The template is evaluated with a binding inside\n the HighLine instance.\n NOTE: modified from original highline, does not care about space at end of\n question. Also, ansi color constants will not work. Be careful what ruby code\n you pass in.\n\n NOTE: This uses a window, so it will persist in the last row. You must call\n hide_bottomline to remove the window. It is preferable to call say_with_pause\n from user programs", "display some text at bottom and wait for a key before hiding window", "since say does not leave the screen, it is not exactly recommended\n  as it will hide what's below. It's better to call pause, or this, which\n  will quickly go off. If the message is not important enough to ask for a pause,\n  the will flicker on screen, but not for too long.", "A helper method for sending the output stream and error and repeat\n of the question.\n\n FIXME: since we write on one line in say, this often gets overidden\n by next say or ask", "Internal method for printing a string", "XXX FIXME this uses only rcommand so what is it doing here.", "Each member of the _items_ Array is passed through ERb and thus can contain\n their own expansions.  Color escape expansions do not contribute to the\n final field width.", "creates xml field for given inputs", "after selecting, traverse selections forward", "after selecting, traverse selections backward", "remove selected indices between given indices inclusive", "Asks user to enter a string or pattern for selecting rows\n Selects rows based on pattern, leaving other selections as-is", "Asks user to enter a string or pattern for UNselecting rows\n UNSelects rows based on pattern, leaving other selections as-is", "bindings related to selection", "given an widget, return the item, so we can change weight or some other config", "internal method, called by repaint to print text_center in the center", "internal method to print text_right", "returns true if the current user owns the object\n tries default 'owner' relations if none given as an argument", "returns the update xml buffer", "suspends current program and puts user on unix prompt", "prompts user for unix command and displays output in viewer", "define a key within a prefix key map such as C-x\n Now that i am moving this from global, how will describe bindings get hold of the bindings\n and descriptions", "set width of a given column\n @param [Number] column offset, starting 0\n @param [Number] width", "Now returns an array with formatted data\n @return [Array<String>] array of formatted data", "Setup a new instance of the ABN search class.\n\n @param [String] guid - the ABR GUID for Web Services access\n @param [Hash] options - options detailed below\n @option options [String] :proxy Proxy URL string if required (Example: http://user:pass@host.example.com:443)\n @return [ABNSearch]\n Performs an ABR search for the ABN setup upon initialization\n\n @param [String] acn - the acn you wish to search for\n @return [Hash] search result in a hash", "Separate mappings for listboxes.\n Some methods don;'t make sense for listboxes and are crashing\n since not present for them. f was being overwritten, too.\n Sorry for duplication, need to clean this somehow.", "currently only adding delete_line and some yank pop functions\n These will all give wrong results in table due to _header_offset", "edit current or given line", "common method to edit given string\n @param [String] string to edit/modify\n @param [String] prompt to display before string\n @param [int] max length of input\n @return [0, -1] return value 0 if okay, -1 if error", "common method to input a blank string\n @param [String] prompt to display before string\n @param [int] max length of input\n @return [0, -1] return value 0 if okay, -1 if error", "repaint only one row since content of that row has changed.\n No recreate of pad is done.", "jump to the next occurence of given regex in the current line.\n It only jumps to next line after exhausting current.\n @param [Regexp] passed to String.index", "this is a barebones handler to be used only if an overriding key handler\n wishes to fall back to default processing after it has handled some keys.\n The complete version is in Defaultkeyhandler.\n BUT the key will be executed again.", "execute binding when a row is entered, used more in lists to display some text\n in a header or footer as one traverses", "search for the next occurence of given regexp. Returns line and col if found, else nil.\n @param [String, Regexp] pattern to search for (uses :index)\n @return [nil] return value of no consequence", "have the renderer get the latest colors from the widget.\n Override this if for some reason the renderer wishes to hardcode its own.\n But then the widgets colors would be changed ?", "derived classes may choose to override this.\n However, they should set size and color and attrib at the start since these\n can change after the object has been created depending on the application.", "default method for rendering a line\n If it is a chunkline, then we take care of it.\n Only if it is a String do we pass to renderer.\n Should a renderer be allowed to handle chunks. Or be yielded chunks?", "pass the array of history values\n Trying out a change where an item can also be sent in.\n I am lost, i want the initialization to happen once.", "add content to buffers of a textview\n @param [Array] text, or String (filename)\n @param [Hash] options, typically :content_type => :ansi or :tmux, and :title", "supply an array of files to the multibuffer. These will be read\n  as the user presses next or last etc.", "display next buffer", "display previous buffer if any", "display a menu so user can do buffer management\n However, how can application add to these. Or disable, such as when we\n add buffer delete or buffer insert or edit", "pops up a list of buffers using titles allowing the user to select\n Based on selection, that buffer is displayed.", "determine length of row since we have chunks now.\n Since chunk implements length, so not required except for the old\n cases of demos that use an array.", "this is just a test of prompting user for a string\n+ as an alternative to the dialog.", "Pass a short message to be printed.\n This creates a label for a short message, and a field for a long one.\n @yield field created\n @param [String] text to display", "This is for larger messages, or messages where the size is not known.\n A textview object is created and yielded.", "editable text area", "make it as simple as possible, don't try to be intelligent or\n clever, put as much on the user", "item_width - width to use per item\n   but the item width may apply to stacks inside not to items", "flow and stack could have a border option", "create the whole thing using a MenuTree which has minimal information.\n It uses a hotkey and a code only. We are supposed to resolve the display text\n and actual proc from the caller using this code.", "To allow a more rubyesque way of defining menus and submenus", "Display prompt_menu in columns using commandwindow\n This is an improved way of showing the \"most\" like menu. The earlier\n format would only print in one row.", "creates pairs of colors at start\n since often classes are overriding init_vars, so not gettin created", "paint a list box cell\n\n  @param [Buffer] window or buffer object used for printing\n  @param [Fixnum] row\n  @param [Fixnum] column\n  @param [Fixnum] actual index into data, some lists may have actual data elsewhere and\n                  display data separate. e.g. rfe_renderer (directory listing)\n  @param [String] text to print in cell\n  @param [Boolean, cell focussed, not focussed\n  @param [Boolean] cell selected or not", "get a character.\n unlike rb_gets allows user to enter control or alt or function character too.\n @param [String] prompt or label to show.\n @param [Hash] configuration such as default or regexp for validation\n @return [Integer] nil if canceled, or ret value of getchar which is numeric\n If default provided, then ENTER returns the default", "This is just experimental, trying out tab_completion\n Prompt user for a file name, allowing him to tab to complete filenames\n @see #choose_file from rcommandwindow.rb\n @param [String] label to print before field\n @param [Integer] max length of field\n @return [String] filename or blank if user cancelled", "prints given text to window, in color at x and y coordinates\n @param [Window] window to write to\n @param [String] text to print\n @param [int] color pair such as $datacolor or $promptcolor\n @param [int] x  row\n @param [int] y  col\n @see Window#printstring", "routine to get a string at bottom of window.\n The first 3 params are no longer required since we create a window\n of our own.\n @param [String] prompt - label to show\n @param [Integer] maxlen - max length of input\n @param [Hash] config - :default, :width of Field, :help_text, :tab_completion\n help_text is displayed on F1\n tab_completion is a proc which helps to complete user input\n NOTE : This method is now only for **backward compatibility**\n rb_getstr had various return codes based on whether user asked for help\n possibly mimicking alpine, or because i could do nothing about it.\n Now, rb_getstr handles that and only returns if the user cancels or enters\n a string, so rb_getstr does not need to return other codes.\n @deprecated", "set column names\n @param [Array] column names or headings", "print a border\n Note that print_border clears the area too, so should be used sparingly.", "set cursor on correct column tview", "print data rows", "Truncates data to fit into display area.\n  Copied from listscrollable since we need to take care of left_margin\n  2011-10-6 This may need to be reflected in listbox and others FIXME", "print header row\n  allows user to override", "prints the column headers\n Uses +convert_value_to_text+ and +print_header_row+", "perhaps we can delete this since it does not respect @pw\n @deprecated  (see _estimate_column_widths)", "move cursor to next column\n FIXME need to account for hidden columns and numbering", "Finds the server with the specified name.", "Finds the public ip for a server", "Returns the fully qualified domain name for a server.", "List all the objects based on the command that is specified.", "Deploys a new server using the specified parameters.", "Deletes the server with the specified name.", "Stops the server with the specified name.", "Start the server with the specified name.", "Finds the service offering with the specified name.", "Finds the template with the specified name.", "Finds the iso with the specified name.", "Finds the disk offering with the specified name.", "Finds the volume with the specified name.", "Deletes the volume with the specified name.", "Fetch project with the specified name", "Filter data on regex or just on string", "Finds the network with the specified name.", "Finds the default network.", "Finds the zone with the specified name.", "Finds the default zone for your account.", "Finds the public ip address for a given ip address string.", "Acquires and associates a public IP to an account.", "Lists all port forwarding rules.", "Gets the SSH port forwarding rule for the specified server.", "Gets the WINRM port forwarding rule for the specified server.", "Creates a port forwarding rule.", "returns a string representation of a given int keycode\n @param [Integer] keycode read by window\n    In some case, such as Meta/Alt codes, the window reads two ints, but still we are using the param\n    as the value returned by ?\\M-a.getbyte(0) and such, which is typically 128 + key\n @return [String] a string representation which is what is to be used when binding a key to an\n     action or Proc. This is close to what vimrc recognizes such as <CR> <C-a> a-zA-z0-9 <SPACE>\n     Hopefully it should be identical to what vim recognizes in the map command.\n     If the key is not known to this program it returns \"UNKNOWN:key\" which means this program\n     needs to take care of that combination. FIXME some numbers are missing in between.\n NOTE do we really need to cache everything ? Only the computed ones should be cached ?", "}}}\n if passed a string in second or third param, will create a color\n and return, else it will return default color\n Use this in order to create a color pair with the colors\n provided, however, if user has not provided, use supplied\n default.\n @param [Integer] color_pair created by ncurses\n @param [Symbol] color name such as white black cyan magenta red green yellow\n @param [Symbol] bgcolor name such as white black cyan magenta red green yellow\n @example get_color $promptcolor, :white, :cyan", "Display key bindings for current widget and form in dialog", "view a file or array of strings", "create a logger giving a path.", "goes with dsl_property\n Can throw a FieldValidationException or PropertyVetoException", "this is supposed to be a duplicate of what dsl_property generates for cases when\n  we need to customise the get portion but not copy the set part. just call this.", "default repaint method. Called by form for all widgets.\n  widget does not have display_length.", "in those cases where we create widget without a form, and later give it to\n some other program which sets the form. Dirty, we should perhaps create widgets\n without forms, and add explicitly.", "returns array of events defined for this object\n @deprecated, should be in eventhandler\ndef event_list\nreturn @_events if defined? @_events\nnil\nend\n 2011-11-12 trying to make color setting a bit sane\n You may set as a color_pair using get_color which gives a fixnum\n or you may give 2 color symbols so i can update color, bgcolor and colorpair in one shot\n if one of them is nil, i just use the existing value", "a general method for all widgets to override with their favorite or most meaninful event\n Ideally this is where the block in the constructor should land up.\n @since 1.5.0    2011-11-21", "set this menubar as the form's menu bar.\n also bind the toggle_key for popping up.\n Should this not be at application level ?", "form repaint,calls repaint on each widget which will repaint it only if it has been modified since last call.\n called after each keypress.", "move cursor to where the fields row and col are\n private", "do not override\n form's trigger, fired when any widget loses focus\n  This wont get called in editor components in tables, since  they are formless", "form calls on_enter of each object.\n However, if a multicomponent calls on_enter of a widget, this code will\n not be triggered. The highlighted part", "These mappings will only trigger if the current field\n  does not use them.", "set value of Field\n fires CHANGE handler\n Please don't use this directly, use +text+\n This name is from ncurses field, added underscore to emphasize not to use", "create a label linked to this field\n Typically one passes a Label, but now we can pass just a String, a label\n is created. This differs from +label+ in positioning. The +Field+ is printed on\n +row+ and +col+ and the label before it. Thus, all fields are aligned on column,\n however you must leave adequate columns for the label to be printed to the left of the field.\n\n NOTE: 2011-10-20 when field attached to some container, label won't be attached\n In such cases, use just +label()+ not +set_label()+.\n @param [Label, String] label object to be associated with this field\n @return label created which can be further customized.\n FIXME this may not work since i have disabled -1, now i do not set row and col 2011-11-5", "FIXME this may not work since i have disabled -1, now i do not set row and col", "goto end of field, \"end\" is a keyword so could not use it.", "sets the visual cursor on the window at correct place\n added here since we need to account for pcol. 2011-12-7\n NOTE be careful of curpos - pcol being less than 0", "checks field against +valid_range+, +above+ and +below+ , returning +true+ if it passes\n set attributes, +false+ if it fails any one.", "label of field  Unused earlier, now will print", "for a button, fire it when label invoked without changing focus\n for other widgets, attempt to change focus to that field", "label's repaint - I am removing wrapping and Array stuff and making it simple 2011-11-12", "set button based on Action", "FIXME 2014-05-31 since form checks for highlight color and sets repaint on on_enter, we shoul not set it.\n   but what if it is set at form level ?\n    also it is not correct to set colors now that form's defaults are taken", "for debugging etc\n=begin\n    def initialize item, item_selectable, state, item_first=-1, item_last=-1, paramstring=nil\n      @item, @item_selectable, @state, @item_first, @item_last =\n        item, item_selectable, state, item_first, item_last \n      @param_string = \"Item event fired: #{item}, #{state}\"\n    end\n=end\n i think only one is needed per object, so create once only", "select the given button or value.\n This may be called by user programs to programmatically select a button", "popup the hist", "please set oldrow before calling this. Store current_index as oldrow before changing. NOTE", "In many situations like placing a textarea or textview inside a splitpane\n+ or scrollpane there have been issues getting the cursor at the right point,\n+ since there are multiple buffers. Finally in tabbedpanes, i am pretty\n+ lost getting the correct position, and i feel we should set the cursor\n+ internally once and for all. So here's an attempt\n paint the cursor ourselves on the widget, rather than rely on getting to the top window with\n the correct coordinates. I do need to erase cursor too. Can be dicey, but is worth the attempt.\n This works perfectly, except for when placed in a Tabbedpane since that prints the form with a row offset\n+ of 2 and the widget does not know of the offset. cursor gets it correct since the form has an add_row.", "finds the next match for the char pressed\n returning the index\n If we are only checking first char, then why chomp ?\n Please note that this is used now by tree, and list can have non-strings, so use to_s", "find forwards\n Using this to start a search or continue search", "find backwards\n Using this to start a search or continue search", "takes a block, this way anyone extending this class can just pass a block to do his job\n This modifies the string", "actual position to write on window\n NOTE can return nil, if user scrolls forward or backward", "pass data to create this tree model\n used to be list", "refresh pad onto window\n overrides super due to header_adjustment and the header too", "for users WITH the given roles create a div area\n with optional class given in options hash and render block\n within this div", "for users WITHOUT the given roles create a div area\n with optional class given in options hash and render block\n within this div", "Generate ruby class from OpenAPI schema\n @param output_path [String] parsed OpenAPI YAML\n @param template_path [String] original template path", "Passes if argument responds to all of the given methods.", "Creates OpenAPI Schema array\n @return [Array[Openapi2ruby::Openapi::Schema]]", "Block signature definition.  Returns a ProcContract with the given\n attributes", "OpenAPI schema properties\n @return [Array[Openapi2ruby::Openapi::Schema]]", "Returns Vehicle objects for all vehicles the account contains", "Validate credentials with a call to the API. By default this just does a find_rates call\n with the orgin and destination both as the carrier's default_location. Override to provide\n alternate functionality, such as checking for test_mode to use test servers, etc.", "Creates a BSON representation of the statement.\n @return [Hash]", "Decode an RLP encoded object in a lazy fashion.\n\n If the encoded object is a byte string, this function acts similar to\n {RLP::Decode#decode}. If it is a list however, a {LazyList} is returned\n instead. This object will decode the string lazily, avoiding both\n horizontal and vertical traversing as much as possible.\n\n The way `sedes` is applied depends on the decoded object: If it is a\n string `sedes` deserializes it as a whole; if it is a list, each element\n is deserialized individually. In both cases, `sedes_options` are passed\n on. Note that, if a deserializer is used, only \"horizontal\" but not\n \"vertical lazyness\" can be preserved.\n\n @param rlp [String] the RLP string to decode\n @param sedes [Object] an object implementing a method `deserialize(code)`\n   which is used as described above, or `nil` if no deserialization should\n   be performed\n @param sedes_options [Hash] additional keyword arguments that will be\n   passed to the deserializers\n\n @return [Object] either the already decoded and deserialized object (if\n   encoded as a string) or an instance of {RLP::LazyList}", "Read an item from an RLP string lazily.\n\n If the length prefix announces a string, the string is read; if it\n announces a list, a {LazyList} is created.\n\n @param rlp [String] the rlp string to read from\n @param start [Integer] the position at which to start reading\n\n @return [Array] A pair `[item, next_start]` where `item` is the read\n   string or a {LazyList} and `next_start` is the position of the first\n   unprocessed byte", "Get a specific element from an rlp encoded nested list.\n\n This method uses {RLP::DecodeLazy#decode_lazy} and, thus, decodes only\n the necessary parts of the string.\n\n @example Usage\n   rlpdata = RLP.encode([1, 2, [3, [4, 5]]])\n   RLP.peek(rlpdata, 0, sedes: RLP::Sedes.big_endian_int) # => 1\n   RLP.peek(rlpdata, [2, 0], sedes: RLP::Sedes.big_endian_int) # => 3\n\n @param rlp [String] the rlp string\n @param index [Integer, Array] the index of the element to peek at (can be\n   a list for nested data)\n @param sedes [#deserialize] a sedes used to deserialize the peeked at\n   object, or `nil` if no deserialization should be performed\n\n @raise [IndexError] if `index` is invalid (out of range or too many levels)", "Defines contract-checked attribute readers with the given hash of method\n name to clause.", "Defines contract-checked attribute writers with the given hash of method\n name to clause.", "Callback from method add event.  If a previous method contract\n declaration was deferred, complete it now with the name of the newly-\n added method.", "If the last argument is a Block, handle it as a special case.  We\n do this to ensure that there's no conflict with any real arguments\n which may accept Procs.", "Initializes the middleware.\n\n     # Responds with \"OK\" on /status\n     use RequestStatus, \"OK\"\n\n You can change what URL to look for:\n\n     use RequestStatus, \"OK\", \"/ping\"\n\n You can also check internal systems and return something more informative.\n\n     use RequestStatus, lambda {\n       status = MyApp.status # A Hash of some live counters or something\n       [200, {\"Content-Type\" => \"application/json\"}, status.to_json]\n     }\n\n app                  - The next Rack app in the pipeline.\n callback_or_response - Either a Proc or a Rack response.\n status_path          - Optional String path that returns the status.\n                        Default: \"/status\"\n\n Returns nothing.", "Initializes the middlware.\n\n app     - The next Rack app in the pipeline.\n options - Hash of options.\n           :host      - String hostname.\n           :revision  - String SHA that describes the version of code\n                        this process is running.\n\n Returns nothing.", "the generated procline", "called immediately after a request to record statistics, update the\n procline, and dump information to the logfile", "Rack entry point.", "render the progress of the task using polling to the task API", "Decode an RLP encoded object.\n\n If the deserialized result `obj` has an attribute `_cached_rlp` (e.g. if\n `sedes` is a subclass of {RLP::Sedes::Serializable}), it will be set to\n `rlp`, which will improve performance on subsequent {RLP::Encode#encode}\n calls. Bear in mind however that `obj` needs to make sure that this value\n is updated whenever one of its fields changes or prevent such changes\n entirely ({RLP::Sedes::Serializable} does the latter).\n\n @param options (Hash) deserialization options:\n\n   * sedes (Object) an object implementing a function `deserialize(code)`\n     which will be applied after decoding, or `nil` if no deserialization\n     should be performed\n   * strict (Boolean) if false inputs that are longer than necessary don't\n     cause an exception\n   * (any options left) (Hash) additional keyword arguments passed to the\n     deserializer\n\n @return [Object] the decoded and maybe deserialized object\n\n @raise [RLP::Error::DecodingError] if the input string does not end after\n   the root item and `strict` is true\n @raise [RLP::Error::DeserializationError] if the deserialization fails", "Read an item from an RLP string.\n\n * `rlp` - the string to read from\n * `start` - the position at which to start reading`\n\n Returns a pair `[item, end]` where `item` is the read item and `end` is\n the position of the first unprocessed byte.", "Read the payload of an item from an RLP string.\n\n * `rlp` - the rlp string to read from\n * `type` - the type of the payload (`:str` or `:list`)\n * `start` - the position at which to start reading\n * `length` - the length of the payload in bytes\n\n Returns a pair `[item, end]`, where `item` is the read item and `end` is\n the position of the first unprocessed byte.", "Context constructor.\n\n @param values [Hash]\n Method `add` allows adding new properties (as a Hash) to the Context.\n\n @param values [Hash]", "Connect to the server and begin handling data", "Send a FreeSWITCH command with options and a callback for the response\n\n @param [#to_s] command the command to run\n @param [optional, Hash] options the command's options, where keys have _ substituted for -\n\n @return [RubyFS::Response] response the command's response object", "Execute an application on a particular call\n\n @param [#to_s] call the call ID on which to execute the application\n @param [#to_s] appname the app to execute\n @param [optional, String] options the application options\n\n @return [RubyFS::Response] response the application's response object", "Declared in each model class with interest in collecting gdpr data.\n Instruments the singleton of those classes so that gdpr data can be\n collected and exported to csv.\n\n Arguments are:\n - set of simple fields: i.e. fields that will be output as is\n - a hash of params:\n {renamed_fields: {<field_from_db> => <field_name_in_output>}\n  table_name:     <the new table name in output>\n  description:    <a comment>\n  join:           <an association>}", "Manages line reset in the console", "Checks the all the version patterns are available\n @return [Boolean]", "Renders gallery markup", "Returns value of item's attribute", "Renders link to the specific image in a gallery", "Encode a Ruby object in RLP format.\n\n By default, the object is serialized in a suitable way first (using\n {RLP::Sedes.infer}) and then encoded. Serialization can be explicitly\n suppressed by setting {RLP::Sedes.infer} to `false` and not passing an\n alternative as `sedes`.\n\n If `obj` has an attribute `_cached_rlp` (as, notably,\n {RLP::Serializable}) and its value is not `nil`, this value is returned\n bypassing serialization and encoding, unless `sedes` is given (as the\n cache is assumed to refer to the standard serialization which can be\n replaced by specifying `sedes`).\n\n If `obj` is a {RLP::Serializable} and `cache` is true, the result of the\n encoding will be stored in `_cached_rlp` if it is empty and\n {RLP::Serializable.make_immutable} will be invoked on `obj`.\n\n @param obj [Object] object to encode\n @param sedes [#serialize(obj)] an object implementing a function\n   `serialize(obj)` which will be used to serialize `obj` before\n   encoding, or `nil` to use the infered one (if any)\n @param infer_serializer [Boolean] if `true` an appropriate serializer\n   will be selected using {RLP::Sedes.infer} to serialize `obj` before\n   encoding\n @param cache [Boolean] cache the return value in `obj._cached_rlp` if\n   possible and make `obj` immutable (default `false`)\n\n @return [String] the RLP encoded item\n\n @raise [RLP::EncodingError] in the rather unlikely case that the item\n   is too big to encode (will not happen)\n @raise [RLP::SerializationError] if the serialization fails", "Gets the bump info\n @private\n @return [Bump::BumpInfo]", "Shows the version patterns.\n @param [Bump::BumpInfo] bumpInfo\n @return [void]", "Prints the pattern info for the given rule\n @param [Bump::FileUpdateRule] rule The rule", "Reports the bumping details.\n @param [Bump::BumpInfo] bumpInfo", "The bump action\n @return [Boolean] true iff success", "Prints the version bump plan.\n @param [Bump::BumpInfo] bump_info The bump info", "Prints the bump plan for the give preid.\n @param [Bump::BumpInfo] bump_info The bump info", "Creating shipping functionality for UPS", "Write the plaintext to the file specified\n\n @return [File] The closed file handle the vault was written to", "Extract the plaintext from a previously written vault file\n\n If the file does not appear to be encrypted the raw contents will be\n returned.\n\n @return [String] The plaintext contents of the vault, this is marked for\n   zeroing before the GC reaps the object. Any data extracted/parsed from\n   this string should be similarly wiped from memory when no longer used.", "Returns true if a given value is a non-empty array\n\n @param value [Object]\n @return [Boolean]", "Returns true if a given value is a list of valid JSON schemas\n\n @param value [Object]\n @param id [String] parent schema id\n @param uniqueness_check [Boolean] check that all schemas are unique\n @return [Boolean]", "Returns true if a given JSON schema is valid\n\n @param schema [Object] schema\n @param id [String] schema id\n @return [Boolean]", "Wrap requests to add an `Accept` header to ask for JSON, and parse\n response bodies as JSON data.", "Same as +deep_merge+, but modifies +self+.", "Formats all keys in Word-Word format", "Unpack a zip +file+ to directory +dest+.", "Determine what files in +dir+ to pack.", "Package directory +dir+ as file +zipfile+.", "This is gonna be a post?", "get a channel, group, im or user list", "join a channel, needed to post to channel", "send message to one channel as a single post with params text, channel, as_user", "OK, HERES THE PLAN...\n\n 1. Get all the directories in the entire file tree.\n 2. Sort them by the length of their absolute path.\n 3. Go through the list, longest paths first, and remove\n    the directories that are empty.\n\n This ensures that directories containing empty directories\n are also pruned.", "setup http connection for sending async incoming webhook messages to slack", "raw post of hash to slack webhook", "add regex to things to hear", "pass list of files containing hear statements, to be opened and evaled", "check message and run blocks for any matches", "run on msg all hear blocks matching text", "The currently authenticated user.", "Authenticates an account with Twitter.", "Starts the bot.", "Loads the bot's actual code which is stored in the bot's +lib+\n subdirectory.", "Runs callbacks.\n @param callback_type [:Symbol] The callback type.\n @param object [Object] The object", "Processes a direct message.\n @param dm [Twitter::DirectMessage] received direct message", "Lists all tasks", "Conversion to a quantity in another unit.\n @param  [String,Symbol,Unit,Quantity] unit unit expression.\n @return [Phys::Quantity] quantity in the unit of +unit+.\n @raise  [Phys::UnitError] if unit conversion is failed.", "Comparison of quantities.\n Before the comparison, it converts +other+ to the unit of +self+.\n @param  [Phys::Quantity] other\n @return [Integer]\n @raise  [Phys::UnitError] if unit conversion is failed.\n Equality. Returns +true+ if +self+ has the same value as +other+.\n Before the comparison, it converts +other+ to the unit of +self+.\n @param  [Phys::Quantity] other\n @return [Boolean]\n Comparison. Returns +true+ if +self+ is greater-than or equal-to +other+.\n Before the comparison, it converts +other+ to the unit of +self+.\n @param  [Phys::Quantity] other\n @return [Boolean]\n @raise  [Phys::UnitError] if unit conversion is failed.\n Comparison. Returns +true+ if +self+ is less-than or equal-to +other+.\n Before the comparison, it converts +other+ to the unit of +self+.\n @param  [Phys::Quantity] other\n @return [Boolean]\n @raise  [Phys::UnitError] if unit conversion is failed.\n Comparison. Returns +true+ if +self+ is less than +other+.\n Before the comparison, it converts +other+ to the unit of +self+.\n @param  [Phys::Quantity] other\n @return [Boolean]\n @raise  [Phys::UnitError] if unit conversion is failed.\n Comparison. Returns +true+ if +self+ is greater than +other+.\n Before the comparison, it converts +other+ to the unit of +self+.\n @param  [Phys::Quantity] other\n @return [Boolean]\n @raise  [Phys::UnitError] if unit conversion is failed.\n Closeness. Returns +true+ if\n   (self-other).abs <= (self.abs+other.abs) * epsilon\n Before the comparison, it converts +other+ to the unit of +self+.\n @param  [Phys::Quantity] other\n @param  [Numeric] epsilon\n @return [Boolean]\n @raise  [Phys::UnitError] if unit conversion is failed.", "Conversion to base unit.\n Returns the quantity converted to a base unit.\n @return [Phys::Quantity] a quantity in the base unit.\n @raise  [Phys::UnitError] if unit conversion is failed.", "Inspect String.\n @return [String]", "serialize a Message object into a String\n\n   message = Message.from_string(\"5L|1|N\") #=> <LIS::Message>\n   message.to_message #=> \"5L|1|N\"", "Try to determine if section numbers come after titles,\n rather than before.\n\n eg:\n\n   Section title\n   1. Section content\n\n versus\n\n   1. Section title\n   Section content", "Transform an Akoma Ntoso XML document back into a plain-text version\n suitable for re-parsing back into XML with no loss of structure.", "Authorize an application.\n\n == Parameters\n\n Hash with options:\n\n   service_token:: token granting access to the specified service_id.\n   app_id::        id of the application to authorize. This is required.\n   app_key::       secret key assigned to the application. Required only if application has\n                   a key defined.\n   service_id::    id of the service (required if you have more than one service)\n   user_id::       id of an end user. Required only when the application is rate limiting\n                   end users.\n   usage::         predicted usage. It is optional. It is a hash where the keys are metrics\n                   and the values their predicted usage.\n                   Example: {'hits' => 1, 'my_metric' => 100}\n   extensions::    Optional. Hash of extension keys and values.\n\n == Return\n\n An ThreeScale::AuthorizeResponse object. It's +success?+ method returns true if\n the authorization is successful, false otherwise. It contains additional information\n about the status of the usage. See the ThreeScale::AuthorizeResponse for more information.\n In case of error, the +error_code+ returns code of the error and +error_message+\n human readable error description.\n\n In case of unexpected internal server error, this method raises a ThreeScale::ServerError\n exception.\n\n == Examples\n\n   response = client.authorize(:app_id => '1234')\n\n   if response.success?\n     # All good. Proceed...\n   end", "It can be a user usage report or an app usage report", "helper to generate the creds_params method", "Creates a reply to this tweet.\n @param tweet_text [:String] tweet text\n @param options [Hash] A customizable set of options.\n @option options [Boolean] :reply_all (false) Add all users mentioned in the tweet text to the reply.", "Scans the tweet text for screen names.\n @param reply_all [Boolean] Include all users in the reply.\n @param screen_name [String] The user's screen name (i.e. that one who clicked \"Reply\")\n @return [Array] An array of user names.", "Replies to this direct message.\n @param direct_message_text [:String] direct message text", "run the request, return the result", "We accept sloppy urls and attempt to clean them up", "Defines a new direct message command.\n @param name [Symbol] The name of the command.  Can only contain alphanumerical characters.\n   The recommended maximum length is 4 characters.\n @param options [Hash] A customizable set of options.\n @option options [Boolean] :admin (true) Require admin status for this command.", "Defines a new task to be run outside of a running Twittbot process.\n @param name [Symbol] The name of the task.\n @param options [Hash] A customizable set of options.\n @option options [String] :desc (\"\") Description of this task", "Saves the botpart's configuration.  This is automatically called when\n Twittbot exits.", "Determine application health.\n\n If all instances are running, returns \"RUNNING\". If only some are\n started, returns the percentage of them that are healthy.\n\n Otherwise, returns application's status.", "Bind services to application.", "Unbind services from application.", "No check is made on the existence of the station", "Return Product web URL according to locale", "15.10, 15.6.1", "Inspect string.\n @return [String]\n @example\n   Phys::Unit[\"N\"].inspect #=> '#<Phys::Unit 1,{\"kg\"=>1, \"m\"=>1, \"s\"=>-2},@expr=\"newton\">'", "Make a string of this unit expressed in base units.\n @return [String]\n @example\n   Phys::Unit[\"psi\"].string_form #=> \"(8896443230521/129032)*1e-04 kg m^-1 s^-2\"", "Conversion Factor to base unit, including dimension-value.\n @return [Numeric]\n @example\n   Phys::Unit[\"deg\"].dimension         #=> {\"pi\"=>1, \"radian\"=>1}\n   Phys::Unit[\"deg\"].factor            #=> (1/180)\n   Phys::Unit[\"deg\"].conversion_factor #=> 0.017453292519943295\n @see #factor", "Convert a quantity to this unit.\n @param [Phys::Quantity] quantity to be converted.\n @return [Phys::Quantity]\n @raise [UnitError] if unit conversion is failed.", "Convert a quantity to this unit only in scale.\n @param [Phys::Quantity] quantity to be converted.\n @return [Phys::Quantity]\n @raise [UnitError] if unit conversion is failed.", "Addition of units.\n Both units must be operable and conversion-allowed.\n @param  [Phys::Unit, Numeric] x  other unit\n @return [Phys::Unit]\n @raise  [Phys::UnitError] if unit conversion is failed.", "Multiplication of units.\n Both units must be operable.\n @param  [Phys::Unit, Numeric] x  other unit\n @return [Phys::Unit]\n @raise  [Phys::UnitError] if not operable.", "Inverse of units.\n This unit must be operable.\n @param  [Phys::Unit, Numeric] unit\n @return [Phys::Unit]\n @raise  [Phys::UnitError] if not operable.", "Exponentiation of units.\n This units must be operable.\n @param  [Numeric] x  numeric\n @return [Phys::Unit]\n @raise  [Phys::UnitError] if not operable.", "Get products with country", "Sends the receipt to the customer who made this payment", "Returns the extracted fulltext or nil if no matching handler was found\n for the file type.", "Returns readable role file exploring possible role files. For example,\n if `role` is `myapp-web-staging`, this method explores files as\n\n 1. myapp-web-staging.yml\n 1. myapp-web-base.yml\n 1. myapp-web.yml\n 1. myapp-base.yml\n 1. myapp.yml\n 1. base.yml\n\n @return [String] detected file path or last candidate path", "View helper to include a bit of jQuery on the page which waits for document\n load and then initializes the Ajax, OpenLayers viewer. Since this works\n via Ajax, Djatoka will need to be running or proxied at the same domain as\n the application to avoid cross-domain restrictions.", "Localize a resources or a resource", "During route initialization, if a condition i18n_locale is present\n Delete it, and store it in @locale", "Called for dynamic route generation\n If a @locale is present and if this locale is not the current one\n  => return nil and refuse to generate the route", "Get the windows which will be open in the next so-many hours\n @param hours [Numeric] how many hours to look ahead\n @return [Wavefront::Response]", "US default constraint is often represented as '' or nil", "For types like pointers or references, we recursively track down\n the base type when doing comparisons.\n\n delim needs to be a regex", "Returns gherkin representation of the feature.", "Retrieves a list of public images with specified filter. If no filter is specified - all images are returned.", "Gets all the versions of the given alert\n @param id [String] ID of the alert\n @reutrn [Wavefront::Resonse] where items is an array of integers", "enum attrubute_t and attributes_t return translated enum values\n\n Example:\n   in the Client model\n     enum gender: { undefined: 0, female: 1, male: 2 }\n   in use\n     Client.first.gender    # => 'female'\n     Client.first.gender_t  # => 'Frau'\n     Client.first.genders_t # => { undefined: 'Nicht definiert', female: 'Frau', male: 'Mann' }\n\n Requires:\n   locale key: activerecord.attributes.#{model_name}.#{enum}.#{enum_value_key}\n   eg.:        activerecord.attributes.client.genders.female                    # => 'Frau'", "Return a time as an integer, however it might come in.\n\n @param time [Integer, String, Time] timestamp\n @param in_ms [Boolean] whether to return epoch milliseconds.\n   Passing in an integer timestamp returns itself, regardless\n   of this value\n @return [Integer] epoch time in seconds\n @raise Wavefront::InvalidTimestamp", "Return a timestamp described by the given string. That is,\n '+5m' is five minutes in the future, and '-.1h' is half an\n hour ago.\n\n @param time [String] relative time string. Must begin with + or\n   -, followed by a number, finished with a lower-case time\n   unit identifier. See #time_multiplier\n @param in_ms [Boolean] whether to return epoch milliseconds.\n   Passing in an integer timestamp returns itself, regardless\n   of this value\n @param ref [Time, DateTime] calculate time relative to this\n   point. Primarily for easier testing. Defaults to \"now\".\n @return [Integer] integer timestamp\n @raise [InvalidRelativeTime] if t does not meet requirements", "naively return the number of seconds from the given\n multiplier. This makes absolutely no attempt to compensate for\n any kind of daylight savings or calendar adjustment. A day is\n always going to 60 seconds x 60 minutes x 24 hours, and a\n year will always have 365 days.\n\n @param suffix [Symbol, String]\n @return [Integer] the number of seconds in one unit of the\n   given suffix\n @raise InvalidTimeUnit if the suffix is unknown", "Creates an agreement\n\n @param agreement [Echochamber::Agreement]\n @return [String] Agreement ID", "All documents relating to an agreement\n\n @param agreement_id [String] (REQUIRED)\n @param recipient_email [String] The email address of the participant to be used to retrieve documents. (REQUIRED)\n @param format [String] Content format of the supported documents. It can have two possible values ORIGINAL or CONVERTED_PDF. (REQUIRED)\n @param version_id [String] Version of the agreement as provided by agreement_info().  If not provided, the latest version of the agreement is used.\n @return [Array] Documents relating to agreement.", "Retrieve a document file from an agreement\n\n @param agreement_id [String]  (REQUIRED)\n @param document_id [String]  (REQUIRED)\n @param file_path [String] File path to save the document.  If no file path is given, nothing is saved to disk.\n @return [String] Raw bytes from document file", "Gets a single combined PDF document for the documents associated with an agreement.\n\n @param agreement_id [String]  (REQUIRED)\n @param file_path [String] File path to save the document.  If no file path is given, nothing is saved to disk.\n @param versionId [String] The version identifier of agreement as provided by get_agreement. If not provided then latest version will be used\n @param participantEmail [String] The email address of the participant to be used to retrieve documents.  If none is given, the auth token will be used to determine the user\n @param attachSupportingDocuments [Boolean] When set to YES, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true.\n @param auditReport [Boolean] When set to YES, attach an audit report to the signed agreement PDF. Default value is false\n @return [String] Raw bytes from document file", "Ensure the given argument is a valid external link template\n\n @return true if it is valid\n @raise Wavefront::Exception::InvalidTemplate if not", "Ensure the given argument is a valid name, for instance for an\n event. Names can contain, AFAIK, word characters.\n\n @param name [String] the name to validate\n @return true if the name is valid\n raise Wavefront::Exception::InvalidName if name is not valid", "Ensure the given argument is a valid string, for a tag name.\n\n @param str [String] the string name to validate\n @return True if the string is valid\n @raise Wavefront::Exception::InvalidString if string is not valid.", "Ensure the given argument is a valid timestamp\n\n @param timestamp [DateTime] the timestamp name to validate\n @return True if the value is valid\n @raise Wavefront::Exception::InvalidTimestamp", "Ensure the given argument is a valid epoch timestamp. Again,\n no range checking.\n\n @param timestamp [String, Integer]\n @return True if the timestamp is valid\n @raise Wavefront::Exception::InvalidMaintenanceWindow", "Ensure the given argument is a valid Wavefront value. Can be\n any form of Numeric, including standard notation.\n\n @param value [Numeric] the source name to validate\n @return True if the value is valid\n @raise Wavefront::Exception::InvalidValue if the value is not valid", "Ensure the given argument is a valid version number\n\n @param version [Integer] the version number to validate\n @return True if the version is valid\n @raise Wavefront::Exception::InvalidVersion if the alert ID is\n   not valid", "Ensure the given argument is a valid Wavefront alert ID.\n Alerts are identified by the epoch-nanosecond at which they\n were created.\n\n @param id [String] the alert ID to validate\n @return True if the alert ID is valid\n @raise Wavefront::Exception::InvalidAlertId if the alert ID is\n   not valid", "There doesn't seem to be a public statement on what's allowed\n in a dashboard name. For now I'm going to assume up to 255 word\n characters.\n\n @param id [String] the dashboard ID to validate\n @return true if the dashboard ID is valid\n @raise Wavefront::Exception::InvalidDashboardID if the\n   dashboard ID is not valid", "Ensure the given argument is a valid derived metric ID.  IDs\n are the millisecond epoch timestamp at which the derived\n metric was created.\n\n @param id [String, Integer]\n @return True if the ID is valid\n @raise Wavefront::Exception::InvalidDerivedMetricId", "Ensure the given argument is a valid external Link ID\n\n @param id [String] the external link ID to validate\n @return True if the link ID is valid\n @raise Wavefront::Exception::InvalidExternalLinkId if the\n   link ID is not valid", "Ensure the given argument is a valid maintenance window ID.\n IDs are the millisecond epoch timestamp at which the window\n was created.\n\n @param id [String, Integer]\n @return True if the ID is valid\n @raise Wavefront::Exception::InvalidMaintenanceWindowId", "Ensure the given argument is a valid alert severity\n\n @param severity [String] severity\n @return true if valid\n @raise Wavefront::Exceptions::InvalidAlertSeverity if not valid", "Ensure the given argument is a valid message ID\n\n @param id [String] message ID\n @return true if valid\n @raise Wavefront::Exceptions::InvalidMessageId if not valid", "Ensure the given argument is a valid query granularity\n\n @param granularity [String] granularity\n @return true if valid\n @raise Wavefront::Exceptions::InvalidGranularity if not\n   valid", "Ensure the given argument is a valid saved search ID.\n\n @param id [String] saved search ID\n @return true if valid\n @raise Wavefront::Exceptions::InvalidSavedSearchId if not valid", "Ensure the given argument is a valid saved search entity type.\n\n @param id [String] entity type\n @return true if valid\n @raise Wavefront::Exceptions::InvalidSavedSearchEntity if not\n   valid", "Ensure the given argument is a valid Wavefront source name\n\n @param source [String] the source name to validate\n @return True if the source name is valid\n @raise Wavefront::Exception::InvalidSourceId if the source name\n   is not valid", "Ensure the given argument is a valid user.\n\n @param user [String] user identifier\n @return true if valid\n @raise Wavefront::Exceptions::InvalidUserId if not valid", "Ensure the given argument is a valid webhook ID.\n\n @param id [String] webhook ID\n @return true if valid\n @raise Wavefront::Exceptions::InvalidWebhook if not valid", "Validate a distribution description\n @param dist [Hash] description of distribution\n @return true if valid\n @raise whichever exception is thrown first when validating\n   each component of the distribution.", "Validate an array of distribution values\n @param vals [Array[Array]] [count, value]\n @return true if valid\n @raise whichever exception is thrown first when validating\n   each component of the distribution.", "Ensure the given argument is a valid Wavefront notificant ID.\n\n @param id [String] the notificant ID to validate\n @return True if the notificant ID is valid\n @raise Wavefront::Exception::InvalidNotificantId if the\n   notificant ID is not valid", "Ensure the given argument is a valid Wavefront\n integration ID. These appear to be lower-case strings.\n\n @param id [String] the integration ID to validate\n @return True if the integration name is valid\n @raise Wavefront::Exception::InvalidIntegrationId if the\n   integration ID is not valid", "Ensure the given argument is a valid distribution interval.\n @param interval [Symbol]\n @raise Wavefront::Exception::InvalidDistributionInterval if the\n   interval is not valid", "Ensure the given argument is a valid distribution count.\n @param count [Numeric]\n @raise Wavefront::Exception::InvalidDistributionCount if the\n   count is not valid", "Fake a response which looks like we get from all the other\n paths. The default response is a single array.", "A bad query doesn't send back a JSON object. It sends back a\n string with an embedded message.", "Make the helper values. We use a Map so they're super-easy to\n access\n\n @param raw [Hash] the combined options from config file,\n   command-line and env vars.\n @return void", "If log callback aren't available we will fail to this, which sucks...", "This mount partitions. We assume that the first partition is a root partition.", "Unmounts partitions in reverse order.", "Build a query body", "Creates the server for previously uploaded disk", "Here we initialize all required plugins and create a plugin chain.\n Initialization involves also plugin configuration validation for specified plugin type.", "Initializes the plugin by executing init, after_init, validate and after_validate methods.\n\n We can be sure only for init method because it is implemented internally in base-plugin.rb,\n for all other methods we need to check if they exist.", "This creates the appliance by executing the plugin chain.\n\n Definition is read and validated. Afterwards a plugin chain is created\n and every plugin in the chain is initialized and validated. The next step\n is the execution of the plugin chain, step by step.\n\n Below you can find the whole process of bootstrapping a plugin.\n\n   Call            Scope\n   ------------------------------------------\n   initialize      required, internal\n   init            required, internal\n   after_init      optional, user implemented\n   validate        optional, user implemented\n   after_validate  optional, user implemented\n   execute         required, user implemented\n   after_execute   optional, user implemented", "Connect to the remote machine and determine the best available settings", "At present we don't have enough meta-data to work with to easily generalise,\n so we have to assume defaults often. This is something to improve later.", "Generates Bitpay Invoice and returns iframe view", "Fires on receipt of payment received window message", "Handle IPN from Bitpay server\n Receives incoming IPN message and retrieves official BitPay invoice for processing", "Reprocess Invoice and update order status", "Adds ec2-user will full sudo access without password per Fedora security guidelines.\n We should not use root access on AMIs as it is not secure and prohibited by AWS.\n\n https://issues.jboss.org/browse/BGBUILD-110", "Returns true if the two steps have the same text, minus any keywords\n and arguments, and false otherwise.\n Deprecated\n\n Returns the entire text of the step. Options can be set to selectively\n exclude certain portions of the text. *left_delimiter* and *right_delimiter*\n are used to determine which parts of the step are arguments.\n\n  a_step = CucumberAnalytics::Step.new(\"Given *some* step with a block:\\n|block line 1|\\n|block line 2|\")\n\n  a_step.step_text\n  #=> ['Given *some* step with a block:', '|block line 1|', '|block line 2|']\n  a_step.step_text(:with_keywords => false)\n  #=> ['*some* step with a block:', '|block line 1|', '|block line 2|']\n  a_step.step_text(:with_arguments => false, :left_delimiter => '*', :right_delimiter => '*')\n  #=> ['Given ** step with a block:']\n  a_step.step_text(:with_keywords => false, :with_arguments => false, :left_delimiter => '-', :right_delimiter => '-'))\n  #=> ['*some* step with a block:']", "Populates the step's arguments based on the step's text and some method of\n determining which parts of the text are arguments. Methods include using\n a regular expression and using the step's delimiters.", "Returns the step string minus any arguments based on the given delimiters.", "Substitute variables in selected string.", "Copies specified files into appliance.\n\n There are two types of paths:\n 1. remote - starting with http:// or https:// or ftp://\n 2. local - all other.\n\n Please use relative paths. Relative means relative to the appliance definition file.\n Using absolute paths will cause creating whole directory structure in appliance,\n which is most probably not exactly what you want.\n\n https://issues.jboss.org/browse/BGBUILD-276", "Retrieves library document file data\n\n @param library_document_id (REQUIRED)\n @param file_id [String] (REQUIRED)\n @param file_path [String] File path for saving the document.  If none is given, nothing will be saved to disk.\n @return [String] Raw library document file data", "Retrieves library combined document file\n\n @param library_document_id (REQUIRED)\n @param file_path [String] File path for saving the document.  If none is given, nothing will be saved to disk.\n @param auditReport [Boolean] When set to YES attach an audit report to the library document PDF. Default value will be false.\n @return [String] Raw library combined document file data", "Beautiful syntax.", "List all Galleries\n\n Example Usage:\n  - require 'kairos'\n  - client = Kairos::Client.new(:app_id => '1234', :app_key => 'abcde1234')\n  - client.gallery_list_all", "To facilitate the management of what could be many nodes found by a single query,\n we forward off any unknown methods to each node in the results query.\n We assume that if one node accepts the method, then all of them will.", "Thread safe way of creating the instance sync", "Being serial shouldn't be much slower as we are blocked by the slowest stopper anyway", "Retrieves the IDs of the documents associated with widget.\n\n @param widget_id [String]\n @param version_id [String] The version identifier of widget as provided by get_widget. If not provided then latest version will be used.\n @param participant_email [String] The email address of the participant to be used to retrieve documents\n @return [Hash] Info about widget documents", "Retrieves the file stream of a document of a widget\n\n @param widget_id [String]\n @param document_id [String]\n @param file_path [String] File path where to save the document.  If none is given, nothing will be saved to file.\n @return [String] Raw file stream", "returns a redirect notice for create, update and destroy actions\n\n Example in ClientsController:\n   redirect_to some_path, redirect_notice           # => 'Klient ge\u00e4ndert.'\n   redirect_to some_path, redirect_notice(@client)  # => 'Klient Example Client ge\u00e4ndert.'", "During route initialization, if a condition i18n_locale is present\n Delete it, store it in @locale, and add it to @defaults", "Turn the API's JSON response and HTTP status code into a Ruby\n object.\n @return [Hash]", "Setup and create the migration", "Initializes the Client object\n\n @param credentials [Echochamber::Credentials] Initialized Echochamber::Credentials\n @return [Echochamber::Client] Initialized Echochamber::Client\n Creates a user for the current application\n\n @param user [Echochamber::User]\n @return [String] User ID of new Echosign user", "Creates a transient document for later referral\n\n @param file_name [String]\n @param mime_type [String]\n @param file_handle [File]\n @return [String] Transient document ID", "skips asking to run the save file if it is a tmp file in a server session\n because the server is exiting so no rerun is possible", "Fake a response which looks like we get from all the other\n paths. I'm expecting the user response model to be made\n consistent with others in the future.", "Setting value of a key to nil in opts_defaults forces non-nil value of key in opts_in", "Interact with a libvirtd, attempt to determine optimal settings where possible.\n Register the appliance as a new domain.", "Make no external connections, just dump a basic XML skeleton and provide sensible defaults\n where user provided values are not given.", "Upload an image via SFTP", "Build the XML domain definition. If the user provides a script, it will be called after\n the basic definition has been constructed with the XML as the sole parameter. The output\n from stdout of the script will be used as the new domain definition.", "Look up a domain by name", "Undefine a domain. The domain will be destroyed first if required.", "Write domain XML to file", "Yields path of tempfile containing content to block\n @yield [String] the path to the tempfile containing content", "Is the user associated with the auth context a member of the group?\n @param group [Group, String] group object or group id\n @return [Boolean]", "Make a POST call to the Wavefront API and return the result as\n a Ruby hash.\n\n @param path [String] path to be appended to the\n   #net[:api_base] path.\n @param body [String,Object] optional body text to post.\n   Objects will be converted to JSON\n @param ctype [String] the content type to use when posting\n @return [Hash] API response", "Make a PUT call to the Wavefront API and return the result as\n a Ruby hash.\n\n @param path [String] path to be appended to the\n   #net[:api_base] path.\n @param body [String] optional body text to post\n @param ctype [String] the content type to use when putting\n @return [Hash] API response", "Try to describe the actual HTTP calls we make. There's a bit\n of clumsy guesswork here", "Returns a gherkin representation of the outline.", "These distributions are stored in memory, and sent to\n Wavefront as native distibutions when the buffer is flushed.\n @param path [String] metric path\n @param value [Array, Numeric] value(s) to add to distribution\n @param interval [Symbol, String] distribution interval, :m,\n   :h, or :d\n @param tags [Hash] point tags", "When we are asked to flush the buffers, duplicate the current\n one, hand it off to the writer class, and clear. If writer\n tells us there was an error, dump the old buffer into the\n the new one for the next flush.", "Play a failed flush full of counters back into the system", "Operator for doing pointer arithmetic\n\n @example Pointer arithmetic\n   m = Malloc.new 4\n   # Malloc(4)\n   m.write 'abcd'\n   n = m + 2\n   # Malloc(2)\n   n.read 2\n   # \"cd\"\n\n @param [Integer] offset Non-negative offset for pointer.\n @return [Malloc] A new Malloc object.", "Write data to memory\n\n @example Reading and writing data\n   m = Malloc.new 4\n   # Malloc(4)\n   m.write 'abcd'\n   m.read 2\n   # \"ab\"\n\n @param [String,Malloc] data A string or malloc object with the data.\n @return [String] Returns the parameter +string+.\n\n @see #read", "Returns a gherkin representation of the example.", "Convert an epoch timestamp into epoch milliseconds. If the\n timestamp looks like it's already epoch milliseconds, return\n it as-is.\n\n @param t [Integer] epoch timestamp\n @return [Ingeter] epoch millisecond timestamp", "Start capturing paths. Providing a block automatically stops the\n capture process upon termination of the scope.\n\n @param Array<#update> Observers to be notified of capture\n   events. Each observer should expect a hash{} containing a\n   +:command+, and potentially +:data+.\n\n @yield Block that automatically calls #stop at the end of scope\n   to cease capture.", "Cracks open the target class, and injects a wrapper to enable\n monitoring. By aliasing the original method the wrapper intercepts the\n call, which it forwards onto the 'real' method before executing the hook.\n\n The hook's functionality is provided via a &block, which is passed the\n caller's +self+ in addition to the wrapped method's parameters.\n\n Locking the +flag+ signals the hook to begin capturing.", "Returns newest version from the array", "Returns valid array of sorted mount points\n\n ['/', '/home'] => ['/', '/home']\n ['swap', '/', '/home'] => ['/', '/home', 'swap']\n ['swap', '/', '/home', '/boot'] => ['/', '/boot', '/home', 'swap']\n ['/tmp-eventlog', '/', '/ubrc', '/tmp-config'] => ['/', '/ubrc', '/tmp-config', '/tmp-eventlog']", "Method called by runner to execute Termfile.\n\n @api public", "expects user in options or @user or trolley being set\n unless @purchasable_item is present\n WARNING: in the case of @purchasable_item\n this method name breaks the principle of least surprise\n maybe alter trollied gem in future to come right", "expects order\n either as instance variables or in options", "Get the URL through which a user must sign in using this session ID.\n @param [Hash] ruparams eBay appends this data to the AcceptURL and RejectURL.\n               In a typical rails app this might include the user's model primary key.\n @return [String] the sign-in URL.", "Creates a new MBean.\n\n object_name:: a string corresponding to a valid ObjectName\n connection::  a connection to a MBean server. If none is passed,\n               use the global connection created by\n               MBean.establish_connection", "Create a pull request\n\n @see https://developer.github.com/v3/pulls/#create-a-pull-request\n @param base [String] The branch (or git ref) you want your changes\n                      pulled into. This should be an existing branch on the current\n                      repository. You cannot submit a pull request to one repo that requests\n                      a merge to a base of another repo.\n @param head [String] The branch (or git ref) where your changes are implemented.\n @param title [String] Title for the pull request\n @param body [String] The body for the pull request (optional). Supports GFM.\n @return [Hash] The newly created pull request\n @example\n   @client.create_pull_request(\"master\", \"feature-branch\",\n     \"Pull Request title\", \"Pull Request body\")", "This is necessary because, for translations, the song title comes with the\n lyric text. Also, the format is not always the same, sometimes it's just one line\n for the title, sometimes it's the title followed by some empty lines.\n Here we remove the first line and any following empty lines, so we have\n a consident API.", "using flags.", "Renders the CAS login URL with re-direct back to some URL.\n @param service_url [String] Optional url to redirect to after authentication.\n @return [String] The CAS login URL.", "Ensure the key is an underscored Symbol.\n\n Examples:\n\n     'ApplyBuyerProtection' -> :apply_buyer_protection\n     'PayPalEmailAddress'   -> :paypal_email_address\n     'SoldOffeBay'          -> :sold_off_ebay\n\n @return [Symbol] the reformatted key.", "Push the repository to the server.\n\n @param local_branch [String] the name of the local branch to push from\n @param remote_branch [String] the name of the remote branch to push to\n\n @option opts [Boolean] :local should this do nothing because it is in local-only mode?\n @option opts [Boolean] :force should it force the push even if it can not fast-forward?\n @option opts [Proc] :prepush a block to call before doing the push\n @option opts [Proc] :postpush a block to call after doing the push\n\n @return [void]", "Does branch manipulation.\n\n @param [String] branch_name the name of the branch\n\n @option opts [Boolean] :delete delete the remote branch\n @option opts [Boolean] :force force the update\n @option opts [Boolean] :all list all branches, local and remote\n @option opts [Boolean] :no_color force not using any ANSI color codes\n @option opts [String]  :rename the new name for the branch\n @option opts [String]  :upstream the new branch to track\n @option opts [String]  :base_branch ('master') the branch to base the new branch off of\n\n @return [String] the output of running the git command", "Remove the files from the Index\n\n @param [Array<String>] files the file names to remove from the Index\n\n @option opts :force if exists and not false, will force the removal of the files\n\n @return [String] the output of the git command", "Writes the current SHA-1 for the tip of the branch to the \"sync control file\"\n\n @return [void]\n @see GitLib#read_sync_control_file", "Delete the sync control file for the branch\n\n @return [void]\n @see GitLib#write_sync_control_file", "Create the CLI for the git command\n\n @param [Symbol, String] cmd the command to run (e.g., :commit)\n @param [Array<String, Symbol>] opts the arguments to pass to the command\n @param [String] redirect ???????\n\n @return [String] the command line to run", "Declares that this class should be search with an instance of the given `operator_class`.\n\n @param operator_class [Class<Metasploit::Model::Search::Operator::Base>] a class to initialize.\n @param options [Hash] Options passed to `operator_class.new` along with `{:klass => self}`, so that the\n   `operator_class` instance knows it was registered as search this class.\n @return [Metasploit::Model::Search::Operator::Base]\n @raise (see Metasploit::Model::Base#invalid!)", "this is inserted into the generated SQL from a dataset that\n contains PlaceHolder instances.", "return a modified dataset containing all the predicates", "Values in the parameter list which are not blank, and not\n an ordering. That is, parameters which will be used to generate\n the filter expression.", "for use in forms", "hash of keys to expressions, but only where\n there are values.", "Returns a hash representation without the root", "Delete this branch\n\n @param [Boolean] force should this force removal even if the branch has not been fully merged?\n\n @return [String] the output of running the git command", "Collects all search attributes from search associations and all attributes from this class to show the valid\n search operators to search.\n\n @return [Hash{Symbol => Metasploit::Model::Search::Operator}] Maps\n   {Metasploit::Model::Search::Operator::Base#name} to {Metasploit::Model::Search::Operator::Base#name}.", "Begin creating an XML string by specifying the root node.\n This also sets the context scope, allowing methods and variables\n outside the block to be accessed.\n @param [String] name the name of the root node element.\n @param [Array]  args the data for this element.\n @param [Block]  block an optional block of sub-elements to be nested\n                 within the root node.", "Create an XML node\n @param [String|Symbol] name the name of the XML element (ul, li, strong, etc...)\n @param [Array] args Can contain a String of text or a Hash of attributes\n @param [Block] block An optional block which will further nest XML", "Return the node content as a String, unless a block is given.\n @return [String] the node data.", "Convert the given Hash of options into a string of XML element attributes.", "Initialize API wrapper.\n\n @param api_key - from mailigen.com . Required.\n @param secure - use SSL. By default FALSE\n\n Call Mailigen api method (Documented in http://dev.mailigen.com/display/AD/Mailigen+API )\n\n @param method - method name\n @param params - params if required for API\n\n @return\n JSON, String data if all goes well.\n Exception if somethnigs goes wrong.", "All api calls throught POST method.\n\n @param url - url to post\n @param params - params in hash\n\n @return\n response body", "Read file with methods", "Returns the string formatted according to a pattern.\n\n Examples:\n format('123456789', 'XXX-XX-XXXX')\n    => \"123-45-6789\"\n format('12345', 'XXX-XX-XXXX')\n    => \"123-45\"\n\n Parameters:\n string  -- The string to be formatted.\n pattern -- The format string, see above examples.\n fill    -- A string for padding. If the empty string, then the pattern is\n            filled as much as possible, and the rest of the pattern is\n            truncated. If nil, and the string is too long for the pattern,\n            the string is returned unchanged.  Otherwise, the string is\n            padded to fill the pattern, which is not truncated.", "Configures Octokit to use the appropriate URLs for GitHub server.\n\n @option opts [String] :base_url The base URL to use for the GitHub server; defaults to {#base_github_api_url_for_remote}\n\n @return [void]\n\n @todo remove opts and pass in base_url directly", "Create a GitHub client using username and password specifically.\n Meant to be used to get an OAuth token for \"regular\" client calls.\n\n @param [Hash] opts the options to create a message with\n @option opts [String] :base_url The base URL to use for the GitHub server\n @option opts [String] :remote_name (#remote_name) The \"remote\" name to use (e.g., 'origin')\n @option opts [String] :user the username to authenticate with\n @option opts [String] :password (#password) the password to authenticate with\n\n @return [Octokit::Client] the Octokit client for communicating with GitHub", "Tries to more gracefully handle the token already existing. See\n\n @return [String] the OAuth token\n\n @raise [TokenAlreadyExists] the token already exists\n @raise [Octokit::UnprocessableEntity] there was another problem", "Registers an association.\n\n @param name [to_sym] Name of the association\n @param options [Hash{Symbol => String}]\n @option options [String] :class_name Name of association's class.\n @return [Metasploit::Model::Association::Reflection] the reflection of the registered association.\n @raise [Metasploit::Model::Invalid] if name is blank.\n @raise [Metasploit::Model::Invalid] if :class_name is blank.", "annex_block is a universal helper to render content from\n the database and display it on the page", "The name of the repository\n\n @example\n   repo_name #=> \"jdigger/git-process\"\n\n @return [String] the name of the repository", "Returns the \"remote name\" to use. By convention the most common name is \"origin\".\n\n If the Git configuration \"gitProcess.remoteName\" is set, that will always be used. Otherwise this\n simple returns the first name it finds in the list of remotes.\n\n @return [String, nil] the remote name, or nil if there are none defined", "Expands the git configuration server name to a url.\n\n Takes into account further expanding an SSH uri that uses SSH aliasing in .ssh/config\n\n @param [String] server_name the git configuration server name; defaults to 'origin'\n\n @option opts [String] :ssh_config_file the SSH config file to use; defaults to ~/.ssh/config\n\n @return the fully expanded URL; never nil\n\n @raise [GitHubService::NoRemoteRepository] there is not a URL set for the server name\n @raise [URI::InvalidURIError] the retrieved URL does not have a schema\n @raise [GitHubService::NoRemoteRepository] if could not figure out a host for the retrieved URL\n @raise [::ArgumentError] if a server name is not provided\n\n @todo use the netrc gem", "Get a String representation of the response XML with indentation.\n @return [String] the response XML.", "Post the xml_request to eBay and record the xml_response.", "Add a word to the blacklist\n\n @param  word        [String]  The word to add to the blacklist\n @param  deep_search [Integer] 1 if deep search on word, otherwise 0 for not (default 0)\n @return             [Boolean] True if successful, false if not", "Remove a word from the blacklist\n\n @param  word  [String]  The word to remove from the blacklist\n @return       [Boolean] True if successful, false if not", "Get the blacklist\n\n @return [Array] An array of words in the blacklist", "Send string to process and logging the string\n @param message [String] Message to logging\n @param command [String] Command to send\n @param secret [Boolearn] Choise to logging command", "Setup default IO logger\n @return [Logger] logger", "YAML file loader\n @param file_type [String] File description\n @param file_name [String] File name to load\n @raise [Error] File load error", "Returns an array containing each symbol in vars for which the\n corresponding instance variable  in the specified object is nil.", "For each symbol in vars, checks to see that the corresponding instance\n variable in the specified object is not nil.\n If any are nil, raises an error listing the nils.", "Print a default header to the screen for every command.", "Make a terminal bell chime", "Have you seen that episode of The Cosby Show where Dizzy Gillespie... ah nevermind.", "Is the given +key+ a known type of object?", "Returns the string identifier associated to this +key+", "Capture STDOUT or STDERR to prevent it from being printed.\n\n    capture(:stdout) do\n      ...\n    end", "A basic file writer", "Refresh the metadata object from SimpleDB. If the record doesn't\n exist it will raise an UnknownObject error", "Returns whether or not all passed values are equal\n\n Ex: multi_eq(1, 1, 1, 2) => false; multi_eq(1, 1, 1, 1) => true", "Returns true if any machine metadata exists for this group", "Returns true if all machines in the group are running instances", "Handshake Auth Message Handling\n\n 1. initiator generates ecdhe-random and nonce and creates auth\n 2. initiator connects to remote and sends auth\n\n New:\n\n   E(remote-pubk,\n     S(ephemeral-privk, ecdh-shared-secret ^ nonce) ||\n     H(ephemeral-pubk) || pubk || nonce || 0x0\n   )\n\n Known:\n\n   E(remote-pubk,\n     S(ephemeral-privk, token ^ nonce) ||\n     H(ephemeral-pubk) || pubk || nonce || 0x1\n   )", "Handshake ack message handling\n\n authRecipient = E(remote-pubk, remote-ephemeral-pubk || nonce || 0x1) // token found\n authRecipient = E(remote-pubk, remote-ephemeral-pubk || nonce || 0x0) // token not found\n\n nonce, ephemeral_pubkey, version are local", "Handshake Key Derivation", "decode legacy pre-EIP-8 auth message format", "decode EIP-8 auth message format", "decode legacy pre-EIP-8 ack message format", "decode EIP-8 ack message format", "Apply defaults for parameters that must have values", "Unapply defaults for parameters that must have values.\n This is important when reloading configuration since\n we don't overwrite existing values. If the default\n ones remained the configuration would not be applied.", "Returns a formatted string for printing command info", "Internal method for extracting results\n @param artifacts [CircleCi::Artifacts]\n @param queries [Array<Query>]\n @return  [ResultSet]", "Get information by permalink with optional one relationship", "Get metadata from an URI using the screen scraping technique.\n\n Example:\n   >> 'Wow! What an awesome site: http://adtangerine.com!'.scrapify\n   => {\n        :title => \"AdTangerine | Advertising Platform for Social Media\",\n        :description => \"AdTangerine is an advertising platform that...\",\n        :images => [\n          \"http://adtangerine.com/assets/logo_adt_og.png\",\n          \"http://adtangerine.com/assets/logo_adt_og.png\n        ],\n        :uri => \"http://adtangerine.com\"\n      }\n Arguments:\n   options: (Hash)\n     - which: (Integer)\n         Which URI in the String will be used. It starts from 0 to N.\n     - images: (Symbol or Array)\n         Image extensions which are allowed to be returned as result.", "Find URIs in the String.\n\n Example:\n   >> 'Wow! What an awesome site: http://adtangerine.com!'.find_uri\n   => 'http://adtangerine.com'\n   >> 'Very cool: http://adtangerine.com and www.twitflink.com'.find_uri 1\n   => 'www.twitflink.com'\n Arguments:\n   which: (Integer)\n     - Which URI in the String: first (0), second (1) and so on.", "Setup parameters for a host to preview", "Bad recall quality, start over", "Performs a conversion. This method immediately begins the\n transcoding process; set all other options first.\n\n @param [String] filename the desired name for the final output\n   file.\n @param [Hash] options additional options to control the behavior\n   of the output process. The provided hash will not be modified.\n @option options [Boolean,:ignore] :overwrite (true) determines\n   the behavior if the desired output file already exists. If\n   `true`, the file is replaced. If `false`, an exception is\n   thrown. If `:ignore`, the file is skipped; i.e., HandBrakeCLI\n   is not invoked.\n @option options [Boolean, String] :atomic (false) provides a\n   pseudo-atomic mode for transcoded output. If true, the\n   transcode will go into a temporary file and only be copied to\n   the specified filename if it completes. If the value is\n   literally `true`, the temporary filename is the target\n   filename with `.handbraking` inserted before the extension. If\n   the value is a string, it is interpreted as a path; the\n   temporary file is written to this path instead of in the\n   ultimate target directory. Any `:overwrite` checking will be\n   applied to the target filename both before and after the\n   transcode happens (the temporary file will always be\n   overwritten). This option is intended to aid in writing\n   automatically resumable batch scripts.\n\n @return [void]", "Returns a structure describing the presets that the current\n HandBrake install knows about. The structure is a two-level\n hash. The keys in the first level are the preset categories. The\n keys in the second level are the preset names and the values are\n string representations of the arguments for that preset.\n\n (This method is included for completeness only. This library does\n not provide a mechanism to translate the argument lists returned\n here into the configuration for a {HandBrake::CLI} instance.)\n\n @return [Hash]", "Copies this CLI instance and appends another command line switch\n plus optional arguments.\n\n This method does not do any validation of the switch name; if\n you use an invalid one, HandBrakeCLI will fail when it is\n ultimately invoked.\n\n @return [CLI]", "Calls a predicate proc repeatedly, sleeping the specified interval\n between calls, returning if the predicate returns true,\n and giving up after the specified number of seconds.\n Displays elapsed and remaining times on the terminal.\n Outputs the time elapsed and the time to go.\n\n @param predicate something that can be called with .() or .call\n   that returns a truthy value that indicates no further retries are necessary\n @param sleep_interval  number of seconds (fractions ok) to wait between tries\n @param timeout_secs maximum number of seconds (fractions ok) during which to retry\n @return true if/when the predicate returns true, false if it times out\n\n Ex: TrickBag::Timing.retry_until_true_or_timeout(->{false}, 1.0, 5)\n\n Example Code:\n\n require 'trick_bag'\n predicate = -> { false }\n print \"Waiting 10 seconds for true to be returned (but it won't):\\n\"\n TrickBag::Timing.retry_until_true_or_timeout(predicate, 1, 10)", "Executes the passed block with the Ruby Benchmark standard library.\n Prints the benchmark string to the specified output stream.\n Returns the passed block's return value.\n\n e.g.   benchmark('time to loop 1,000,000 times') { 1_000_000.times { 42 }; 'hi' }\n outputs the following string:\n   0.050000   0.000000   0.050000 (  0.042376): time to loop 1,000,000 times\n  and returns: 'hi'\n\n @param caption the text fragment to print after the timing data\n @param out_stream object responding to << that will get the output string\n   defaults to $stdout\n @block the block to execute and benchmark", "Runs the passed block in a new thread, ensuring that its execution time\n does not exceed the specified duration.\n\n @param max_seconds maximum number of seconds to wait for completion\n @param check_interval_in_secs interval in seconds at which to check for completion\n @block block of code to execute in the secondary thread\n\n @return [true, block return value] if the block completes before timeout\n      or [false, nil] if the block is still active (i.e. the thread is still alive)\n      when max_seconds is reached", "optionally implement create", "optionally implement receive", "Encode key and value, and write to +stream+.", "Returns the most recent backup object for the given path", "Returns the frames for the next protocol up to protocol window size bytes.", "Shows a visual diff of 2 arrays by comparing the string representations\n of the arrays with one element per line.\n @param format can be any valid Diffy option, e.g. :color\n     see https://github.com/samg/diffy/blob/master/lib/diffy/format.rb", "Encrypt data with ECIES method using the public key of the recipient.", "Evaluate the URI's HTML document and get its metadata.\n\n Example:\n   >> eval_uri('http://adtangerine.com', [:png])\n   => {\n        :title => \"AdTangerine | Advertising Platform for Social Media\",\n        :description => \"AdTangerine is an advertising platform that...\",\n        :images => [\n          \"http://adtangerine.com/assets/logo_adt_og.png\",\n          \"http://adtangerine.com/assets/logo_adt_og.png\n        ],\n        :uri => \"http://adtangerine.com\"\n      }\n Arguments:\n   uri: (String)\n     - URI.\n   exts: (Array)\n     - Allowed type of images.", "Filter images returning those with the allowed extentions.\n\n Example:\n   >> sf_check_img_ext('http://source.com/image.gif', :jpg)\n   => []\n   >> sf_check_img_ext(\n        ['http://source.com/image.gif','http://source.com/image.jpg'],\n        [:jpg, :png]\n      )\n   => ['http://source.com/image.jpg']\n Arguments:\n   images: (String or Array)\n     - Images which will be checked.\n   allowed: (String, Symbol or Array)\n     - Allowed types of image extension.", "Select regexes for URIs, protocols and image extensions.\n\n Example:\n   >> sf_regex(:uri)\n   => /\\b((((ht|f)tp[s]?:\\/\\/).../i,\n   >> sf_regex(:image, :jpg)\n   => /(^http{1}[s]?:\\/\\/([w]{3}\\.)?.+\\.(jpg)(\\?.+)?$)/i\n Arguments:\n   type: (Symbol or String)\n     - Regex type: :uri, :protocol, :image\n   args: (*)\n     - Anything.", "Organize XPaths.", "Check and return only the valid image URIs.\n\n Example:\n   >>  sf_fix_imgs(\n         ['http://adtangerine.com/image.png', '/assets/image.jpg'],\n         'http://adtangerine.com',\n         :jpg\n       )\n   => ['http://adtangerine/assets/image.jpg']\n Arguments:\n   imgs: (Array)\n     - Image URIs got from the HTML doc.\n   uri: (String)\n     - Used as basis to the URIs that don't have any protocol/domain set.\n   exts: (Symbol or Array)\n     -  Allowed image extesntions.", "Looks for ENV-ROLE configuration in machines. There must be\n at least one definition in the config for this to return true\n That's how Rudy knows the current group is defined.", "We grab the appropriate routines config and check the paths\n against those defined for the matching machine group.\n Disks that appear in a routine but not in a machine will be\n removed and a warning printed. Otherwise, the routines config\n is merged on top of the machine config and that's what we return.\n\n This means that all the disk info is returned so we know what\n size they are and stuff.\n Return a hash:\n\n      :after:\n      - :root: !ruby/object:Proc {}\n      - :rudy: !ruby/object:Proc {}\n      :disks:\n        :create:\n          /rudy/example1:\n            :device: /dev/sdr\n            :size: 2\n          /rudy/example2:\n            :device: /dev/sdm\n            :size: 1\n\n NOTE: dashes in +action+ are converted to underscores. We do this\n because routine names are defined by method names and valid\n method names don't use dashes. This way, we can use a dash on the\n command-line which looks nicer (underscore still works of course).", "Returns true if this is the default machine environment and role", "Error checking of environment variable to embed\n @param param [String] Embedding target command", "Embedding environment variable to parameter\n @param param [String] Embedding target command\n @return [String] Embedded command", "Fills the pool with the minimum number of threads\n Returns array of created threads", "Flush the thread pool. Mainly used for forcibly resizing\n the pool if existing threads have a long thread life waiting\n for input.", "Resize the pool", "Spawn interactive process\n @yield [] Operations for interactive process", "Search prompt and send command, while process is opened\n @yield [match] Send operations when found prompt\n @yieldparam match [String] Expect matches string (prompt)", "Check for existence of prohibited image content\n\n @param  imgurl  [String] URL of the image to be moderated\n @param  options [Hash]   Options hash, used to set additional parameters\n @return         [String] Image ID that is used to return results to the callback function", "Return status of image moderation\n\n @param  imgid   [String] ID of the image being moderated\n @param  options [Hash]   Options hash, used to set additional parameters\n @return         [String] Status of image moderation", "Return number of image submissions remaining on license\n\n @return [Integer] Number of image submissions remaining", "String xor.", "Add custom colormatchers\n\n Passing a hash or a array of hashes with custom colormatchers.\n\n Add the following to your deploy.rb or in your ~/.caprc\n\n == Example:\n\n   require 'capistrano_colors'\n\n   capistrano_color_matchers = [\n     { :match => /command finished/,       :color => :hide,      :prio => 10, :prepend => \"$$$\" },\n     { :match => /executing command/,      :color => :blue,      :prio => 10, :attribute => :underscore, :timestamp => true },\n     { :match => /^transaction: commit$/,  :color => :magenta,   :prio => 10, :attribute => :blink },\n     { :match => /git/,                    :color => :white,     :prio => 20, :attribute => :reverse },\n   ]\n\n   colorize( capistrano_color_matchers )\n\n You can call colorize multiple time with either a hash or an array of hashes multiple times.\n\n == Colors:\n\n :color can have the following values:\n\n * :hide  (hides the row completely)\n * :none\n * :black\n * :red\n * :green\n * :yellow\n * :blue\n * :magenta\n * :cyan\n * :white\n\n == Attributes:\n\n :attribute can have the following values:\n\n * :bright\n * :dim\n * :underscore\n * :blink\n * :reverse\n * :hidden\n\n\n  == Text alterations\n\n :prepend gives static text to be prepended to the output\n :replace replaces the matched text in the output\n :timestamp adds the current time before the output", "Initialize a new Nutcracker process wrappper\n @param [Hash] options\n @option options [String] :config_file (conf/nutcracker.yaml) path to nutcracker's configuration file\n @option options [String] :stats_uri Nutcracker stats URI - tcp://localhost:22222\n @option options [String] :max_memory use fixed max memory size ( ignore server configuration )\n @option options [Array] :args ([]) array with additional command line arguments\n launching the Nutcracker service", "Syntactic sugar for initialize plugins", "Returns hash with server and node statistics\n See example.json @ project root to get details about the structure", "Returns hash with information about a given Redis", "Check for existence of profanity\n\n @param  text    [String]  Text to test for profanity\n @param  options [Hash]    Options hash, used to set additional parameters\n @return         [Boolean] True if text contains profanity, false if not", "Check for existence of profanity and return number of profane words found\n\n @param  text    [String]  Text to test for profanity\n @param  options [Hash]    Options hash, used to set additional parameters\n @return         [Integer] The number of profane words found in text", "Replace any matched profanity with provided symbol\n\n @param  text    [String]  Text to test for profanity\n @param  symbol  [String]  The symbol to replace each character of matched profanity\n @param  options [Hash]    Options hash, used to set additional parameters\n @return         [String]  The original text, replaced with the provided symbol", "Return an array of matched profanity\n\n @param  text    [String]  Text to test for profanity\n @param  options [Hash]    Options hash, used to set additional parameters\n @return         [Array]   The array of matched profane words", "Print info about a security group\n\n * +group+ is a Rudy::AWS::EC2::Group object", "Start our thread", "Parses UNIX timestamps and creates Time objects", "Checks if the TXT record\n for a domain is valid.", "Composite 9 gravity", "Outputs instance or writes image to disk", "Create a collins client instance\n @param [Hash] options host, username and password are required\n @option options [String] :host a scheme, hostname and port (e.g. https://hostname)\n @option options [Logger] :logger a logger to use, one is created if none is specified\n @option options [Fixnum] :timeout (10) timeout in seconds to wait for a response\n @option options [String] :username username for authentication\n @option options [String] :password password for authentication\n @option options [String] :managed_process see {#manage_process}\n @option options [Boolean] :strict (false) see {#strict}\n Interact with a collins managed process\n @param [String] name Name of process\n @raise [CollinsError] if no managed process is specified/found\n @return [Collins::ManagedState::Mixin] see mixin for more information", "Set cell value. Adds cell to end of Row and adds new Column if there is no Column for +key_", "Converts the resources into a Mustache-compatible template dictionary.", "Take the screenshot\n Do we need pixel depth??", "Add a new Column with +key+", "Add all Elm modules imported in the target file as dependencies, then\n recursively do the same for each of those dependent modules.", "Provides a safe wrapper for our monkeypatched logger\n\n If the provided logger responds to a trace method, use that method. Otherwise fallback to\n using the debug method.", "Return the URL of a Freebase service\n\n @param [String] service the service\n @return [String] the url of the service", "Make a GET request\n\n @param [String] url the url to request\n @param [Hash] params the params of the request\n @return the request response", "Handle the response\n\n If success, return the response body\n If failure, raise an error", "Get the proxy options for HTTParty\n\n @return [Hash] the proxy options", "Number of zeros to the right of the decimal point. Useful for formtting time data.", "Apply a given patch to a given node\n @param [Array<Markdiff::Operations::Base>] operations\n @param [Nokogiri::XML::Node] node\n @return [Nokogiri::XML::Node] Converted node", "Creates a patch from given two nodes\n @param [Nokogiri::XML::Node] before_node\n @param [Nokogiri::XML::Node] after_node\n @return [Array<Markdiff::Operations::Base>] operations", "Utility method to do both creating and applying a patch\n @param [String] before_string\n @param [String] after_string\n @return [Nokogiri::XML::Node] Converted node", "1. Create identity map and collect patches from descendants\n   1-1. Detect exact-matched nodes\n   1-2. Detect partial-matched nodes and recursively walk through its children\n 2. Create remove operations from identity map\n 3. Create insert operations from identity map\n 4. Return operations as a patch\n\n @param [Nokogiri::XML::Node] before_node\n @param [Nokogiri::XML::Node] after_node\n @return [Array<Markdiff::Operations::Base>] operations", "Remove all columns that only contain a blank string, zero, or nil", "Remove all columns that contain the same value in all rows", "Remove preceding and trailing whitespace from all cells. By default, Table does not\n strip whitespace from cells.", "Return the gateway address for the specified pool, or the first gateway\n @note If there is no address in the specified pool, the gateway of the first usable address is\n used, which may not be desired.\n @param [String] pool The address pool to find a gateway on\n @return [String] Gateway address, or nil", "Create a deep copy of a hash\n\n This is useful for copying a hash that will be mutated\n @note All keys and values must be serializable, Proc for instance will fail\n @param [Hash] hash the hash to copy\n @return [Hash]", "Require that a value not be empty\n\n If the value is a string, ensure that once stripped it's not empty. If the value responds to\n `:empty?`, ensure that it's not. Otherwise ensure the value isn't nil.\n\n @param [Object] value the value to check\n @param [String] message the exception message to use if the value is empty\n @param [Boolean,Object] return_value If true, returns value. If not false, returns the object\n @raise [ExpectationFailedError] if the value is empty\n @return [NilClass,Object] NilClass, or respecting return_value", "Require that a guard condition passes\n\n Simply checks that the guard is truthy, and throws an error otherwise\n @see #require_non_empty", "Resolve an asset from a string tag or collins asset\n @note This is perhaps the only collins specific method in Util\n @param [Collins::Asset,String,Symbol] asset_or_tag\n @return [Collins::Asset] a collins asset\n @raise [ExpectationFailedError] if asset\\_or\\_tag isn't valid", "Given a hash, rewrite keys to symbols\n\n @param [Hash] hash the hash to symbolize\n @param [Hash] options specify how to process the hash\n @option options [Boolean] :rewrite_regex if the value is a regex and this is true, convert it to a string\n @option options [Boolean] :downcase if true, downcase the keys as well\n @raise [ExpectationFailedError] if hash is not a hash", "Given a hash, convert all keys to strings\n @see #symbolize_hash", "-> Nodes", "String -> Feature -> Feature -> Integer ->", "Return Symbol for +key+. Translate Column and String. Return +key+ unmodified for anything else.", "Authorize the client\n for a domain name.\n\n Challenge options:\n  - HTTP (default and recommended)\n  - DNS", "Fill in the missing asset parameter on the dynamic method if needed\n\n If {Collins::Client} responds to the method, and the method requires an `asset_or_tag`, we\n insert the asset specified during initialization into the args array. If the method does not\n require an `asset_or_tag`, we simply proxy the method call as is. If {Collins::Client} does\n not respond to the method, we defer to `super`.\n\n @example\n   collins_client.get('some_tag')            # => returns that asset\n   collins_client.with_asset('some_tag').get # => returns that same asset\n\n @note this method should never be called directly", "Initializes the client with the supplied Connection\n @param [Connection] connection the logged in Connection\n @return [FileboundClient::Client] an instance of FileboundClient::Client\n Executes a GET request on the current Filebound client session expecting JSON in the body of the response\n @param [String] url the resource url to request\n @param [Hash] query_params the optional query parameters to pass to the GET request\n @return [Hash] the JSON parsed hash of the response body", "Return this `Option` if non-empty, otherwise return the result of evaluating the default\n @example\n  Option(nil).or_else { \"foo\" } == Some(\"foo\")\n @return [Option<Object>]", "If the option value is defined, apply the specified block to that value\n\n @example\n  Option(\"15\").map{|i| i.to_i}.get == 15\n\n @yieldparam [Object] block The current value\n @yieldreturn [Object] The new value\n @return [Option<Object>] Optional value", "Same as map, but flatten the results\n\n This is useful when operating on an object that will return an `Option`.\n\n @example\n   Option(15).flat_map {|i| Option(i).filter{|i2| i2 > 0}} == Some(15)\n\n @see #map\n @return [Option<Object>] Optional value", "Return relation with given name.\n\n @param name [String, Symbol] Relation name.\n @return [Relation] Relation.", "Apply annotations to a file\n\n @param path [String] Relative path (from root of application) of directory to apply annotations to.\n @param suffix [String] Optionally specify suffix of files to apply annotation to (e.g. \"<model.name>_<suffix>.rb\").\n @param extension [String] Optionally specify extension of files to apply annotaations to (e.g. \"<model.name>_<suffix>.<extension>\").", "Gather model classes and generate annotation for each one.", "Generate annotation text.\n @param model [Class] An ActiveRecord model class.", "Sends a GET request to the supplied resource using the supplied params hash\n @param [String] url the url that represents the resource\n @param [Hash] params the params Hash that will be sent in the request (keys: query, headers, body)\n @return [Net::HTTPResponse] the response from the GET request", "Sends a PUT request to the supplied resource using the supplied params hash\n @param [String] url the url that represents the resource\n @param [Hash] params the params Hash that will be sent in the request (keys: query, headers, body)\n @return [Net::HTTPResponse] the response from the PUT request", "Sends a POST request to the Filebound API's login endpoint to request a new security token\n @return [true, false] returns true if the login was successful and the token was set", "Writes image to disk", "Return hash or array of errors if response included\n such a thing otherwise it returns nil.", "Allow us to read the first line of a csv file to automatically generate the attribute names.\n Spaces are replaced with underscores and non-word characters are removed.\n\n Keep in mind that there is potential for overlap in using this (i.e. you have a field named\n files+ and one named files- and they both get named 'files').\n\n You can specify aliases to rename fields to prevent conflicts and/or improve readability and compatibility.\n\n i.e. read_attributes_from_file('files+' => 'files_plus', 'files-' => 'files_minus)", "Given a CSV row return an instance of an object defined by this mapping", "Initialize properties in invoice with values from owner", "Gets data for CurrentInvoiceLine from the API", "Not relying on default rails logging, we more often use lograge.\n We still want to log incoming params safely, which lograge doesn't include\n this does the same sensative param filtering as rails defaults\n It also allows for logging headers and cookies", "Returns entity objects for a given interval of days.", "Updates Entity with its data from the API", "Deletes entity permanently from E-conomic.", "Updates properties of Entity with the values from hash", "Constructor to create an SMS - optionally pass in to, from and message\n @param to [String] the phone number to send the SMS to, as a string. Spaces will be stripped; + symbol allowed.\n @param from [String] the phone number to send the SMS from, as a string. Spaces will be stripped; + symbol allowed.\n @param message [String] the message to send. The first 160 characters only will be sent.\n Send an sms from your account.", "Fetches all entities from the API.", "Fetches Entity data from API and returns an Entity initialized with that\n data added to Proxy", "Gets data for Entity from the API. Returns Hash with the response data", "Fetches all data for the given handles. Returns Array with hashes of\n entity data", "Requests an action from the API endpoint", "Fetches all current orders from the API.", "=begin\nChecks whether the module is already mounted and if not then configures for mounting.\n=end", "=begin\nFunction to copy the module of interest to project location.\n=end", "=begin\n Function to create the necessary migrations and models. \n=end", "=begin\nFunction to copy the module files to project location.\n=end", "=begin\nFunction to configure the module files.\n=end", "=begin\nFunction to add the module dependency gems to project Gemfile.\n=end", "=begin\nUnmounts the modules by removing the respective module files.\n=end", "Define a rule for this object\n\n The rule parameter can be one of the following:\n\n * a symbol that matches to a class in the Validation::Rule namespace\n  * e.g. rule(:field, :not_empty)\n * a hash containing the rule as the key and it's parameters as the values\n  * e.g. rule(:field, :length => { :minimum => 3, :maximum => 5 })\n * an array combining the two previous types", "Determines if this object is valid. When a rule fails for a field,\n this will stop processing further rules. In this way, you'll only get\n one error per field", "Adds a single rule to this object", "Adds a set of parameterized rules to this object", "Resolves the specified rule name to a rule class", "Converts a symbol to a class name, taken from rails", "Store validation info for easy and fast access.", "Creates an element\n @param [String] selector to identify element\n @param [Hash] options\n @option options [Capypage::Element] :base_element Base element for the element to be created\n @option options [Symbol] :select_using Selector to switch at element level", "=begin\nCreates the application base directories.\n=end", "=begin\nFunction to create the API modules.\n=end", "=begin\nFunction to configure the Goliath server.\n=end", "=begin\nFunction to copy the template files project location.\n=end", "=begin\nGenerates the model file with CRED functionality.\n=end", "=begin\nGenerates migration files for the scaffold.\n=end", "=begin\nConfigures the migration file with the required user input.\n=end", "=begin\nEdits the migration file with the user specified model attributes.\n=end", "=begin\nGenerates the api file with CRED functionality apis enabled.\n=end", "=begin\nConfigures the api file with respect to the user input.\n=end", "=begin\nMounts the scaffold apis onto the application.\n=end", "=begin\nConfigures for mounting the scaffold apis.\n=end", "=begin\nConverts the string into snake case format.\n=end", "if block is in chain or in queue", "called in railtie", "Initializes new instance of Chunker\n\n @param [OpenNlp::Model] model chunker model\n @param [Model::Tokenizer] token_model tokenizer model\n @param [Model::POSTagger] pos_model part-of-speech tagging model\n Chunks a string into part-of-sentence pieces\n\n @param [String] str string to chunk\n @return [Array] array of chunks with part-of-sentence information", "Gets a list of greek words and generates the greeklish version of\n each word.\n\n @param greek_words a list of greek words\n @return a list of greeklish words", "Detects sentences in a string\n\n @param [String] string string to detect sentences in\n @return [Array<String>] array of detected sentences", "Detects sentences in a string and returns array of spans\n\n @param [String] str\n @return [Array<OpenNlp::Util::Span>] array of spans for detected sentences", "This method generates the greek variants of the greek token that\n receives.\n\n @param token_string the greek word\n @return a list of the generated greek word variations", "Detects names for provided array of tokens\n\n @param [Array<String>] tokens tokens to run name detection on\n @return [Array<Java::opennlp.tools.util.Span>] names detected", "Called if there's a newblock announced on the network.", "Called if a new peer is connected.", "No way to check if this really an interesting block at this point.\n Might lead to an amplification attack, need to track this proto and\n judge usefulness.", "this function will post expr_str exactly as encoded", "return meta data for all equip with related points", "Initializes new instance of Parser\n\n @param [OpenNlp::Model::Parser] parser_model\n @param [OpenNlp::Model::Tokenizer] token_model\n Parses text into instance of Parse class\n\n @param [String] text text to parse\n @return [OpenNlp::Parser::Parse]", "Parses the specified value that was returned from a call to the IG Markets API.\n\n @param [Hash, Array, Object] response The response or part of a response that should be parsed. If this is of type\n        `Hash` then all hash keys will converted from camel case into snake case and their values will each be\n        parsed individually by a recursive call. If this is of type `Array` then each item will be parsed\n        individually by a recursive call. All other types are passed through unchanged.\n\n @return [Hash, Array, Object] The parsed object, the type depends on the type of the `response` parameter.", "Categorizes a string passed as parameter to one of the categories\n\n @param [String] str string to be categorized\n @return [String] category", "Context should contain accessible routes.", "Identifies words with only Greek lowercase characters.\n\n @param input The string that will examine\n @return true if the string contains only Greek characters", "Closes this position. If called with no options then this position will be fully closed at current market prices,\n partial closes and greater control over the close conditions can be achieved by using the relevant options.\n\n @param [Hash] options The options for the position close.\n @option options [Float] :level Required if and only if `:order_type` is `:limit` or `:quote`.\n @option options [:limit, :market, :quote] :order_type The order type. `:market` indicates to fill the order at\n                 current market level(s). `:limit` indicates to fill at the price specified by `:level` (or a more\n                 favorable one). `:quote` is only permitted following agreement with IG Markets. Defaults to\n                 `:market`.\n @option options [String] :quote_id The Lightstreamer quote ID. Required when `:order_type` is `:quote`.\n @option options [Float] :size The size of the position to close. Defaults to {#size} which will close the entire\n                 position, or alternatively specify a smaller value to partially close this position.\n @option options [:execute_and_eliminate, :fill_or_kill] :time_in_force The order fill strategy.\n                 `:execute_and_eliminate` will fill this order as much as possible within the constraints set by\n                 `:order_type`, `:level` and `:quote_id`. `:fill_or_kill` will try to fill this entire order within\n                 the constraints, however if this is not possible then the order will not be filled at all. If\n                 `:order_type` is `:market` (the default) then `:time_in_force` will be automatically set to\n                 `:execute_and_eliminate`.\n\n @return [String] The resulting deal reference, use {DealingPlatform#deal_confirmation} to check the result of\n         the position close.", "Updates this position. No attributes are mandatory, and any attributes not specified will be kept at their\n current value.\n\n @param [Hash] new_attributes The attributes of this position to update.\n @option new_attributes [Float] :limit_level The new limit level for this position.\n @option new_attributes [Float] :stop_level The new stop level for this position.\n @option new_attributes [Boolean] :trailing_stop Whether to use a trailing stop for this position.\n @option new_attributes [Integer] :trailing_stop_distance The distance away in pips to place the trailing stop.\n @option new_attributes [Integer] :trailing_stop_increment The step increment to use for the trailing stop.\n\n @return [String] The deal reference of the update operation. Use {DealingPlatform#deal_confirmation} to check\n         the result of the position update.", "Initializes this password encryptor with the specified encoded public key and timestamp.\n\n @param [String] encoded_public_key\n @param [String] time_stamp\n Takes an encoded public key and calls {#public_key=} with the decoded key.\n\n @param [String] encoded_public_key The public key encoded in Base64.", "Encrypts a password using this encryptor's public key and time stamp, which must have been set prior to calling\n this method.\n\n @param [String] password The password to encrypt.\n\n @return [String] The encrypted password encoded in Base64.", "determines if node is a placeholder selector starting widht the %f- convention for typography rulesets", "Return the address that should be used as coinbase for new blocks.\n\n The coinbase address is given by the config field pow.coinbase_hex. If\n this does not exist, the address of the first account is used instead.\n If there are no accounts, the coinbase is `DEFAULT_COINBASE`.\n\n @raise [ValueError] if the coinbase is invalid (no string, wrong\n   length) or there is no account for it and the config flag\n   `accounts.check_coinbase` is set (does not apply to the default\n   coinbase).", "Add an account.\n\n If `store` is true the account will be stored as a key file at the\n location given by `account.path`. If this is `nil` a `ValueError` is\n raised. `include_address` and `include_id` determine if address and id\n should be removed for storage or not.\n\n This method will raise a `ValueError` if the new account has the same\n UUID as an account already known to the service. Note that address\n collisions do not result in an exception as those may slip through\n anyway for locked accounts with hidden addresses.", "Replace the password of an account.\n\n The update is carried out in three steps:\n\n 1. the old keystore file is renamed\n 2. the new keystore file is created at the previous location of the old\n   keystore file\n 3. the old keystore file is removed\n\n In this way, at least one of the keystore files exists on disk at any\n time and can be recovered if the process is interrupted.\n\n @param account [Account] which must be unlocked, stored on disk and\n   included in `@accounts`\n @param include_address [Bool] forwarded to `add_account` during step 2\n @param include_id [Bool] forwarded to `add_account` during step 2\n\n @raise [ValueError] if the account is locked, if it is not added to the\n   account manager, or if it is not stored", "Find an account by either its address, its id, or its index as string.\n\n Example identifiers:\n\n - '9c0e0240776cfbe6fa1eb37e57721e1a88a563d1' (address)\n - '0x9c0e0240776cfbe6fa1eb37e57721e1a88a563d1' (address with 0x prefix)\n - '01dd527b-f4a5-4b3c-9abb-6a8e7cd6722f' (UUID)\n - '3' (index)\n\n @param identifier [String] the accounts hex encoded, case insensitive\n   address (with optional 0x prefix), its UUID or its index (as string,\n   >= 1)\n\n @raise [ValueError] if the identifier could not be interpreted\n @raise [KeyError] if the identified account is not known to the account\n   service", "Return the account with a given id.\n\n Note that accounts are not required to have an id.\n\n @raise [KeyError] if no matching account can be found", "Get an account by its address.\n\n Note that even if an account with the given address exists, it might\n not be found if it is locked. Also, multiple accounts with the same\n address may exist, in which case the first one is returned (and a\n warning is logged).\n\n @raise [KeyError] if no matching account can be found", "Compares this model to another, the attributes and class must match for them to be considered equal.\n\n @param [Model] other The other model to compare to.\n\n @return [Boolean]\n Converts this model into a nested hash of attributes. This is simlar to just calling {#attributes}, but in this\n case any attributes that are instances of {Model} will also be transformed into a hash in the return value.\n\n @return [Hash]", "Signs in to the IG Markets Dealing Platform, either the live platform or the demo platform.\n\n @param [String] username The IG Markets username.\n @param [String] password The IG Markets password.\n @param [String] api_key The IG Markets API key.\n @param [:live, :demo] platform The platform to use.\n\n @return [ClientAccountSummary] The client account summary returned by the sign in request. This result can also\n                                be accessed later using {#client_account_summary}.", "Returns a formatted string for the specified currency amount and currency, and colors it red for negative values\n and green for positive values. Two decimal places are used for all currencies except the Japanese Yen.\n\n @param [Float, Integer] amount The currency amount to format.\n @param [String] currency_name The currency.\n\n @return [String] The formatted and colored currency amount, e.g. `\"USD -130.40\"`, `\"AUD 539.10\"`, `\"JPY 3560\"`.", "Takes a string or symbol that uses snake case and converts it to a camel case symbol.\n\n @param [String, Symbol] value The string or symbol to convert to camel case.\n\n @return [Symbol]", "Dump the keystore for later disk storage.\n\n The result inherits the entries `crypto` and `version` from `Keystore`,\n and adds `address` and `id` in accordance with the parameters\n `include_address` and `include_id`.\n\n If address or id are not known, they are not added, even if requested.\n\n @param include_address [Bool] flag denoting if the address should be\n   included or not\n @param include_id [Bool] flag denoting if the id should be included or\n   not", "Sign a Transaction with the private key of this account.\n\n If the account is unlocked, this is equivalent to\n `tx.sign(account.privkey)`.\n\n @param tx [Transaction] the transaction to sign\n @raise [ValueError] if the account is locked", "Detects missing unstratified populations from the generated @populations array", "copy local file to remote", "copy remote file to local", "yeild chunksize of path one chunk at a time", "Tokenizes a string\n\n @param [String] str string to tokenize\n @return [Array] array of string tokens", "Adds tags to tokens passed as argument\n\n @param [Array<String>, String] tokens tokens to tag\n @return [Array<String>, String] array of part-of-speech tags or string with added part-of-speech tags", "Reloads this account's attributes by re-querying the IG Markets API.", "Specifies an array of 'only' keys in BASE object that would be 'included' in the response.\n\n @param [Array] fields Array of the 'only' reference keys to be included in response.\n @param [Array] fields_with_base Can be used to denote 'only' fields of the reference class\n\n Example\n    # Include only title and description field in response\n    @query = @stack.content_type('category').query\n    @query.only(['title', 'description'])\n\n    # Query product and include only the title and description from category reference\n    @query = @stack.content_type('product').query\n    @query.include_reference('category')\n          .only('category', ['title', 'description'])\n\n @return [Contentstack::Query]", "Updates this working order. No attributes are mandatory, and any attributes not specified will be kept at their\n current values.\n\n @param [Hash] new_attributes The attributes of this working order to update. See\n        {DealingPlatform::WorkingOrderMethods#create} for a description of the attributes.\n @option new_attributes [Time] :good_till_date\n @option new_attributes [Float] :level\n @option new_attributes [Integer] :limit_distance\n @option new_attributes [Float] :limit_level\n @option new_attributes [Integer] :stop_distance\n @option new_attributes [Float] :stop_level\n @option new_attributes [:limit, :stop] :type\n\n @return [String] The deal reference of the update operation. Use {DealingPlatform#deal_confirmation} to check\n         the result of the working order update.", "add found color to @colors", "Apply the layout if it exists\n @api private", "Read from process's memory.\n\n This method has *almost* same arguements and return types as {IO#read}.\n The only difference is this method needs parameter +addr+ (which\n will be passed to paramter +from+ in {IO#read}).\n\n @param [Integer, String] addr\n   The address start to read.\n   When String is given, it will be safe-evaluated.\n   You can use variables such as +'heap'/'stack'/'libc'+ in this parameter.\n   See examples.\n @param [Integer] num_elements\n   Number of elements to read. See {IO#read}.\n\n @return [String, Object, Array<Object>]\n   See {IO#read}.\n\n @example\n   process = MemoryIO.attach(`pidof victim`.to_i)\n   puts process.read('heap', 4, as: :u64).map { |c| '0x%016x' % c }\n   # 0x0000000000000000\n   # 0x0000000000000021\n   # 0x00000000deadbeef\n   # 0x0000000000000000\n   #=> nil\n   process.read('heap+0x10', 4, as: :u8).map { |c| '0x%x' % c }\n   #=> ['0xef', '0xbe', '0xad', '0xde']\n\n   process.read('libc', 4)\n   #=> \"\\x7fELF\"\n @see IO#read", "Write objects at +addr+.\n\n This method has *almost* same arguments as {IO#write}.\n\n @param [Integer, String] addr\n   The address to start to write.\n   See examples.\n @param [Object, Array<Object>] objects\n   Objects to write.\n   If +objects+ is an array, the write procedure will be invoked +objects.size+ times.\n\n @return [void]\n\n @example\n   process = MemoryIO.attach('self')\n   s = 'A' * 16\n   process.write(s.object_id * 2 + 16, 'BBBBCCCC')\n   s\n   #=> 'BBBBCCCCAAAAAAAA'\n @see IO#write", "Returns the path to the `.netrc` file containing the Turbot host's entry\n with the user's email address and API key.\n\n @return [String] the path to the `.netrc` file", "Reads a `.netrc` file.\n\n @return [Netrc] the `.netrc` file", "Saves the user's email address and AP key to the Turbot host's entry in the\n `.netrc` file.", "Seed the database from a downloaded dump.", "Dump the production DB.", "Try to define platform-specific function, rescue error, return message", "Defines CamelCase method calling Win32 API function, and associated API object", "+recursively_find_and_replace_command_substitutions+ is responsible for recursively\n finding and expanding command substitutions, in a depth first manner.", "VISITOR METHODS FOR AST TREE WALKING", "Returns a list of undocumented symbols in the current diff.\n\n Available scopes:\n\n  * `modified`\n  * `all`\n\n @param [Key] scope\n @return [Array of symbol]", "callbacks from Liqpay server", "Returns a hash of all the brokers in the", "Returns a list of consumer groups that are registered against the Kafka cluster.", "Returns a hash of all the topics in the Kafka cluster, indexed by the topic name.", "Creates a topic on the Kafka cluster, with the provided number of partitions and\n replication factor.", "Triggers a preferred leader elections for the provided list of partitions. If no list of\n partitions is provided, the preferred leader will be elected for all partitions in the cluster.", "Recursively creates a node in Zookeeper, by recusrively trying to create its\n parent if it doesn not yet exist.", "Deletes a node and all of its children from Zookeeper.", "Find one valid song from given text.\n @return [Ikku::Song]", "Judge if given text is valid song or not.\n @return [true, false]", "Search all valid songs from given text.\n @return [Array<Array>]", "Returns a list of all partitions that are currently led by this broker.", "Returns a list of all partitions that host a replica on this broker.", "Returns whether this broker is currently considered critical.\n\n A broker is considered critical if it is the only in sync replica\n of any of the partitions it hosts. This means that if this broker\n were to go down, the partition woild become unavailable for writes,\n and may also lose data depending on the configuration and settings.", "returns need bits from the input buffer\n == Format Notes\n bits are stored LSB to MSB", "==Example\n f = File.open \"example.z\"\n i = Inflate.new\n i.inflate f.read", "Calls the pre_render method if it exists and then adds any necessary\n layouts to this convertible document.\n\n payload - The site payload Hash.\n layouts - A Hash of {\"name\" => \"layout\"}.\n\n Returns nothing.", "Allows site hooks to merge data into the site payload\n\n Returns the patched site payload", "Compute euclidien distance.\n\n @param coordinates an array of coord or a Ball instance", "Set up a decoration.\n\n @param [Proc, UnboundMethod, nil] block used for defining a method right away\n @param [String, Symbol] name given to the generated method if block is given\n @yield callback called with method name once method is defined\n @yieldparam [Symbol] method name of the method that is to be decorated", "find images for this thread, specified by starting page_no", "Calls Detekt task of your gradle project.\n It fails if `gradlew` cannot be found inside current directory.\n It fails if `severity` level is not a valid option.\n It fails if `xmlReport` configuration is not set to `true` in your `build.gradle` file.\n @return [void]", "Override winrm to support sspinegotiate option.\n @param [String,URI] endpoint the WinRM webservice endpoint\n @param [Symbol] transport either :kerberos(default)/:ssl/:plaintext\n @param [Hash] opts Misc opts for the various transports.\n   @see WinRM::HTTP::HttpTransport\n   @see WinRM::HTTP::HttpGSSAPI\n   @see WinRM::HTTP::HttpSSL\n Get the builder obj for output request\n @param [String] shell_id The shell id on the remote machine.  See #open_shell\n @param [String] command_id The command id on the remote machine.  See #run_command\n @return [Builder::XmlMarkup] Returns a Builder::XmlMarkup for request message", "Get the Output of the given shell and command\n @param [String] shell_id The shell id on the remote machine.  See #open_shell\n @param [String] command_id The command id on the remote machine.  See #run_command\n @return [Hash] Returns a Hash with a key :exitcode and :data.  Data is an Array of Hashes where the cooresponding key\n   is either :stdout or :stderr.  The reason it is in an Array so so we can get the output in the order it ocurrs on\n   the console.", "An attribute is allowed if it's white listed\n or it's a valid attribute and not black listed\n @param name [Symbol]\n @param user [User] who is performing request", "Returns the parameters for the Turbot API, based on the base URL of the\n Turbot server.\n\n @return [Hash] the parameters for the Turbot API", "Checks if this gateway is able to handle the given device\n @param device [#to_pling_device]\n @return [Boolean]", "alist -> hash", "parse s-expression string and return sexp objects.", "replace special symbols", "Write to stream.\n\n @param [Object, Array<Object>] objects\n   Objects to be written.\n\n @param [Integer] from\n   The position to start to write.\n\n @param [nil, Symbol, Proc] as\n   Decide the method to process writing procedure.\n   See {MemoryIO::Types} for all supported types.\n\n   A +Proc+ is allowed, which should accept +stream+ and one object as arguments.\n\n   If +objects+ is a descendent instance of {Types::Type} and +as+ is +nil,\n   +objects.class+ will be used for +as+.\n   Otherwise, when +as = nil+, this method will simply call +stream.write(objects)+.\n\n @return [void]\n\n @example\n   stream = StringIO.new\n   io = MemoryIO::IO.new(stream)\n   io.write('abcd')\n   stream.string\n   #=> \"abcd\"\n\n   io.write([1, 2, 3, 4], from: 2, as: :u16)\n   stream.string\n   #=> \"ab\\x01\\x00\\x02\\x00\\x03\\x00\\x04\\x00\"\n\n   io.write(['A', 'BB', 'CCC'], from: 0, as: :c_str)\n   stream.string\n   #=> \"A\\x00BB\\x00CCC\\x00\\x00\"\n @example\n   stream = StringIO.new\n   io = MemoryIO::IO.new(stream)\n   io.write(%w[123 4567], as: ->(s, str) { s.write(str.size.chr + str) })\n   stream.string\n   #=> \"\\x03123\\x044567\"\n\n @example\n   stream = StringIO.new\n   io = MemoryIO::IO.new(stream)\n   cpp_string = CPP::String.new('A' * 4, 15, 16)\n   # equivalent to io.write(cpp_string, as: :'cpp/string')\n   io.write(cpp_string)\n   stream.string\n   #=> \"\\x10\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x04\\x00\\x00\\x00\\x00\\x00\\x00\\x00AAAA\\x00\"\n @see Types", "Convert input into snake-case.\n\n This method also converts +'::'+ to +'/'+.\n\n @param [String] str\n   String to be converted.\n\n @return [String]\n   Converted string.\n\n @example\n   Util.underscore('MemoryIO')\n   #=> 'memory_io'\n\n   Util.underscore('MyModule::MyClass')\n   #=> 'my_module/my_class'", "Evaluate string safely.\n\n @param [String] str\n   String to be evaluated.\n @param [{Symbol => Integer}] vars\n   Predefined variables\n\n @return [Integer]\n   Result.\n\n @example\n   Util.safe_eval('heap + 0x10 * pp', heap: 0xde00, pp: 8)\n   #=> 56960 # 0xde80", "Unpack a string into an integer.\n Little endian is used.\n\n @param [String] str\n   String.\n\n @return [Integer]\n   Result.\n\n @example\n   Util.unpack(\"\\xff\")\n   #=> 255\n   Util.unpack(\"@\\xE2\\x01\\x00\")\n   #=> 123456", "Pack an integer into +b+ bytes.\n Little endian is used.\n\n @param [Integer] val\n   The integer to pack.\n   If +val+ contains more than +b+ bytes,\n   only lower +b+ bytes in +val+ will be packed.\n\n @param [Integer] b\n\n @return [String]\n   Packing result with length +b+.\n\n @example\n   Util.pack(0x123, 4)\n   #=> \"\\x23\\x01\\x00\\x00\"", "Retrieve the nearest point from the given coord array.\n\n available keys for options are :root and :limit\n\n Wikipedia tell us (excerpt from url http://en.wikipedia.org/wiki/Kd%5Ftree#Nearest%5Fneighbor%5Fsearch)\n\n Searching for a nearest neighbour in a k-d tree proceeds as follows:\n 1. Starting with the root node, the algorithm moves down the tree recursively,\n    in the same way that it would if the search point were being inserted\n    (i.e. it goes left or right depending on whether the point is less than or\n    greater than the current node in the split dimension).\n 2. Once the algorithm reaches a leaf node, it saves that node point as the \"current best\"\n 3. The algorithm unwinds the recursion of the tree, performing the following steps at each node:\n    1. If the current node is closer than the current best, then it becomes the current best.\n    2. The algorithm checks whether there could be any points on the other side of the splitting\n       plane that are closer to the search point than the current best. In concept, this is done\n       by intersecting the splitting hyperplane with a hypersphere around the search point that\n       has a radius equal to the current nearest distance. Since the hyperplanes are all axis-aligned\n       this is implemented as a simple comparison to see whether the difference between the splitting\n       coordinate of the search point and current node is less than the distance (overall coordinates) from\n       the search point to the current best.\n       1. If the hypersphere crosses the plane, there could be nearer points on the other side of the plane,\n          so the algorithm must move down the other branch of the tree from the current node looking for\n          closer points, following the same recursive process as the entire search.\n       2. If the hypersphere doesn't intersect the splitting plane, then the algorithm continues walking\n          up the tree, and the entire branch on the other side of that node is eliminated.\n 4. When the algorithm finishes this process for the root node, then the search is complete.\n\n Generally the algorithm uses squared distances for comparison to avoid computing square roots. Additionally,\n it can save computation by holding the squared current best distance in a variable for comparison.", "Retrieve the parent to which this coord should belongs to", "Sends command to the TeamSpeak 3 server and returns the response\n\n   command('use', {'sid' => 1}, '-away')", "Translates HTML block\n noinspection RubyArgCount", "Returns language flag", "Returns language name", "Returns language selector UI", "Language Direction Support\n\n switches CSS positions based on the language direction\n <%= tml_style_attribute_tag('float', 'right') %> => \"float: right\" : \"float: left\"\n <%= tml_style_attribute_tag('align', 'right') %> => \"align: right\" : \"align: left\"", "Creates a clone for each item in the collection and yields it for\n transformation along with the corresponding item. The transformed clones\n are inserted after the element to clone.\n @param [Array] collection data that cloned elements should be transformed with\n @yield [Nokogiri::XML::Node] the cloned element\n @yield [Object] an item from the collection", "Creates a clone and yields it to the given block along with the given item.\n @param [Object] item the item to use with the clone\n @yield [Nokogiri::XML:Node] the cloned node\n @yield [Object] the given item\n @return [Nokogiri::XML::Node] the transformed clone", "Replaces the text content of the selected elements.\n\n Markup in the given content is escaped. Use {#html} if you want to\n replace the contents with live markup.\n\n @param [String] selector a CSS or XPath string describing the elements to\n   transform\n @param [String] content the text that should be the new contents\n @example\n   text('h1', 'a title')\n   find('h1').text('a title')\n   text('p', '<b>title</b>') # <p>&lt;b&gt;title&lt;/title&gt;</p>", "Adds or updates the given attribute or attributes of the selected elements.\n\n @param [String] selector a CSS or XPath string describing the elements to\n   transform\n @param [String,Hash] attributes_or_attribute_name if a String, replaces\n   that attribute with the given value. If a Hash, uses the keys as\n   attribute names and values as attribute values\n @param [String] value the value for the replaced attribute. Used only if\n   attributes_or_attribute_name is a String\n @example\n   attr('p', :id => 'an_id', :style => 'display: none')\n   attr('p', :id, 'an_id')\n   find('p').attr(:id, 'an_id')", "Replaces the selected elements with a clone for each item in the\n collection. If multiple elements are selected, only the first element\n will be used for cloning. All selected elements will be removed.\n\n @param [String] selector a CSS or XPath string describing the elements to\n   transform\n @param [Enumerable] collection the items that are the base for each\n   cloned element\n @example\n   titles = %w(one two three)\n   find('.post').replace_each(titles) do |title|\n     text('h1', title)\n   end", "Adds the given class names to the selected elements.\n\n @param [String] selector a CSS or XPath string describing the elements to\n   transform\n @param [String] class_names a CSS class name that should be added\n @example\n   add_class('a#home', 'selected')\n   find('a#home').add_class('selected')", "Removes the given class names from the selected elements.\n\n Ignores class names that are not present.\n\n @param [String] selector a CSS or XPath string describing the elements to\n   transform\n @param [String] class_names a CSS class name that should be removed\n @example\n   remove_class('a#home', 'selected')\n   find('a#home').remove_class('selected')", "Replaces the contents of the selected elements with live markup.\n\n @param [String] selector a CSS or XPath string describing the elements to\n   transform\n @param [String] inner_html the new contents of the selected elements. Markup is\n @example\n   html('p', '<b>Welcome!</b>')\n   find('p').html('<b>Welcome!</b>')", "Adds the given markup to the end of the selected elements.\n\n @param [String] selector a CSS or XPath string describing the elements to\n   which this HTML should be appended\n @param [String] html_to_append the new markup to append to the selected\n   element. Markup is not escaped.", "Selects an element or elements for chained transformation.\n\n If given a block, the selection will be in effect during the block.\n\n If not given a block, a {Selection} will be returned on which\n transformation methods can be called. Any methods called on the\n Selection will be delegated back to the view with the selector inserted\n into the parameter list.\n\n @param [String] selector a CSS or XPath string describing the element to\n   transform\n @return [Selection] a proxy object on which transformation methods can be\n   called\n @example\n   find('.post') do\n     text('h1', post.title)\n     text('p', post.body)\n   end\n   find('h1').text(post.title).add_class('active')", "Clones an element, sets it as the current context, and yields to the\n given block with the given item.\n\n @param [Nokogiri::HTML::Element] the element to clone\n @param [Object] item the item that should be yielded to the block\n @yield [Object] the item passed as item\n @return [Nokogiri::HTML::Element] the clone of the original element", "Helper to be internally invoked by component on activation", "Attempts to match the pattern_element starting at the end of what has already been matched\n If successful, adds the resulting Node to matches.\n returns nil on if pattern_element wasn't matched; non-nil if it was skipped or matched", "a simple \"transaction\" - logs the curent number of matches,\n if the block's result is false, it discards all new matches", "to_canonical_s\n format the address in a postal service canonical format", "Returns all entries in the database as a horizontal Mortadella table", "Returns the given object as a vertical Mortadella table", "Handles a request encoded as JSON.\n Returns the result as a JSON encoded string.", "Handles a deserialized request and returns the result\n\n `req` must either be a Hash (single request), or an Array (batch request)\n\n `handle` returns an Array of results for batch requests, and a single\n Hash for single requests.", "Internal method that validates and executes a single request.", "Internal method invoked by `initialize`.  Iterates through the Contract and\n creates proxy classes for each interface.", "Sends a JSON-RPC request.  This method is automatically called by the proxy classes,\n so in practice you don't usually call it directly.  However, it is available if you\n wish to avoid the use of proxy classes.\n\n * `method` - string of the method to invoke. Format: \"interface.function\".\n              For example: \"ContactService.saveContact\"\n * `params` - parameters to pass to the function. Must be an Array", "Takes the URL to the server endpoint and parses it\n `request` is the only required method on a transport class.\n\n `req` is a JSON-RPC request with `id`, `method`, and optionally `params` slots.\n\n The transport is very simple, and does the following:\n\n * Serialize `req` to JSON. Make sure to use `:ascii_only=true`\n * POST the JSON string to the endpoint, setting the MIME type correctly\n * Deserialize the JSON response string\n * Return the deserialized hash", "Sends the batch of requests to the server.\n\n Returns an Array of RpcResponse instances.  The Array is ordered\n in the order of the requests made to the batch.  Your code needs\n to check each element in the Array for errors.\n\n * Cannot be called more than once\n * Will raise RpcException if the batch is empty", "Takes a JSON-RPC request hash, and returns a 3 element tuple. This is called as\n part of the request validation sequence.\n\n `0` - JSON-RPC response hash representing an error. nil if valid.\n `1` - Interface instance on this Contract that matches `req[\"method\"]`\n `2` - Function instance on the Interface that matches `req[\"method\"]`", "Validates that the parameters on the JSON-RPC request match the types specified for\n this function\n\n Returns a JSON-RPC response hash if invalid, or nil if valid.\n\n * `req` - JSON-RPC request hash\n * `func` - Barrister::Function instance", "Validates that the result from a handler method invocation match the return type\n for this function\n\n Returns a JSON-RPC response hash if invalid, or nil if valid.\n\n * `req` - JSON-RPC request hash\n * `result` - Result object from the handler method call\n * `func` - Barrister::Function instance", "Validates the type for a single value. This method is recursive when validating\n arrays or structs.\n\n Returns a string describing the validation error if invalid, or nil if valid\n\n * `name` - string to prefix onto the validation error\n * `expected` - expected type (hash)\n * `expect_array` - if true, we expect val to be an Array\n * `val` - value to validate", "Recursively resolves all fields for the struct and its ancestors\n\n Returns an Array with all the fields", "Sends a notification to the configured outputs.\n\n @param [Exception] exception The error.\n @param [Hash<Object, Object>] request The request params\n @param [Hash<Object, Object>] environment The environment status.\n @param [Hash<Object, Object>] session The session status.", "Override setter to coerce the given value if a coercion is defined", "Initialize panel from the given window.\n\n This maintains an internal registry of panels created\n for event dispatching purposes\n Render this panel by surfacing it ot hte top of the stack", "Generate a unique id", "Return the value of a parameter, or nil if it doesn't exist.", "Raise an exception if the parameter is not found.", "Raise an exception if the parameter does not respond to a given set of methods.", "Assign a default value to a parameter.", "Check a parameter against a regular expression.", "Check a parameter against a hash of proc's.", "Allow a parameter to default to @name", "This converts a data hash provided by answers, and returns a Puppet\n Enterprise compatible hiera config file ready for use.\n\n @return [String] a string of parseable hocon\n @example Generating an answer file for a series of hosts\n   hosts.each do |host|\n     answers = Beaker::Answers.new(\"2.0\", hosts, \"master\")\n     create_remote_file host, \"/mypath/answer\", answers.answer_hiera\n  end", "Convert a TripIt DateTime Object to a Ruby DateTime Object", "Check if the cache is up to date for the target and if not execute the\n build command. This method does not support parallelization.\n\n @param short_cmd_string [String]\n   Short description of build action to be printed when env.echo ==\n   :short.\n @param target [String] Name of the target file.\n @param command [Array<String>]\n   The command to execute to build the target.\n @param sources [Array<String>] Source file name(s).\n @param env [Environment] The Environment executing the builder.\n @param cache [Cache] The Cache object.\n\n @return [String,false]\n   The name of the target on success or false on failure.", "Invoke window finalization routine by destroying it\n and all children", "Return child containing specified screen coordiantes, else nil", "Erase window drawing area", "Remove Border around window", "Normal getch unless sync enabled in which case,\n timeout will be checked & components synchronized", "Set window color", "Return window dimensions as an array containing rows & cols", "Gets the next unallocated IP, given an IP to start with.", "sanitize! is the method that is called when a model is saved.\n It can be called to manually sanitize attributes.", "Returns the FactoryGirl version of this Creator's attributes", "Adds a provider to the chain. Providers are tried in the order\n they are added, so the order is important.\n\n @param provider [#lookup]\n @param *args the arguments passed to the providers constructor\n @raise [ArgumentError] if an invalid provider is given\n @return [void]", "Tries all providers in the order they were added to provide a response\n for setting.\n\n @param setting [SettingPath,String] nested settings as strings should\n   be separated by a dot\n @param ... further args passed to the provider\n @return [Array,Hash,String,Boolean,nil] whatever the responding\n   provider provides is casted to a {String}, except for some special values", "Specify a build directory for this Environment.\n\n Source files from src_dir will produce object files under obj_dir.\n\n @param src_dir [String, Regexp]\n   Path to the source directory. If a Regexp is given, it will be matched\n   to source file names.\n @param obj_dir [String]\n   Path to the object directory. If a Regexp is given as src_dir, then\n   obj_dir can contain backreferences to groups matched from the source\n   file name.\n\n @return [void]", "Build all build targets specified in the Environment.\n\n When a block is passed to Environment.new, this method is automatically\n called after the block returns.\n\n @return [void]", "Expand a construction variable reference.\n\n @param varref [nil, String, Array, Proc, Symbol, TrueClass, FalseClass] Variable reference to expand.\n @param extra_vars [Hash, VarSet]\n   Extra variables to use in addition to (or replace) the Environment's\n   construction variables when expanding the variable reference.\n\n @return [nil, String, Array, Symbol, TrueClass, FalseClass] Expansion of the variable reference.", "Execute a builder command.\n\n @param short_desc [String] Message to print if the Environment's echo\n   mode is set to :short\n @param command [Array] The command to execute.\n @param options [Hash] Optional options, possible keys:\n   - :env - environment Hash to pass to Kernel#system.\n   - :options - options Hash to pass to Kernel#system.\n\n @return [true,false,nil] Return value from Kernel.system().", "Define a build target.\n\n @param method [Symbol] Method name.\n @param args [Array] Method arguments.\n\n @return [BuildTarget]\n   The {BuildTarget} object registered, if the method called is a\n   {Builder}.", "Manually record a given target as depending on the specified files.\n\n @param target [String,BuildTarget] Target file.\n @param user_deps [Array<String>] Dependency files.\n\n @return [void]", "Build a list of source files into files containing one of the suffixes\n given by suffixes.\n\n This method is used internally by Rscons builders.\n\n @deprecated Use {#register_builds} instead.\n\n @param sources [Array<String>] List of source files to build.\n @param suffixes [Array<String>]\n   List of suffixes to try to convert source files into.\n @param cache [Cache] The Cache.\n @param vars [Hash] Extra variables to pass to the builder.\n\n @return [Array<String>] List of the converted file name(s).", "Find and register builders to build source files into files containing\n one of the suffixes given by suffixes.\n\n This method is used internally by Rscons builders. It should be called\n from the builder's #setup method.\n\n @since 1.10.0\n\n @param target [String]\n   The target that depends on these builds.\n @param sources [Array<String>]\n   List of source file(s) to build.\n @param suffixes [Array<String>]\n   List of suffixes to try to convert source files into.\n @param vars [Hash]\n   Extra variables to pass to the builders.\n @param options [Hash]\n   Extra options.\n @option options [Array<String>] :features\n   Set of features the builder must provide. Each feature can be proceeded\n   by a \"-\" character to indicate that the builder must /not/ provide the\n   given feature.\n   * shared - builder builds a shared object/library\n\n @return [Array<String>]\n   List of the output file name(s).", "Invoke a builder to build the given target based on the given sources.\n\n @param builder [Builder] The Builder to use.\n @param target [String] The target output file.\n @param sources [Array<String>] List of source files.\n @param cache [Cache] The Cache.\n @param vars [Hash] Extra variables to pass to the builder.\n @param options [Hash]\n   @since 1.10.0\n   Options.\n @option options [Boolean] :allow_delayed_execution\n   @since 1.10.0\n   Allow a threaded command to be scheduled but not yet completed before\n   this method returns.\n @option options [Object] :setup_info\n   Arbitrary builder info returned by Builder#setup.\n\n @return [String,false] Return value from the {Builder}'s +run+ method.", "Expand a path to be relative to the Environment's build root.\n\n Paths beginning with \"^/\" are expanded by replacing \"^\" with the\n Environment's build root.\n\n @param path [String, Array<String>]\n   The path(s) to expand.\n\n @return [String, Array<String>]\n   The expanded path(s).", "Execute a command using the system shell.\n\n The shell is automatically determined but can be overridden by the SHELL\n construction variable. If the SHELL construction variable is specified,\n the flag to pass to the shell is automatically dtermined but can be\n overridden by the SHELLFLAG construction variable.\n\n @param command [String] Command to execute.\n\n @return [String] The command's standard output.", "Merge construction variable flags into this Environment's construction\n variables.\n\n This method does the same thing as {#append}, except that Array values in\n +flags+ are appended to the end of Array construction variables instead\n of replacing their contents.\n\n @param flags [Hash]\n   Set of construction variables to merge into the current Environment.\n   This can be the value (or a modified version) returned by\n   {#parse_flags}.\n\n @return [void]", "Print the Environment's construction variables for debugging.", "Print the builder run message, depending on the Environment's echo mode.\n\n @param short_description [String]\n   Builder short description, printed if the echo mode is :short.\n @param command [Array<String>]\n   Builder command, printed if the echo mode is :command.\n\n @return [void]", "Add a build target.\n\n @param target [String] Build target file name.\n @param builder [Builder] The {Builder} to use to build the target.\n @param sources [Array<String>] Source file name(s).\n @param vars [Hash] Construction variable overrides.\n @param args [Object] Deprecated; unused.\n\n @return [void]", "Start a threaded command in a new thread.\n\n @param tc [ThreadedCommand]\n   The ThreadedCommand to start.\n\n @return [void]", "Wait for threaded commands to complete.\n\n @param options [Hash]\n   Options.\n @option options [Set<ThreadedCommand>, Array<ThreadedCommand>] :which\n   Which {ThreadedCommand} objects to wait for. If not specified, this\n   method will wait for any.\n @option options [Boolean] :nonblock\n   Set to true to not block.\n\n @return [ThreadedCommand, nil]\n   The {ThreadedCommand} object that is finished.", "Check if any of the requested threads are finished.\n\n @param threads [Array<Thread>]\n   The threads to check.\n @param nonblock [Boolean]\n   Whether to be non-blocking. If true, nil will be returned if no thread\n   is finished. If false, the method will wait until one of the threads\n   is finished.\n\n @return [Thread, nil]\n   The finished thread, if any.", "Find a builder that meets the requested features and produces a target\n of the requested name.\n\n @param target [String]\n   Target file name.\n @param source [String]\n   Source file name.\n @param features [Array<String>]\n   See {#register_builds}.\n\n @return [Builder, nil]\n   The builder found, if any.", "Determine if a builder meets the requested features.\n\n @param builder [Builder]\n   The builder.\n @param features [Array<String>]\n   See {#register_builds}.\n\n @return [Boolean]\n   Whether the builder meets the requested features.", "The answer value for a provided question.  Use the user answer when\n available, otherwise return the default.\n\n @param [Hash] options options for answer file\n @option options [Symbol] :answers Contains a hash of user provided\n   question name and answer value pairs.\n @param [String] default Should there be no user value for the provided\n   question name return this default\n @return [String] The answer value", "Writes out a knife.rb based on the settings in this configuration. Uses the\n `knife_config_path` and `chef_config_path` to determine where to write it.", "upload a single attachment and return the data for the note_attachments\n returns nil and provides an error in case the attachment upload failed", "upload the file directly to ITRP", "sanitize_attributes is used to define sanitizable attributes within a model definition.", "Returns a cached reference to a variable or searches all\n surrounding scopes for a variable. If no variable is found,\n it returns nil and a nested scope will create the variable\n in itself.", "nicely formats the amount and currency", "Encapsulates window operation in color pair attribute", "Schedule a group of VMs for provision. This takes a group name, which is a\n string, an array of provisioner objects, and a list of string dependencies.\n If anything in the dependencies list hasn't been pre-declared, it refuses\n to continue.\n\n This method will return nil if the server group is already provisioned.", "Sleep until this list of dependencies are resolved. In parallel mode, will\n raise if an exeception occurred while waiting for these resources. In\n serial mode, wait_for just returns nil.", "Helper method for scheduling. Wraps items in a timeout and immediately\n checks all running workers for exceptions, which are immediately bubbled up\n if there are any. If do_loop is true, it will retry the timeout.", "This method determines what 'waiters', or provisioners that cannot\n provision yet because of unresolved dependencies, can be executed.", "Return layout containing component\n If coordinates are contained in a child in current layout", "Return boolean indicating if layout contains specified child", "Create new child window and add it to layout", "Select elements using a predicate block.\n\n @return [Enumerable] the elements that pass the predicate\n\n @see ::Enumerable#select", "Remove duplicate values.\n\n @return [Enumerable] elements which have not been previously encountered\n @overload uniq\n\n @overload uniq(&block)\n\n @see ::Enumerable#uniq", "Select the first n elements.\n\n @param n [Integer] the number of elements to take\n @return [Enumerable] the first N elements\n\n @see ::Enumerable#take", "Select elements while a predicate returns true.\n\n @return [Enumerable] all elements before the first that fails the predicate\n\n @see ::Enumerable#take_while", "Ignore the first n elements.\n\n @param n [Integer] the number of elements to drop\n @return [Enumerable] elements after the first N\n\n @see ::Enumerable#drop", "Reject elements while a predicate returns true.\n\n @return [Enumerable] all elements including and after the first that fails the predicate\n\n @see ::Enumerable#drop_while", "Select elements matching a pattern.\n\n @return [Enumerable] elements for which the pattern matches\n\n @see ::Enumerable#grep", "Flatten the collection, such that Enumerable elements are included inline.\n\n @return [Enumerable] elements of elements of the collection\n\n @see ::Array#flatten", "Ignore nil values.\n\n @return [Enumerable] the elements that are not nil\n\n @see ::Array#compact", "Helper to be internally invoked by navigation component\n on activation", "Internal helper, logic invoked when a component gains focus", "Internal helper, navigate to selected component under current", "Errors raised here identify the class_name that is not implementing or is\n implemented with the wrong arity required by the Interface.", "Transform symbol arguments to a hash of nil arity", "Makes a get-request to apilayer's service", "Download sites_urls from response.\n\n @param [Hash] response  Response returned by #automate.\n\n @return [Array] HTML bodies from sites_urls.", "Perform an HTTP request to the Infosimples Data API.\n\n @param [String] service  API method name.\n @param [Symbol] method   HTTP method (:get, :post, :multipart).\n @param [Hash]   payload  Data to be sent through the HTTP request.\n\n @return [Hash] Parsed JSON from the API response.", "the country the source is registered in", "Each line of input is parsed.\n If parser fails, output explaination of why.\n If parser succeeds, evaluate parse_tree_node, &block", "Sets the variables to the selected stage using cap rbenv set", "build a list of variables from ENV_FILE and yeilds it", "Returns a hash of selected variables and values", "Create a VarSet.\n\n @param vars [Hash] Optional initial variables.\n Access the value of variable.\n\n @param key [String, Symbol] The variable name.\n\n @return [Object] The variable's value.", "Check if the VarSet contains a variable.\n\n @param key [String, Symbol] The variable name.\n\n @return [Boolean] Whether the VarSet contains the variable.", "Add or overwrite a set of variables.\n\n @param values [VarSet, Hash] New set of variables.\n\n @return [VarSet] Returns self.", "Create a new VarSet object based on the first merged with other.\n\n @param other [VarSet, Hash] Other variables to add or overwrite.\n\n @return [VarSet] The newly created VarSet.", "Return a Hash containing all variables in the VarSet.\n\n @since 1.8.0\n\n This method is not terribly efficient. It is intended to be used only by\n debugging code to dump out a VarSet's variables.\n\n @return [Hash] All variables in the VarSet.", "Create a deep copy of an object.\n\n Only objects which are of type String, Array, or Hash are deep copied.\n Any other object just has its referenced copied.\n\n @param obj [Object] Object to deep copy.\n\n @return [Object] Deep copied value.", "upload a CSV file to import\n @param csv: The CSV File or the location of the CSV file\n @param type: The type, e.g. person, organization, people_contact_details\n @raise Itrp::UploadFailed in case the file could was not accepted by ITRP and +block_until_completed+ is +true+\n @raise Itrp::Exception in case the import progress could not be monitored", "Export CSV files\n @param types: The types to export, e.g. person, organization, people_contact_details\n @param from: Retrieve all files since a given data and time\n @param block_until_completed: Set to true to monitor the export progress\n @param locale: Required for translations export\n @raise Itrp::Exception in case the export progress could not be monitored", "Expand the given header with the default header", "Parameter value typecasting", "Return completely initialized CDK component", "Invoke CDK activation routine", "Override bind_key to use cdk bindings mechanism", "Ask the application name", "Get git remotes from current git and ask to select one", "convert the pattern into a set of lamba functions", "returns a Node object if it matches, nil otherwise", "Write the cache to disk.\n\n @return [void]", "Make any needed directories and record the ones that are created for\n removal upon a \"clean\" operation.\n\n @param path [String] Directory to create.\n\n @return [void]", "Calculate and return a file's checksum.\n\n @param file [String] The file name.\n\n @return [String] The file's checksum.", "Loads the contents of a file within the context of the current object\n\n @param [#to_s] filename\n   path to the file to load\n\n @raise [IOError] if the file does not exist or cannot be read", "Loads the contents of a file within the context of the current object's class\n\n @param [#to_s] filename\n   path to the file to load\n\n @raise [IOError] if the file does not exist or cannot be read", "attempt to match the pattern defined in self.parser in parent_node.src starting at offset parent_node.next", "initialize PatternElement as a parser that matches a named sub-rule", "initialize the PatternElement from hashed parameters", "return temp file for each chunk", "run a command against a group of servers. These commands are run in\n parallel, but the command itself does not complete until all the threads\n have finished running.", "Run a command against a single IP. Returns the exit status.", "run a command, and instead of capturing the exit status, return the data\n captured during the command run.", "Creates a security group and saves it to the security_group_setting_path.", "Ensures security groups exist.\n\n If @security_groups is :auto, creates one and sets it up with the\n security_group_open_ports on TCP and UDP.\n\n If @security_groups is an array of group names or a single group name,\n asserts they exist. If they do not exist, it raises.", "The JSON value, if single resource is queried this is a Hash, if multiple resources where queried it is an Array\n If the response is not +valid?+ it is a Hash with 'message' and optionally 'errors'", "retrieve a value from the resource\n if the JSON value is an Array a array with the value for each resource will be given\n @param keys: a single key or a key-path separated by comma", "Configuration API\n Specifies behavior to run for specific connections based on the id number\n assigned to that connection. Connection ids are 1-based.\n\n The selector can be any of the following:\n   Number - Run the code on that connection id\n   Range - Run the code for a connection id in that range\n   Proc - Call the proc with the id and run if it matches\n   '*' - Run this code for any connection that doesn't match others", "Not really part of the public API but users could use this to\n implement their own fancy command", "Creates a new record with the given attributes in the database", "Get the next job that is ready to run from the JobSet.\n\n This method will remove the job from the JobSet.\n\n @param targets_still_building [Array<String>]\n   Targets that are not finished building. This is used to avoid returning\n   a job as available to run if it depends on one of the targets that are\n   still building as a source.\n\n @return [nil, Hash]\n   The next job to run.", "Ask the stage name", "Conditionally executes based on the level of debugging requested.\n\n `CHEF_WORKFLOW_DEBUG` in the environment is converted to an integer. This\n integer is compared to the first argument. If it is higher than the first\n argument, the block supplied will execute.\n\n Optionally, if there is a `else_block`, this block will be executed if the\n condition is *not* met. This allows a slightly more elegant (if less ugly)\n variant of dealing with the situation where if debugging is on, do one\n thing, and if not, do something else.\n\n Examples:\n\n     if_debug(1) do\n       $stderr.puts \"Here's a debug message\"\n     end\n\n This will print \"here's a debug message\" to standard error if debugging is\n set to 1 or greater.\n\n     do_thing = lambda { run_thing }\n     if_debug(2, &do_thing) do\n       $stderr.puts \"Doing this thing\"\n       do_thing.call\n     end\n\n If debugging is set to 2 or higher, \"Doing this thing\" will be printed to\n standard error and then `run_thing` will be executed. If lower than 2 or\n off, will just execute `run_thing`.", "return nil if no addional data is available", "Check if attributes are valid, and raise an exception if they're not.\n\n @raise {MissingRequiredAttributeError} if an attribute that is\n   required was not provided.\n @raise {UnacceptableAttributeError} if a non-whitelisted attribute\n   was provided.\n @return [true] if the attribute are all valid, and all required\n   attributes are provided.", "Render the element.\n\n Pays attention to the formatter type, doctype, pretty print options,\n etc. See {Element#render} for options.", "html-escape a string, paying attention to indentation too.", "Render the opening tag.\n\n Considers:\n  - attributes\n  - XHTML or HTML?\n  - are there any children?\n\n #render_close_tag assumes that this will not leave a tag open in XHTML\n unless there are children.", "Iterate over all the children, calling render.", "Fill default render options.\n\n These are as defined for {#render}, with the addition of a\n +:depth+ value of 0. Other values aren't guaranteed to stay fixed,\n check source for current values.", "Normalize the children.\n\n For example, turn +['foo', 'bar']+ into +['foobar']+.\n\n This is needed to stop things like pretty printing adding extra\n whitespace between the two strings.", "You don't want to implement this function in your subclasses -\n just reimplement compose instead.\n\n This calls compose, provides the 'yield' magic, and callls render on\n the output.", "channel type dispatch", "Check your account usage for a given period and timeframe\n\n @param period [String] (Optional) Period is one of either hourly, daily or monthly\n @param start_time [Integer] (Optional) Unix timestamp of the start of the period\n   you are querying\n @param end_time [Integer] (Optional) Unix timestamp of the end of the period\n   you are querying\n @return [Object] API reponse object", "Returns the specified ole object for input elements on a web page.\n\n This method is used internally by Watir and should not be used externally. It cannot be marked as private because of the way mixins and inheritance work in watir\n\n   * how - symbol - the way we look for the object. Supported values are\n                  - :name\n                  - :id\n                  - :index\n                  - :value etc\n   * what  - string that we are looking for, ex. the name, or id tag attribute or index of the object we are looking for.\n   * types - what object types we will look at.\n   * value - used for objects that have one name, but many values. ex. radio lists and checkboxes", "Click a button with caption\n\n TODO: Caption is same as value\n\n Usage:\n   click_button_with_caption(\"Confirm payment\")", "submit first submit button", "Submits a watch action request.\n @param (see #watch)\n @param unwatch [Boolean] Whether the request should unwatch the pages or not.\n @return (see #watch)", "try operation, ignore if errors occur\n\n Example:\n   failsafe { click_link(\"Logout\") }  # try logout, but it still OK if not being able to (already logout))", "Return a random string in a rangeof pre-defined strings", "If an array or range is passed, a random value will be selected to match.\n All other values are simply returned.", "Data Driven Tests\n\n  Processing each row in a CSV file, must have heading rows\n\n  Usage:\n\n   process_each_row_in_csv_file(@csv_file) { |row|\n     goto_page(\"/\")\n     enter_text(\"username\", row[1])\n     enter_text(\"password\", row[2])\n     click_button(\"Sign in\")\n     page_text.should contain(row[3])\n     failsafe{ click_link(\"Sign off\") }\n   }", "returns list of top crashes for the given build", "Attach to existing browser window\n\n  attach_browser(:title, \"Page\" )\n  attach_browser(:url, \"http://wwww...\" )", "for text field can be easier to be identified by attribute \"id\" instead of \"name\", not recommended though\n\n params opts takes :appending => true or false, if true, won't clear the text field.", "Return page HTML with absolute references of images, stylesheets and javascripts", "absolutize_page using hpricot", "Wait the element with given id to be present in web page\n\n Warning: this not working in Firefox, try use wait_util or try instead", "Clear popup windows such as 'Security Alert' or 'Security Information' popup window,\n\n Screenshot see http://kb2.adobe.com/cps/165/tn_16588.html\n\n You can  also by pass security alerts by change IE setting, http://kb.iu.edu/data/amuj.html\n\n Example\n   clear_popup(\"Security Information\", 5, true) # check for Security Information for 5 seconds, click Yes", "Use AutoIT3 to send password\n title starts with \"Connect to ...\"", "Initialize presenter with the current controller", "Creates a new Identity Token\n\n @param identity_id [String] ID of the Identity for which you are creating\n   a token\n @param service [String] The service this token will be used to access. For\n   example; 'facebook'\n @param token [String] The token provided by the PYLON data provider\n @return [Object] API reponse object", "Returns a list of Tokens for a given Identity\n\n @param identity_id [String] ID of the Identity we are fetching Tokens for\n @param per_page [Integer] (Optional) How many Tokens should be returned\n   per page of results\n @param page [Integer] (Optional) Which page of results to return\n @return [Object] API reponse object", "collect the XML representation for the pack using an XMLMarkup object", "The ArchiveTask class delegates this method\n so we can create the archive.\n the file_map is the result of the computations of the include and exclude filters.", "eg. first_image(@product)", "humanizing various things", "Returns the mean squared error of the forecast.", "Add resources to a Managed Source\n\n @param id [String] ID of the Managed Source you are adding resources to\n @param resources [Array] Array of resources you are adding to your source\n @param validate [Boolean] Whether you want to validate your new resources\n   against the third party API (i.e. the Facebook or Instagram API)", "Remove resources from a Managed Source\n\n @param id [String] ID of the Managed Source you are removing resources\n   from\n @param resource_ids [Array] Array of resource_id strings you need to\n   remove from your source", "Add auth tokens to a Managed Source\n\n @param id [String] ID of the Managed Source you are adding Auth tokens to\n @param auth [Array] Array of auth tokens you are adding to your source\n @param validate [Boolean] Whether you want to validate your new tokens\n   against the third party API (i.e. the Facebook or Instagram API)", "Remove auth tokens from a Managed Source\n\n @param id [String] ID of the Managed Source you are removing auth tokens\n   from\n @param auth_ids [Array] Array of auth_id strings you need to remove from\n   your source", "Logs the user into the wiki. This is generally required for editing and getting restricted data.\n @param username [String] The username\n @param password [String] The password\n @see https://www.mediawiki.org/wiki/API:Login MediaWiki Login API Docs\n @since 0.1.0\n @raise [AuthenticationError]\n @return [Boolean] True if the login was successful.", "Creates an account using the standard procedure.\n @param username [String] The desired username.\n @param password [String] The desired password.\n @param language [String] The language code to be set as default for the account. Defaults to 'en', or English.\n Use the language code, not the name.\n @param reason [String] The reason for creating the account, as shown in the account creation log. Optional.\n @see #check_create\n @see https://www.mediawiki.org/wiki/API:Account_creation MediaWiki Account Creation Docs\n @since 0.1.0\n @return [Boolean] True if successful, false if not.", "Creates an account using the random password sent by email procedure.\n @param email [String] The desired email address\n @param (see #create_account)\n @see #check_create\n @see https://www.mediawiki.org/wiki/API:Account_creation MediaWiki Account Creation Docs\n @since 0.1.0\n @return [Boolean] True if successful, false if not.", "For current page souce to a file in specified folder for inspection\n\n   save_current_page(:dir => \"C:\\\\mysite\", filename => \"abc\", :replacement => true)", "= Convenient functions\n\n Execute the provided block until either (1) it returns true, or\n (2) the timeout (in seconds) has been reached. If the timeout is reached,\n a TimeOutException will be raised. The block will always\n execute at least once.\n\n This does not handle error, if the given block raise error, the statement finish with error\n Examples:\n   wait_until {puts 'hello'}\n   wait_until { div(:id, :receipt_date).exists? }", "Blocks the user.\n @param (see #unblock)\n @param expiry [String] The expiry timestamp using a relative expiry time.\n @param nocreate [Boolean] Whether to allow them to create an account.\n @see https://www.mediawiki.org/wiki/API:Block MediaWiki Block API Docs\n @since 0.5.0\n @raise [BlockError]\n @return (see #unblock)", "Unblocks the user.\n @param user [String] The user affected.\n @param reason [String] The reason to show in the block log.\n @see https://www.mediawiki.org/wiki/API:Block MediaWiki Block API Docs\n @since 0.5.0\n @raise [BlockError]\n @return [Fixnum] The block ID.", "Pare one DS segment", "Merges a DS header hash into each measurement\n @return [Array] Measurements with header and static metadata merged in", "Creates a Limit for an Identity\n\n @param identity_id [String] ID of the Identity for which you are creating\n   a limit\n @param service [String] The service this limit will apply to. For example;\n   'facebook'\n @param total_allowance [Integer] (Optional) The daily interaction limit for this Identity\n @param analyze_queries [Integer] (Optional) The hourly analysis query limit for this Identity\n @return [Object] API reponse object", "Get the Limit for a given Identity and Service\n\n @param identity_id [String] ID of the Identity you wish to return limits\n   for\n @param service [String] Name of the service you are retreiving limits for\n @return [Object] API reponse object", "Returns a list Identities and their Limits for a given Service\n\n @param service [String] ID of the Identity we are fetching Limits for\n @param per_page [Integer] (Optional) How many Identities and Limits should\n   be returned per page of results\n @param page [Integer] (Optional) Which page of results to return\n @return [Object] API reponse object", "Removes a Service Limit for an Identity\n\n @param identity_id [String] ID of the Identity for which you wish to\n   remove the Limit\n @param service [String] Service from which you wish to remove the Limit\n @return [Object] API response object", "Create a new generator, specifying the family name to use, and the\n raw YAML input.\n Generate an ECS task definition as a raw Ruby hash.", "Parse a Docker-style `mem_limit` and convert to megabytes.", "Parse a Docker-style port mapping and convert to ECS format.", "Construction can throw ArgumentError, but does no parsing or type-conversion\n Returns a copy of the VersionCluster with the integer at the provided index incremented by one.\n Raises a TypeError if the value at that index is not an integer.", "Returns a copy of the VersionCluster with the integer at the provided index decremented by one.\n Raises a TypeError if the value at that index is not an integer.\n Raises a RangeError if the value is zero or less", "a & b must have the same length", "Creates a new managed source\n\n @param source_type [String] Type of Managed Source you are creating. e.g.\n   facebook_page, instagram, etc\n @param name [String] Name of this Managed Source\n @param parameters [Hash] Source-specific configuration parameters\n @param resources [Array] Array of source-specific resources\n @param auth [Array] Array of source-specific auth credentials", "Update a Managed Source\n\n @param id [String] ID of the Managed Source you are updating\n @param source_type [String] Type of Managed Source you are updating\n @param name [String] Name (or new name) of the Managed Source\n @param parameters [Hash] Source-specific configuration parameters\n @param resources [Array] Array of source-specific resources\n @param auth [Array] Array of source-specific auth credentials", "Retrieve details of a Managed Source\n\n @param id [String] ID of the Managed Source you are getting. Omitting the\n   ID will return a list of Managed Sources\n @param source_type [String] Limits the list of Managed Sources returned to\n   only sources of a specific source type if specified\n @param page [Integer] Number of Managed Sources to return on one page of\n   results\n @param per_page [Integer] Number of Managed Sources to return per page", "Retrieve log details of Managed Sources\n\n @param id [String] ID of the Managed Source for which you are collecting\n   logs\n @param page [Integer] Number of Managed Source logs to return on one page\n   of results\n @param per_page [Integer] Number of Managed Source logs to return per page", "Parse the source lessfile and write to target cssfile", "Query the tag hierarchy on interactions populated by a particular\n   recording\n\n @param hash [String] Hash of the recording you wish to query\n @param id [String] ID of the recording you wish to query\n @param service [String] The PYLON service to make this API call against\n @return [Object] API reponse object", "Hit the PYLON Sample endpoint to pull public sample data from a PYLON recording\n\n @param hash [String] The CSDL hash that identifies the recording you want to sample\n @param count [Integer] Optional number of public interactions you wish to receive\n @param start_time [Integer] Optional start timestamp for filtering by date\n @param end_time [Integer] Optional end timestamp for filtering by date\n @param filter [String] Optional PYLON CSDL for a query filter\n @param id [String] ID of the recording you wish to sample\n @param service [String] The PYLON service to make this API call against\n @return [Object] API reponse object", "Hit the PYLON Reference endpoint to expose reference data sets\n\n @param service [String] The PYLON service to make this API call against\n @param slug [String] Optional slug of the reference data set you would like to explore\n **opts\n @param per_page [Integer] (Optional) How many data sets should be returned per page of results\n @param page [Integer] (Optional) Which page of results to return", "Returns the errors between the observed values and the one step\n ahead forecasts.", "default tenon action link", "extention of action_link for boolean toggles", "default tenon edit link", "default tenon delete link", "Build and call @operation, set @response, @request, and @xml\n @raise on faults\n @return [Hash]", "This is proof-of-concept quality code.\n @todo Need to extract boundary and start markers from Content-Type header:\n Content-Type: multipart/related; type=\"application/xop+xml\"; boundary=\"uuid:14b8db9f-a393-4786-be3f-f0f7b12e14a2\"; start=\"<root.message@cxf.apache.org>\"; start-info=\"application/soap+xml\"\n @return [String]", "Return 1C ole client suitable class instance\n @param type [Symbol] type of 1C ole client.\n  See {Enterprise::Ole::OLE_CLIENT_TYPES}\n @param requiremet [String, Gem::Version::Requirement] require version spec\n @raise [ArgumentError] if invalid +type+ given", "Check for \"Security Information\" and \"Security Alert\" alert popup, click 'Yes'\n\n Usage: For individual test suite\n\n before(:all) do\n  $popup = Thread.new { check_for_alerts }\n  open_in_browser\n  ...\n end\n\n after(:all) do\n   close_browser\n   Thread.kill($popup)\n end\n\n or for all tests,\n  $popup = Thread.new { check_for_alerts }\n  at_exit{ Thread.kill($popup) }", "Start a background process to click the button on a javascript popup window", "Performs a Mediawiki API query and provides the response, dealing with continuation as necessary.\n @param params [Hash] A hash containing MediaWiki API parameters.\n @param base_return [Any] The return value to start with. Defaults to an empty array.\n @yield [base_return, query] Provides the value provided to the base_return parameter, and the value in the\n   'query' key in the API response. See the API documentation for more information on this. If the base_return\n   value is modified in the block, its modifications will persist across each continuation loop.\n @return [Any] The base_return value as modified by the yielded block.", "Helper method for query methods that return a two-dimensional hashes in which the keys are not relevant to the\n   returning value. In most cases this key is a redundant page or revision ID that is also available in the object.\n @param (see #query_ary)", "Helper method for query methods that return an array built from the query objects.\n @param params [Hash] A hash containing MediaWiki API parameters.\n @param base_response_key [String] The key inside the \"query\" object to collect.\n @param property_key [String] The key inside the object (under the base_response_key) to collect.", "Gets the limited version of the integer, to ensure nobody provides an int that is too large.\n @param integer [Fixnum] The number to limit.\n @param max_user [Fixnum] The maximum limit for normal users.\n @param max_bot [Fixnum] The maximum limit for bot users.\n @since 0.8.0\n @return [Fixnum] The capped number.", "The list of ancestors is very long.\n Trim it down to just the length of the class we are looking for.\n\n Takes an optional block method to transform the result\n with a map operation", "Sets callback that handles rate limit exceeding. Additionally to\n described options supports all the `before_action` options.\n\n @example Renders text with time left in case of rate limit exceeding.\n   rate_limit limit: 100, per: 1.hour, only: :index do |info|\n     render plain: \"Next request can be done in #{info.time_left} seconds\",\n            status: :too_many_requests\n   end\n\n @param [Hash] options\n @option options [Symbol] :strategy Rate limiting strategy.\n   Default value is :sliding_window_log\n @option options [Fixnum, Lambda, Proc] :limit The number of allowed\n   requests per time period. Default value is 100\n @option options [Fixnum, Lambda, Proc] :per Time period in seconds.\n   Default value is 1.hour\n @option options [Lambda, Proc] :pattern Can be used if you want to use\n   something instead of IP as cache key identifier. For example\n   `-> { current_user.id }`. Default value is `request.remote_ip`\n @option options [Object] :cient Redis client.\n   Uses `Redis.new` if not specified\n\n @yield [info] Executed if rate limit exceded. This argument is mandatory.\n @yieldparam [RailsRateLimiter::Result] Represent information about\n   rate limiting", "Prepare a new Historics query\n\n @param hash [String] Hash of compiled CSDL filter\n @param start [Integer] Start timestamp for your Historics Query. Should be\n   provided as a Unix timestamp\n @param end_time [Integer] End timestamp for your Historics Query. Should\n   be provided as a Unix timestamp\n @param name [String] The name of your Historics query\n @param sources [String] Comma separated list of data sources you wish to\n   query\n @param sample [Integer] Sample size of your Historics query\n @return [Object] API reponse object", "Pause Historics query\n\n @param id [String] ID of the Historics query you need to pause\n @param reason [String] You can give a reason for pausing the query", "Stop Historics query\n\n @param id [String] ID of the Historics query you need to stop\n @param reason [String] You can give a reason for stopping the query", "Check the data coverage in the archive for a specified interval\n\n @param start [Integer] Start timestamp for the period you wish to query.\n   Should be provided as a Unix timestamp\n @param end_time [Integer] End timestamp for the period you wish to query.\n   Should be provided as a Unix timestamp\n @param sources [String] Comma separated list of data sources you wish to\n   query", "Update the name of an Historics query\n\n @param id [String] ID of the Historics query you need to update\n @param name [String] New name for the Historics query", "Get details for a given Historics query\n\n @param id [String] ID of the Historics query you need to get\n @param with_estimate [Boolean] 1 or 0 indicating whether you want to see\n   the estimated completion time of the Historics query", "Get details for a list of Historics within the given page constraints\n\n @param max [Integer] Max number of Historics you wish to return per page\n @param page [Integer] Which page of results you need returned\n @param with_estimate [Boolean] 1 or 0 indicating whether you want to see\n   the estimated completion time of the Historics query", "witness program\n Returns segwit script pubkey which generated from witness version and witness program.", "parse script pubkey into witness version and witness program", "Add new work item to issue\n\n issue_id   string  youtrack ticket id\n attributes    hash\n      user         string  login name of the user who will be set as the author of the work item. (defaults to logged in user)\n      date         string  date and time of the new work item in ISO8601 time format (defaults to current date)\n      duration     string  Duration of the work item in minutes\n      description  string  Activity description", "Takes the array of setlist items and create SetLists", "Receive an EPP frame from the server. Since the connection is blocking,\n this method will wait until the connection becomes available for use. If\n the connection is broken, a SocketError will be raised. Otherwise,\n it will return a string containing the XML from the server.", "Sends a standard login request to the EPP server.", "Sends a standard logout request to the EPP server.", "Find category by name", "Find forum by name, knowing the category name", "Given a category name, find a forum by name. Create the category and forum either doesn't exist.", "Find topic by name, knowing the forum name and category name", "Create a forum in the given category id", "Create a topic in the given forum id", "Returns the actual image_tag", "own assert method", "Assert a link containing specified text in the page\n\n  <a href=\"\">Click Me</a>\n  assert_link_present_with_text(\"Click \") # =>", "radio\n radio_group is the name field, radio options 'value' field", "Construct a new JedisRb Pool.\n\n Possible options are:\n   * config - (redis.clients.jedis.JedisPoolConfig/Wrapped::PoolConfig) the pool configuration\n   * host - (String) Redis host\n   * port - (Integer) Redis port\n   * connection_timeout - (Integer) the connection timeout in milliseconds\n   * password - (String) Redis password\n   * database - (Integer) Redis database\n   * client_name (String) the client name\n   * convert_objects (Boolean) Ruby object casting\n\n By passing in convert_objects: true, Pool can convert return values to\n their Ruby type equivalent. Currently, the following are supported:\n   * java.util.Set => Set\n   * java.util.Map => Hash\n   * java.util.List => Array\n\n Depending on your use case, this conversion may be costly, so it is not\n the default. Please evaluate your application's requirements carefully\n before opting in.\n Lease a connection from the pool and yield it to the given block.\n\n Leased connections will be automatically returned to the pool upon successful\n or unsuccessful execution of the block.\n\n Connections are of type redis.clients.jedis.Jedis.\n See the documentation[https://github.com/xetorthio/jedis/wiki] for more details.", "Convert Java return values to their ruby equivalents.", "Create a new Historics Preview\n\n @param hash [String] Hash of compiled CSDL definition\n @param sources [String] Comma separated list of data sources you wish to\n   perform this Historics Preview against\n @param parameters [String] Historics Preview parameters. See our\n   {http://dev.datasift.com/docs/api/1/previewcreate /preview/create API\n   Docs} for full documentation\n @param start [String] Start timestamp for your Historics Preview. Should\n   be provided as Unix timestamp\n @param end_time [String] End timestamp for your Historics Preview. Should\n   be provided as Unix timestamp", "Makes a login call and sets the Cookie headers\n\n Returns the status code of the connection call", "Prefix with an underscore to use base Asset styles", "Logs a step to the registered Hero.logger.\n @note Users info for the log level.\n @param [Symbol, String] id The identifier for the step. [:before, :after]\n @param [Object] step\n @param [Object] context\n @param [Object] options", "Creates a Task; this call requires use of an identity API key\n\n @param service [String] Service you wish to create a Task for\n @param type [String] Type of Task to be run\n @param subscription_id [String] Subscription ID as returned by /pylon/start\n @param name [String] Human identifier for this Task\n @param parameters [Hash] Object representing the parameters for the Task type\n @return [Object] API reponse object", "Gets a list of all current Tasks on the service. This call may be accessed using either a\n   main or identity-level API key.\n\n @param service [String] Search Tasks by Service\n @param type [String] (Optional) Type of Task to be run (Default: 'analysis')\n @param per_page [Integer] (Optional) How many Tasks should be returned per page of results\n @param page [Integer] (Optional) Which page of results to return\n @param status [String] (Optional) Filter by Tasks on Status\n @return [Object] API reponse object", "Register this task definition with ECS, and update the corresponding\n service.", "Set the number of running copies of a service we want to have.", "Run this task definition as a one-shot ECS task, with the specified\n overrides.", "Generates Javascript code from a HandlebarsJS template.\n The SC template name is derived from the lowercase logical asset path\n by replacing non-alphanum characheters by underscores.", "Returns a moving average for this array, given either a number\n of terms or a list of weights.\n\n See MovingAverage for more detail.", "Creates a new MovingAverage given a list of weights.\n\n See also the class methods simple and weighted.\n Calculates the moving average for the given array of numbers.\n\n Moving averages won't include values for terms at the beginning or end of\n the array, so there will be fewer numbers than in the original.", "Error checking for weights", "Sends a purge API request, and handles the return value and warnings.\n @param params [Hash<Object, Object>] The parameter hash to begin with. Cannot include the titles or action keys.\n @param (see #purge)\n @return (see #purge)\n @see (see #purge)\n @note (see #purge)", "def options\n Reset all config options to their defaults", "Checks if the syntax of the given CSDL is valid\n\n @param boolResponse [Boolean] If true a boolean is returned indicating\n whether the CSDL is valid, otherwise the full response object is returned", "Calculate the DPU cost of running a filter, or Historics query\n\n @param hash [String] CSDL hash for which you wish to find the DPU cost\n @param historics_id [String] ID of Historics query for which you wish to\n   find the DPU cost\n @return [Object] API reponse object", "Triggers Synx on all projects that were modified or added\n to the project. Returns accumulated list of issues\n for those projects.\n\n @return [Array<(String, String)>]", "Validate the token", "Calculate the SHA-1 of an array of big-endian words, and a bit length", "Perform the appropriate triplet combination function for the current\n iteration", "Calculate the HMAC-SHA1 of a key and some data", "Convert an 8-bit or 16-bit string to an array of big-endian words\n In 8-bit function, characters >255 have their hi-byte silently ignored.", "Convert an array of big-endian words to a base-64 string", "Creates a new Identity\n\n @param label [String] A unique identifier for this Identity\n @param status [String] (Optional, Default: \"active\") What status this\n   Identity currently has. Possible values are 'active' and 'disabled'\n @param master [Boolean] (Optional, Default: false) Whether this is the\n   master Identity for your account\n @return [Object] API reponse object", "Returns a list of Identities\n\n @param label [String] (Optional) Search by a given Identity label\n @param per_page [Integer] (Optional) How many Identities should be\n   returned per page of results\n @param page [Integer] (Optional) Which page of results to return\n @return [Object] API reponse object", "Definition can be either a name, array, or hash.", "Google books search", "Google books filtration", "Check that a Push subscription definition is valid\n\n @param params [Hash] Hash of Push subscription parameters\n @param bool_response [Boolean] True if you want a boolean response. False\n   if you want the full response object", "Retrieve log messages for a specific subscription\n\n @param id [String] ID of the Push subscription to retrieve logs for\n @param page [Integer] Which page of logs to retreive\n @param per_page [Integer] How many logs to return per page\n @param order_by [String, Symbol] Which field to sort results by\n @param order_dir [String, Symbol] Order results in ascending or descending", "Retrieve log messages for all subscriptions\n\n @param page [Integer] Which page of logs to retreive\n @param per_page [Integer] How many logs to return per page\n @param order_by [String, Symbol] Which field to sort results by\n @param order_dir [String, Symbol] Order results in ascending or descending", "Get details of the subscription with the given filter hash\n\n @param hash [String] CSDL filter hash\n @param page [Integer] Which page of logs to retreive\n @param per_page [Integer] How many logs to return per page\n @param order_by [String, Symbol] Which field to sort results by\n @param order_dir [String, Symbol] Order results in ascending or descending\n @param include_finished [Integer] Include Push subscriptions in a\n   'finished' state in your results\n @param all [Boolean] Also include Push subscriptions created via the web\n   UI in your results", "Get details of the subscription with the given Historics ID\n\n @param historics_id [String] ID of the Historics query for which you are\n   searching for the related Push subscription\n @param page [Integer] Which page of logs to retreive\n @param per_page [Integer] How many logs to return per page\n @param order_by [String, Symbol] Which field to sort results by\n @param order_dir [String, Symbol] Order results in ascending or descending\n @param include_finished [Integer] Include Push subscriptions in a\n   'finished' state in your results\n @param all [Boolean] Also include Push subscriptions created via the web\n   UI in your results", "Get details of all subscriptions within the given page constraints\n\n @param page [Integer] Which page of logs to retreive\n @param per_page [Integer] How many logs to return per page\n @param order_by [String, Symbol] Which field to sort results by\n @param order_dir [String, Symbol] Order results in ascending or descending\n @param include_finished [Integer] Include Push subscriptions in a\n   'finished' state in your results\n @param all [Boolean] Also include Push subscriptions created via the web\n   UI in your results", "Pull data from a 'pull' type Push Subscription\n\n @param id [String] ID of the Push subscription to pull data from\n @param size [Integer] Max size (bytes) of the data that should be returned\n @param cursor [String] Point to a specific point in your Push buffer using\n   a cursor\n @param callback [Method] Pass a callback to process each interaction\n   returned from a successful pull request", "Performs a standard non-creation edit.\n @param title [String] The page title.\n @param text [String] The new content.\n @param opts [Hash<Symbol, Any>] The options hash for optional values in the request.\n @option opts [Boolean] :minor Will mark the edit as minor if true.\n @option opts [Boolean] :bot Will mark the edit as bot edit if true. Defaults to true.\n @option opts [String] :summary The edit summary. Optional.\n @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API\n   documentation\n @see https://www.mediawiki.org/wiki/API:Edit MediaWiki Edit API Docs\n @since 0.2.0\n @raise [EditError] if the edit failed somehow\n @return [String] The new revision ID\n @return [Boolean] False if there was no change in the edit.", "Creates a new page.\n @param title [String] The new page's title.\n @param text [String] The new page's content.\n @param opts [Hash<Symbol, Any>] The options hash for optional values in the request.\n @option opts [String] :summary The edit summary. Defaults to \"New page\".\n @option opts [Boolean] :bot Will mark the edit as a bot edit if true. Defaults to true.\n @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API\n   documentation\n @see https://www.mediawiki.org/wiki/API:Edit MediaWiki Edit API Docs\n @since 0.3.0\n @raise [EditError] If there was some error when creating the page.\n @return [String] The new page ID", "Uploads a file from a URL.\n @param url [String] The URL to the file.\n @param filename [String] The preferred filename. This can include File: at the beginning, but it will be\n   removed through regex. Optional. If omitted, it will be everything after the last slash in the URL.\n @return [Boolean] Whether the upload was successful. It is likely that if it returns false, it also raised a\n   warning.\n @raise [UploadInvalidFileExtError] When the file extension provided is not valid for the wiki.\n @raise [EditError]\n @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API\n   documentation\n @see https://www.mediawiki.org/wiki/API:Upload MediaWiki Upload API Docs\n @since 0.3.0", "Performs a move on a page.\n @param from [String] The page to be moved.\n @param to [String] The destination of the move.\n @param opts [Hash<Symbol, Any>] The options hash for optional values in the request.\n @option opts [String] :reason The reason for the move, which shows up in the log.\n @option opts [Boolean] :talk Whether to move the associated talk page. Defaults to true.\n @option opts [Boolean] :suppress_redirect Set to a truthy value in order to prevent the API from making a redirect\n   page.\n @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API\n   documentation\n @see https://www.mediawiki.org/wiki/API:Move MediaWiki Move API Docs\n @since 0.5.0\n @raise [EditError]\n @return [Boolean] True if it was successful.", "Deletes a page.\n @param title [String] The page to delete.\n @param reason [String] The reason to be displayed in logs. Optional.\n @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API\n   documentation\n @see https://www.mediawiki.org/wiki/API:Delete MediaWiki Delete API Docs\n @since 0.5.0\n @raise [EditError]\n @return [Boolean] True if successful.", "List all targets.\n @return [Void]", "render template with layout and partials", "generates new recording as csv row\n to new or existing DIANE file", "normalizes and slugifies\n recording user handle", "Create a connection to send request", "Configure a Violation instance\n\n @param [Object] resource\n   the validated object\n @param [String, #call, Hash] message\n   an optional custom message for this Violation\n @param [Hash] options\n   options hash for configuring concrete subclasses\n\n @api public\n @api public", "Creates a group of async call and blocks\n\n When async blocks and calls are inside a together block, they can act as a group.\n\n A together block waits for all the async call/blocks that were started within itself to stop before continuing.\n\n   together do\n     5.times do\n       async { sleep(1) }\n     end\n   end\n   # waits for all 5 async blocks to complete\n\n A together block will also yield a {Group}. This can be used to interact with the other async calls/blocks.\n\n   together do |group|\n     5.times do\n       async do\n         # stop everyone else\n         group.interrupt if something?\n       end\n     end\n   end\n\n @yield [Group] group of async blocks/calls\n @see Group Group class", "start the service", "Stop the Service\n\n This method:\n * Stops receiving new messages\n * waits for processing incoming and outgoing messages to be completed\n * close the channel", "RECIEVING MESSAGES\n process messages on the service queue", "process a response message\n\n If a message is put on this services response queue\n its response will be pushed onto the blocking queue", "process a returned message\n\n If a message is sent to a queue that cannot be found,\n rabbitmq returns that message to this method", "send a message to an exchange with routing key\n\n *exchange*:: A AMQP exchange\n *routing_key*:: The routing key to use\n *message*:: The message to be sent\n *options*:: The message options", "send a request to a service, this will wait for a response\n\n *service_name*:: the name of the service\n *message*:: the message to be sent\n\n This method can optionally take a block which will be executed asynchronously and yielded the response", "send a message to a resource\n\n *message*:: HTTP formatted message to be sent, must contain `'path'` key with URL path\n\n This method can optionally take a block which will be executed asynchronously and yielded the response", "Takes a path and converts it into a routing key\n\n *path*:: path string\n\n For example, path '/test/path' will convert to routing key 'test.path'", "format the HTTP message\n\n The entire body is a JSON string with the keys:\n\n Request Information:\n\n 1. *body*: A string of body information\n 2. *verb*: The HTTP verb for the query, e.g. GET\n 3. *headers*: an object with headers in is, e.g. {\"X-HEADER-KEY\": \"value\"}\n 4. *path*: the path of the request, e.g. \"/v1/users/1337\"\n 5. *query*: an object with keys for query, e.g. {'search': 'flux'}\n\n Call information:\n\n 1. *scheme*: the scheme used for the call\n 2. *host*: the host called to make the call\n 3. *port*: the port the call was made on\n\n Authentication information:\n\n 1. *session*: undefined structure that can be passed in the message\n so that a service does not need to re-authenticate with each message", "Calling +gets+ returns a hash containing the oembed data.", "Call with no argument to use default", "The second page that is created holds the BlogPostPortlet and displays the individual\n post view, along with it's comments.", "This function can be used to stop the command execution and\n add a new error.\n Using err inside a callback should not stop the execution but\n should avoid the call of the next callback.\n Every time you call this function, a new error should be added\n to the errors list.\n If the exceptions option is active, it should raise a new error.\n\n ==== Attributes\n\n * +message+ - The message string of the error.\n * +code+ - The error code.", "This function initializes the command required data.", "This function validates the single parameters sets with the \"validates\" method.", "Calls get_unit with key to get value between 0.0 and 1.0, then converts that value to an index within the given list of choices.\nchoices can be an array or an argument list of arbitrary size.", "Returns a new instance of the permitter by initializing it with params, current_user, current_ability.", "Delegates handling the transition to the source state, which\n makes sure that there are no ambiguous transitions for the\n same event.", "Actually send the given data to a socket, and potentially log it along\n the way.\n\n @param [String] The desired name of the new Cube event.\n @param [DateTime] Optional. A specific time when the Cube event occurred.\n @param [Object] Optional. Typically an integer, but can be any object.\n @param [Hash] Optional. Anything in this hash will be stored in the\n   `data` subdocument of the Cube event.", "Creates a link tag of the given +name+ using a URL created by the set of +options+,\n with outbound link tracking under +track_path+ in Google Analytics. The +html_options+\n will accept a hash of attributes for the link tag.", "Creates a link tag of the given +name+ using a URL created by the set of +options+\n if +condition+ is true, with outbound link tracking under +track_path+ in Google Analytics.\n The +html_options+ will accept a hash of attributes for the link tag.", "Creates a link tag of the given +name+ using a URL created by the set of +options+\n unless the current request URI is the same as the link's, with outbound link tracking\n under +track_path+ in Google Analytics. If the request URI is the same as the link\n URI, only the name is returned, or the block is yielded, if one exists.\n The +html_options+ will accept a hash of attributes for the link tag.", "Enqueue a job to handle the delayed action after an elapsed interval\n\n @param interval [#to_f] Number of seconds to wait. `to_f` will be called on\n   this argument to convert to seconds.\n @param options [Hash] options similar to Sidekiq's `perform_in`", "Enqueue a job to handle the delayed action after at a certain time\n\n @param timestamp [#to_f] Timestamp to execute job at. `to_f` will be called on\n   this argument to convert to a timestamp.\n @param options [Hash] options similar to Sidekiq's `perform_at`", "Enqueue a job to handle the delayed action in a given timeframe\n\n @param timestamp [#to_f] Timestamp to execute job at. `to_f` will be called on\n   this argument to convert to a timestamp.\n @param options [Hash] options similar to Sidekiq's `perform_at`\n @option options [Number] :spread_duration Size of window to spread workers out over\n @option options [Number] :spread_in Start of window offset from now\n @option options [Number] :spread_at Start of window offset timestamp\n @option options [rand|mod] :spread_method perform either a random or modulo spread,\n   default: *:rand*\n @option options [Number] :spread_mod_value value to use for determining mod offset\n @option options [Symbol] :spread_mod_method method to call to get the value to use\n   for determining mod offset", "If the message can be parsed into a Hash it will respond to the reactor's websocket connection with the same message in JSON format\n otherwise will try send the message how it is and escaped into JSON format\n\n @param [CelluloidPubsub::Reactor] reactor The  reactor that received an unhandled message\n @param [Object] data The message that the reactor could not handle\n\n @return [void]\n\n @api public", "Build all targets.\n @return [Void]", "returns a ruby hash of", "Parse the authentication tokens out of the response and makes them available as a hash\n\n tokens[:auth] => Google requires this for every request (added to HTTP headers on GET requests)\n tokens[:sid]  => Not used\n tokens[:lsid] => Not used", "a wrapper around GetProvider\n\n @param provider_id [String] optional Allscripts user id\n @param user_name [String] optional Allscripts user_name\n @return [Array<Hash>, Array, MagicError] a list of providers", "a wrapper around GetProviders\n\n @param security_filter [String] optional EntryCode of the Security_Code_DE dictionary for the providers being sought. A list of valid security codes can be obtained from GetDictionary on the Security_Code_DE dictionary.\n @param name_filter [String] optional If specified, will filter for providers with a lastname or entrycode that match. Defaults to %.\n @param show_only_providers_flag [String] optional (Y/N) Indicate whether or not to return only users that are also Providers. Defaults to Y.\n @param internal_external [String] optional I for Internal (User/providers that are internal to the enterprise). E for External (Referring physicians). Defaults to I.\n @param ordering_authority [String] optional Show only those users with an ordering provider level of X (which is a number)\n @param real_provider [String] optional Whether an NPI (National Provider ID) is required (Y/N). Y returns only actual providers. Default is N.\n @return [Array<Hash>, Array, MagicError] a list of providers", "a wrapper around GetPatientProblems\n\n @param patient_id [String] patient id\n @param show_by_encounter [String] Y or N (defaults to `N`)\n @param assessed [String]\n @param encounter_id [String] id for a specific patient encounter\n @param filter_on_id [String]\n @param display_in_progress [String]\n @return [Array<Hash>, Array, MagicError] a list of found problems,\n an empty array, or an error", "a wrapper around GetResults\n\n @param patient_id [String] patient id\n @param since [String] Specify a date/time combination to return only results that have been modified on or after that date/time. For example, 2014-01-01 or 2015-01-14 08:44:28.563. Defaults to nil\n @return [Array<Hash>, Array, MagicError] a list of found results (lab/imaging),\n an empty array, or an error", "a wrapper around GetSchedule, returns appointments scheduled under the\n the user for a given date range\n\n @param start_date [Date] start date inclusive\n @param end_date [Date] end date inclusive\n @return [Array<Hash>, Array, MagicError] a list of scheduled appointments, an empty array, or an error", "a wrapper around GetEncounterList\n\n @param patient_id [String] patient id\n @param encounter_type [String] encounter type to filter on from Encounter_Type_DE\n @param when_or_limit [String] filter by specified date\n @param nostradamus [String] how many days to look into the future. Defaults to 0.\n @param show_past_flag [String] show previous encounters, \"Y\" or \"N\". Defaults to Y\n @param billing_provider_user_name [String] filter by user name (if specified)\n @return [Array<Hash>, Array, MagicError] a list of encounters", "a wrapper around GetListOfDictionaries, which returns\n list of all dictionaries\n\n @return [Array<Hash>, Array, MagicError] a list of found dictionaries,\n an empty array, or an error", "a wrapper around GetDictionary, which returnsentries\n from a specific dictionary.\n\n @param dictionary_name [String] the name of the desired dictionary,\n a \"TableName\" value from `get_list_of_dictionaries`\n @return [Array<Hash>, Array, MagicError] a list dictionary entries,\n an empty array, or an error", "a wrapper around GetServerInfo, which returns\n the time zone of the server, unity version and date\n and license key\n\n @return [Array<Hash>, Array, MagicError]  local information about the\n server hosting the Unity webservice.", "The balance of the account. This instance method is intended for use only\n on instances of account subclasses.\n\n If the account has a normal credit balance, the debits are subtracted from the credits\n unless this is a contra account, in which case credits are substracted from debits.\n\n For a normal debit balance, the credits are subtracted from the debits\n unless this is a contra account, in which case debits are subtracted from credits.\n\n Takes an optional hash specifying :from_date and :to_date for calculating balances during periods.\n :from_date and :to_date may be strings of the form \"yyyy-mm-dd\" or Ruby Date objects\n\n @example\n   >> liability.balance({:from_date => \"2000-01-01\", :to_date => Date.today})\n   => #<BigDecimal:103259bb8,'0.1E4',4(12)>\n\n @example\n   >> liability.balance\n   => #<BigDecimal:103259bb8,'0.2E4',4(12)>\n\n @return [BigDecimal] The decimal value balance", "Anytime an exception happens, we want to skedaddle out of the way\n and let life roll on without any tracking in the loop.", "Add an 'itemprop' to the properties", "Add any properties referred to by 'itemref'", "Build a hash for every node that is not at the correct, final position\n which includes any nodes that need to be moved. Used for autocorrecting.", "Node to class mapping", "Collect all violations into a single list.\n\n @api public", "Returns the value of get_unit from the Factory assigned to the given key.\nWhen a key is needed that a Factory is not already assigned to, one will be assigned at random from the pool of source factories.", "Takes a hash with all keys supported by Factory.", "Validates that the attributes's value is in the set of accepted\n values.\n\n @option [Boolean] :allow_nil (true)\n   true if nil is allowed, false if not allowed.\n\n @option [Array] :accept ([\"1\", 1, \"true\", true, \"t\"])\n   A list of accepted values.\n\n @example Usage\n   require 'virtus'\n   require 'aequitas'\n\n   class Page\n     include Virtus\n     include Aequitas\n\n     attribute :license_agreement_accepted, String\n     attribute :terms_accepted, String\n\n     validates_acceptance_of :license_agreement, :accept => \"1\"\n     validates_acceptance_of :terms_accepted, :allow_nil => false\n\n     # a call to valid? will return false unless:\n     # license_agreement is nil or \"1\"\n     # and\n     # terms_accepted is one of [\"1\", 1, \"true\", true, \"t\"]\n   end", "Validates that the given attribute is confirmed by another\n attribute. A common use case scenario is when you require a user to\n confirm their password, for which you use both password and\n password_confirmation attributes.\n\n @option [Boolean] :allow_nil (true)\n   true or false.\n\n @option [Boolean] :allow_blank (true)\n   true or false.\n\n @option [Symbol] :confirm (firstattr_confirmation)\n   The attribute that you want to validate against.\n\n @example Usage\n   require 'virtus'\n   require 'aequitas'\n\n   class Page\n     include Virtus\n     include Aequitas\n\n     attribute :password, String\n     attribute :email, String\n\n     attr_accessor :password_confirmation\n     attr_accessor :email_repeated\n\n     validates_confirmation_of :password\n     validates_confirmation_of :email, :confirm => :email_repeated\n\n     # a call to valid? will return false unless:\n     # password == password_confirmation\n     # and\n     # email == email_repeated\n   end", "Validate whether a field is numeric.\n\n @option [Boolean] :allow_nil\n   true if number can be nil, false if not.\n\n @option [Boolean] :allow_blank\n   true if number can be blank, false if not.\n\n @option [String] :message\n   Custom error message, also can be a callable object that takes\n   an object (for pure Ruby objects) or object and property\n   (for DM resources).\n\n @option [Numeric] :precision\n   Required precision of a value.\n\n @option [Numeric] :scale\n   Required scale of a value.\n\n @option [Numeric] :gte\n   'Greater than or equal to' requirement.\n\n @option [Numeric] :lte\n   'Less than or equal to' requirement.\n\n @option [Numeric] :lt\n   'Less than' requirement.\n\n @option [Numeric] :gt\n   'Greater than' requirement.\n\n @option [Numeric] :eq\n   'Equal' requirement.\n\n @option [Numeric] :ne\n   'Not equal' requirement.\n\n @option [Boolean] :integer_only\n   Use to restrict allowed values to integers.", "Validates that the specified attribute is present.\n\n For most property types \"being present\" is the same as being \"not\n blank\" as determined by the attribute's #blank? method. However, in\n the case of Boolean, \"being present\" means not nil; i.e. true or\n false.\n\n @note\n   dm-core's support lib adds the blank? method to many classes,\n\n @see lib/dm-core/support/blank.rb (dm-core) for more information.\n\n @example Usage\n   require 'virtus'\n   require 'aequitas'\n\n   class Page\n     include Virtus\n     include Aequitas\n\n     attribute :required_attribute, String\n     attribute :another_required,   String\n     attribute :yet_again,          String\n\n     validates_presence_of :required_attribute\n     validates_presence_of :another_required, :yet_again\n\n     # a call to valid? will return false unless\n     # all three attributes are not blank (according to Aequitas.blank?)\n   end", "Validates that the specified attribute is of the correct primitive\n type.\n\n @example Usage\n   require 'virtus'\n   require 'aequitas'\n\n   class Person\n     include Virtus\n     include Aequitas\n\n     attribute :birth_date, Date\n\n     validates_primitive_type_of :birth_date\n\n     # a call to valid? will return false unless\n     # the birth_date is something that can be properly\n     # casted into a Date object.\n   end", "Returns hash array of all\n recordings in DIANE file", "returns and puts formatted recordings\n returned by query", "Look for reported or failed rules of a particular type in the instance doc", "Initializes and returns a Redis object.\n\n Requires params hash i.e.\n {\n   :host => [String] (The hostname of the Redis server)\n   :port => [String] (Numeric port number)\n }\n\n For further documentation refer to https://github.com/redis/redis-rb\n\n Any errors thrown are generated by the redis-rb client.\n\n @param [Hash] params\n @return [Redis]\n\n Registers a hit corresponding to the key specified, requires the max hit count and the duration to be passed.\n\n @param [String] key : Should be unique for one operation, can be added for multiple operations if a single rate\n                       limiter is to be used for those operations.\n @param [Integer] count : Max rate limit count\n @param [Integer] duration : Duration of the time window.\n\n Count and duration params could change in each call and the limit breach value is returned corresponding to that.\n Ideally this method should be called with each param a constant on the application level.\n\n Returns false if the limit has been breached.\n Returns true if limit has not been breached. (duh)", "Gets the ETA for the next window start only if the limit has been breached.\n Returns 0 if the limit has not been breached.\n @param [String] key\n @param [Integer] count\n @param [Integer] duration", "Get key from Rinda server.", "Parse the ids to the same string format.\n contentfulAttribute == ruby_attribute", "Initialize an ChefClient configuration\n\n ==== Notes\n options parameter must include values for :validation_key, :server_url and :node_name\n\n ==== Examples\n   chef_client = Cloudster::ChefClient.new(\n    :validation_key => 'asd3e33880889098asdnmnnasd8900890a8sdmasdjna9s880808asdnmnasd90-a',\n    :server_url => 'http://10.50.60.70:4000',\n    :node_name => 'project.environment.appserver_1',\n    :validation_client_name => 'chef-validator',\n    :interval => 1800\n   )\n\n ==== Parameters\n * options<~Hash> -\n     * :validation_key: String containing the key used for validating this client with the server. This can be taken from the chef-server validation.pem file. Mandatory field\n     * :server_url: String containing the fully qualified domain name of the chef-server. Mandatory field\n     * :node_name: String containing the name for the chef node. It has to be unique across all nodes in the particular chef client-server ecosystem. Mandatory field\n     * :interval: Integer containing the interval(in seconds) between chef-client runs. Default value : 1800 seconds\n     * :validation_client_name: String containing the name of the validation client. \"ORGNAME-validator\" if using hosted chef server. Default: 'chef-validator'\n Merges the required CloudFormation template for installing the Chef Client to the template of the EC2 instance\n\n\n ==== Examples\n   chef_client = Cloudster::ChefClient.new(\n    :validation_key => 'asd3e33880889098asdnmnnasd8900890a8sdmasdjna9s880808asdnmnasd90-a',\n    :server_url => 'http://10.50.60.70:4000',\n    :node_name => 'project.environment.appserver_1'\n   )\n   ec2 = Cloudster::Ec2.new(\n    :name => 'AppServer',\n    :key_name => 'mykey',\n    :image_id => 'ami_image_id',\n    :instance_type => 't1.micro'\n   )\n\n   chef_client.add_to ec2\n\n ==== Parameters\n * instance of EC2", "Execute all rules in this context against the resource.\n\n @param [Object] resource\n   the resource to be validated\n\n @return [Array(Violation)]\n   an Array of Violations", "Initialize a Cloud instance\n\n ==== Notes\n options parameter must include values for :access_key_id and\n :secret_access_key in order to create a connection\n\n ==== Parameters\n * options<~Hash>\n   * :access_key_id : A string containing the AWS access key ID (Required)\n   * :secret_access_key : A string containing the AWS secret access key (Required)\n   * :region : A string containing the region where the stack should be created/updated (Optional). Can be one of\n     us-east-1(default), us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-northeast-1, ap-southeast-2, sa-east-1\n\n ==== Examples\n   cloud = Cloudster::Cloud.new(\n    :access_key_id => 'aws_access_key_id',\n    :secret_access_key => 'aws_secret_access_key',\n    :region => 'us-east-1'\n   )\n Generates CloudFormation Template for the stack\n\n ==== Examples\n   cloud = Cloudster::Cloud.new(\n    :access_key_id => 'aws_access_key_id',\n    :secret_access_key => 'aws_secret_access_key',\n    :region => 'us-east-1'\n   )\n\n   cloud.template(:resources => [<AWS RESOURCES ARRAY>], :description => 'This is the description for the stack template')\n\n ==== Notes\n options parameter must include values for :resources\n\n ==== Parameters\n * options<~Hash> -\n   * :resources : An array of Cloudster resource instances.  Defaults to {}.\n   * :description : A string which will be used as the Description of the CloudFormation template.\n\n ==== Returns\n * JSON cloud formation template", "Get details of all RDS resources in a stack\n\n ==== Examples\n   cloud = Cloudster::Cloud.new(\n    :access_key_id => 'aws_access_key_id',\n    :secret_access_key => 'aws_secret_access_key',\n    :region => 'us-east-1'\n   )\n   cloud.get_rds_details(:stack_name => 'ShittyStack')\n\n ==== Parameters\n * options<~Hash>\n   * :stack_name : A string which will contain the name of the stack\n\n ==== Returns\n * A hash of RDS details where the key is the logical name and value is the RDS detail", "Get details of all EC2 instances in a stack\n\n ==== Examples\n   cloud = Cloudster::Cloud.new(\n    :access_key_id => 'aws_access_key_id',\n    :secret_access_key => 'aws_secret_access_key',\n    :region => 'us-east-1'\n   )\n   cloud.get_ec2_details(:stack_name => 'ShittyStack')\n\n ==== Parameters\n * options<~Hash>\n   * :stack_name : A string which will contain the name of the stack\n\n ==== Returns\n * A hash of instance details where the key is the logical instance name and value is the instance detail", "Get details of all Elastic Load Balancers in the stack\n\n ==== Examples\n   cloud = Cloudster::Cloud.new(\n    :access_key_id => 'aws_access_key_id',\n    :secret_access_key => 'aws_secret_access_key',\n    :region => 'us-east-1'\n   )\n   cloud.get_elb_details(:stack_name => 'ShittyStack')\n\n ==== Parameters\n * options<~Hash>\n   * :stack_name : A string which will contain the name of the stack\n\n ==== Returns\n * A hash containing elb details where the key is the logical name and value contains the details", "Returns a hash containing the output values of each resource in the Stack\n\n ==== Examples\n   cloud = Cloudster::Cloud.new(\n    :access_key_id => 'aws_access_key_id',\n    :secret_access_key => 'aws_secret_access_key',\n    :region => 'us-east-1'\n   )\n   cloud.outputs(:stack_name => 'RDSStack')\n\n ==== Parameters\n * options<~Hash>\n   * :stack_name : A string which will contain the name of the stack\n\n ==== Returns\n * Hash containing outputs of the stack", "Returns true if S3 bucket name is available, else returns false\n\n ==== Examples\n   cloud = Cloudster::Cloud.new(\n    :access_key_id => 'aws_access_key_id',\n    :secret_access_key => 'aws_secret_access_key',\n    :region => 'us-east-1'\n   )\n   cloud.is_s3_bucket_name_available?('test-bucket-name')\n\n ==== Parameter\n * String containing the bucket name\n\n ==== Returns\n * true - If bucket name is available\n * false - If bucket name is not available", "output as hash", "Contructs an Adb object for issuing commands to the connected device or emulator.\n\n If the adb path is not specified in the +opts+ hash it is determined in the following order:\n 1. Try and use the unix which command to locate the adb binary.\n 2. Use the ANDROID_HOME environment variable.\n 3. Default to adb (no path specified).\n\n @param [Hash] opts The options to create the Adb object with.\n @option opts [Logger] :log A log4r logger that debug information can be sent too.\n @option opts [Boolean] :dry_run Does not execute the *adb* command but will log the command and set last_command.\n @option opts [Boolean] :adb_path Manually set the path to the adb binary.\n Returns a list of all connected devices. The collection is returned as a hash\n containing the device name <tt>:name</tt> and the serial <tt>:serial</tt>.\n @return [Array<Device>] THe list of connected devices/emulators.", "Returns a list of all installed packages on the device.\n @param [Hash] adb_opts Options for the adb command (@see #run_adb)\n @return [Hash] THe list of installed packages. The hash returned contains the apk file name <tt>:apk</tt> and the name of the package <tt>:name</tt>.", "sets the celluloid logger and the celluloid exception handler\n\n @return [void]\n\n @api private", "sets the celluloid exception handler\n\n @return [void]\n\n @api private", "creates the log file where the debug messages will be printed\n\n @return [void]\n\n @api private", "receives a list of options that need to be parsed\n if it is an Array will return the first element , otherwise if it is\n an Hash will return the hash with string keys, otherwise an empty hash\n\n @param  [Hash, Array]  options the options that need to be parsed\n\n @return [Hash]\n\n @api private", "Constructor\n accepts an array of files", "This returns an empty string if can't form a valid\n absolute url as per the Microdata spec.", "Store operator.\n\n   h[key] = value\n\n Or with additional index.\n\n  h[key,index] = value", "Perform a request\n\n @param method [String] Type of request path\n @param path [String] URL path to send request\n @param opts [Hash] Request parameters\n @return [Hashie::Mash] Response", "Sets the state machine's current_state to self, calls all entry\n actions and activates triggering mechanisms of all outgoing\n transitions.", "Sets the state machine's current_state to nil, calls all exit\n actions and deactivates triggering mechanisms of all outgoing\n transitions.", "Cleans up references to allow easier GC.", "Executes the registered transition for the given event type and\n event trigger value, if such a transition exists and it is\n allowed.\n\n @raise [RuntimeError] if multiple transitions would be allowed at\n   the same time.", "Determine whether or not this is a valid user", "Convert option_keys to hash and return", "one entry for each file", "the method will link the current actor to the actor that is attached to, and the connection to the current actor\n\n @return [void]\n\n @api public", "callback executes when actor receives a message from a subscribed channel\n and parses the message using JSON.parse and dispatches the parsed\n message to the original actor that made the connection\n\n @param [JSON] data\n\n @return [void]\n\n @api public", "callback executes when connection closes\n\n @param [String] code\n\n @param [String] reason\n\n @return [void]\n\n @api public", "method used to send an action to the webserver reactor , to a chanel and with data\n\n @param [String] action\n @param [String] channel\n @param [Hash] data\n\n @return [void]\n\n @api private", "method used to send messages to the webserver\n checks too see if the message is a hash and if it is it will transform it to JSON and send it to the webser\n otherwise will construct a JSON object that will have the key action with the value 'message\" and the key message witth the parameter's value\n\n @param [Hash] message\n\n @return [void]\n\n @api private", "method that checks if the data is a Hash\n\n if the data is a hash then will stringify the keys and will call the method {#delegate_action}\n that will handle the message, otherwise will call the method {#handle_unknown_action}\n\n @see #delegate_action\n @see #handle_unknown_action\n\n @param [Hash] json_data\n\n @return [void]\n\n @api public", "the method will unsubscribe a client by closing the websocket connection if has unscribed from all channels\n and deleting the reactor from the channel list on the server\n\n @param [String] channel\n\n @return [void]\n\n @api public", "the method will delete the reactor from the channel list on the server\n\n @param [String] channel\n\n @return [void]\n\n @api public", "the method will unsubscribe all  clients subscribed to a channel by closing the\n\n @param [String] channel\n\n @return [void]\n\n @api public", "adds the curent actor the list of the subscribers for a particular channel\n and registers the new channel\n\n @param [String] channel\n @param [Object] message\n\n @return [void]\n\n @api public", "method for publishing data to a channel\n\n @param [String] current_topic The Channel to which the reactor instance {CelluloidPubsub::Reactor} will publish the message to\n @param [Object] json_data The additional data that contains the message that needs to be sent\n\n @return [void]\n\n @api public", "the method will publish to all subsribers of a channel a message\n\n @param [String] current_topic\n @param [#to_s] message\n\n @return [void]\n\n @api public", "unsubscribes all actors from all channels and terminates the curent actor\n\n @param [String] _channel NOT USED - needed to maintain compatibility with the other methods\n @param [Object] _json_data NOT USED - needed to maintain compatibility with the other methods\n\n @return [void]\n\n @api public", "kills all reactors registered on a channel and closes their websocket connection\n\n @param [String] channel\n @return [void]\n\n @api public", "Sends a custom message.  See the docs for all the possible options\n @see https://docs.emaildirect.com/#RelaySendCustomEmail", "Assimilate all rules contained in +other+ into the receiver\n\n @param [ContextualRuleSet] other\n   the ContextualRuleSet whose rules are to be assimilated\n\n @return [self]\n\n @api private", "Initialize and assign a RuleSet for the named context\n\n @param [Symbol] context_name\n   the name of the context to be defined. noop if already defined\n\n @return [self]\n\n @api private", "Does the work of making HTTP calls and then going through a suite of tests on the response to make\n sure it's valid and not an error", "Creates a valid query string for GA", "Instantiation of the Client\n\n @param url [String] Allscripts URL to be used to make Unity API calls\n @param app_name [String] app name assigned by Allscripts\n @param app_username [String] the app username supplied by Allscripts\n @param app_password [String] the app password supplied by Allscripts\n Gets security token necessary in all workflows\n @return [String] security token", "Assign a security token from `get_token` to a specific Allscripts user.\n This creates a link on the Allscripts server that allows that token\n to be used in subsequent `magic` calls passed that user's username.\n\n @param username [String] the Allscripts user's username (from Allscripts)\n @param password [String] the Allscripts user's password (from Allscripts)\n @return [Hash] user permissions, etc.", "Validate a token generated and passed by Allscripts during SSO\n Falls back and looks for sso_token on the client if not passed one\n Note that sso_token is not the token from `get_token``\n\n TODO: test and validate. Add error handling\n\n @param sso_token [String] the Allscripts SSO token (from Allscripts)", "Main method for interacting with the Allscripts UnityAPI\n\n @param action [String] the API action to be performed\n @param magic_params [MagicParams] a params object\n used to build the Magic Action request body's user_id,\n patient_id, and magic parameters. The patient_id\n is sometimes oprional and the numbered\n params are generally optional, but must be sent\n as blank strings if unused.\n @return [Hash, MagicError] the parsed JSON response from Allscripts or\n a `MagicError` with the API error message(hopefully)", "Don't create methods until first access", "Specify where your AirVideo Server lives. If your HTTP_PROXY environment variable is set, it will be honoured.\n\n At the moment I'm expecting ENV['HTTP_PROXY'] to have the form 'sub.domain.com:8080', I throw an http:// and bung it into URI.parse for convenience.\n Potentially confusing:\n * Sending 'server:port' will use that address as an HTTP proxy\n * An empty string (or something not recognisable as a URL with http:// put infront of it) will try to use the ENV['HTTP_PROXY'] variable\n * Sending nil or any object that can't be parsed to a string will remove the proxy\n\n NB. You can access the @proxy URI object externally, but changing it will *not* automatically call set_proxy", "Returns the Output template for resources\n\n ==== Parameters\n * output: Hash containing the valid outputs and their cloudformation translations", "validate the configured page before returning it", "Initialize an ElasticIp\n\n ==== Notes\n options parameter must include values for :name\n\n ==== Examples\n   elastic_ip = Cloudster::ElasticIp.new(:name => 'ElasticIp')\n\n ==== Parameters\n * options<~Hash> -\n     * :name: String containing the name of ElastiCache resource\n Merges the required CloudFormation template for adding an ElasticIp to an EC2 instance\n\n\n ==== Examples\n   elastic_ip = Cloudster::ElasticIp.new(:name => 'AppServerEIp')\n   ec2 = Cloudster::Ec2.new(\n    :name => 'AppServer',\n    :key_name => 'mykey',\n    :image_id => 'ami_image_id',\n    :instance_type => 't1.micro'\n   )\n\n   elastic_ip.add_to ec2\n\n ==== Parameters\n * instance of EC2", "Store a value for the given key.\nValues will be scaled to the range 0 to 1 - the largest value yet seen will be scaled to 1.0, the smallest yet seen to 0.0.", "Returns the input key assigned to the given get_unit key.\nIf none is assigned, randomly assigns one of the available input keys.", "`documentizer` just takes a record and converts it to a string", "This function initializes the event required data.", "Log a message at the given level if the logger is present\n\n This isn't generally a recommended method to use while logging in your\n libraries. Instead see {#debug}, {#info}, {#warn}, {#error}, {#fatal}, and\n {#unknown} as they simplify messaging considerably.\n\n If you don't want to use the recommended methods and want more control for\n some reason. There are a few ways to log a message depending on your usecase.\n\n The first is probably the most generally useful, which is logging messages\n that aren't costly to build. This is accomplished as follows:\n\n     add(::Logger::INFO, 'some message', nil)\n\n The second is for use cases in which it is costly to build the log message\n as it avoids executing the block until the logger knows that the message\n level will be displayed. If the message level would not be displayed then\n the block is not executed, saving the performance cost of building the\n message.\n\n     add(::Logger::INFO) { 'some expensive message' }\n\n The third gives you the benefits of preventing uneeded expensive messages\n but also allows you to override the program name that will be prefixed on\n that log message. This is accomplished as follows.\n\n     add(::Logger::INFO, nil, 'overridden progname') { 'some expensive message' }\n\n It is important to realize that if the wrapped logger is nil then this\n method will simply do nothing.\n\n @param severity ::Logger::DEBUG, ::Logger::INFO, ::Logger::WARN,\n   ::Logger::ERROR, ::Logger::FATAL, ::Logger::UNKNOWN\n @param message the optional message to log\n @param progname_or_message the optional program name or message, if\n   message is nil, and a block is NOT provided, then progname_or_message is\n   treated as a message rather than progname\n @param block the block to evaluate and yield a message, generally useful\n   preventing building of expensive messages when message of that level\n   aren't allowed", "identify client\n return identification string\n on error return nil and set @response to http response code", "Return instances for namespace and classname", "Return list of classnames for given object_path", "Return associations for instance", "Initializes an AccessToken from a hash\n\n @param [Hash] hash a Hash contains access_token and expires\n @return [AccessToken] the initalized AccessToken", "create end point reference URI", "Handle client connection or protocol fault\n\n @return: true if fault", "return list of namespaces", "Enumerate class names", "Download the latest backup\n @param {string} output_filename\n @param {hash} options\n Valid options:\n => {string?} target_backup - If a target is set, a backup will be pulled from there,\n    otherwise, we'll pull from the latest backup\n @param {hash} options", "Stores the recently backed up file in a specified S3 bucket\n @param {string} backup_location", "generate method parameter information\n return nil if no parameters", "generate .rb class declaration", "classmap - generate map of classes and their .mof files", "get all words with given prefix", "add a single element to the enumerable.\n You may pass a single parameter, or a key, value. In any case,\n all will added.\n\n Here all the logic will be present to handle the \"special case\"\n enumerables. Most notedly, Hash and Array will require special\n treatment.", "Start up queue runners", "Push a task into the queue", "Grab the oldest work item available", "Quit - empty the queue and wait for remaining jobs to complete", "Return an array of all jobs with the requested\n status.", "Removes nil values", "Add something to the work queue", "Take something from the queue", "Return a hash of the results", "Sort queue by server nickname", "Get jobs by status", "An execution group is \"done\" if nothing is queued or running\n and at least one job has completed.", "Is this execution group running anything?", "Queue a held job by id", "Cancel a job by id", "user upload xml", "Apart from renewing the auth of the combination received, we also renew\n all the metrics of the associated application. The reason is that to renew\n a single metric we need to perform one call to 3scale, and to renew all\n the limited metrics of an application we also need one. If the metric\n received does not have limits defined, we need to perform two calls, but\n still it is worth to renew all of them for that price.\n\n Note: Some exceptions can be raised inside the futures that are executed\n by the thread pool. For example, when 3scale is not accessible, when\n renewing the cached authorizations fails, or when publishing to the\n response channels fails. Trying to recover from all those cases does not\n seem to be worth it. The request that published the message will wait for\n a response that will not arrive and eventually, it will timeout. However,\n if the request retries, it is likely to succeed, as the kind of errors\n listed above are (hopefully) temporary.", "Generates methods to enter text into a text field, clear the text\n field, get the hint as well as the description\n\n @example\n   text(:first_name, :index => 0)\n   # will generate 'first_name', 'first_name=', 'clear_first_name', 'first_name_hint' and 'first_name_description' methods\n\n @param  [Symbol]  the name used for the generated methods\n @param  [Hash]  locator for how the text is found  The valid\n keys are:\n  * :id\n  * :index", "Generates a method to click a button and determine if it is enabled.\n\n @example\n   button(:save, :text => 'Save')\n   # will generate 'save' and 'save_enabled?' methods\n\n @param  [Symbol]  the name used for the generated methods\n @param  [Hash]  locator for how the button is found  The valid\n keys are:\n  * :text\n  * :index\n  * :id", "Generates one method to click a list item.\n\n @example\n   list_item(:details, :text => 'Details')\n   # will generate 'details' method\n\n @example\n   list_item(:details, :index => 1, :list => 1)\n   # will generate 'details' method to select second item in the\n   # second list\n\n @example\n   list_item(:details, :index => 2)\n   # will generate 'details' method to select third item in the\n   # first list\n\n @param  [Symbol]  the name used for the generated methods\n @param  [Hash]  locator for how the list item is found  The valid\n keys are:\n  * :text\n  * :index\n  * :list - only us with :index to indicate which list to use on\n the screen.  Default is 0", "Generates one method to click a checkbox.\n\n @example\n   checkbox(:enable, :text => 'Enable')\n   # will generate 'enable' method\n\n @param  [Symbol]  the name used for the generated methods\n @param  [Hash]  locator for how the checkbox is found  The valid\n keys are:\n  * :text\n  * :index\n  * :id", "Generates one method to click a radio button.\n\n @example\n   radio_button(:circle, :text => 'Circle')\n   # will generate 'circle' method\n\n @param  [Symbol]  the name used for the generated methods\n @param  [Hash]  locator for how the checkbox is found  The valid\n keys are:\n  * :text\n  * :index\n  * :id", "Generaes method to interact with an image.\n\n @example\n   image(:headshot, :id => 'headshot')\n   # will generate 'click_headshot' method to click the image,\n   # 'wait_for_headshot' which will wait until the image has\n   # loaded a drawable and 'headshot_view' to return the view\n\n @param  [Symbol]  the name used for the generated methods\n @param  [Hash]  locator indicating an id for how the image is found.\n The only valid keys are:\n   * :index", "Gathers all the knowledge and put it into your app.\n\n === Usage\n\n @example:\n   learner = Knowledge::Learner.new\n\n   # Do some config (add adapters, define your setter, etc.)\n\n   learner.gather!", "Enables an adapter.\n\n === Usage\n\n @example:\n   learner = Knowledge::Learner.new\n\n   # Register your adapter\n   learner.register_adapter(name: :my_adapter, klass: MyAdapter)\n\n   # Now you can enable it\n   learner.enable_adapter(name: :my_adapter)\n\n === Errors\n\n @raises [Knowledge::AdapterNotFound] if adapter is not available\n\n === Parameters\n\n @param :name [String | Symbol]\n @param :variables [Hash | String | nil]", "Registers an adapter and enable it if asked.\n\n === Usage\n\n @example:\n   learner = Knowledge::Learner.new\n\n   learner.register_adapter(name: :my_adapter, klass: MyAdapter, enable: true)\n\n === Parameters\n\n @param :name [String | Symbol]\n @param :klass [Class]\n @param :enable [Boolean]\n @param :variables [Hash | String | nil]", "Sets variables for a given adapter.\n\n === Usage\n\n @example:\n   learner = Knowledge::Learner.new\n\n   learner.set_adapter_variables(name: :default, variables: { foo: :bar })\n\n === Parameters\n\n @param :name [String | Symbol]\n @param :variables [Hash | nil]", "Sets variables as a hash for a given adapter.\n\n === Usage\n\n @example\n   learner = Knowledge::Learner.new\n\n   learner.set_adapter_variables_by_hash(name: :default, variables: { foo: :bar })\n\n === Parameters\n\n @param :name [String | Symbol]\n @param :variables [Hash]", "Registers & enables one of the lib's default adapters.\n\n If you're writing a gem to add an adapter to knowledge, please have a look at\n Knowledge::Learned#register_default_adapter\n\n === Usage\n\n @example:\n   learner = Knowledge::Learner.new\n\n   learner.use(name: :ssm)\n\n === Parameters\n\n @param :name [String | Symbol]\n @param :enable [Boolean]", "Opens the config file and sets the variable config.\n\n === Parameters\n\n @param path [String]", "Updates the index.", "set namespaces for commands", "Given a method's file string, line number and defining module, returns a hash\n of attributes defined for that method.", "Scrapes a given string for commented @keywords, starting with the line above the given line", "Call this method before set any values", "Returns a key chain which includes all parent's keys and self keys", "Given a result xml element, return a hash of the values we're interested in.", "Append a string to the history buffer if enabled.", "Parse chimpd command line options", "Spawn a WEBrick Web server", "Spawn threads to process submitted requests", "For exceptions that are likely to require the user intervention, we log\n errors. For example, when the report could not be made because the 3scale\n client received an invalid provider key.\n On the other hand, for errors that are likely to be temporary, like when\n we could not connect with 3scale, we log a warning.", "The main method that creates the message and renders the SMS templates. There are\n two ways to call this method, with a block, or without a block.\n\n It accepts a headers hash. This hash allows you to specify\n the most used headers in an SMS message, these are:\n\n * +:to+ - Who the message is destined for, can be a string of addresses, or an array\n   of addresses.\n * +:from+ - Who the message is from\n\n You can set default values for any of the above headers (except +:date+)\n by using the ::default class method:\n\n  class Notifier < SmsCarrier::Base\n    default from: '+886987654321'\n  end\n\n If you do not pass a block to the +sms+ method, it will find all\n templates in the view paths using by default the carrier name and the\n method name that it is being called from, it will then create parts for\n each of these templates intelligently, making educated guesses on correct\n content type and sequence, and return a fully prepared <tt>Sms</tt>\n ready to call <tt>:deliver</tt> on to send.\n\n For example:\n\n   class Notifier < SmsCarrier::Base\n     default from: 'no-reply@test.lindsaar.net'\n\n     def welcome\n       sms(to: 'mikel@test.lindsaar.net')\n     end\n   end\n\n Will look for all templates at \"app/views/notifier\" with name \"welcome\".\n If no welcome template exists, it will raise an ActionView::MissingTemplate error.\n\n However, those can be customized:\n\n   sms(template_path: 'notifications', template_name: 'another')\n\n And now it will look for all templates at \"app/views/notifications\" with name \"another\".\n\n You can even render plain text directly without using a template:\n\n   sms(to: '+886987654321', body: 'Hello Mikel!')", "Initialized a new Client object\n\n @param options [Hash]\n @return[ACTV::Client]\n Returns assets that match a specified query.\n\n @authentication_required No\n @param q [String] A search term.\n @param options [Hash] A customizable set of options.\n @return [ACTV::SearchResults] Return assets that match a specified query with search metadata\n @example Returns assets related to running\n   ACTV.assets('running')\n   ACTV.search('running')", "Returns an organizer with the specified ID\n\n @authentication_required No\n @return ACTV::Organizer The requested organizer.\n @param id [String] An assset ID.\n @param options [Hash] A customizable set of options.\n @example Return the organizer with the id AA388860-2718-4B20-B380-8F939596B123\n   ACTV.organizer(\"AA388860-2718-4B20-B380-8F939596B123\")", "Returns an asset with the specified url path\n\n @authentication_required No\n @return [ACTV::Asset] The requested asset\n @param path [String]\n @example Return an asset with the url http://www.active.com/miami-fl/running/miami-marathon-and-half-marathon-2014\n   ACTV.asset_by_path(\"http://www.active.com/miami-fl/running/miami-marathon-and-half-marathon-2014\")", "Returns articles that match a specified query.\n\n @authentication_required No\n @param q [String] A search term.\n @param options [Hash] A customizable set of options.\n @return [ACTV::SearchResults] Return articles that match a specified query with search metadata\n @example Returns articles related to running\n   ACTV.articles('running')\n   ACTV.articles('running')", "Returns an article with the specified ID\n\n @authentication_required No\n @return [ACTV::Article] The requested article.\n @param id [String] An article ID.\n @param options [Hash] A customizable set of options.\n @example Return the article with the id BA288960-2718-4B20-B380-8F939596B123\n   ACTV.article(\"BA288960-2718-4B20-B380-8F939596B123\")", "Returns popular interests\n\n @authentication_required No\n @param options [Hash] A customizable set of options.\n @return [ACTV::PopularInterestSearchResults] Return intersts\n @example Returns most popular interests\n   ACTV.popular_interests()\n   ACTV.popular_interests({per_page: 8})", "Returns a result with the specified asset ID and asset type ID\n\n @authentication_required No\n @return [ACTV::EventResult] The requested event result.\n @param assetId [String] An asset ID.\n @param assetTypeId [String] An asset type ID.\n @example Return the result with the assetId 286F5731-9800-4C6E-ADD5-0E3B72392CA7 and assetTypeId 3BF82BBE-CF88-4E8C-A56F-78F5CE87E4C6\n   ACTV.event_results(\"286F5731-9800-4C6E-ADD5-0E3B72392CA7\",\"3BF82BBE-CF88-4E8C-A56F-78F5CE87E4C6\")", "Returns results with multiple queries\n @param options list of search options\n @example ACTV.multi_search({category: 'event', per_page: 4}, {category: 'articles OR quiz', per_page: 5})", "Perform an HTTP Request", "More optimized data fetch. Gets an array of address range structs\n @param register_list [Array<RegistersRunLength] Register ranges to log. Optional, has a default\n @return [Array<Integer>] List of the register values in the order requested", "Get the headers for the bulk_log data\n @param register_list [Array<RegistersRunLength] Register ranges to log. Optional, has a default\n @return [Array<String>] Array of the headers", "Declare a key, with default values\n\n @param [Symbol] keys\n @param [Hash] options, the last param must be an option with a defaults hash", "Declare an attribute with default value\n\n @param [Symbol] value\n @param [Hash] options, options with a default Hash", "Determine content encoding by reviewing message headers.\n\n @raise [InvalidEncodingError] if encoding does not exist in Ruby\n @return [Encoding]", "Write a single header to this frame.\n\n @param [String] key\n @param [String] value", "Wrapper around a call to list all stations\n\n @return [Response] [A response object unless]", "Find a previously declared Destination\n @param destination_name [Symbol] the name of the destination\n @return [Destination::Base] the requested destination\n @raise [MessageDriver::NoSuchDestinationError] if there is no destination with that name", "Extract metadata from the document.", "A sanitize transformer that will check the document for IFRAME tags and\n validate them against +allowed_iframe_hosts+.", "updates the asset list with tenant theme where it's\n necessary", "Authenticates a member's username and password and binds them to the current API session.\n\n @see https://api.yourmembership.com/reference/2_00/Auth_Authenticate.htm\n\n @param user_name [String] The username of the member that is being authenticated.\n @param password [String] The clear text password of the member that is being authenticated.\n\n @return [Hash] Returns the member's ID and WebsiteID. The returned WebsiteID represents the numeric identifier\n  used by the YourMembership.com application for navigation purposes. It may be used to provide direct navigation to\n  a member's profile, photo gallery, personal blog, etc.", "Returns an array of metric names. The array is guaranteed to have all the\n parents first, and then the rest.\n In 3scale, metric hierarchies only have 2 levels. In other words, a\n metric that has a parent cannot have children.", "Returns every object within dist miles\n of obj\n\n @param  obj [Api] [Api Object]\n @param  dist [Float] [Distance to consider]\n\n @return [type] [description]", "Delegates any undefined methods to the underlying data", "Grab work items from the ChimpQueue and process them\n Only stop is @ever_exit is false", "Ensures that args count is equal to params count plus diff", "Procedure that calls api function expecting a callback. If runtime block is given\n it is converted into actual callback, otherwise procedure returns an array of all\n handles pushed into callback by api enumeration", "A score between 0 and 1 representing the level of alliteration", "Replace the words in the word list with the word n places after it", "Returns true if each word is one letter larger than the previous", "Returns true if the string is a sequence of words in each of which is one letter larger than the\n previous, or each word in the sequence is one letter less than the previous", "Keep the edit window in sync!", "Compute what should be on the screen.", "Bring the screen into agreement with the image.", "Create an anonymous module that defines a method\n with the same name as main method being defined.\n Add some memoize code to check whether the method\n has been previously called or not. If it's not\n been then call the underlying method and store the result.\n\n We then prepend this module so that its method\n comes first in the method-lookup chain.", "Run the block inside a subprocess, and return the value.\n\n @return [#object_id] The result.", "Returns body string if successful or nil if not.", "Returns nil if dependencies or parsing fails", "Writes all results to one file for future splitting.\n @param file_name [String] name of the local export file\n @return [Integer] number of records to export.", "Returns the s3 key to be used\n @return [String] file key with extension", "Uploads splitted CSVs\n @param files [Array<String>] array of files paths to upload", "Run a unit of work with retries\n This is called from the subclass with a code block to yield to", "Transfer payment amount to payer bank account via transfers API", "Set up reasonable defaults\n\n\n Entry point for the chimp command line application", "Check for any invalid combinations of command line options", "Api1.6 equivalent", "Verify that all returned instances from the API match our tag request", "Given some array names, return the arrays hrefs\n Api1.5", "Given a list of servers", "This function returns @script_to_run which is extracted from matching\n the desired script against all server templates or the script URL", "Takes the number of st's to search in,\n and reduces @op_scripts to only those who are\n repeated enough times.", "Returns all matching operational scripts in the st list passed", "Execute the user's command and provide for retrys etc.", "Allow user to verify results and retry if necessary", "Get the results from the QueueRunner and format them\n in a way that's easy to display to the user", "Completely process a non-interactive chimp object command\n This is used by chimpd, when processing a task.", "Connect to chimpd and wait for the work queue to empty, and\n prompt the user if there are any errors.", "Starts the Worker with the given connection or group name", "emulate click of the control identified by id", "Unfortunately the Tuner API track JSON doesn't include the musicId, a\n track identifier that's constant among different user sessions. However,\n we can fetch it via the Song's Explorer XML URL.", "In order to run the task, we need to call run_executable on ourselves", "Does all the CLI work", "Deletes records flagged for deletion on target and then delete the queue from source", "NOTUSED by islam", "An SMS was delivered.", "Creation of object hash when sending request to soap", "Checks that the the condition is met. This means the attribute identified\n by path_prefix and key_path satisfies the optional predicate, which when\n nil simply checks for existence.\n\n @param path_prefix [String]\n @param key_path [String]\n @param predicate [String|Regexp|Proc|NilClass]\n\n @returns [Boolean] True if :required_if condition is met, false otherwise\n\n @raise [AttributorException] When an unsupported predicate is passed", "Options we don't want to expose when describing attributes", "Validates stuff and checks dependencies", "Sorts an array of objects or hashes using a sort field. Sort is reversed with reverse_sort set to true.", "Pipes output of multiple commands recursively, given initial object", "Read a line from the console with edit and history.", "Set up the options", "Set up the prompt.", "for when there's no rails form object and you really just need inputs", "Returns the distance this object is from the given\n latitude and longitude.  Distance is as the crow flies.\n\n @param  lat [Float] [A latitude position]\n @param  long [Float] [A longitude position]\n\n @return [Float] [Distance from the input postion in miles]", "Allow hash keys to be used as methods", "This performs a cleanup of the reports to be flushed.\n We can decide later whether it is better to leave this responsibility\n to the caller of the method.\n\n Returns an array of hashes where each of them has a service_id,\n credentials, and a usage. The usage is another hash where the keys are\n the metrics and the values are guaranteed to respond to to_i and to_s.", "Join the passed-in name parts with the passed in separator.\n\n @param parts [Array<#to_s>]\n @param separator [#to_s] (ObjectInspector.configuration.flags_separator)", "Join the passed-in flags with the passed in separator.\n\n @param flags [Array<#to_s>]\n @param separator [#to_s] (ObjectInspector.configuration.flags_separator)", "Join the passed-in issues with the passed in separator.\n\n @param issues [Array<#to_s>]\n @param separator [#to_s] (ObjectInspector.configuration.issues_separator)", "Join the passed-in items with the passed in separator.\n\n @param items [Array<#to_s>]\n @param separator [#to_s] (ObjectInspector.configuration.info_separator)", "Auxiliar function to execute a block with other locale set", "A more humanised version of the maintenance window", "Fetch the latest ticker data\n\n @authenticated false\n @return [MtGox::Ticker]\n @example\n   MtGox.ticker", "Fetch both bids and asks in one call, for network efficiency\n\n @authenticated false\n @return [Hash] with keys :asks and :bids, which contain arrays as described in {MtGox::Client#asks} and {MtGox::Clients#bids}\n @example\n   MtGox.offers", "Fetch recent trades\n\n @authenticated false\n @return [Array<MtGox::Trade>] an array of trades, sorted in chronological order\n @example\n   MtGox.trades\n   MtGox.trades :since => 12341234", "Create a new order\n\n @authenticated true\n @param type [String] the type of order to create, either \"buy\" or \"sell\"\n @param amount [Numberic] the number of bitcoins to buy/sell\n @param price [Numeric or Symbol] the bid/ask price in USD, or :market if placing a market order\n @return [String] order ID for the order, can be inspected using order_result\n @example\n   # Sell one bitcoin for $123\n   MtGox.add_order! :sell, 1.0, 123.0", "Transfer bitcoins from your Mt. Gox account into another account\n\n @authenticated true\n @param amount [Numeric] the number of bitcoins to withdraw\n @param address [String] the bitcoin address to send to\n @return [String] Completed Transaction ID\n @example\n   # Withdraw 1 BTC from your account\n   MtGox.withdraw! 1.0, '1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L'", "Process pipes for Scientist", "Main method which processes all pipe commands, both default and user-defined ones.", "global_opt can come from Hirb callback or Scientist", "Validate the generated AIXM or OFMX atainst it's XSD and return the\n errors found.\n\n @return [Array<String>] validation errors", "Invoke command string even with namespaces", "Parse the children of a node", "Get the content from a node", "Invert an angle by 180 degrees\n\n @example\n   AIXM.a(120).invert     # => AIXM.a(300)\n   AIXM.a(\"34L\").invert   # => AIXM.a(\"16R\")\n   AIXM.a(\"33X\").invert   # => AIXM.a(\"33X\")\n\n @return [AIXM::A] inverted angle", "Returns a Hash. The keys are the reports and the values their associated\n async authorization tasks.", "create a new screen given a class name", "Renders Markdown in the current document\n\n It supports header 1-6, bold text, italic text, strikethrough and links\n\n It supports the same options as +Prawn::Document#text+\n\n   Prawn::Document.generate('markdown.pdf') do\n     markdown '# Welcome to Prawndown!'\n     markdown '**Important:** We _hope_ you enjoy your stay!'\n   end", "The line editor processing loop.", "A little more to the right please!", "Logs timing information about the rendering of a single view, template or\n partial.\n\n Unlike {#log_view_rendering_block}, this form does not expect a block.\n However, you are expected to pass timing information to the options\n hash.\n\n The `union_station_hooks_rails` gem automatically calls\n {#log_view_rendering_block} for you if your application is a Rails app.\n It will call this on every view or partial rendering.\n\n @option options [String] :name Name of the view, template or partial\n   that is being rendered.\n @option options [TimePoint or Time] :begin_time The time at which this\n   view rendering begun. See {UnionStationHooks.now} to learn more.\n @option options [TimePoint or Time] :end_time The time at which this view\n   rendering ended. See {UnionStationHooks.now} to learn more.\n @option options [Boolean] :has_error (optional) Whether an uncaught\n   exception occurred during the view rendering. Default: false.", "Strict conversion method for creating a `ComparableVersion` object out of\n anything that can be interpreted is a ComparableVersion.\n\n @param [Object] value the object to be converted\n\n @example\n   ComparableVersion(1)\n   # => #<ComparableVersion @major=1, @minor=nil, @tiny=nil, @patch=nil>\n\n   ComparableVersion(1.2)\n   # => #<ComparableVersion @major=1, @minor=2, @tiny=nil, @patch=nil>\n\n   ComparableVersion(\"1.2.3\")\n   # => #<ComparableVersion @major=1, @minor=2, @tiny=3, @patch=nil>\n\n   ComparableVersion([\"1\", \"2\", \"3\", \"4\"])\n   # => #<ComparableVersion @major=1, @minor=2, @tiny=3, @patch=4>", "Archives current target files to epub\n\n @param path [String] path to created archive\n\n @return [String] path", "Creates name of epub file for current book and current target\n\n @return [String] name of result epub file", "Repeatedly gets the list of eligable commits and runs TinyCI against them until there are no more remaining", "A couple json serialization methods copied from active_support", "Add an asset to the node.  Body must be empty.  Will upsert the asset if it doesn't exist\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.\n @param id id identifying a domain model\n @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.\n @param asset_id id of an asset\n @param [Hash] opts the optional parameters\n @return [AssetBody]", "Delete an Asset\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param asset_id id of an asset\n @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.\n @param [Hash] opts the optional parameters\n @return [nil]", "Get details of a given asset\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.\n @param asset_id id of an asset\n @param [Hash] opts the optional parameters\n @return [AssetBody]", "Get for assets in the relevant node\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.\n @param id id identifying a domain model\n @param [Hash] opts the optional parameters\n @option opts [Array<String>] :filter_asset_type type of asset to return. This filters the results by asset type, but returns all the assets associated with the result.\n @option opts [Float] :offset index to start result set from\n @option opts [Float] :limit number of records to return\n @return [AssetResultSet]", "Remove an asset from the relevant node\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.\n @param id id identifying a domain model\n @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.\n @param asset_id id of an asset\n @param [Hash] opts the optional parameters\n @return [nil]", "Create erb generator\n\n @param [Data] data\n   The data class to be used within the template\n Compile the template\n\n @param [IO] source\n   The source template to be used\n @param [IO] destination\n   The output io handle", "saves to the Solr index", "convert instance to Solr document", "Process text with remote web-service", "declares a class as solr-searchable\n\n ==== options:\n fields:: This option can be used to specify only the fields you'd\n          like to index. If not given, all the attributes from the\n          class will be indexed. You can also use this option to\n          include methods that should be indexed as fields\n\n           class Movie < ActiveRecord::Base\n             acts_as_solr :fields => [:name, :description, :current_time]\n             def current_time\n               Time.now.to_s\n             end\n           end\n\n          Each field passed can also be a hash with the value being a field type\n\n           class Electronic < ActiveRecord::Base\n             acts_as_solr :fields => [{:price => :range_float}]\n             def current_time\n               Time.now\n             end\n           end\n\n          The field types accepted are:\n\n          :float:: Index the field value as a float (ie.: 12.87)\n          :integer:: Index the field value as an integer (ie.: 31)\n          :boolean:: Index the field value as a boolean (ie.: true/false)\n          :date:: Index the field value as a date (ie.: Wed Nov 15 23:13:03 PST 2006)\n          :string:: Index the field value as a text string, not applying the same indexing\n                    filters as a regular text field\n          :range_integer:: Index the field value for integer range queries (ie.:[5 TO 20])\n          :range_float:: Index the field value for float range queries (ie.:[14.56 TO 19.99])\n\n          Setting the field type preserves its original type when indexed\n\n          The field may also be passed with a hash value containing options\n\n          class Author < ActiveRecord::Base\n            acts_as_solr :fields => [{:full_name => {:type => :text, :as => :name}}]\n            def full_name\n              self.first_name + ' ' + self.last_name\n            end\n          end\n\n          The options accepted are:\n\n          :type:: Index the field using the specified type\n          :as:: Index the field using the specified field name\n\n additional_fields:: This option takes fields to be include in the index\n                     in addition to those derived from the database. You\n                     can also use this option to include custom fields\n                     derived from methods you define. This option will be\n                     ignored if the :fields option is given. It also accepts\n                     the same field types as the option above\n\n                      class Movie < ActiveRecord::Base\n                       acts_as_solr :additional_fields => [:current_time]\n                       def current_time\n                         Time.now.to_s\n                       end\n                      end\n\n exclude_fields:: This option taks an array of fields that should be ignored from indexing:\n\n                    class User < ActiveRecord::Base\n                      acts_as_solr :exclude_fields => [:password, :login, :credit_card_number]\n                    end\n\n include:: This option can be used for association indexing, which\n           means you can include any :has_one, :has_many, :belongs_to\n           and :has_and_belongs_to_many association to be indexed:\n\n            class Category < ActiveRecord::Base\n              has_many :books\n              acts_as_solr :include => [:books]\n            end\n\n           Each association may also be specified as a hash with an option hash as a value\n\n           class Book < ActiveRecord::Base\n             belongs_to :author\n             has_many :distribution_companies\n             has_many :copyright_dates\n             has_many :media_types\n             acts_as_solr(\n               :fields => [:name, :description],\n               :include => [\n                 {:author => {:using => :fullname, :as => :name}},\n                 {:media_types => {:using => lambda{|media| type_lookup(media.id)}}}\n                 {:distribution_companies => {:as => :distributor, :multivalued => true}},\n                 {:copyright_dates => {:as => :copyright, :type => :date}}\n               ]\n             ]\n\n           The options accepted are:\n\n           :type:: Index the associated objects using the specified type\n           :as:: Index the associated objects using the specified field name\n           :using:: Index the associated objects using the value returned by the specified method or proc.  If a method\n                    symbol is supplied, it will be sent to each object to look up the value to index; if a proc is\n                    supplied, it will be called once for each object with the object as the only argument\n           :multivalued:: Index the associated objects using one field for each object rather than joining them\n                          all into a single field\n\n facets:: This option can be used to specify the fields you'd like to\n          index as facet fields\n\n           class Electronic < ActiveRecord::Base\n             acts_as_solr :facets => [:category, :manufacturer]\n           end\n\n boost:: You can pass a boost (float) value that will be used to boost the document and/or a field. To specify a more\n         boost for the document, you can either pass a block or a symbol. The block will be called with the record\n         as an argument, a symbol will result in the according method being called:\n\n           class Electronic < ActiveRecord::Base\n             acts_as_solr :fields => [{:price => {:boost => 5.0}}], :boost => 10.0\n           end\n\n           class Electronic < ActiveRecord::Base\n             acts_as_solr :fields => [{:price => {:boost => 5.0}}], :boost => proc {|record| record.id + 120*37}\n           end\n\n           class Electronic < ActiveRecord::Base\n             acts_as_solr :fields => [{:price => {:boost => :price_rating}}], :boost => 10.0\n           end\n\n if:: Only indexes the record if the condition evaluated is true. The argument has to be\n      either a symbol, string (to be eval'ed), proc/method, or class implementing a static\n      validation method. It behaves the same way as ActiveRecord's :if option.\n\n        class Electronic < ActiveRecord::Base\n          acts_as_solr :if => proc{|record| record.is_active?}\n        end\n\n offline:: Assumes that your using an outside mechanism to explicitly trigger indexing records, e.g. you only\n           want to update your index through some asynchronous mechanism. Will accept either a boolean or a block\n           that will be evaluated before actually contacting the index for saving or destroying a document. Defaults\n           to false. It doesn't refer to the mechanism of an offline index in general, but just to get a centralized point\n           where you can control indexing. Note: This is only enabled for saving records. acts_as_solr doesn't always like\n           it, if you have a different number of results coming from the database and the index. This might be rectified in\n           another patch to support lazy loading.\n\n             class Electronic < ActiveRecord::Base\n               acts_as_solr :offline => proc {|record| record.automatic_indexing_disabled?}\n             end\n\n auto_commit:: The commit command will be sent to Solr only if its value is set to true:\n\n                 class Author < ActiveRecord::Base\n                   acts_as_solr :auto_commit => false\n                 end\n\n dynamic_attributes: Default false. When true, requires a has_many relationship to a DynamicAttribute\n                     (:name, :value) model. Then, all dynamic attributes will be mapped as normal attributes\n                    in Solr, so you can filter like this: Model.find_by_solr \"#{dynamic_attribute.name}:Lorem\"\n\n taggable: Default false. When true, indexes tags with field name tag. Tags are taken from taggings.tag\n\n spatial: Default false. When true, indexes model.local.latitude and model.local.longitude as coordinates.", "Builds a map to enable getting references by type and id\n\n eg.\n {\n   \"users\" => {\n     \"1\" => { \"id\" => \"1\", \"name\" => \"John\" },\n     \"5\" => { \"id\" => \"5\", \"name\" => \"Walter\" },\n   }\n }", "Builds a map to translate references to types\n\n eg.\n { \"author\" => \"users\", \"comments\" => \"comments\" }", "track all task runs", "Constructor, allows injection of generic configuration params.\n\n @param working_dir [String] The working directory to execute against.\n @param commit [String] SHA1 of git object to run against\n @param logger [Logger] Logger object\n @param time [Time] Override time of object creation. Used solely for testing at this time.\n @param config [Hash] Override TinyCI config object, normally loaded from `.tinyci` file. Used solely for testing at this time.\n Runs the TinyCI system against the single git object referenced in `@commit`.\n\n @return [Boolean] `true` if the commit was built and tested successfully, `false` otherwise", "Instantiate the Builder object according to the class named in the config", "Instantiate the Hooker object according to the class named in the config", "Fetch playlist songs", "need start_at, ends_on", "Pass the command to run, and a timeout", "The primary resource is keyed per the request.", "Base method to send a request to Quora API.\n @param [required, string] supported field (or multiple fields CSV) to retrieve\n @param [optional, bool] filter if field is a key in result hash, only this\n       value is returned", "Override method_missing so any method that starts with \"get_\" will be\n defined.\n\n i.e.\n client.get_profile\n\n will generate =>\n\n def get_profile\n   get(\"profile\")\n end", "Logging controller-related information \n Logs that you are calling a web framework controller action. Of course,\n you should only call this if your web framework has the concept of\n controller actions. For example Rails does, but Sinatra and Grape\n don't.\n\n This form takes an options hash as well as a block. You can pass\n additional information about the web framework controller action, which\n will be logged. The block is expected to perform the actual request\n handling. When the block returns, timing information about the block is\n automatically logged.\n\n See also {#log_controller_action} for a form that doesn't\n expect a block.\n\n The `union_station_hooks_rails` gem automatically calls this for you\n if your application is a Rails app.\n\n @yield The given block is expected to perform request handling.\n @param [Hash] options Information about the controller action.\n   All options are optional.\n @option options [String] :controller_name\n   The controller's name, e.g. `PostsController`.\n @option options [String] :action_name\n   The controller action's name, e.g. `create`.\n @option options [String] :method\n   The HTTP method that the web framework thinks this request should have,\n   e.g. `GET` and `PUT`. The main use case for this option is to support\n   Rails's HTTP verb emulation. Rails uses a parameter named\n   [`_method`](http://guides.rubyonrails.org/form_helpers.html#how-do-forms-with-patch-put-or-delete-methods-work-questionmark)\n   to emulate HTTP verbs besides GET and POST. Other web frameworks may\n   have a similar mechanism.\n @return The return value of the block.\n\n @example Rails example\n   # This example shows what to put inside a Rails controller action\n   # method. Note that all of this is automatically done for you if you\n   # use the union_station_hooks_rails gem.\n   options = {\n     :controller_name => self.class.name,\n     :action_name => action_name,\n     :method => request.request_method\n   }\n   reporter.log_controller_action_block(options) do\n     do_some_request_processing_here\n   end", "Logs that you are calling a web framework controller action. Of course,\n you should only call this if your web framework has the concept of\n controller actions. For example Rails does, but Sinatra and Grape\n don't.\n\n You can pass additional information about the web framework controller\n action, which will be logged.\n\n Unlike {#log_controller_action_block}, this form does not expect a block.\n However, you are expected to pass timing information to the options\n hash.\n\n The `union_station_hooks_rails` gem automatically calls\n {#log_controller_action_block} for you if your application is a Rails\n app.\n\n @param [Hash] options Information about the controller action.\n @option options [String] :controller_name (optional)\n   The controller's name, e.g. `PostsController`.\n @option options [String] :action_name (optional if :controller_name\n   isn't set) The controller action's name, e.g. `create`.\n @option options [String] :method (optional)\n   The HTTP method that the web framework thinks this request should have,\n   e.g. `GET` and `PUT`. The main use case for this option is to support\n   Rails's HTTP verb emulation. Rails uses a parameter named\n   [`_method`](http://guides.rubyonrails.org/form_helpers.html#how-do-forms-with-patch-put-or-delete-methods-work-questionmark)\n   to emulate HTTP verbs besides GET and POST. Other web frameworks may\n   have a similar mechanism.\n @option options [TimePoint or Time] :begin_time The time at which the\n   controller action begun. See {UnionStationHooks.now} to learn more.\n @option options [TimePoint or Time] :end_time The time at which the\n   controller action ended. See {UnionStationHooks.now} to learn more.\n @option options [Boolean] :has_error (optional) Whether an uncaught\n   exception occurred during the request. Default: false.\n\n @example\n   # This example shows what to put inside a Rails controller action\n   # method. Note that all of this is automatically done for you if you\n   # use the union_station_hooks_rails gem.\n   options = {\n     :controller_name => self.class.name,\n     :action_name => action_name,\n     :method => request.request_method,\n     :begin_time => UnionStationHooks.now\n   }\n   begin\n     do_some_request_processing_here\n   rescue Exception\n     options[:has_error] = true\n     raise\n   ensure\n     options[:end_time] = UnionStationHooks.now\n     reporter.log_controller_action(options)\n   end", "Remove a vertex", "Make an edge between two vertices", "Find the edge connecting two vertices", "Returns whether two vertices are connected", "Finds instances of a model. Terms are ANDed by default, can be overwritten\n by using OR between terms\n\n Here's a sample (untested) code for your controller:\n\n  def search\n    results = Book.find_by_solr params[:query]\n  end\n\n For specific fields searching use :filter_queries options\n\n ====options:\n offset:: - The first document to be retrieved (offset)\n page:: - The page to be retrieved\n limit:: - The number of rows per page\n per_page:: - Alias for limit\n filter_queries:: - Use solr filter queries to sort by fields\n\n             Book.find_by_solr 'ruby', :filter_queries => ['price:5']\n\n sort:: - Orders (sort by) the result set using a given criteria:\n\n             Book.find_by_solr 'ruby', :sort => 'description asc'\n\n field_types:: This option is deprecated and will be obsolete by version 1.0.\n               There's no need to specify the :field_types anymore when doing a\n               search in a model that specifies a field type for a field. The field\n               types are automatically traced back when they're included.\n\n                 class Electronic < ActiveRecord::Base\n                   acts_as_solr :fields => [{:price => :range_float}]\n                 end\n\n facets:: This option argument accepts the following arguments:\n          fields:: The fields to be included in the faceted search (Solr's facet.field)\n          query:: The queries to be included in the faceted search (Solr's facet.query)\n          zeros:: Display facets with count of zero. (true|false)\n          sort:: Sorts the faceted resuls by highest to lowest count. (true|false)\n          browse:: This is where the 'drill-down' of the facets work. Accepts an array of\n                   fields in the format \"facet_field:term\"\n          mincount:: Replacement for zeros (it has been deprecated in Solr). Specifies the\n                     minimum count necessary for a facet field to be returned. (Solr's\n                     facet.mincount) Overrides :zeros if it is specified. Default is 0.\n\n          dates:: Run date faceted queries using the following arguments:\n            fields:: The fields to be included in the faceted date search (Solr's facet.date).\n                     It may be either a String/Symbol or Hash. If it's a hash the options are the\n                     same as date_facets minus the fields option (i.e., :start:, :end, :gap, :other,\n                     :between). These options if provided will override the base options.\n                     (Solr's f.<field_name>.date.<key>=<value>).\n            start:: The lower bound for the first date range for all Date Faceting. Required if\n                    :fields is present\n            end:: The upper bound for the last date range for all Date Faceting. Required if\n                  :fields is prsent\n            gap:: The size of each date range expressed as an interval to be added to the lower\n                  bound using the DateMathParser syntax.  Required if :fields is prsent\n            hardend:: A Boolean parameter instructing Solr what do do in the event that\n                      facet.date.gap does not divide evenly between facet.date.start and facet.date.end.\n            other:: This param indicates that in addition to the counts for each date range\n                    constraint between facet.date.start and facet.date.end, other counds should be\n                    calculated. May specify more then one in an Array. The possible options are:\n              before:: - all records with lower bound less than start\n              after:: - all records with upper bound greater than end\n              between:: - all records with field values between start and end\n              none:: - compute no other bounds (useful in per field assignment)\n              all:: - shortcut for before, after, and between\n            filter:: Similar to :query option provided by :facets, in that accepts an array of\n                     of date queries to limit results. Can not be used as a part of a :field hash.\n                     This is the only option that can be used if :fields is not present.\n\n Example:\n\n   Electronic.find_by_solr \"memory\", :facets => {:zeros => false, :sort => true,\n                                                 :query => [\"price:[* TO 200]\",\n                                                            \"price:[200 TO 500]\",\n                                                            \"price:[500 TO *]\"],\n                                                 :fields => [:category, :manufacturer],\n                                                 :browse => [\"category:Memory\",\"manufacturer:Someone\"]}\n\n\n Examples of date faceting:\n\n  basic:\n    Electronic.find_by_solr \"memory\", :facets => {:dates => {:fields => [:updated_at, :created_at],\n      :start => 'NOW-10YEARS/DAY', :end => 'NOW/DAY', :gap => '+2YEARS', :other => :before}}\n\n  advanced:\n    Electronic.find_by_solr \"memory\", :facets => {:dates => {:fields => [:updated_at,\n    {:created_at => {:start => 'NOW-20YEARS/DAY', :end => 'NOW-10YEARS/DAY', :other => [:before, :after]}\n    }], :start => 'NOW-10YEARS/DAY', :end => 'NOW/DAY', :other => :before, :filter =>\n    [\"created_at:[NOW-10YEARS/DAY TO NOW/DAY]\", \"updated_at:[NOW-1YEAR/DAY TO NOW/DAY]\"]}}\n\n  filter only:\n    Electronic.find_by_solr \"memory\", :facets => {:dates => {:filter => \"updated_at:[NOW-1YEAR/DAY TO NOW/DAY]\"}}\n\n\n\n scores:: If set to true this will return the score as a 'solr_score' attribute\n          for each one of the instances found. Does not currently work with find_id_by_solr\n\n            books = Book.find_by_solr 'ruby OR splinter', :scores => true\n            books.records.first.solr_score\n            => 1.21321397\n            books.records.last.solr_score\n            => 0.12321548\n\n lazy:: If set to true the search will return objects that will touch the database when you ask for one\n        of their attributes for the first time. Useful when you're using fragment caching based solely on\n        types and ids.\n\n relevance:: Sets fields relevance\n\n            Book.find_by_solr \"zidane\", :relevance => {:title => 5, :author => 2}", "It's used to rebuild the Solr index for a specific model.\n  Book.rebuild_solr_index\n\n If batch_size is greater than 0, adds will be done in batches.\n NOTE: If using sqlserver, be sure to use a finder with an explicit order.\n Non-edge versions of rails do not handle pagination correctly for sqlserver\n without an order clause.\n\n If a finder block is given, it will be called to retrieve the items to index.\n This can be very useful for things such as updating based on conditions or\n using eager loading for indexed associations.", "Sometimes SIGTERM causes Dir.mktmpdir to not properly delete the temp folder\n Remove 1 day old folders", "Returns a key that matches the parameter in a case-insensitive manner.\n\n @param key [String, Symbol]\n @return [Symbol]", "Time to second precision", "Convert value from SimpleDB String version to real ruby value.", "Calls HTTP HEAD on the URL template. It takes the +template_values+ hash and merges the values into the template.\n\n A template will contain a URL like this:\n   https://sandbox.familysearch.org/platform/tree/persons-with-relationships{?access_token,person}\n or\n   https://sandbox.familysearch.org/platform/tree/persons/{pid}/matches{?access_token}\n\n The {?person} type attributes in the first example will be passed as querystring parameters. These will automatically be URL Encoded\n by the underlying Faraday library that handles the HTTP request.\n\n The {pid} type attibutes will simply be substituted into the URL.\n\n *Note*: The +access_token+ parameter doesn't need to be passed here. This should be handled by the FamilySearch::Client's\n Authorization header.\n\n *Args*    :\n - +template_values+: A Hash object containing the values for the items in the URL template. For example, if the URL is:\n     https://sandbox.familysearch.org/platform/tree/persons-with-relationships{?access_token,person}\n   then you would pass a hash like this:\n     :person => 'KWQS-BBQ'\n   or\n     'person' => 'KWQS-BBQ'\n *Returns* :\n - +Faraday::Response+ object. This object contains methods +body+, +headers+, and +status+. +body+ should contain a Hash of the\n   parsed result of the request.\n *Raises*  :\n - +FamilySearch::Error::MethodNotAllowed+: if you call +head+ for a template that doesn't allow HEAD method.", "retrieves all individual student's details - you must use the DCID !!!\n @param params [Hash] - use either: {dcid: \"12345\"} or {id: \"12345\"}\n @return [Hash] - in the format of:\n { :student=>\n   { \"@expansions\"=> \"demographics, addresses, alerts, phones, school_enrollment, ethnicity_race, contact, contact_info, initial_enrollment, schedule_setup, fees, lunch\",\n     \"@extensions\"=> \"s_stu_crdc_x,activities,c_studentlocator,u_students_extension,u_studentsuserfields,s_stu_ncea_x,s_stu_edfi_x,studentcorefields\",\n     \"_extension_data\"=> {\n       \"_table_extension\"=> [\n         { \"recordFound\"=>false,\n           \"_field\"=> [\n             {\"name\"=>\"preferredname\", \"type\"=>\"String\", \"value\"=>\"Guy\"},\n             {\"name\"=>\"student_email\", \"type\"=>\"String\", \"value\"=>\"guy@las.ch\"}\n           ],\n           \"name\"=>\"u_students_extension\"\n         },\n         { \"recordFound\"=>false,\n           \"_field\"=> [\n             {\"name\"=>\"transcriptaddrzip\", \"type\"=>\"String\", \"value\"=>1858},\n             {\"name\"=>\"transcriptaddrcountry\", \"type\"=>\"String\", \"value\"=>\"CH\"},\n             {\"name\"=>\"transcriptaddrcity\", \"type\"=>\"String\", \"value\"=>\"Bex\"},\n             {\"name\"=>\"transcriptaddrstate\", \"type\"=>\"String\", \"value\"=>\"VD\"},\n             {\"name\"=>\"transcriptaddrline1\", \"type\"=>\"String\", \"value\"=>\"LAS\"},\n             {\"name\"=>\"transcriptaddrline2\", \"type\"=>\"String\", \"value\"=>\"CP 108\"}\n           ],\n           \"name\"=>\"u_studentsuserfields\"\n         }\n       ]\n     },\n     \"id\"=>7337,\n     \"local_id\"=>555807,\n     \"student_username\"=>\"guy807\",\n     \"name\"=>{\"first_name\"=>\"Mountain\", \"last_name\"=>\"BIV\"},\n     \"demographics\"=>{\"gender\"=>\"M\", \"birth_date\"=>\"2002-08-26\", \"projected_graduation_year\"=>2021},\n     \"addresses\"=>\"\",\n     \"alerts\"=>\"\",\n     \"phones\"=>\"\",\n     \"school_enrollment\"=> {\n       \"enroll_status\"=>\"A\",\n       \"enroll_status_description\"=>\"Active\",\n       \"enroll_status_code\"=>0,\n       \"grade_level\"=>9,\n       \"entry_date\"=>\"2018-06-22\",\n       \"exit_date\"=>\"2019-08-06\",\n       \"school_number\"=>2,\n       \"school_id\"=>2,\n       \"full_time_equivalency\"=>{\"fteid\"=>970, \"name\"=>\"FTE Admissions\"}\n     },\n     \"ethnicity_race\"=>{\"federal_ethnicity\"=>\"NO\"},\n     \"contact\"=>{\"guardian_email\"=>\"guydad@orchid.ch\"},\n     \"contact_info\"=>{\"email\"=>\"guy@las.ch\"},\n     \"initial_enrollment\"=>{\"district_entry_grade_level\"=>0, \"school_entry_grade_level\"=>0},\n     \"schedule_setup\"=>{\"next_school\"=>33, \"sched_next_year_grade\"=>10},\n     \"fees\"=>\"\",\n     \"lunch\"=>{\"balance_1\"=>\"0.00\", \"balance_2\"=>\"0.00\", \"balance_3\"=>\"0.00\", \"balance_4\"=>\"0.00\", \"lunch_id\"=>0}\n   }\n }\n @note the data within \"u_students_extension\" - is unique for each school", "build the api query - you can use splats to match any character\n @param params [Hash] - valid keys include: :status_code (or :enroll_status), :username, :last_name, :first_name, :student_id (or :local_id), :id (or :dcid)\n @return [String] - \"id==345;name.last_name==BA*\"", "Build the list of directories to compact according to the options", "Create a .tar.gz file from a directory\n Done in pure ruby to ensure portability", "Synchronously execute a command as a subprocess and return the output.\n\n @param [Array<String>] command The command line\n @param [String] label A label for debug and logging purposes\n\n @return [String] The output of the command\n @raise [SubprocessError] if the subprocess returns status > 0", "Synchronously execute a chain multiple commands piped into each other as a\n subprocess and return the output.\n\n @param [Array<Array<String>>] commands The command lines\n @param [String] label A label for debug and logging purposes\n\n @return [String] The output of the command\n @raise [SubprocessError] if the subprocess returns status > 0", "Synchronously execute a command as a subprocess and and stream the output\n to `STDOUT`\n\n @param [Array<String>] command The command line\n @param [String] label A label for debug and logging purposes\n @param [String] pwd Optionally specify a different working directory in which to execute the command\n\n @return [TrueClass] `true` if the command executed successfully\n @raise [SubprocessError] if the subprocess returns status > 0", "fetch a single property", "takes a long time to complete!", "version defaults to the current production version, which is pretty\n much always going to be the most meaningful thing to look at", "version defaults to current production version here too", "Lookup the `passenger-config` command, either by respecting the\n `PASSENGER_CONFIG` environment variable, or by looking it up in `PATH`.\n If the command cannot be found, the current process aborts with an\n error message.", "Unit tests must undo the Bundler environment so that the gem's\n own Gemfile doesn't affect subprocesses that may have their\n own Gemfile.", "Writes the given content to the file at the given path. If or or more\n parent directories don't exist, then they are created.", "Opens a debug shell. By default, the debug shell is opened in the current\n working directory. If the current module has the `prepare_debug_shell`\n method, that method is called before opening the debug shell. The method\n could, for example, change the working directory.\n\n This method does *not* raise an exception if the debug shell exits with\n an error.", "Asserts that something should eventually happen. This is done by checking\n that the given block eventually returns true. The block is called\n once every `check_interval` msec. If the block does not return true\n within `deadline_duration` secs, then an exception is raised.", "Asserts that something should never happen. This is done by checking that\n the given block never returns true. The block is called once every\n `check_interval` msec, until `deadline_duration` seconds have passed.\n If the block ever returns true, then an exception is raised.", "Create a user definde command\n @return [nil]\n @param [Symbol] name The user defined command name\n @param [Hash] options Options.\n @option options :blocking (false) Describe if the execution is blocking or non-blocking\n @option options :log_path (false) Path used to store logs # (dont store logs if no path specified)", "Method missing processing for the command processors", "Remove song from user library", "Get playlist by ID", "Create new user playlist", "Add song to favorites", "COMPARE ORIGINAL AND FORMATTED PHONE", "Initialize the classifier with sane defaults\n if customised data is not provided\n Adds a data point to the training data", "Adds the details of a cipher test to the Result object.\n @param version [Symbol] the SSL Version\n @param cipher [String] the SSL cipher\n @param key_length [Integer] the length of encryption key\n @param status [Symbol] :accepted or :rejected", "Configure a template for a given asset type\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.\n @param template_body template body\n @param [Hash] opts the optional parameters\n @return [TemplateBody]", "Delete a template for a given asset type\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.\n @param [Hash] opts the optional parameters\n @return [TemplateBody]", "update a template for a given asset type\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.\n @param template_body template body\n @param [Hash] opts the optional parameters\n @return [TemplateBody]", "def thr\n  count = (@ticks - @last_count).to_f\n  if @last_time.nil?\n    seconds = 0.001\n  else\n    seconds = Time.now - @last_time\n  end\n  thr = count / seconds\nend\ndef thr_msg\n  thr = self.thr\n  if @history.nil?\n    @history ||= [thr]\n  else\n    @history << thr\n    max_history ||= case\n                  when @ticks > 20\n                    count = @ticks - @last_count\n                    if @max\n                      times = @max / count\n                      num = times / 20\n                      num = 2 if num < 2\n                    else\n                      num = 10\n                    end\n                    count * num\n                  else\n                    20\n                  end\n    max_history = 30 if max_history > 30\n    max_history = 100\n    @history.shift if @history.length > max_history\n  end\n  @mean_max ||= 0\n  if @history.length > 3\n    w_mean = 0\n    total_w = 0\n    @history.each_with_index do |v,i|\n      c = i ** 10\n      w_mean += v * c\n      total_w += c\n    end\n    mean = @mean = w_mean.to_f / total_w\n    @mean_max = mean if mean > @mean_max\n  end\n  if mean.nil? or mean.to_i > 1\n    str = \"#{ Log.color :blue, thr.to_i.to_s } per sec.\"\n    str << \" #{ Log.color :yellow, mean.to_i.to_s } avg. #{Log.color :yellow, @mean_max.to_i.to_s} max.\" if @mean_max > 0\n  else\n    str = \"#{ Log.color :blue, (1/thr).ceil.to_s } secs each\"\n    str << \" #{ Log.color :yellow, (1/mean).ceil.to_s } avg. #{Log.color :yellow, (1/@mean_max).ceil.to_s} min.\" if @mean_max > 0\n  end\n  str\nend", "Initializes the scanner object\n @param host [String] IP address or hostname to scan\n @param port [Integer] Port number to scan, default: 443\n @param timeout [Integer] Timeout for connections, in seconds. default: 5\n @raise [StandardError] Raised when the configuration is invalid\n Checks whether the scanner option has a valid configuration\n @return [Boolean] True or False, the configuration is valid.", "Initiate the Scan against the target. Will test each cipher one at a time.\n @return [Result] object containing the details of the scan", "Retrieve the X509 Cert from the target service,\n @param ssl_version [Symbol] The SSL version to use (:SSLv2,  :SSLv3, :TLSv1)\n @param cipher [String] The SSL Cipher to use\n @return [OpenSSL::X509::Certificate] if the certificate was retrieved\n @return [Nil] if the cert couldn't be retrieved", "Validates that the SSL Version and Cipher are valid both seperately and\n together as part of an SSL Context.\n @param ssl_version [Symbol] The SSL version to use (:SSLv2,  :SSLv3, :TLSv1)\n @param cipher [String] The SSL Cipher to use\n @raise [StandardError] If an invalid or unsupported SSL Version was supplied\n @raise [StandardError] If the cipher is not valid for that version of SSL", "Logs the begin of a user-defined activity, for display in the\n activity timeline.\n\n An activity is a block in the activity timeline in the Union Station\n user interace. It has a name, a begin time and an end time.\n\n This form logs only the name and the begin time. You *must* also\n call {#log_user_activity_end} later with the same name to log the end\n time.\n\n @param name The name that should show up in the activity timeline.\n   It can be any arbitrary name but may not contain newlines.\n @return id An ID which you must pass to {#log_user_activity_end} later.", "Logs the end of a user-defined activity, for display in the\n activity timeline.\n\n An activity is a block in the activity timeline in the Union Station\n user interace. It has a name, a begin time and an end time.\n\n This form logs only the name and the end time. You *must* also\n have called {#log_user_activity_begin} earlier with the same name to log\n the begin time.\n\n @param id The ID which you obtained from {#log_user_activity_begin}\n   earlier.\n @param [Boolean] has_error Whether an uncaught\n   exception occurred during the activity.", "Logs a user-defined activity, for display in the activity timeline.\n\n An activity is a block in the activity timeline in the Union Station\n user interace. It has a name, a begin time and an end time.\n\n Unlike {#log_user_activity_block}, this form does not expect a block.\n However, you are expected to pass timing information.\n\n @param name The name that should show up in the activity timeline.\n   It can be any arbitrary name but may not contain newlines.\n @param [TimePoint or Time] begin_time  The time at which this activity\n   begun. See {UnionStationHooks.now} to learn more.\n @param [TimePoint or Time] end_time The time at which this activity\n   ended. See {UnionStationHooks.now} to learn more.\n @param [Boolean] has_error Whether an uncaught\n   exception occurred during the activity.", "Logs an exception that occurred during a request.\n\n If you want to use an exception that occurred outside the\n request/response cycle, e.g. an exception that occurred in a thread,\n use {UnionStationHooks.log_exception} instead.\n\n If {#log_controller_action_block} or {#log_controller_action}\n was called during the same request, then the information passed to\n those methods will be included in the exception report.\n\n @param [Exception] exception", "Logs a database query that was performed during the request.\n\n @option options [String] :name (optional) A name for this database\n   query activity. Default: \"SQL\"\n @option options [TimePoint or Time] :begin_time The time at which this\n   database query begun. See {UnionStationHooks.now} to learn more.\n @option options [TimePoint or Time] :end_time The time at which this\n   database query ended. See {UnionStationHooks.now} to learn more.\n @option options [String] :query The database query string.", "Combine scores for each pair of records via mean, then compare the\n combined score to the threshold. Notify observers if there's a match.", "Check that `value` can be uped through the supertype, then verify all\n constraints. Raise an error if anything goes wrong.", "login with Quora user and password", "Total empty space left over by uneven packing.", "moves the tallest bin to the middle", "Direct API access\n @param verb [Symbol] hmtl verbs (:delete, :get, :patch, :post, :put)\n @param options [Hash] allowed keys are {query: {}, body: {}} - uses :query for gets, and use :body for put and post\n @return [HTTParty] - useful things to access include: obj.parsed_response (to access returned data) & obj.code to be sure the response was successful \"200\"", "gets API auth token and puts in header HASH for future requests with PS server\n @return [Hash] - of auth token and time to live from powerschol server\n {'access_token' => \"addsfabe-aads-4444-bbbb-444411ffffbb\",\n  'token_type' => \"Bearer\",\n  'expires_in' => \"2504956\"\n  'token_expires' => (Time.now + 3600)}\n @note - to enable PS API - In PowerSchool go to System>System Settings>Plugin Management Configuration>your plugin>Data Provider Configuration to manually check plugin expiration date", "Generates an interface for the +apps+ endpoint.", "Generates the interface for the +orders+ endpoint. Supply an order UUID if\n you would like to access endpoints for a specific order, otherwise, supply\n no parameters.", "Consume all records from a topic. Each record will be yielded\n to block along with consumer instance. Will listen to topic\n after all records have been consumed.\n\n topic  - topic to consume from [String]\n yields - record, consumer [String, Kafka::Consumer]\n return - [nil]", "Creates an object just like sudo_create but calls save! instead of save so an exception is raised if the record is invalid\n\n ==== Example\n   # Create a single new object where admin is a protected attribute\n   User.sudo_create!(:first_name => 'Pete', :admin => true)", "Returns a new instance of Field.\n\n @param [Symbol] name The field's name\n @param [Hash] schema The field's schema information\n Convert the column schema information to a hash of column options, one of\n which is `:type`. The other options modify that type (e.g. `:size`).\n\n Here are some examples:\n\n | Database type    | Ruby type          | Other modifiers       |\n |------------------|--------------------|-----------------------|\n | mediumint        | Fixnum             |                       |\n | smallint         | Fixnum             |                       |\n | int              | Fixnum             |                       |\n | int(10) unsigned | Bignum             |                       |\n | tinyint          | TrueClass, Integer |                       |\n | bigint           | Bignum             |                       |\n | real             | Float              |                       |\n | float            | Float              |                       |\n | double           | Float              |                       |\n | boolean          | TrueClass          |                       |\n | text             | String             | text: true            |\n | date             | Date               |                       |\n | datetime         | DateTime           |                       |\n | timestamp        | DateTime           |                       |\n | time             | Time               | only_time: true       |\n | varchar(255)     | String             | size: 255             |\n | char(10)         | String             | size: 10, fixed: true |\n | money            | BigDecimal         | size: [19, 2]         |\n | decimal          | BigDecimal         |                       |\n | numeric          | BigDecimal         |                       |\n | number           | BigDecimal         |                       |\n | blob             | File               |                       |\n | year             | Integer            |                       |\n | identity         | Integer            |                       |\n | **other types**  | String             |                       |\n\n @note This method is copied from\n   {http://sequel.jeremyevans.net/rdoc-plugins/classes/Sequel/SchemaDumper.html `Sequel::SchemaDumper`}.\n @return [Hash]", "Creates a new Observer object\n Called by the Observable module through Webcrawler.", "Answers a call given a skype Call ID.  Returns an Array of Call objects.", "Since SimpleDB supports multiple attributes per value, the values are an array.\n This method will return the value unwrapped if it's the only, otherwise it will return the array.", "Check each entry in order from array", "Provide relevant inspect information", "Updates the scheduled time", "Update the time period of the repeating event\n\n @param schedule [String] a standard CRON job line or a human readable string representing a time period.", "Create a repeating event that occurs each time period\n\n @param time [String] a human readable string representing the time period. 3w2d4h1m2s for example.\n @param callback [Proc] a block or method to execute when the event triggers\n @return [::UV::Repeat]", "Create a one off event that occurs after the time period\n\n @param time [String] a human readable string representing the time period. 3w2d4h1m2s for example.\n @param callback [Proc] a block or method to execute when the event triggers\n @return [::UV::OneShot]", "Create a one off event that occurs at a particular date and time\n\n @param time [String, Time] a representation of a date and time that can be parsed\n @param callback [Proc] a block or method to execute when the event triggers\n @return [::UV::OneShot]", "Create a repeating event that uses a CRON line to determine the trigger time\n\n @param schedule [String] a standard CRON job line.\n @param callback [Proc] a block or method to execute when the event triggers\n @return [::UV::Repeat]", "Schedules an event for execution\n\n @param event [ScheduledEvent]", "Removes an event from the schedule\n\n @param event [ScheduledEvent]", "Remove an element from the array", "Ensures the current timer, if any, is still\n accurate by checking the head of the schedule", "Is called when the libuv timer fires", "Define a new Stately state machine.\n\n As an example, let's say you have an Order object and you'd like an elegant state machine for\n it. Here's one way you might set it up:\n\n     Class Order do\n       stately start: :processing do\n         state :completed do\n           prevent_from :refunded\n\n           before_transition from: :processing, do: :calculate_total\n           after_transition do: :email_receipt\n\n           validate :validates_credit_card\n         end\n\n         state :invalid do\n           prevent_from :completed, :refunded\n         end\n\n         state :refunded do\n           allow_from :completed\n\n           after_transition do: :email_receipt\n         end\n       end\n     end\n\n This example is doing quite a few things, paraphrased as:\n\n   * It sets up a new state machine using the default state attribute on Order to store the\n     current state. It also indicates the initial state should be :processing.\n   * It defines three states: :completed, :refunded, and :invalid\n   * Order can transition to the completed state from all but the refunded state. Similar\n     definitions are setup for the other two states.\n   * Callbacks are setup using before_transition and after_transition\n   * Validations are added. If a validation fails, it prevents the transition.\n\n Stately tries hard not to surprise you. In a typical Stately implementation, you'll always have\n an after_transition, primarily to call save (or whatever the equivalent is to store the\n instance's current state).", "input is needed for the `TestRunner` so it can use it with stubbing\n otherwise it is ignored when building a local cmd", "input and given opts are needed for the `TestRunner` so it can use it with\n stubbing otherwise they are ignored when building a remote cmd", "Defines several new targets with same configuration\n\n @param [Array<String, Symbol>] names\n\n @return [Array<Target>] result target", "Creates a new HTTP wrapper to handle the network portions of the API requests\n @param [Hash] args Same as [SmugMug::HTTP]", "Generates an OAuth signature and updates the args with the required fields\n @param [String] method HTTP method that the request is sent as\n @param [String] uri Full URL of the request\n @param [Hash] form_args Args to be passed to the server", "Find user by ID", "Find user by username", "Get popular songs\n type => daily, monthly", "Get top broadcasts\n count => specifies how many broadcasts to get", "Perform search request for query", "Get stream authentication by song ID", "Perform API request", "Configure a provider for the oeffi module\n\n Possible providers:\n :atc, :avv, :bahn, :bayern, :bsag, :bsvag, :bvb, :bvg, :ding, :dsb, :dub, :eireann, :gvh, :invg, :ivb,\n :kvv, :linz, :location, :lu, :maribor, :met, :mvg, :mvv, :naldo, :nasa, :nri, :ns, :nvbw, :nvv, :oebb,\n :pl, :rt, :sad, :sbb, :se, :septa, :sf, :sh, :sncb, :stockholm, :stv, :svv, :sydney, :tfi, :tfl, :tlem,\n :tlsw, :tlwm, :vagfr, :vbb, :vbl, :vbn, :vgn, :vgs, :vmobil, :vms, :vmv, :vor, :vrn, :vrr, :vrt, :vvm,\n :vvo, :vvs, :vvt, :vvv, :wien, :zvv", "COMPARE ORIGINAL AND FORMATTED ADR", "FORMAT FULL ADDRESS", "Registers a new view hook\n @param name [String]\n @param options [Hash] for Defaced", "Add a node\n @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.\n @param body node\n @param [Hash] opts the optional parameters\n @return [NodeBody]", "Delete a node\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param id id identifying a domain model\n @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.\n @param [Hash] opts the optional parameters\n @return [nil]", "Get details of a given node\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param id id identifying a domain model\n @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.\n @param [Hash] opts the optional parameters\n @option opts [Array<String>] :include comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets\n @return [NodeBody]", "Replaces the node with the data sent in the body\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param id id identifying a domain model\n @param body node\n @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.\n @param [Hash] opts the optional parameters\n @return [NodeBody]", "Perform a partial update of a node\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param id id identifying a domain model\n @param body node\n @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.\n @param [Hash] opts the optional parameters\n @return [NodeBody]", "Download the cookbook from the remote hg repository\n\n @return void", "Perform a mercurial command.\n\n @param [String] command\n   the command to run\n @param [Boolean] error\n   whether to raise error if the command fails\n\n @raise [String]\n   the +$stdout+ from the command", "The path where this hg repository is cached.\n\n @return [Pathname]", "create the session for the user using the password strategy and returning the user JSON", "destroy the session for the user using params id", "Checks if a file already exists in the site source", "Should always comes from the admin tool", "Write config data to config file.", "Symbolizes keys. Changes `database` key to `database_dir`.", "Default configuration data.", "Returns a Trustlines object for this account.\n @return [Trustlines]\n @raise [RippleRestError] if RippleRest server returns an error\n @raise [ProtocolError] if protocol is wrong or network is down", "Returns a AccountSettings object for this account.\n @return [AccountSettings]\n @raise [RippleRestError] if RippleRest server returns an error\n @raise [ProtocolError] if protocol is wrong or network is down", "Returns a Payments object for this account.\n @return [Payments]", "Query `rippled` for possible payment \"paths\" through the Ripple Network to deliver the given amount to the specified `destination_account`. If the `destination_amount` issuer is not specified, paths will be returned for all of the issuers from whom the `destination_account` accepts the given currency.\n @param destination_account [String, Account] destination account\n @param destination_amount [String, Amount] destination amount\n @param source_currencies [Array<String>] an array of source currencies that can be used to constrain the results returned (e.g. `[\"XRP\", \"USD+r...\", \"BTC+r...\"]`) Currencies can be denoted by their currency code (e.g. USD) or by their currency code and issuer (e.g. `USD+r...`). If no issuer is specified for a currency other than XRP, the results will be limited to the specified currencies but any issuer for that currency will do.\n @raise [RippleRestError] if RippleRest server returns an error\n @raise [ProtocolError] if protocol is wrong or network is down\n @return [Array<Payment>]", "Create a Payment object with some field filled.\n @return [Payment]", "Browse historical payments in bulk.\n @option options [String, Account] :source_account If specified, limit the results to payments initiated by a particular account\n @option options [String, Account] :destination_account If specified, limit the results to payments made to a particular account\n @option options [Boolean] :exclude_failed if set to true, this will return only payment that were successfully validated and written into the Ripple Ledger\n @option options [String] :start_ledger If earliest_first is set to true this will be the index number of the earliest ledger queried, or the most recent one if earliest_first is set to false. Defaults to the first ledger the rippled has in its complete ledger. An error will be returned if this value is outside the rippled's complete ledger set\n @option options [String] :end_ledger If earliest_first is set to true this will be the index number of the most recent ledger queried, or the earliest one if earliest_first is set to false. Defaults to the last ledger the rippled has in its complete ledger. An error will be returned if this value is outside the rippled's complete ledger set\n @option options [Boolean] :earliest_first Determines the order in which the results should be displayed. Defaults to true\n @option options [Fixnum] :results_per_page Limits the number of resources displayed per page. Defaults to 20\n @option options [Fixnum] :page The page to be displayed. If there are fewer than the results_per_page number displayed, this indicates that this is the last page\n @raise [RippleRestError] if RippleRest server returns an error\n @raise [ProtocolError] if protocol is wrong or network is down\n @return [Array<Payment>]", "Parse and handle command line options", "Returns image tag for an object's attachment, with optional link element wrapped around it.\n\n   @param Object                   - Required\n   @param String :alt              - Defaults to object.title\n   @param String :title\n   @param String :class\n   @param String :style\n   @param String :dimensions       - Dragonfly-esque dimensions... @see http://markevans.github.com/dragonfly/file.Processing.html\n   @param String :link             - Destination for link_to tag\n   @param Symbol :encode           - :gif, :jpg, :png, etc. Defaults to :png\n   @param Object :object           - Dragonfly object, defaults to object.file\n   @param Boolean :video           - Link to an iframe lightbox?\n   @param String :video_dimensions - (width)x(height), defaults to 500x350", "get a template for a given asset type\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.\n @param [Hash] opts the optional parameters\n @return [TemplateBody]", "Measures the silhouette coefficient of a cluster compared to all other clusters\n Returns the average silhouette coefficient of a cluster", "Calculates the a1 value of a cluster", "Converts field types into Solr types", "Sends an add command to Solr", "Sends the delete command to Solr", "escape everything properly; run in sh to ensure full profile is loaded", "Force convert to array of files if glob pattern", "Return introspect object that can be delivered to openplacos server", "Push pin to component", "Let's rock! Run the component", "Parse inputs and outputs to communicate with server", "Print an error message and make the server quit", "Makes a face with num_edges edges, which will be attached to nothing.", "This adds a face that will be attached to the given vertices\n   Make sure the vertices are connected, or it will raise an error\n All new vertices and edges will be created\n This will automatically make_neighbors with any faces that share\n   a vertex with the new face", "Return all faces containing the given vertices", "Return all neighbors of the given faces\n Neighbor is defined as sharing a vertex,\n not necessarily sharing an edge.", "COMPARE ORIGINAL AND FORMATTED PROPER", "Invoke `dress` on each candidate type in turn. Return the value\n returned by the first one that does not fail. Fail with an TypeError if no\n candidate succeeds at tranforming `value`.", "For training data points we make sure all the features\n are added to the feature list", "Add an integration\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param body integration\n @param [Hash] opts the optional parameters\n @return [IntegrationBody]", "Delete an integration\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param integration_id id of an integration\n @param integration_type Type of external integration, e.g. &#39;lti1&#39;\n @param [Hash] opts the optional parameters\n @return [nil]", "Get details of a given integration\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param integration_type Type of external integration, e.g. &#39;lti1&#39;\n @param integration_id id of an integration\n @param [Hash] opts the optional parameters\n @return [IntegrationBody]", "Replace an integration\n @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.\n @param integration_id id of an integration\n @param integration_type Type of external integration, e.g. &#39;lti1&#39;\n @param body integration\n @param [Hash] opts the optional parameters\n @return [IntegrationBody]", "Returns the absolute path to the root of the current git directory\n\n @return [String] the path", "Parses the data returned from Solr", "Reorders the instances keeping the order returned from Solr", "Adds the score to each one of the instances found", "COMPARE ORIGINAL AND FORMATTED URL", "Supporting Methods Below", "Packs a single element with a given height into a column.\n\n pack_element should be called withing pack_in_columns's block:\n\n   pack_in_columns(3) do\n     pack_element(100) do\n       \"A\"\n     end\n  end\n\n Accepts parameter strings or block content (ERB, strings, etc).", "prepare data to update student database extensions\n @param data [Hash] - with the format: {u_students_extension: {field1: data1, field2: data2}}\n @return [Hash] - with data like below:\n { \"name\"=>\"u_students_extension\",\n   \"recordFound\"=>false,\n   \"_field\"=> [\n     {\"name\"=>\"preferredname\", \"type\"=>\"String\", \"value\"=>\"Joe\"},\n     {\"name\"=>\"student_email\", \"type\"=>\"String\", \"value\"=>\"joe@las.ch\"},\n   ]\n }", "prepare data to built-in database extensions\n @param data [Hash] - with the format: {u_studentsuserfields: {field1: data1, field2: data2}}\n @return [Hash] - with data like below:\n { \"name\"=>\"u_students_extension\",\n   \"recordFound\"=>false,\n   \"_field\"=> [\n     {\"name\"=>\"transcriptaddrzip\", \"type\"=>\"String\", \"value\"=>75230},\n     {\"name\"=>\"transcriptaddrcountry\", \"type\"=>\"String\", \"value\"=>\"United States\"},\n     {\"name\"=>\"transcriptaddrcity\", \"type\"=>\"String\", \"value\"=>\"dallas\"},\n     {\"name\"=>\"transcriptaddrstate\", \"type\"=>\"String\", \"value\"=>\"Texas\"},\n     {\"name\"=>\"transcriptaddrline1\", \"type\"=>\"String\", \"value\"=>\"6138 meadow rd\"}\n   ]\n }", "strip a ! from the end of a +String+ or +Symbol+", "camel-case a +String+", "camel-case the keys of a +Hash+", "given an exploded qname, apply a given namespace and uri if the qname\n has no namespace already", "given an exploded qname, camelize the local_part", "check the response codes of an Exchange Web Services request.\n the supplied block makes a SOAP request, and the response is parsed\n out and checked", "check the status of the response of a single part of a multi-part request", "Fetch the attribute on `arg`, which is expected to be a Hash object.\n\n This method allows working with ruby hashes having either Symbols or\n Strings as keys. It ensures that no Symbol is created by the rest of the\n code, since this would provide a DoS attack vector under MRI.", "return rondom sentences from word resource\n\n @param [Fixnum] total count of sentence\n @return [String] words", "Invokes SET command for a given object with id, property and value\n @param[String] property Property to be set\n @param[String] value Property value", "Sub and union", "Tuples and relations", "Get a placeholder image, using placehold.it by default\n @param [String] size\n @param [Hash] options\n @return [String]", "Save the account settings\n @raise [ArgumentError] if secret is missing from the Account object\n @raise [RippleRestError] if RippleRest server returns an error\n @raise [ProtocolError] if protocol is wrong or network is down\n @return [void]", "Submits a payment\n @return [String] Client resource ID\n @raise [ArgumentError] if secret is missing from the Account object\n @raise [RippleRestError] if RippleRest server returns an error\n @raise [ProtocolError] if protocol is wrong or network is down", "return a list of Item objects given a hash formed from an Items element", "return a list of Item objects from a list of GetItemResponseMessages", "Performs White Similarity comparison against the keys, and gives the\n value of the closest match.\n\n @param value [String] a string value to compare to the hash map keys.\n @param threshold [Float] the value at which a string is considered to\n   be a match\n\n @return [RDF::Vocabulary::Term, nil] the closest DCMI type match, or `nil`\n   if none is sufficiently close\n\n @see Text::WhiteSimilarity\n @see http://www.catalysoft.com/articles/strikeamatch.html article defining\n   the White Similarity algorithm\n\n @todo consider text similarity algorithms/strategies and move text\n   matching to a utility and behind a Facade interface.", "index action, this set a collection of objects to an instance variable\n which can be accessed from the view using the collection helper method.\n The instance variable name is a pluralization of the model name defined\n in the restful macro.", "create action, creates a new object off the received params and sets an\n instance variable if record is saved then a redirect to index action is\n made.\n\n If record fail to be saved, the new form is renderd and the instance\n variable can be accessed from the view using the resource\n helper method. The instance variable is named after the model name\n defined in the restful macro.", "Extract a page's worth of records from a Primo XML search result.\n @param xml [String] an XML document returned from a Primo search\n @return [Array] an array of @record_class instances", "Overridable method for available sortable fields", "Overridable method for available filterable fields", "Constructs a text status report", "Generate a format string to justify all values", "Generate a header string", "Extracts the year and month from the given XML element.\n\n @param [Nokogiri::XML::Element] element The XML element.\n @return [Array<Integer, Integer>] An Array consisting of year and month.", "Extracts the date from the given XML element.\n\n @param [Nokogiri::XML::Element] element The XML element.\n @return [Date]", "Extracts the date and time from the given XML element.\n\n @param [Nokogiri::XML::Element] element The XML element.\n @return [DateTime]", "Extracts the bytes received and sent from the given XML element.\n\n @param [Nokogiri::XML::Element] element The XML element.\n @return [Array<Integer, Integer>] An Array consisting of bytes received\n   and bytes sent.", "todo... document this", "HTTP GET method\n\n @param [String] path", "HTTP PUT method\n\n @param [String] path", "HTTP POST method\n\n @param [String] path", "HTTP DELETE method\n\n @param [String] path", "Chart\n A Chart is chosen by Pollster editors. One example is \\\"Obama job approval - Democrats\\\". It is always based upon a single Question.  Users should strongly consider basing their analysis on Questions instead. Charts are derived data; Pollster editors publish them and change them as editorial priorities change.\n @param slug Unique identifier for a Chart\n @param [Hash] opts the optional parameters\n @return [Chart]", "Poll\n A Poll on Pollster is a collection of questions and responses published by a reputable survey house. This endpoint provides raw data from the survey house, plus Pollster-provided metadata about each question.  Pollster editors don't include every question when they enter Polls, and they don't necessarily enter every subpopulation for the responses they _do_ enter. They make editorial decisions about which questions belong in the database.\n @param slug Unique Poll identifier. For example: &#x60;gallup-26892&#x60;.\n @param [Hash] opts the optional parameters\n @return [Poll]", "Returns the Float value of rate or nil", "Log a message, tagged for application-wide consistency\n\n @param [Symbol] priority  a priority tag\n @param [string] msg  the message to log", "Takes OSGB36 or TM75 Latitude and Longitude coords\n and returns WGS84 Latitude and Longitude", "Populates a timespan with a begin and end date.\n\n @param timespan [DPLA::MAP::TimeSpan]\n\n @return [DPLA::MAP::TimeSpan]", "Converts an EDTF date to a begin and end date.\n\n @param date [Date, DateTime, EDTF::Interval] a date, with or without EDTF\n   precision features; or an interval.\n\n @return [Array<Date, DateTime>] an array of two elements containing the\n   begin and end dates.", "Reduces a timespan with multiple begin or end dates to a single earliest\n begin date and a single latest end date.\n\n @param timespan [DPLA::MAP::TimeSpan] the timespan to reduce\n\n @return [DPLA::MAP::TimeSpan] an updated timespan", "Runs the block, setting the start and end time of the run. The given block\n is passed an instance of the agent, and a URI representing this Activity.\n\n Handles logging of activity start/stop and failure states.\n\n @raise [RuntimeError] re-raises logged errors on Activity failure", "Logout from Emailvision API\n\n @return [Boolean] true if the connection has been destroyed", "Make the actual call to the prowl api", "Get the aggregation, populated with data from Marmotta, which corresponds\n to this SearchIndexDocument\n @return [DPLA::MAP::Aggregation, nil]", "Performs a lookup for the given filename and returns the most specific\n folder that contains the file.", "The inheritance path of controllers that is used as default lookup path.", "Performs a lookup for a template folder using the cache.", "A simple template lookup cache for each controller.", "Gets the prefix from the cache. Returns nil if it's not there yet.", "Stores the found prefix in the cache.", "Perform a template lookup if the prefix corresponds to the current controller's path.", "Adds the given value to the hash\n Flushes expired data to DB", "Creates a new Meter and stores is in the hash", "Add a ChildDeclaration to this mapping\n\n @param [Symbol] name\n @param [Hash] opts accepts options; expected options: :class\n\n @return [ChildDeclaration]", "Add a PropertyDeclaration to this mapping\n\n @param [Symbol] name\n @param [Hash] value ; defaults to nil\n\n @return [ChildDeclaration]", "Serialize the packet to an array of bytes.", "The final request to ESPN api after all option parsing has been completed.\n @return [HeadlineResponse] a headline response object.", "Attempts to parse a string into a valid EDTF or `Date` format.\n\n   - Attempts to split `#providedLabel` on '-', '/', '..', 'to', 'until', and\n     looks for EDTF and `Date.parse` patterns on either side, setting them to\n     `#begin` and `#end`. Both split and unsplit dates are parsed as follows:\n   - Attempts to parse `#providedLabel` as an EDTF interval and populates\n     begin and end with their respective values.\n   - Attempts to match to a number of regular expressions which specify\n     ranges informally.\n   - Attempts to parse `#providedLabel` as a single date value with\n     `Date.parse` and enters that value to both `#begin` and `#end`.\n\n @param date_str [String] a string which may contain a date range\n @param allow_interval [Boolean] a flag specifing whethe to use\n   #range_match to look for range values.\n\n @return [Date, EDTF::Epoch, EDTF::Interval, nil] the date parsed or nil\n @see http://www.loc.gov/standards/datetime/", "Matches a wide variety of date ranges separated by '..' or '-'\n\n @param str [String] a string which may contain a date range\n @return [Array(String)] the begining and ending dates of an identified\n    range", "Preprocess the date string to remove extra whitespace and convert ad hoc\n formatting to equivalent EDTF.\n\n @todo should '-` be intepreted as 'x' or '?'\n @see http://www.loc.gov/standards/datetime/pre-submission.html#maskedprecision", "Remove 'circa' or 'about' or variations and return an uncertian ETDF\n dates.\n\n @param str [String]\n @return [Date, nil] an EDTF date, marked uncertian; or `nil`\n @see #parse", "Execute this manifest, applying all resources defined. Execute returns\n true if successfull, and false if unsucessfull. By default, this\n will only execute a manifest that has not already been executed?.\n The +force+ argument, if true, removes this check.", "Execute this manifest, applying all resources defined. Execute returns\n true if successfull, and raises an exception if not. By default, this\n will only execute a manifest that has not already been executed?.\n The +force+ argument, if true, removes this check.", "Evaluate the methods calls queued in self.recipes", "Create a reference to another Puppet Resource.", "Creates a new Puppet Resource and adds it to the Catalog.", "Renders the index view, giving `@validation_reports` and `@qa_reports`\n for the specified provider.", "Overloaded method to return all the attributes from the\n sale + billing + shipping objects.\n\n @return [Hash]\n   Filled attributes with the original Alpha Card Services\n   transaction variables names.\n\n @example\n   billing = AlphaCard::Billing.new(email: 'test@example.com')\n   shipping = AlphaCard::Shipping.new(first_name: 'John', last_name: 'Doe')\n   order = AlphaCard::Order.new(id: '1', billing: billing, shipping: shipping)\n   order.attributes_for_request\n\n   #=>  { orderid: '1', email: 'test@example.com', shipping_first_name: 'John', shipping_last_name: 'Doe' }", "Lets get revoking", "Ensure the value is returned with the correct type\n @param [String, Symbol, nil] value\n @return [String, Symbol, nil]", "Check if the provided `fallback` is valid\n\n @param [String, Symbol, nil] fallback", "Set the default fallback value.\n\n @param [String, Symbol, nil] fallback\n @return [void]", "Profiles a block, capturing information on the garbage collector. The\n return value is an Array containing the result of the yielded block\n and a String with a report on the profiling results.\n\n Options:\n\n * +:disable_gc+ - disables garbage collection for the duration of the\n   block and then renables it immediately afterwards. This allows you to\n   control when GC is run and see the results.\n * +:title+ - a title to use for logging.\n\n More options for this method can be found in the default settings,\n located in ActiveProfiling::Railtie::DEFAULT_GC_STATISTICS_OPTIONS.\n\n This method only works with versions of Ruby that implement\n GC::Profiler or that have been patched to implement some additional\n garbage collection statistics. In older versions, such as version\n 1.8.7, you can either use Ruby Enterprise Edition or patch your build\n with the GC statistics patch found here:\n\n http://blog.pluron.com/2008/02/memory-profilin.html", "Processes exactly one request, but doesn't define how the request gets\n here.\n @private", "Defines how the server handles exception.", "Adds an appropritate provenance statement with the given URI and saves\n the resource.\n\n This method treats RDFSources as stateful resources. This is in conflict\n with the PROV model, which assumes each revision is its own Resource. The\n internal predicate `dpla:wasRevisedBy` is used for non-generating\n revisions of stateful RDFSources.\n\n @todo Assuming a Marmotta LDP server, there are version URIs available\n   (via Memento) which could be used for a direct PROV implementation.\n   Consider options for doing that either alongside or in place of this\n   approach.\n\n @param activity_uri [#to_term] the URI of the prov:Activity to mark as\n   generating or revising the saved resource.\n\n @see #save\n\n @see http://www.w3.org/TR/prov-primer/\n @see http://www.w3.org/TR/2013/REC-prov-o-20130430/", "Store this agent's generator activity, which is the activity that\n produced the target entities upon which the current agent will operate.\n\n It is assumed that the agent class will define #entity_behavior, which\n returns the class of the appropriate behavior.\n\n `generator_uri' can be a string or RDF::URI.\n\n In the future, we might want to take a `generator_activity' parameter,\n because not every activity will modify its entities with provenance\n messages; an indexing activity, in particular.  In this case an LDP URI\n representing the activity is not relevant.\n\n @see Krikri::Mapper::Agent\n @see Krikri::Harvester", "You can override deep_vars in your class to specify which instance_variables should be deep cloned.\n As it is, all Arrays and Hashes are deep cloned.", "url as a string\n the post data as a hash", "Swap elements of the two indexes.", "Initiates a system call with the given arguments.\n\n @param [Array] args The arguments for the system call.\n\n @overload system_call(*args)\n   @return [String] The output of STDOUT or STDERR, depending of the exit\n     status of the called command.\n\n @overload system_call(*args, &block)\n   @yield [error_result] A block yielded when the called command exited\n     unsuccessfully.\n   @yieldparam [String] error_result The STDERR output.\n   @return [Object] The value the called block returns.", "Wake up earliest thread", "Wake up all threads", "Attempt to lock. Returns true if lock is aquired and false if not.", "This is a simple helper method to help keep threads from ending\n up stuck waiting for a lock when a thread locks the monitor and\n then decides to die without unlocking. It is only called when\n new locks are attempted or a check is made if the monitor is\n currently locked.", "Unlock the monitor", "Starts the timer for waiting threads with a timeout", "Returns only filled attributes with the original Alpha Card Services\n transaction variables names.\n\n @param attrs [Hash]\n   Attributes that must be converted to AlphaCard request params/\n   Default value is <code>filled_attributes</code>.\n\n @example\n   order = AlphaCard::Order.new(id: '1', tax: nil, po_number: 'PO123')\n   order.attributes_for_request\n\n   #=> { orderid: '1', ponumber: 'PO123' }", "Validate required attributes to be filled. Raises an exception\n if one of the attribute is not specified.\n\n @raise [AlphaCard::InvalidObjectError] error if required attributes not set", "refresh and pull the full document from the index", "You should use Elastics.post_bulk_string if you have an already formatted bulk data-string", "Fetches and gives the examples for the word\n @example\n    word.examples\n    #=> [\"There is an easy answer to this question, and it involves some good news and\u00a0 some bad news.\",\n         \"Then there was an awkward silence as though they were waiting for me to answer\u00a0 another question.\",..]\n @return [Array] containing the examples.", "Fetches and gives synonyms for the word\n @example\n    word.similar_words\n    #=> => [\"answer\", \"inquire\", \"question mark\", \"sentence\",.. ]\n @return [Array] containing similar words", "Parameters for the Solr request.\n Limits search by @provider_id if it has been specified.", "Return the id of a document randomly selected from the search index.\n @param provider_id [String, nil] the id of the provider that the randomly\n selected document will belong to.\n @return [String, nil] the id of the randomly selected document. If none are\n   available, gives `nil`", "Returns a Pathname for the location relative to this pathname's absolute location.", "Render enriched record for view\n @param [Krikri::SearchIndexDocument]\n @return [String]", "Render original record for view\n @param [Krikri::SearchIndexDocument]\n @return [String]", "Implement cookie acceptance when a visitor click the 'accept' button", "Return whether the player of a specified color has their king currently in check\n by checking the attack vectors of all the opponents players against the king location\n Also, check whether king currently in check, has all of their valid moves within\n their opponents attack vectors, and therefore are in checkmate (@checkmate)", "List of transactions", "List of transactions by address", "Returns traffic information for a certain interface.\n\n @param [String] id The name of the interface.\n @raise [UnknownInterface] An error that is raised if the\n   specified interface is not tracked.\n @return [Interface]", "Cert subject for End-User", "Sets the alias name for the interface.\n\n @raise [Error] Raised when a new nickname could not be set.\n @param [String] nick The alias name for the interface.", "Constructor for creating a client.  Options are\n @param options [Hash] The different options to pass to the connection\n @option options [String] :name - The name of the WAMP Client\n @option options [WampClient::Connection] :wamp - Allows a different WAMP to be passed in\n @option options [String] :uri The uri of the WAMP router to connect to\n @option options [String] :realm The realm to connect to\n @option options [String, nil] :protocol The protocol (default if wamp.2.json)\n @option options [String, nil] :authid The id to authenticate with\n @option options [Array, nil] :authmethods The different auth methods that the client supports\n @option options [Hash] :headers Custom headers to include during the connection\n @option options [WampClient::Serializer::Base] :serializer The serializer to use (default is json)\n Opens the connection", "Adds a procedure to the client", "Adds a subscription to the client", "endregion\nregion WAMP Methods\n Performs a WAMP call\n @note This method is blocking if the callback is not nil", "Performs a WAMP publish\n @note This method is blocking if the callback is not nil", "Performs a WAMP register\n @note This method is blocking if the callback is not nil", "Performs a WAMP subscribe\n @note This method is blocking if the callback is not nil", "endregion\nregion Private Methods\n Queues the command and blocks it the callback is not nil\n @param [WampRails::Command::Base] - The command to queue\n @param [Block] - The block to call when complete", "use this method when you are tracking the change of another app\n you must pass the app_id of the app being affected by the change", "Format data into a report", "Check if a provided object is semantically empty.\n\n @param [Object] value", "Builds patterns matching a predicate or chain of predicates given,\n assigning an unbound variable to each set of matches and passing it to\n the next pattern.\n\n @param predicates [#to_uri, Array<#to_uri>] a predicate or list of\n   predicates to build patterns against.\n\n @return [Array<Array<#to_term>>] An array of pattern arrays\n @see RDF::Query\n @see RDF::Query::Pattern", "Calls methods below to return a list of positions which are valid moves\n for piece at index p1, given the current board layout as defined in manifest", "Returns all valid positions a pawn at index p1 can move to", "Returns valid positions a knight at index p1 can move to", "Note that find_by_identity will return nil if there's not a current iteration of the identity", "The first iteration can be defined with a specific start date, but\n that is in general a bad idea, since it complicates obtaining\n the first iteration", "Cert issuer details", "Add Extensions needed", "Return the balise tbody and its content", "Calculate the total entries\n Return a tr and td with a colspan of total entries", "Given an activity, use the bulk-update method to load its revised\n entities into the search index.\n\n Any errors on bulk adds are caught and logged, and the batch is skipped.\n\n @param activity [Krikri::Activity]", "Enumerate arrays of JSON strings, one array per batch that is supposed\n to be loaded into the search index.\n\n @param aggregations [Enumerator]\n @return [Enumerator] Each array of JSON strings", "Given an activity, load its revised entities into the search index one\n at a time.\n\n Any errors on individual record adds are caught and logged, and the\n record is skipped.\n\n @param activity [Krikri::Activity]", "Get field names from Solr schema in host application.\n Will raise exception if file not found.\n @return [Array]", "Flattens a nested hash\n Joins keys with \"_\" and removes \"@\" symbols\n Example:\n   flat_hash( {\"a\"=>\"1\", \"b\"=>{\"c\"=>\"2\", \"d\"=>\"3\"} )\n   => {\"a\"=>\"1\", \"b_c\"=>\"2\", \"b_d\"=>\"3\"}", "Add any missing names required for calculations that are named", "Return the total number of documents reported by a CouchDB view.\n\n @param opts [Hash]  Analysand::Database#view options\n                     - view:  database view name\n @return [Fixnum]", "Makes requests to a CouchDB view to yield documents.\n\n The following will only send requests to the endpoint until it\n has 1000 records:\n\n     records.take(1000)\n\n Batches of records are requested, in order to avoid using\n `Analysand::StreamingViewResponse`, and the CouchDB `startkey` parameter\n is used for greater efficiency than `skip` in locating the next page of\n records.\n\n @return [Enumerator]\n @see Analysand::Viewing\n @see http://docs.couchdb.org/en/latest/couchapp/views/collation.html#all-docs", "Return an enumerator that provides individual records from batched view\n requests.\n\n @return [Enumerator]\n @see #records", "Retrieves a specific document from CouchDB.\n\n Uses Analysand::Database#get!, which raises an exception if the\n document cannot be found.\n\n @see Analysand::Database#get!", "Opening the classes which are defined as receivers.", "Provides the class of Sender", "Provides the classes of Receivers", "Given a current set of options and a number of records from the last\n request, generate the options for the next request.\n\n @param opts [Hash] an options hash from the previous request\n @param record_count [#to_i]\n\n @return [Hash] the next request's options hash", "auto increment slug until it is unique", "Each record is assumed to have an 'id' attribute required for creation.\n In addition, other create parameters can be specified by the +custom_attribute_names+\n method on the record.", "Given a basic rack environment, will properly fill it in\n with the information gleaned from the parsed request. Note that\n this only fills the subset that can be determined by the parser\n library. Namely, the only rack. variable set is rack.input. You should also\n have defaults in place for SERVER_NAME and SERVER_PORT, as they\n are required.", "Return a new connection by calling the connection proc with the given server name,\n and checking for connection errors.", "Create a new asynchronous URL fetcher.\n\n @param opts [Hash] a hash of the supported options, which are:\n @option opts [Boolean] :follow_redirects  Whether to follow HTTP 3xx\n   redirects.\n @option opts [Integer] :max_redirects Number of redirects to follow before\n   giving up. (default: 10)\n @option opts [Boolean] :inline_exceptions If true, pass exceptions as a\n   5xx response with the exception string in the body. (default: false)\n\n Run a request (in a new thread) and return a promise-like object for the\n response.\n\n @param uri [URI] the URI to be fetched\n @param headers [Hash<String, String>] HTTP headers to include with the\n   request\n @param opts [Hash] options to override the ones provided when\n   AsyncUriGetter was initialized. All supported options from `#initialize`\n   are available here as well.", "Compute exportable options after overriding preferences", "Returns the details of a specific NodeType", "Returns the applicationKeys for an application\n\n Authentication:\n The client must be configured with a valid api\n access token to call this action. The token\n must include at least one of the following scopes:\n all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationKeys.*, or applicationKeys.get.\n\n Parameters:\n *  {string} applicationId - ID associated with the application\n *  {string} sortField - Field to sort the results by. Accepted values are: key, status, id, creationDate, lastUpdated\n *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc\n *  {string} page - Which page of results to return\n *  {string} perPage - How many items to return per page\n *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status\n *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.\n *  {string} losantdomain - Domain scope of request (rarely needed)\n *  {boolean} _actions - Return resource actions in response\n *  {boolean} _links - Return resource link in response\n *  {boolean} _embedded - Return embedded resources in response\n\n Responses:\n *  200 - Collection of applicationKeys (https://api.losant.com/#/definitions/applicationKeys)\n\n Errors:\n *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)\n *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)", "Create a new applicationKey for an application\n\n Authentication:\n The client must be configured with a valid api\n access token to call this action. The token\n must include at least one of the following scopes:\n all.Application, all.Organization, all.User, applicationKeys.*, or applicationKeys.post.\n\n Parameters:\n *  {string} applicationId - ID associated with the application\n *  {hash} applicationKey - ApplicationKey information (https://api.losant.com/#/definitions/applicationKeyPost)\n *  {string} losantdomain - Domain scope of request (rarely needed)\n *  {boolean} _actions - Return resource actions in response\n *  {boolean} _links - Return resource link in response\n *  {boolean} _embedded - Return embedded resources in response\n\n Responses:\n *  201 - Successfully created applicationKey (https://api.losant.com/#/definitions/applicationKeyPostResponse)\n\n Errors:\n *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)\n *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)", "Returns the class for the given, class, scope, or record", "For use in adapters to delegate to method named receive_subject_action", "Load the settings from a compliant easyrsa.yml file. This can be used for\n easy setup with frameworks other than Rails.\n\n @example Configure easyrsa.\n   easyrsa.load!(\"/path/to/easyrsa.yml\")\n\n @param [ String ] path The path to the file.", "Limit the records returned by a Solr request to those belonging to the\n current provider.\n @param [Hash] solr_parameters a hash of parameters to be sent to Solr.\n @param [Hash] user_parameters a hash of user-supplied parameters.", "Create an instance and from given options +Hash+.\n\n [:session] +Session+ underlying session to use when talking to the API\n\n POST a request to this model's /list route, passing parameters. Returns\n a new instance of the model object with populated data via\n +Model.from_api+.\n\n [models] +String+ name of the model to request listed data for\n [params] +Hash+ parameters to send with the request\n [default_params] +Hash+ default parameters to merge +params+ into", "Allows snake_case accessor to top-level data values keyed by their\n camelCase counterparts. An attempt to be moar Rubyish.\n\n   device.tracking_profile\n   #=> 'adaptive'\n\n   device.trackingProfile\n   #=> 'adaptive'", "A bit convoluted because post_form uses form_data= to assign the data, so in that case req.body will be empty", "Runs the enrichment against a node. Can match literal values, and Language\n values with a provided label.\n\n @example with a matching value\n   lang = enrich_value('finnish')\n   #=> #<DPLA::MAP::Controlled::Language:0x3f(default)>\n   lang.providedLabel\n   #=> ['finnish']\n   lang.exactMatch.map(&:to_term)\n   #=> [#<RDF::Vocabulary::Term:0x9b URI:http://lexvo.org/id/iso639-3/fin>]\n\n @example with no match\n   lang = enrich_value('moomin')\n   #=> #<DPLA::MAP::Controlled::Language:0x3f(default)>\n   lang.providedLabel\n   #=> ['moomin']\n   lang.exactMatch\n   #=> []\n\n @param value [ActiveTriples::Resource, #to_s]\n @return [DPLA::MAP::Controlled::Language, nil] a resource representing the\n   language match.", "Runs the enrichment over a string.\n\n @param label [#to_s] the string to match\n @return [ActiveTriples::Resource] a blank node with a `dpla:providedLabel`\n   of `label` and a `skos:exactMatch` of the matching lexvo language,\n   if any", "Move this node above the specified node\n\n This method changes the node's parent if nescessary.", "Matches and consumes non-meaningful whitespace.", "Matches single and double quoted strings", "Generates and saves the field report for the provider, sending SPARQL\n queries as necessary.\n\n @return [Hash]", "Generates and saves the coun treport for the provider, sending SPARQL\n queries as necessary.\n\n @return [Hash]", "Accepts an optional set of database options\n\n If no options are provided, attempts to read options from\n config/database.yml\n\n If config/database.yml doesn't exist, Dotenv is used to try to load a\n .env file, then uses any SEQUELIZER_* environment variables as\n database options\n Returns a Sequel connection to the database", "Override register to first check if a schema is registered by fingerprint\n Also, allow additional params to be passed to register.", "Override to add support for additional params", "Call an API with given options, and parse the TSV response.\n\n @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:\n   the data deserialized from response body (could be nil), response status code and response headers.", "Return a td with the formated value or action for columns", "Return a td with the formated value or action for headers", "Create the link for actions\n Set the I18n translation or the given block for the link's name", "Create the link based on object\n Set an ajax link if option link_remote is set to true", "Return the formated cell's value", "Format the value based on value's type", "Rendering the report as either a full `field` report or a `count` report.\n\n Responds to format of `text/csv` with a CSV rendering of the requested\n report type.", "Any environment variables in the .env file are loaded and then\n any environment variable starting with SEQUELIZER_ will be used\n as an option for the database", "Convenience method to scrape input from cvar output and return that data.\n Returns integers as a numeric type if possible.\n\n ex: rcon.cvar(\"mp_friendlyfire\") => 1\n\n NOTE: This file has not been updated since previous version. Please be aware there may be outstanding Ruby2 bugs", "Sends a RCon command to the server. May be used multiple times\n after an authentication is successful.", "Requests authentication from the RCon server, given a\n password. Is only expected to be used once.", "Create a new cell with the class FormatCell\n Add the object in @cells", "Return each column in the model's database table", "Return true if the column is in the model's database table", "Format ask to send options to cell", "Gives dictionary meaning for the word\n @example\n    word.dictionary_meaning\n    #or\n    word.meaning\n @note This method will hit the {Dictionary::PREFIX ENDPOINT} and will consume some time to generate result\n @return [String] containing meaning from Reference {Dictionary} for the word", "Fetches the first meaning from Urban Dictionary for the word.\n @note This method will hit the {Urban::PREFIX ENDPOINT} and will consume some time to generate result\n @example\n    word.urban_meaning\n @see #urban_meanings\n @return [String] containing meaning from {Urban} Dictionary for the word", "Prompts for input, handling playback of prompts, DTMF grammar construction, and execution\n\n @example A basic DTMF digit collection:\n   ask \"Welcome, \", \"/opt/sounds/menu-prompt.mp3\",\n       timeout: 10, terminator: '#', limit: 3\n\n The first arguments will be a list of sounds to play, as accepted by #play, including strings for TTS, Date and Time objects, and file paths.\n :timeout, :terminator and :limit options may be specified to automatically construct a grammar, or grammars may be manually specified.\n\n @param [Object, Array<Object>] args A list of outputs to play, as accepted by #play\n @param [Hash] options Options to modify the grammar\n @option options [Boolean] :interruptible If the prompt should be interruptible or not. Defaults to true\n @option options [Integer] :limit Digit limit (causes collection to cease after a specified number of digits have been collected)\n @option options [Integer] :timeout Timeout in seconds before the first and between each input digit\n @option options [String] :terminator Digit to terminate input\n @option options [RubySpeech::GRXML::Grammar, Array<RubySpeech::GRXML::Grammar>] :grammar One of a collection of grammars to execute\n @option options [String, Array<String>] :grammar_url One of a collection of URLs for grammars to execute\n @option options [Hash] :input_options A hash of options passed directly to the Punchblock Input constructor. See\n @option options [Hash] :output_options A hash of options passed directly to the Punchblock Output constructor\n\n @return [Result] a result object from which the details of the utterance may be established\n\n @see Output#play\n @see http://rdoc.info/gems/punchblock/Punchblock/Component/Input.new Punchblock::Component::Input.new\n @see http://rdoc.info/gems/punchblock/Punchblock/Component/Output.new Punchblock::Component::Output.new", "Creates and manages a multiple choice menu driven by DTMF, handling playback of prompts,\n invalid input, retries and timeouts, and final failures.\n\n @example A complete example of the method is as follows:\n   menu \"Welcome, \", \"/opt/sounds/menu-prompt.mp3\", tries: 2, timeout: 10 do\n     match 1, OperatorController\n\n     match 10..19 do\n       pass DirectController\n     end\n\n     match 5, 6, 9 do |exten|\n       play \"The #{exten} extension is currently not active\"\n     end\n\n     match '7', OfficeController\n\n     invalid { play \"Please choose a valid extension\" }\n     timeout { play \"Input timed out, try again.\" }\n     failure { pass OperatorController }\n   end\n\n The first arguments will be a list of sounds to play, as accepted by #play, including strings for TTS, Date and Time objects, and file paths.\n :tries and :timeout options respectively specify the number of tries before going into failure, and the timeout in seconds allowed on each digit input.\n The most important part is the following block, which specifies how the menu will be constructed and handled.\n\n #match handles connecting an input pattern to a payload.\n The pattern can be one or more of: an integer, a Range, a string, an Array of the possible single types.\n Input is matched against patterns, and the first exact match has it's payload executed.\n Matched input is passed in to the associated block, or to the controller through #options.\n\n Allowed payloads are the name of a controller class, in which case it is executed through its #run method, or a block, which is executed in the context of the current controller.\n\n #invalid has its associated block executed when the input does not possibly match any pattern.\n #timeout's block is run when timeout expires before receiving any input\n #failure runs its block when the maximum number of tries is reached without an input match.\n\n Execution of the current context resumes after #menu finishes. If you wish to jump to an entirely different controller, use #pass.\n Menu will return :failed if failure was reached, or :done if a match was executed.\n\n @param [Object] args A list of outputs to play, as accepted by #play\n @param [Hash] options Options to use for the menu\n @option options [Integer] :tries Number of tries allowed before failure\n @option options [Integer] :timeout Timeout in seconds before the first and between each input digit\n @option options [Boolean] :interruptible If the prompt should be interruptible or not. Defaults to true\n @option options [String, Symbol] :mode Input mode to accept. May be :voice or :dtmf.\n @option options [Hash] :input_options A hash of options passed directly to the Punchblock Input constructor\n @option options [Hash] :output_options A hash of options passed directly to the Punchblock Output constructor\n\n @return [Result] a result object from which the details of the utterance may be established\n\n @see Output#play\n @see CallController#pass", "Returns a scope that includes the features for this record as the table_alias and the features for other as other_alias\n Performs a spatial intersection between the two sets of features, within the buffer distance given in meters", "Given an aggregation, take each enrichment specified by the `chain'\n given in our instantiation, and apply that enrichment, with the given\n options, modifying the aggregation in-place.", "Transform the given hash recursively by turning all of its string keys\n and values into symbols.\n\n Symbols are expected in the enrichment classes, and we will usually be\n dealing with values that have been deserialized from JSON.", "Instance methods\n Create an object for this name+date in the db if one does not already exist.\n Add the value from this object to the one in the DB.\n Returns the result of the ActiveRecord save operation.", "POST the tag's +@data+ to the API via 'tag/permissions/update', and return\n the same object with the new +@data+ returned from API call.", "POST the device's +@data+ to the API via 'device/update', and return\n the same object with the new +@data+ returned from API call.", "Fetches and gives meanings for the word from Urban Dictionary\n @example\n    word.meanings\n    #=> [\"A fuck, nothing more, just a fuck\",\n         \"Describes someone as being the sexiest beast alive. Anyone who is blessed with the name Krunal should get a medal.\",..]\n @see #meaning\n @return [Array] containing the meanings for the word.", "Creates mappings and passes DSL methods through to them, then adds them to\n a global registry.\n\n @param name [Symbol] a unique name for the mapper in the registry.\n @param opts [Hash] options to pass to the mapping instance, options are:\n   :class, :parser, and :parser_args\n @yield A block passed through to the mapping instance containing the\n   mapping in the language specified by MappingDSL", "Run the harvest.\n\n Individual records are processed through `#process_record` which is\n delegated to the harvester's `@harvest_behavior` by default.\n\n @return [Boolean]\n @see Krirki::Harvesters:HarvestBehavior", "Finds all entities generated or revised by the activity whose URI is\n given.\n\n @param activity_uri [#to_uri] the URI of the activity to search\n\n @param include_invalidated [Boolean]  Whether to include entities that\n   have been invalidated with <http://www.w3.org/ns/prov#invalidatedAtTime>\n\n @see https://www.w3.org/TR/prov-o/#invalidatedAtTime\n @see Krikri::LDP::Invalidatable\n\n @return [RDF::SPARQL::Query] a query object that, when executed, will\n   give solutions containing the URIs for the resources in `#record`.", "color temperature commands", "Change a catalog\n @param [String] catalog Name of the catalog - One of {OpenTox::QMRFReport::CATALOGS CATALOGS}.\n @param [String] id Single entry node in the catalog e.G.: \"<software contact='mycontact@mydomain.dom' description=\"My QSAR Software \" id=\"software_catalog_2\" name=\"MySoftware\" number=\"\" url=\"https://mydomain.dom\"/>\n @param [Hash] valuehash Key-Value Hash with attributes for a single catalog node\n @return [Error]  returns Error message if fails", "get an attribute from a catalog entry\n @param [String] catalog Name of the catalog. One of {OpenTox::QMRFReport::CATALOGS CATALOGS}.\n @param [String] id entry id in the catalog\n @param [String] key returns value of a key in a catalog node\n @return [String, false] returns value of a key in a catalog node or false if catalog entry do not exists.", "Link to the current page, changing the session provider the given\n value.\n @param provider [String, nil]", "Constructs a single meter description", "Constructs a list of meter descriptions", "Renders the _form partial with locals", "adds ... in between like if you have to long names in apple finder so you can i.e see the beginning and the suffix", "POST an API request to the given path, with optional params and\n headers. Returns a normal Ruby +Hash+ of the response data.\n\n [params]        +Hash+ parameters to include in the request (will be converted to JSON)\n [other_headers] +Hash+ headers to include in the request in addition to the defaults.", "Creates and raises a +GeotriggerError+ from an API error response.", "Given a String `s', return an array of two elements split on a comma\n and any whitespace around the comma.\n\n If the string does not split into two strings representing decimal\n values, then return [nil, nil] because the string does not make sense as\n coordinates.\n\n @param s [String]  String of, hopefully, comma-separated decimals\n\n @return [Array]", "third param is optional, because earlier versions of rspec sent only two args", "Lightly wraps Faraday to manage requests of various types, their bodies\n and headers.\n\n @param method [Symbol] HTTP method/verb.\n @param body [#to_s] the request body.\n @param headers [Hash<String, String>] a hash of HTTP headers;\n   e.g. {'Content-Type' => 'text/plain'}.\n\n @raise [Faraday::ClientError] if the server responds with an error status.\n   Faraday::ClientError#response contains the full response.\n @return [Faraday::Response] the server's response", "Renders the show view for the provider given by `id`.", "Removes unlikely elements from the document.  These are elements who have classes\n that seem to indicate they are comments, headers, footers, nav, etc", "Scores the document elements based on an algorithm to find elements which hold page\n content.", "Distills the document down to just its content.\n\n @param [Hash] options Distillation options\n @option options [Symbol] :dirty Do not clean the content element HTML", "Attempts to clean the top scoring node from non-page content items, such as\n advertisements, widgets, etc", "It could be possible that an answer code equals a session field. We add \"answer_\" in that case so that we get uniqe question codes for sure", "Sends ListRecords requests lazily.\n\n The following will only send requests to the endpoint until it\n has 1000 records:\n\n     records.take(1000)\n\n @param opts [Hash] opts to pass to OAI::Client\n @see #expected_opts", "Gets a single record with the given identifier from the OAI endpoint\n\n @param identifier [#to_s] the identifier of the record to get\n @param opts [Hash] options to pass to the OAI client", "Concatinates two enumerators\n @todo find a better home for this. Reopen Enumerable? or use the\n    `Enumerating` gem: https://github.com/mdub/enumerating", "Runs the request in the given block against the sets specified in `opts`.\n Results are concatenated into a single enumerator.\n\n Sets that respond with an error (`OAI::Exception`) will return empty\n and be skipped.\n\n @param opts [Hash] the options to pass, including all sets to process.\n @yield gives options to the block once for each set. The\n   block should run the harvest action with the options and give an\n   Enumerable.\n @yieldparam set_opts [Hash]\n @yieldreturn [Enumerable] a result set to wrap into the retured lazy\n   enumerator\n\n @return [Enumerator::Lazy] A lazy enumerator concatenating the results\n   of the block with each set.", "POST the trigger's +@data+ to the API via 'trigger/update', and return\n the same object with the new +@data+ returned from API call.", "If passed a hash, scans hash for certain options and sets up hash\n to be fed to Sequel.connect\n\n If fed anything, like a string that represents the URL for a DB,\n the string is returned without modification", "Returns a proc that should be executed after Sequel connects to the\n datebase.\n\n Right now, the only thing that happens is if we're connecting to\n PostgreSQL and the schema_search_path is defined, each schema\n is created if it doesn't exist, then the search_path is set for\n the connection.", "This runs the block and stores any new instance variables that were set.\n\n binding - The same Object that is given to #run.\n\n Returns nothing.", "Ensure the block is setup to run first, and that the test run is wrapped\n in a database transaction.", "reload any AR instances", "Returns list of authors that talk about the query. The list is sorted by frequency of posts and the influence of authors.\n\n @param [String] q the search query string\n @param [Hash] options method options\n @option options [Symbol] :window Time window for results. (default: :all) Options: :dynamic most relevant, :hour last hour, :day last day, :week last week, :month last month, :all all time. You can also use the h6 (6 hours) d3 (3 days) syntax.\n @option options [Integer] :page page number of the result set. (default: 1, max: 10)\n @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)\n @return [Hashie::Mash]", "Returns list of URLs posted by an author\n\n @param [String] url URL string for the author.\n @param [Hash] options method options\n @option options [String] :contains Query string to filter results\n @option options [Integer] :page page number of the result set. (default: 1, max: 10)\n @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)\n @return [Topsy::Page]", "Returns list of URLs related to a given URL\n\n @param [String] url URL string for the author.\n @param [Hash] options method options\n @option options [Integer] :page page number of the result set. (default: 1, max: 10)\n @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)\n @return [Topsy::Page]", "Returns list of results for a query.\n\n @param [String] q the search query string\n @param [Hash] options method options\n @option options [Symbol] :window Time window for results. (default: :all) Options: :dynamic most relevant, :hour last hour, :day last day, :week last week, :month last month, :all all time. You can also use the h6 (6 hours) d3 (3 days) syntax.\n @option options [Integer] :page page number of the result set. (default: 1, max: 10)\n @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)\n @option options [String] :site narrow results to a domain\n @return [Topsy::Page]", "Returns count of results for a search query.\n\n @param [String] q the search query string\n @return [Topsy::SearchCounts]", "Returns mention count data for the given query\n\n @param [String] q - The query.  Use site:domain.com to get domain counts and @username to get mention counts.\n @param [String] count_method - what is being counted - \"target\" (default) -  the number of unique links , or \"citation\" - cthe number of unique tweets about links\n @param [Integer] slice -\n @param [Integer] period -", "Returns counts of tweets for a URL\n\n @param [String] url the url to look up\n @param [Hash] options method options\n @option options [String] :contains Query string to filter results\n @return [Topsy::Stats]", "Returns list of tags for a URL.\n\n @param [String] url the search query string\n @param [Hash] options method options\n @option options [Integer] :page page number of the result set. (default: 1, max: 10)\n @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)\n @return [Topsy::Page]", "Returns list of trending terms\n\n @param [Hash] options method options\n @option options [Integer] :page page number of the result set. (default: 1, max: 10)\n @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)\n @return [Topsy::Page]", "Returns info about a URL\n\n @param [String] url the url to look up\n @return [Topsy::UrlInfo]", "extracts the header key", "Repeatedly make long-polling request until receive data, hit error, or timeout\n Treat \"terminating\" and \"reconnecting\" errors as an empty poll result\n\n @param [Symbol] verb for HTTP REST request\n @param [EM:HttpRequest] connection to server from previous request\n @param [Hash] request_options for HTTP request\n @param [Time] stop_at time for polling\n\n @return [TrueClass] always true\n\n @raise [HttpException] HTTP failure with associated status code", "Beautify response header keys so that in same form as RestClient\n\n @param [Hash] headers from response\n\n @return [Hash] response headers with keys as lower case symbols", "Retrieve current agent tags and give result to block\n\n === Parameters\n options(Hash):: Request options\n   :raw(Boolean):: true to yield raw tag response instead of deserialized tags\n   :timeout(Integer):: timeout in seconds before giving up and yielding an error message\n\n === Block\n Given block should take one argument which will be set with an array\n initialized with the tags of this instance\n\n === Return\n true:: Always return true", "Queries a list of servers in the current deployment which have one or more\n of the given tags.\n\n === Parameters\n tags(String, Array):: Tag or tags to query or empty\n options(Hash):: Request options\n   :raw(Boolean):: true to yield raw tag response instead of deserialized tags\n   :timeout(Integer):: timeout in seconds before giving up and yielding an error message\n\n === Block\n Given block should take one argument which will be set with an array\n initialized with the tags of this instance\n\n === Return\n true:: Always return true", "Add given tags to agent\n\n === Parameters\n new_tags(String, Array):: Tag or tags to be added\n options(Hash):: Request options\n   :timeout(Integer):: timeout in seconds before giving up and yielding an error message\n\n === Block\n A block is optional. If provided, should take one argument which will be set with the\n raw response\n\n === Return\n true always return true", "Remove given tags from agent\n\n === Parameters\n old_tags(String, Array):: Tag or tags to be removed\n options(Hash):: Request options\n   :timeout(Integer):: timeout in seconds before giving up and yielding an error message\n\n === Block\n A block is optional. If provided, should take one argument which will be set with the\n raw response\n\n === Return\n true always return true", "Runs a tag query with an optional list of tags.\n\n === Parameters\n tags(Array):: Tags to query or empty or nil\n hrefs(Array):: hrefs of resources to query with empty or nil meaning all instances in deployment\n options(Hash):: Request options\n   :raw(Boolean):: true to yield raw tag response instead of unserialized tags\n   :timeout(Integer):: timeout in seconds before giving up and yielding an error message\n\n === Block\n Given block should take one argument which will be set with an array\n initialized with the tags of this instance\n\n === Return\n true:: Always return true", "Runs a tag update with a list of new or old tags\n\n === Parameters\n new_tags(Array):: new tags to add or empty\n old_tags(Array):: old tags to remove or empty\n block(Block):: optional callback for update response\n\n === Block\n A block is optional. If provided, should take one argument which will be set with the\n raw response\n\n === Return\n true:: Always return true", "Initialize error tracker\n\n @param [Object] agent object using this tracker\n @param [String] agent_name uniquely identifying agent process on given server\n\n @option options [Integer, NilClass] :shard_id identifying shard of database in use\n @option options [Hash] :trace_level for restricting backtracing and Errbit reporting\n   with exception class as key and :no_trace, :caller, or :trace as value; exceptions\n   with :no_trace are not backtraced when logging nor are they recorded in stats\n   or reported to Errbit\n @option options [Array<Symbol, String>] :filter_params names whose values are to be\n   filtered when notifying\n @option options [String] :airbrake_endpoint URL for Airbrake for reporting exceptions\n   to Errbit\n @option options [String] :airbrake_api_key for using the Airbrake API to access Errbit\n\n @return [TrueClass] always true", "Log error and optionally track in stats\n Errbit notification is left to the callback configured in the stats tracker\n Logging works even if init was never called\n\n @param [String, Object] component reporting error; non-string is snake-cased\n @param [String] description of failure for use in logging\n @param [Exception, String] exception to be logged and tracked in stats;\n   string errors are logged but not tracked in stats\n @param [Packet, Hash, NilClass] packet associated with exception\n @param [Symbol, NilClass] trace level override unless excluded by configured\n   trace levels\n\n @return [Boolean] true if successfully logged, otherwise false", "Track error in stats\n\n @param [String] component reporting error\n @param [Exception] exception to be tracked\n @param [Packet, Hash, NilClass] packet associated with exception\n\n @return [TrueClass] always true", "Notify Errbit of error if notification enabled\n\n @param [Exception, String] exception raised\n @param [Packet, Hash] packet associated with exception\n @param [Object] agent object reporting error\n @param [String,Object] component or service area where error occurred\n\n @return [TrueClass] always true", "Create proc for making callback to notifier\n\n @return [Proc] notifier callback", "Configure Airbrake for exception notification\n\n @param [String] agent_name uniquely identifying agent process on given server\n\n @option options [Integer, NilClass] :shard_id identifying shard of database in use\n @option options [Array<Symbol, String>] :filter_params names whose values are to be\n   filtered when notifying\n @option options [String] :airbrake_endpoint URL for Airbrake for reporting exceptions\n   to Errbit\n @option options [String] :airbrake_api_key for using the Airbrake API to access Errbit\n\n @return [TrueClass] always true\n\n @raise [RuntimeError] airbrake gem missing", "Apply parameter filter\n\n @param [Hash] params to be filtered\n\n @return [Hash] filtered parameters", "Update the time this agent last received a request or response message\n and restart the inactivity timer thus deferring the next connectivity check\n Also forward this message receipt notification to any callbacks that have registered\n\n === Block\n Optional block without parameters that is activated when a message is received\n\n === Return\n true:: Always return true", "Check whether broker connection is usable by pinging a router via that broker\n Attempt to reconnect if ping does not respond in PING_TIMEOUT seconds and\n if have reached timeout limit\n Ignore request if already checking a connection\n\n === Parameters\n id(String):: Identity of specific broker to use to send ping, defaults to any\n   currently connected broker\n max_ping_timeouts(Integer):: Maximum number of ping timeouts before attempt\n   to reconnect, defaults to MAX_PING_TIMEOUTS\n\n === Return\n true:: Always return true", "Start timer that waits for inactive messaging period to end before checking connectivity\n\n === Return\n true:: Always return true", "Determine whether request has already been serviced\n\n === Parameters\n token(String):: Generated message identifier\n\n === Return\n (String|nil):: Identity of agent that already serviced request, or nil if none", "Get local cache statistics\n\n === Return\n stats(Hash|nil):: Current statistics, or nil if cache empty\n   \"local total\"(Integer):: Total number in local cache, or nil if none\n   \"local max age\"(String):: Time since oldest local cache entry created or updated", "Parse arguments and execute request\n\n === Parameters\n options(Hash):: Command line options\n\n === Return\n true:: Always return true", "Kill process defined in pid file\n\n === Parameters\n sig(String):: Signal to be used for kill\n\n === Return\n true:: Always return true", "Stop agent process\n\n === Parameters\n agent_name(String):: Agent name\n\n === Return\n (Boolean):: true if process was stopped, otherwise false", "List all configured agents\n\n === Return\n never", "Determine configuration settings for this agent and persist them if needed\n Reuse existing agent identity when possible\n\n === Parameters\n action(String):: Requested action\n options(Hash):: Command line options\n\n === Return\n cfg(Hash):: Persisted configuration options", "Enable the use of an HTTP proxy for this process and its subprocesses\n\n === Parameters\n proxy_setting(String):: Proxy to use\n exceptions(String):: Comma-separated list of proxy exceptions (e.g. metadata server)\n\n === Return\n true:: Always return true", "Apply serializers in order until one succeeds\n\n === Parameters\n action(Symbol):: Serialization action: :dump or :load\n packet(Object|String):: Object or serialized data on which action is to be performed\n serializers(Array):: Serializers to apply in order\n id(String):: Optional identifier of source of data for use in determining who is the receiver\n\n === Return\n (String|Object):: Result of serialization action\n\n === Raises\n SerializationError:: If none of the serializers can perform the requested action\n RightScale::Exceptions::ConnectivityFailure:: If cannot access external services", "Forward any method invocation to targets\n\n === Parameters\n m(Symbol):: Method that should be multiplexed\n args(Array):: Arguments\n\n === Return\n res(Object):: Result of first target in list", "Determine whether this object, or ALL of its targets, responds to\n the named method.\n\n === Parameters\n m(Symbol):: Forwarded method name\n\n === Return\n (true|false):: True if this object, or ALL targets, respond to the names method; false otherwise", "User friendly result status\n\n === Parameters\n reason(Boolean):: Whether to include failure reason information, default to false\n\n === Return\n (String):: Name of result code", "Limited length error string\n\n === Return\n e(String):: String of no more than MAX_ERROR_SIZE characters", "Open command socket and wait for input on it\n This can only be called again after 'stop_listening' was called\n\n === Parameters\n socket_port(Integer):: Socket port on which to listen\n\n === Block\n The given block should take two arguments:\n   * First argument will be given the commands sent through the socket\n     Commands should be serialized using RightScale::CommandSerializer.\n   * Second argument contains the connection that should be given back to\n     +reply+ to send reply\n\n === Return\n true:: Always return true\n\n === Raise\n (ArgumentError):: If block is missing\n (Exceptions::Application):: If +listen+ has already been called and +stop+ hasn't since\n (Exceptions::Application):: If port is already bound", "Write given data to socket, must be listening\n\n === Parameters\n conn(EM::Connection):: Connection used to send data\n data(String):: Data that should be written\n close_after_writing(TrueClass|FalseClass):: Whether TCP connection with client should be\n                                             closed after reply is sent\n\n === Return\n true:: Always return true", "Handle log level request\n\n === Parameters\n options(Hash):: Command line options\n\n === Return\n true:: Always return true", "Send log level request to agent\n\n === Parameters\n agent_name(String):: Agent name\n command(String):: Command request\n options(Hash):: Command line options\n\n === Return\n (Boolean):: true if agent running, otherwise false", "Parse common options between rad and rnac\n\n === Parameters\n opts(OptionParser):: Options parser with options to be parsed\n options(Hash):: Storage for options that are parsed\n\n === Return\n true:: Always return true", "Generate agent identity from options\n Build identity from base_id, token, prefix and agent name\n\n === Parameters\n options(Hash):: Hash containing identity components\n\n === Return\n options(Hash)::", "Determine agent type\n\n === Parameters\n type(String):: Agent type\n name(String):: Agent name\n\n === Return\n (String):: Agent type", "Initialize registry\n Register as an actor\n\n === Parameters\n actor(Actor):: Actor to be registered\n prefix(String):: Prefix used in request to identify actor\n\n === Return\n (Actor):: Actor registered\n\n === Raises\n ArgumentError if actor is not an Actor", "Initialize cache\n Add item to cache", "Retrieve item from cache\n Store item returned by given block if any", "Delete item from cache", "Create client for making HTTP REST requests\n\n @param [Array, String] urls of server being accessed as array or comma-separated string\n\n @option options [String] :api_version for X-API-Version header\n @option options [String] :server_name of server for use in exceptions; defaults to host name\n @option options [String] :health_check_path in URI for health check resource;\n   defaults to DEFAULT_HEALTH_CHECK_PATH\n @option options [Array] :filter_params symbols or strings for names of request parameters\n   whose values are to be hidden when logging; also applied to contents of any parameters\n   in CONTENT_FILTERED_PARAMS; can be augmented on individual requests\n @option options [Boolean] :non_blocking i/o is to be used for HTTP requests by applying\n   EM::HttpRequest and fibers instead of RestClient; requests remain synchronous\n Check health of server\n\n @param [String] host name of server\n\n @return [Object] health check result from server\n\n @raise [NotResponding] server is not responding", "Construct headers for request\n\n @param [String] request_uuid uniquely identifying request\n @param [Hash] options per #request\n\n @return [Hash] headers for request", "Make REST request\n\n @param [Symbol] verb for HTTP REST request\n @param [String] path in URI for desired resource\n @param [Hash] connect_options for HTTP connection\n @param [Hash] request_options for HTTP request\n @param [Hash] used container for returning :host used for request;\n   needed so that can return it even when the request fails with an exception\n\n @return [Array] result to be returned followed by response code, body, and headers\n\n @raise [NotResponding] server not responding, recommend retry\n @raise [HttpException] HTTP failure with associated status code", "Make long-polling request\n\n @param [String] path in URI for desired resource\n @param [Hash] connect_options for HTTP connection\n @param [Hash] request_options for HTTP request\n @param [Integer] request_timeout for a non-nil result\n @param [Time] started_at time for request\n @param [Hash] used container for returning :host used for request;\n   needed so that can return it even when the request fails with an exception\n\n @return [Array] result to be returned followed by response code, body, and headers\n\n @raise [NotResponding] server not responding, recommend retry\n @raise [HttpException] HTTP failure with associated status code", "Handle no result from balancer\n Distinguish the not responding case since it likely warrants a retry by the client\n Also try to distinguish between the targeted server not responding and that server\n gatewaying to another server that is not responding, so that the receiver of\n the resulting exception is clearer as to the source of the problem\n\n @param [RightSupport::Net::NoResult] no_result exception raised by request balancer when it\n   could not deliver request\n @param [String] host server URL where request was attempted\n\n @yield [exception] required block called for reporting exception of interest\n @yieldparam [Exception] exception extracted\n\n @return [TrueClass] always true\n\n @raise [NotResponding] server not responding, recommend retry", "Log successful request completion\n\n @param [Object] result to be returned to client\n @param [Integer, NilClass] code for response status\n @param [Object] body of response\n @param [Hash] headers for response\n @param [String] host server URL where request was completed\n @param [String] path in URI for desired resource\n @param [String] request_uuid uniquely identifying request\n @param [Time] started_at time for request\n @param [Symbol] log_level to use when logging information about the request\n   other than errors\n\n @return [TrueClass] always true", "Log request failure\n Also report it as audit entry if an instance is targeted\n\n @param [String] host server URL where request was attempted if known\n @param [String] path in URI for desired resource\n @param [Hash] params for request\n @param [Array] filter list of parameters whose value is to be hidden\n @param [String] request_uuid uniquely identifying request\n @param [Time] started_at time for request\n @param [Exception, String] exception or message that should be logged\n\n @return [TrueClass] Always return true", "Generate log text describing request and failure if any\n\n @param [String] path in URI for desired resource\n @param [Hash] params for HTTP request\n @param [Array, NilClass] filter augmentation to base filter list\n @param [String] host server URL where request was attempted if known\n @param [Exception, String, NilClass] exception or failure message that should be logged\n\n @return [String] Log text", "Apply parameter hiding filter\n\n @param [Hash, Object] params to be filtered with strings or symbols as keys\n @param [Array] filter names of params as strings (not symbols) whose value is to be hidden;\n   also filter the contents of any CONTENT_FILTERED_PARAMS\n\n @return [Hash] filtered parameters", "Split string into an array unless nil or already an array\n\n @param [String, Array, NilClass] object to be split\n @param [String, Regex] pattern on which to split; defaults to comma\n\n @return [Array] split object", "Initialize manager\n Handle stats request\n\n === Parameters\n options(Hash):: Command line options\n\n === Return\n true:: Always return true", "Request and display statistics for agents\n\n === Parameters\n options(Hash):: Command line options\n\n === Return\n true:: Always return true", "Request and display statistics for agent\n\n === Parameters\n agent_name(String):: Agent name\n options(Hash):: Command line options\n\n === Return\n (Boolean):: true if agent running, otherwise false", "Switch back to sending requests after in-memory queue gets flushed\n Idempotent\n\n === Return\n true:: Always return true", "Queue given request in memory\n\n === Parameters\n kind(Symbol):: Kind of request: :send_push or :send_request\n type(String):: Dispatch route for the request; typically identifies actor and action\n payload(Object):: Data to be sent with marshalling en route\n target(Hash|NilClass):: Target for request\n token(String):: Token uniquely identifying request\n expires_at(Integer):: Time in seconds in Unix-epoch when this request expires and\n   is to be ignored by the receiver; value 0 means never expire\n skewed_by(Integer):: Amount of skew already applied to expires_at in seconds\n\n === Block\n Optional block used to process response asynchronously with the following parameter:\n   result(Result):: Response with an OperationResult of SUCCESS, RETRY, NON_DELIVERY, or ERROR\n\n === Return\n true:: Always return true", "Send any requests that were queued while in offline mode and have not yet timed out\n Do this asynchronously to allow for agents to respond to requests\n Once all in-memory requests have been flushed, switch off offline mode\n\n === Parameters\n again(Boolean):: Whether being called in a loop\n\n === Return\n true:: Always return true", "Compute a cryptographic hash of the information in this policy; helps\n callers compare two policies to see if they are equivalent.\n @see https://github.com/rightscale/cmaro/domain/login_policy.go", "Make HTTP request\n\n @param [Symbol] verb for HTTP REST request\n @param [String] path in URI for desired resource\n @param [String] host name of server\n @param [Hash] connect_options for HTTP connection (ignored)\n @param [Hash] request_options for HTTP request\n\n @return [Array] result to be returned followed by response code, body, and headers\n\n @raise [HttpException] HTTP failure with associated status code", "Make long-polling requests until receive data, hit error, or timeout\n\n @param [Hash] connection to server from previous request with keys :host, :path,\n   and :expires_at, with the :expires_at being adjusted on return\n @param [Hash] request_options for HTTP request\n @param [Time] stop_at time for polling\n\n @return [Array] result to be returned followed by response code, body, and headers\n\n @raise [HttpException] HTTP failure with associated status code", "Make HTTP request once\n\n @param [Symbol] verb for HTTP REST request\n @param [String] url for request\n @param [Hash] request_options for HTTP request\n\n @return [Array] result to be returned followed by response code, body, and headers\n\n @raise [HttpException] HTTP failure with associated status code", "Create cache\n Store pending request\n\n === Parameters\n token(String):: Generated message identifier\n pending_request(PendingRequest):: Pending request\n\n === Return\n (PendingRequest):: Stored request", "Generate configuration from specified options and the agent's base options\n and write them to a file\n\n === Parameters\n options(Hash):: Command line options\n\n === Return\n true:: Always return true", "Load initial configuration for agent, if any\n\n === Return\n cfg(Hash):: Initial agent configuration options", "Check agent type consistency and existence of initialization file and actors directory\n\n === Parameters\n options(Hash):: Command line options\n cfg(Hash):: Initial configuration settings\n\n === Return\n true:: Always return true", "Write configuration options to file after applying any overrides\n\n === Parameters\n options(Hash):: Command line options\n cfg(Hash):: Configurations options with which specified options are to be merged\n\n === Return\n true:: Always return true", "Add a repository...\n\n === Parameters\n (Hash):: collection of repos to be checked out on the instance\n :repo_sha (String):: the hash id (SHA) of the repository\n :repo_detail (Hash):: info needed to checkout this repo\n   {\n     <Symbol> Type of repository: one of :git, :svn, :download or :local\n       * :git denotes a 'git' repository that should be retrieved via 'git clone'\n       * :svn denotes a 'svn' repository that should be retrieved via 'svn checkout'\n       * :download denotes a tar ball that should be retrieved via HTTP GET (HTTPS if uri starts with https://)\n       * :local denotes cookbook that is already local and doesn't need to be retrieved\n     :repo_type => <Symbol>,\n     <String> URL to repository (e.g. git://github.com/opscode/chef-repo.git)\n     :url => <String>,\n     <String> git commit or svn branch that should be used to retrieve repository\n       Optional, use 'master' for git and 'trunk' for svn if tag is nil.\n       Not used for raw repositories.\n     :tag => <String>,\n     <Array> Path to cookbooks inside repostory\n       Optional (use location of repository as cookbook path if nil)\n     :cookbooks_path => <Array>,\n     <String> Private SSH key used to retrieve git repositories\n       Optional, not used for svn and raw repositories.\n     :ssh_key => <String>,\n     <String> Username used to retrieve svn and raw repositories\n       Optional, not used for git repositories.\n     :username => <String>,\n     <String> Password used to retrieve svn and raw repositories\n       Optional, not used for git repositories.\n     :password => <String>\n  }\n :cookbook_positions (Array):: List of CookbookPositions to be developed.  Represents the subset of cookbooks identified as the \"dev cookbooks\"\n\n === Return\n result(Hash):: The entry added to the collection of repositories", "List command implementation\n\n === Parameters\n opts(Hash):: Should contain the connection for sending data\n\n === Return\n true:: Always return true", "Set log level command\n\n === Return\n true:: Always return true", "Send a request to a single target or multiple targets with no response expected other\n than routing failures\n Persist the request en route to reduce the chance of it being lost at the expense of some\n additional network overhead\n Enqueue the request if the target is not currently available\n Never automatically retry the request if there is the possibility of it being duplicated\n Set time-to-live to be forever\n\n === Parameters\n type(String):: Dispatch route for the request; typically identifies actor and action\n payload(Object):: Data to be sent with marshalling en route\n target(Hash|NilClass) Target for request, which may be a specific agent (using :agent_id),\n   potentially multiple targets (using :tags, :scope, :selector), or nil to route solely\n   using type:\n   :agent_id(String):: serialized identity of specific target\n   :tags(Array):: Tags that must all be associated with a target for it to be selected\n   :scope(Hash):: Scoping to be used to restrict routing\n     :account(Integer):: Restrict to agents with this account id\n     :shard(Integer):: Restrict to agents with this shard id, or if value is Packet::GLOBAL,\n       ones with no shard id\n   :selector(Symbol):: Which of the matched targets to be selected, either :any or :all,\n     defaults to :any\n options(Hash):: Request options\n   :token(String):: Universally unique ID for request; defaults to random generated\n   :time_to_live(Numeric):: Number of seconds before a request expires and is to be ignored;\n     non-positive value or nil means never expire; defaults to 0\n\n === Block\n Optional block used to process routing responses asynchronously with the following parameter:\n   result(Result):: Response with an OperationResult of SUCCESS, RETRY, NON_DELIVERY, or ERROR,\n     with an initial SUCCESS response containing the targets to which the request was sent\n     and any additional responses indicating any failures to actually route the request\n     to those targets, use RightScale::OperationResult.from_results to decode\n\n === Return\n true:: Always return true\n\n === Raise\n ArgumentError:: If target invalid\n SendFailure:: If sending of request failed unexpectedly\n TemporarilyOffline:: If cannot send request because RightNet client currently disconnected\n   and offline queueing is disabled", "Send a request to a single target with a response expected\n Automatically retry the request if a response is not received in a reasonable amount of time\n or if there is a non-delivery response indicating the target is not currently available\n Timeout the request if a response is not received in time, typically configured to 2 minutes\n Because of retries there is the possibility of duplicated requests, and these are detected and\n discarded automatically for non-idempotent actions\n Allow the request to expire per the agent's configured time-to-live, typically 1 minute\n Note that receiving a response does not guarantee that the request activity has actually\n completed since the request processing may involve other asynchronous requests\n\n === Parameters\n type(String):: Dispatch route for the request; typically identifies actor and action\n payload(Object):: Data to be sent with marshalling en route\n target(Hash|NilClass) Target for request, which may be a specific agent (using :agent_id),\n   one chosen randomly from potentially multiple targets (using :tags, :scope), or nil to\n   route solely using type:\n   :agent_id(String):: serialized identity of specific target\n   :tags(Array):: Tags that must all be associated with a target for it to be selected\n   :scope(Hash):: Scoping to be used to restrict routing\n     :account(Integer):: Restrict to agents with this account id\n     :shard(Integer):: Restrict to agents with this shard id, or if value is Packet::GLOBAL,\n       ones with no shard id\n options(Hash):: Request options\n   :token(String):: Universally unique ID for request; defaults to random generated\n   :time_to_live(Numeric):: Number of seconds before a request expires and is to be ignored;\n     non-positive value or nil means never expire; defaults to configured :time_to_live\n\n === Block\n Required block used to process response asynchronously with the following parameter:\n   result(Result):: Response with an OperationResult of SUCCESS, RETRY, NON_DELIVERY, or ERROR,\n     use RightScale::OperationResult.from_results to decode\n\n === Return\n true:: Always return true\n\n === Raise\n ArgumentError:: If target invalid or block missing", "Build and send packet\n\n === Parameters\n kind(Symbol):: Kind of request: :send_push or :send_request\n type(String):: Dispatch route for the request; typically identifies actor and action\n payload(Object):: Data to be sent with marshalling en route\n target(Hash|NilClass):: Target for request\n   :agent_id(String):: Identity of specific target\n   :tags(Array):: Tags that must all be associated with a target for it to be selected\n   :scope(Hash):: Scoping to be used to restrict routing\n     :account(Integer):: Restrict to agents with this account id\n     :shard(Integer):: Restrict to agents with this shard id, or if value is Packet::GLOBAL,\n       ones with no shard id\n   :selector(Symbol):: Which of the matched targets to be selected: :any or :all\n options(Hash):: Request options\n   :token(String):: Universally unique ID for request; defaults to random generated\n   :time_to_live(Numeric):: Number of seconds before a request expires and is to be ignored;\n     non-positive value or nil means never expire for :send_push and means use configured\n     time-to-live for :send_request\n\n === Block\n Optional block used to process response asynchronously with the following parameter:\n   result(Result):: Response with an OperationResult of SUCCESS, RETRY, NON_DELIVERY, or ERROR\n\n === Return\n true:: Always return true\n\n === Raise\n ArgumentError:: If target invalid", "Build packet or queue it if offline\n\n === Parameters\n kind(Symbol):: Kind of request: :send_push or :send_request\n type(String):: Dispatch route for the request; typically identifies actor and action\n payload(Object):: Data to be sent with marshalling en route\n target(Hash|NilClass):: Target for request\n   :agent_id(String):: Identity of specific target\n   :tags(Array):: Tags that must all be associated with a target for it to be selected\n   :scope(Hash):: Scoping to be used to restrict routing\n     :account(Integer):: Restrict to agents with this account id\n     :shard(Integer):: Restrict to agents with this shard id, or if value is Packet::GLOBAL,\n       ones with no shard id\n   :selector(Symbol):: Which of the matched targets to be selected: :any or :all\n options(Hash):: Request options\n   :token(String):: Universally unique ID for request; defaults to random generated\n   :time_to_live(Numeric):: Number of seconds before a request expires and is to be ignored;\n     non-positive value or nil means never expire for :send_push and means use configured\n     time-to-live for :send_request\n\n === Block\n Optional block used to process response asynchronously with the following parameter:\n   result(Result):: Response with an OperationResult of SUCCESS, RETRY, NON_DELIVERY, or ERROR\n\n === Return\n (Push|Request|NilClass):: Packet created, or nil if queued instead\n\n === Raise\n ArgumentError:: If target is invalid", "Handle response to a request\n\n === Parameters\n response(Result):: Packet received as result of request\n\n === Return\n true:: Always return true", "Take any actions necessary to quiesce client interaction in preparation\n for agent termination but allow message receipt to continue\n\n === Return\n (Array):: Number of pending non-push requests and age of youngest request", "Create displayable dump of unfinished non-push request information\n Truncate list if there are more than 50 requests\n\n === Return\n info(Array(String)):: Receive time and token for each request in descending time order", "Get sender statistics\n\n === Parameters\n reset(Boolean):: Whether to reset the statistics after getting the current ones\n\n === Return\n stats(Hash):: Current statistics:\n   \"non-deliveries\"(Hash|nil):: Non-delivery activity stats with keys \"total\", \"percent\", \"last\",\n     and 'rate' with percentage breakdown per reason, or nil if none\n   \"offlines\"(Hash|nil):: Offline activity stats with keys \"total\", \"last\", and \"duration\",\n     or nil if none\n   \"pings\"(Hash|nil):: Request activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown for \"success\" vs. \"timeout\", or nil if none\n   \"request kinds\"(Hash|nil):: Request kind activity stats with keys \"total\", \"percent\", and \"last\"\n     with percentage breakdown per kind, or nil if none\n   \"requests\"(Hash|nil):: Request activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per request type, or nil if none\n   \"requests pending\"(Hash|nil):: Number of requests waiting for response and age of oldest,\n     or nil if none\n   \"result errors\"(Hash|nil):: Error result activity stats with keys \"total\", \"percent\", \"last\",\n     and 'rate' with percentage breakdown per error, or nil if none\n   \"results\"(Hash|nil):: Results activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per operation result type, or nil if none\n   \"retries\"(Hash|nil):: Retry activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per request type, or nil if none\n   \"send failure\"(Hash|nil):: Send failure activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per failure type, or nil if none", "Reset dispatch statistics\n\n === Return\n true:: Always return true", "Send request via HTTP\n Use next_tick for asynchronous response and to ensure\n that the request is sent using the main EM reactor thread\n\n === Parameters\n kind(Symbol):: Kind of request: :send_push or :send_request\n target(Hash|NilClass):: Target for request\n packet(Push|Request):: Request packet to send\n received_at(Time):: Time when request received\n\n === Block\n Optional block used to process response asynchronously with the following parameter:\n   result(Result):: Response with an OperationResult of SUCCESS, RETRY, NON_DELIVERY, or ERROR\n\n === Return\n true:: Always return true", "Send request via HTTP and then immediately handle response\n\n === Parameters\n kind(Symbol):: Kind of request: :send_push or :send_request\n target(Hash|NilClass):: Target for request\n packet(Push|Request):: Request packet to send\n received_at(Time):: Time when request received\n\n === Block\n Optional block used to process response asynchronously with the following parameter:\n   result(Result):: Response with an OperationResult of SUCCESS, RETRY, NON_DELIVERY, or ERROR\n\n === Return\n true:: Always return true", "Send request via AMQP\n If lack connectivity and queueing enabled, queue request\n\n === Parameters\n kind(Symbol):: Kind of request: :send_push or :send_request\n target(Hash|NilClass):: Target for request\n packet(Push|Request):: Request packet to send\n received_at(Time):: Time when request received\n\n === Block\n Optional block used to process response asynchronously with the following parameter:\n   result(Result):: Response with an OperationResult of SUCCESS, RETRY, NON_DELIVERY, or ERROR\n\n === Return\n true:: Always return true", "Send request via AMQP without retrying\n Use mandatory flag to request return of message if it cannot be delivered\n\n === Parameters\n packet(Push|Request):: Request packet to send\n ids(Array|nil):: Identity of specific brokers to choose from, or nil if any okay\n\n === Return\n (Array):: Identity of brokers to which request was published\n\n === Raise\n SendFailure:: If sending of request failed unexpectedly\n TemporarilyOffline:: If cannot send request because RightNet client currently disconnected\n   and offline queueing is disabled", "Send request via AMQP with one or more retries if do not receive a response in time\n Send timeout result if reach configured retry timeout limit\n Use exponential backoff with RETRY_BACKOFF_FACTOR for retry spacing\n Adjust retry interval by average response time to avoid adding to system load\n when system gets slow\n Rotate through brokers on retries\n Check connectivity after first retry timeout\n\n === Parameters\n packet(Request):: Request packet to send\n parent_token(String):: Token for original request\n count(Integer):: Number of retries so far\n multiplier(Integer):: Multiplier for retry interval for exponential backoff\n elapsed(Integer):: Elapsed time in seconds since this request was first attempted\n broker_ids(Array):: Identity of brokers to be used in priority order\n\n === Return\n true:: Always return true", "Deliver the response and remove associated non-push requests from pending\n including all associated retry requests\n\n === Parameters\n response(Result):: Packet received as result of request\n pending_request(Hash):: Associated pending request\n\n === Return\n true:: Always return true", "Initialize RightNet client\n Must be called before any other functions are usable\n\n @param [AuthClient] auth_client providing authorization session for HTTP requests\n\n @option options [Numeric] :open_timeout maximum wait for connection\n @option options [Numeric] :request_timeout maximum wait for response\n @option options [Numeric] :listen_timeout maximum wait for event when long-polling\n @option options [Numeric] :retry_timeout maximum before stop retrying\n @option options [Array] :retry_intervals between successive retries\n @option options [Boolean] :retry_enabled for requests that fail to connect or that return a retry result\n @option options [Boolean] :non_blocking i/o is to be used for HTTP requests by applying\n   EM::HttpRequest and fibers instead of RestClient; requests remain synchronous\n @option options [Boolean] :long_polling_only never attempt to create a WebSocket, always long-polling instead\n @option options [Array] :filter_params symbols or strings for names of request parameters whose\n   values are to be hidden when logging; also applied to contents of any parameters named :payload\n\n @return [TrueClass] always true\n\n @raise [ArgumentError] no auth client", "Route a request to a single target or multiple targets with no response expected\n Persist the request en route to reduce the chance of it being lost at the expense of some\n additional network overhead\n Enqueue the request if the target is not currently available\n Never automatically retry the request if there is the possibility of it being duplicated\n Set time-to-live to be forever\n\n @param [String] type of request as path specifying actor and action\n @param [Hash, NilClass] payload for request\n @param [String, Hash, NilClass] target for request, which may be identity of specific\n   target, hash for selecting potentially multiple targets, or nil if routing solely\n   using type; hash may contain:\n   [Array] :tags that must all be associated with a target for it to be selected\n   [Hash] :scope for restricting routing which may contain:\n     [Integer] :account id that agents must be associated with to be included\n     [Integer] :shard id that agents must be in to be included, or if value is\n       Packet::GLOBAL, ones with no shard id\n   [Symbol] :selector for picking from qualified targets: :any or :all;\n     defaults to :any\n\n @option options [String] :request_uuid uniquely identifying this request; defaults to\n   randomly generated\n @option options [Numeric] :time_to_live seconds before request expires and is to be ignored;\n   non-positive value or nil means never expire\n\n @return [NilClass] always nil since there is no expected response to the request\n\n @raise [RuntimeError] init was not called\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is out of service or too busy to respond\n @raise [Exceptions::RetryableError] request failed but if retried may succeed\n @raise [Exceptions::Terminating] closing client and terminating service\n @raise [Exceptions::InternalServerError] internal error in server being accessed", "Set callback for each successful communication excluding health checks\n\n @param [Array] types of server: :auth, :api, or :router; defaults to all\n\n @yield [] required block executed after successful communication\n\n @return [TrueClass] always true\n\n @raise [RuntimeError] init was not called", "Create a new instance of this class\n\n === Parameters\n timestamp(Time):: Timestamp associated with this result\n router_cert(String):: Arbitrary string\n id_cert(String):: Arbitrary string\n id_key(String):: Arbitrary string\n secret(String):: Shared secret with which the result is encrypted\n\n Serialize an enrollment result\n\n === Parameters\n obj(EnrollmentResult):: Object to serialize\n\n === Return\n (String):: Serialized object", "Check whether authorized\n\n @return [TrueClass] always true if don't raise exception\n\n @raise [Exceptions::Unauthorized] not authorized\n @raise [Exceptions::RetryableError] authorization expired, but retry may succeed", "Maps the given DevRepository to a has that can be consumed by the RightScraper gem\n\n === Returns\n (Hash)::\n   :repo_type (Symbol):: Type of repository: one of :git, :svn, :download or :local\n     * :git denotes a 'git' repository that should be retrieved via 'git clone'\n     * :svn denotes a 'svn' repository that should be retrieved via 'svn checkout'\n     * :download denotes a tar ball that should be retrieved via HTTP GET (HTTPS if uri starts with https://)\n     * :local denotes cookbook that is already local and doesn't need to be retrieved\n   :url (String):: URL to repository (e.g. git://github.com/opscode/chef-repo.git)\n   :tag (String):: git commit or svn branch that should be used to retrieve repository\n                       Optional, use 'master' for git and 'trunk' for svn if tag is nil.\n                       Not used for raw repositories.\n   :cookbooks_path (Array):: Path to cookbooks inside repostory\n                                             Optional (use location of repository as cookbook path if nil)\n   :first_credential (String):: Either the Private SSH key used to retrieve git repositories, or the Username used to retrieve svn and raw repositories\n   :second_credential (String):: Password used to retrieve svn and raw repositories", "Determines if this object is valid.\n\n === Return\n result(Boolean):: true if this object is valid, false if required fields are nil or empty", "Initialize the new agent\n\n === Parameters\n opts(Hash):: Configuration options per start method above\n\n === Return\n true:: Always return true\n Put the agent in service\n This requires making a RightNet connection via HTTP or AMQP\n and other initialization like loading actors\n\n === Return\n true:: Always return true", "Connect to an additional AMQP broker or reconnect it if connection has failed\n Subscribe to identity queue on this broker\n Update config file if this is a new broker\n Assumes already has credentials on this broker and identity queue exists\n\n === Parameters\n host(String):: Host name of broker\n port(Integer):: Port number of broker\n index(Integer):: Small unique id associated with this broker for use in forming alias\n priority(Integer|nil):: Priority position of this broker in list for use\n   by this agent with nil meaning add to end of list\n force(Boolean):: Reconnect even if already connected\n\n === Return\n (String|nil):: Error message if failed, otherwise nil", "Disconnect from an AMQP broker and optionally remove it from the configuration\n Refuse to do so if it is the last connected broker\n\n === Parameters\n host(String):: Host name of broker\n port(Integer):: Port number of broker\n remove(Boolean):: Whether to remove broker from configuration rather than just closing it,\n   defaults to false\n\n === Return\n (String|nil):: Error message if failed, otherwise nil", "There were problems while setting up service for this agent on the given AMQP brokers,\n so mark these brokers as failed if not currently connected and later, during the\n periodic status check, attempt to reconnect\n\n === Parameters\n ids(Array):: Identity of brokers\n\n === Return\n (String|nil):: Error message if failed, otherwise nil", "Gracefully terminate execution by allowing unfinished tasks to complete\n Immediately terminate if called a second time\n Report reason for termination if it is abnormal\n\n === Parameters\n reason(String):: Reason for abnormal termination, if any\n exception(Exception|String):: Exception or other parenthetical error information, if any\n\n === Return\n true:: Always return true", "Retrieve statistics about agent operation\n\n === Parameters:\n options(Hash):: Request options:\n   :reset(Boolean):: Whether to reset the statistics after getting the current ones\n\n === Return\n result(OperationResult):: Always returns success", "Get request statistics\n\n === Parameters\n reset(Boolean):: Whether to reset the statistics after getting the current ones\n\n === Return\n stats(Hash):: Current statistics:\n   \"connect requests\"(Hash|nil):: Stats about requests to update AMQP broker connections with keys \"total\", \"percent\",\n     and \"last\" with percentage breakdown by \"connects: <alias>\", \"disconnects: <alias>\", \"enroll setup failed:\n     <aliases>\", or nil if none\n   \"exceptions\"(Hash|nil):: Exceptions raised per category, or nil if none\n     \"total\"(Integer):: Total exceptions for this category\n     \"recent\"(Array):: Most recent as a hash of \"count\", \"type\", \"message\", \"when\", and \"where\"\n   \"non-deliveries\"(Hash):: AMQP message non-delivery activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown by request type, or nil if none\n   \"request failures\"(Hash|nil):: Request dispatch failure activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per failure type, or nil if none\n   \"response failures\"(Hash|nil):: Response delivery failure activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per failure type, or nil if none", "Reset agent statistics\n\n === Return\n true:: Always return true", "Set the agent's configuration using the supplied options\n\n === Parameters\n opts(Hash):: Configuration options\n\n === Return\n true:: Always return true", "Handle events received by this agent\n\n === Parameters\n event(Hash):: Event received\n\n === Return\n nil:: Always return nil indicating no response since handled separately via notify", "Convert event hash to packet\n\n === Parameters\n event(Hash):: Event to be converted\n\n === Return\n (Push|Request):: Packet", "Convert result packet to event\n\n === Parameters\n result(Result):: Event to be converted\n\n === Return\n (Hash):: Event", "Create dispatcher per queue for use in handling incoming requests\n\n === Return\n [Hash]:: Dispatchers with queue name as key", "Load the ruby code for the actors\n\n === Return\n true:: Always return true", "Create client for HTTP-based RightNet communication\n The code loaded with the actors specific to this application\n is responsible for calling this function\n\n === Parameters\n auth_client(AuthClient):: Authorization client to be used by this agent\n\n === Return\n true:: Always return true", "Setup client status collection\n\n === Return\n true:: Always return true", "Setup non-delivery handler\n\n === Return\n true:: Always return true", "Setup queue for this agent\n\n === Parameters\n name(String):: Queue name\n ids(Array):: Identity of brokers for which to subscribe, defaults to all usable\n\n === Return\n (Array):: Identity of brokers to which subscribe submitted (although may still fail)", "Handle packet from queue\n\n === Parameters\n queue(String):: Name of queue from which message was received\n packet(Packet):: Packet received\n header(AMQP::Frame::Header):: Packet header containing ack control\n\n === Return\n true:: Always return true", "Dispatch request and then send response if any\n\n === Parameters\n request(Push|Request):: Packet containing request\n queue(String):: Name of queue from which message was received\n\n === Return\n true:: Always return true", "Deliver response to request sender\n\n === Parameters\n result(Result):: Packet containing response\n\n === Return\n true:: Always return true", "Finish any remaining agent setup\n\n === Return\n true:: Always return true", "Publish current stats\n\n === Return\n true:: Always return true", "Gracefully stop processing\n Close clients except for authorization\n\n === Parameters\n timeout(Integer):: Maximum number of seconds to wait after last request received before\n   terminating regardless of whether there are still unfinished requests\n\n === Return\n true:: Always return true", "Finish termination after all requests have been processed\n\n === Parameters\n timeout(Integer):: Maximum number of seconds to wait after last request received before\n   terminating regardless of whether there are still unfinished requests\n\n === Return\n true:: Always return true", "Send command to running agent\n\n === Parameters\n options(Hash):: Hash of options and command name\n   options[:name]:: Command name\n   options[:...]:: Other command specific options, passed through to agent\n verbose(Boolean):: Whether client should display debug info\n timeout(Integer):: Number of seconds we should wait for a reply from the agent\n\n === Block\n handler: Command results handler\n\n === Return\n true:: Always return true\n\n === Raise\n RuntimeError:: Timed out waiting for result, raised in EM thread", "Initialize pid file location from agent identity and pid directory\n Check whether pid file can be created\n Delete any existing pid file if process is not running anymore\n\n === Return\n true:: Always return true\n\n === Raise\n AlreadyRunning:: If pid file already exists and process is running", "Write pid to pid file\n\n === Return\n true:: Always return true", "Update associated command protocol port\n\n === Parameters\n options[:listen_port](Integer):: Command protocol port to be used for this agent\n options[:cookie](String):: Cookie to be used together with command protocol\n\n === Return\n true:: Always return true", "Read pid file content\n Empty hash if pid file does not exist or content cannot be loaded\n\n === Return\n content(Hash):: Hash containing 3 keys :pid, :cookie and :port", "Marshal packet into MessagePack format\n\n === Parameters\n a(Array):: Arguments\n\n === Return\n msg(String):: Marshalled packet", "Marshal packet into JSON format\n\n === Parameters\n a(Array):: Arguments\n\n === Return\n js(String):: Marshalled packet", "Determine enough precision for floating point value to give at least two significant\n digits and then convert the value to a decimal digit string of that precision\n\n === Parameters\n value(Float):: Value to be converted\n\n === Return\n (String):: Floating point digit string", "Generate log friendly serialized identity for one or more ids\n Limit to 1000 bytes\n\n === Parameters\n ids(Array|String):: Serialized identity or array of serialized identities\n\n === Return\n (String):: Log friendly serialized identity", "Generate token used to trace execution of operation across multiple packets\n\n === Return\n tr(String):: Trace token, may be empty", "Create RightNet router client\n\n @param [AuthClient] auth_client providing authorization session for HTTP requests\n\n @option options [Numeric] :open_timeout maximum wait for connection; defaults to DEFAULT_OPEN_TIMEOUT\n @option options [Numeric] :request_timeout maximum wait for response; defaults to DEFAULT_REQUEST_TIMEOUT\n @option options [Numeric] :listen_timeout maximum wait for event; defaults to DEFAULT_LISTEN_TIMEOUT\n @option options [Boolean] :long_polling_only never attempt to create a WebSocket, always long-polling instead\n @option options [Numeric] :retry_timeout maximum before stop retrying; defaults to DEFAULT_RETRY_TIMEOUT\n @option options [Array] :retry_intervals between successive retries; defaults to DEFAULT_RETRY_INTERVALS\n @option options [Boolean] :retry_enabled for requests that fail to connect or that return a retry result\n @option options [Numeric] :reconnect_interval for reconnect attempts after lose connectivity\n @option options [Boolean] :non_blocking i/o is to be used for HTTP requests by applying\n   EM::HttpRequest and fibers instead of RestClient; requests remain synchronous\n @option options [Array] :filter_params symbols or strings for names of request parameters whose\n   values are to be hidden when logging; also applied to contents of any parameters named :payload\n\n @raise [ArgumentError] auth client does not support this client type\n Route a request to a single target or multiple targets with no response expected\n Persist the request en route to reduce the chance of it being lost at the expense of some\n additional network overhead\n Enqueue the request if the target is not currently available\n Never automatically retry the request if there is the possibility of it being duplicated\n Set time-to-live to be forever\n\n @param [String] type of request as path specifying actor and action\n @param [Hash, NilClass] payload for request\n @param [Hash, NilClass] target for request, which may be a specific agent (using :agent_id),\n   potentially multiple targets (using :tags, :scope, :selector), or nil to route solely\n   using type:\n   [String] :agent_id serialized identity of specific target\n   [Array] :tags that must all be associated with a target for it to be selected\n   [Hash] :scope for restricting routing which may contain:\n     [Integer] :account id that agents must be associated with to be included\n     [Integer] :shard id that agents must be in to be included, or if value is\n       Packet::GLOBAL, ones with no shard id\n   [Symbol] :selector for picking from qualified targets: :any or :all;\n     defaults to :any\n\n @option options [String] :request_uuid uniquely identifying this request; defaults to\n   randomly generated\n @option options [Numeric] :time_to_live seconds before request expires and is to be ignored;\n   non-positive value or nil means never expire\n\n @return [NilClass] always nil since there is no expected response to the request\n\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is out of service or too busy to respond\n @raise [Exceptions::RetryableError] request failed but if retried may succeed\n @raise [Exceptions::Terminating] closing client and terminating service\n @raise [Exceptions::InternalServerError] internal error in server being accessed", "Route a request to a single target with a response expected\n Automatically retry the request if a response is not received in a reasonable amount of time\n or if there is a non-delivery response indicating the target is not currently available\n Timeout the request if a response is not received in time, typically configured to 30 sec\n Because of retries there is the possibility of duplicated requests, and these are detected and\n discarded automatically for non-idempotent actions\n Allow the request to expire per the agent's configured time-to-live, typically 1 minute\n\n @param [String] type of request as path specifying actor and action\n @param [Hash, NilClass] payload for request\n @param [Hash, NilClass] target for request, which may be a specific agent (using :agent_id),\n   one chosen randomly from potentially multiple targets (using :tags, :scope), or nil to\n   route solely using type:\n   [String] :agent_id serialized identity of specific target\n   [Array] :tags that must all be associated with a target for it to be selected\n   [Hash] :scope for restricting routing which may contain:\n     [Integer] :account id that agents must be associated with to be included\n\n @option options [String] :request_uuid uniquely identifying this request; defaults to\n   randomly generated\n @option options [Numeric] :time_to_live seconds before request expires and is to be ignored;\n   non-positive value or nil means never expire\n\n @return [Result, NilClass] response from request\n\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is out of service or too busy to respond\n @raise [Exceptions::RetryableError] request failed but if retried may succeed\n @raise [Exceptions::Terminating] closing client and terminating service\n @raise [Exceptions::InternalServerError] internal error in server being accessed", "Route event\n Use WebSocket if possible\n Do not block this request even if in the process of closing since used for request responses\n\n @param [Hash] event to send\n @param [Array, NilClass] routing_keys as strings to assist router in delivering\n   event to interested parties\n\n @return [TrueClass] always true\n\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is out of service or too busy to respond\n @raise [Exceptions::RetryableError] request failed but if retried may succeed\n @raise [Exceptions::Terminating] closing client and terminating service\n @raise [Exceptions::InternalServerError] internal error in server being accessed", "Receive events via an HTTP WebSocket if available, otherwise via an HTTP long-polling\n\n @param [Array, NilClass] routing_keys for event sources of interest with nil meaning all\n\n @yield [event] required block called each time event received\n @yieldparam [Hash] event received\n\n @return [TrueClass] always true, although only returns when closing\n\n @raise [ArgumentError] block missing\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is out of service or too busy to respond\n @raise [Exceptions::RetryableError] request failed but if retried may succeed\n @raise [Exceptions::Terminating] closing client and terminating service\n @raise [Exceptions::InternalServerError] internal error in server being accessed", "Perform listen action, then wait prescribed time for next action\n A periodic timer is not effective here because it does not wa\n\n @param [Array, NilClass] routing_keys for event sources of interest with nil meaning all\n\n @yield [event] required block called each time event received\n @yieldparam [Hash] event received\n\n @return [Boolean] false if failed or terminating, otherwise true", "Wait specified interval before next listen loop\n Continue waiting if interval changes while waiting\n\n @param [Time] started_at time when first started waiting\n @param [Numeric] interval to wait\n @param [Array, NilClass] routing_keys for event sources of interest with nil meaning all\n\n @yield [event] required block called each time event received\n @yieldparam [Hash] event received\n\n @return [TrueClass] always true", "Update listen state\n\n @param [Symbol] state next\n @param [Integer] interval before next listen action\n\n @return [TrueClass] always true\n\n @raise [ArgumentError] invalid state", "Try to create WebSocket connection\n\n @param [Array, NilClass] routing_keys for event sources of interest with nil meaning all\n\n @yield [event] required block called each time event received\n @yieldparam [Hash] event received\n\n @return [TrueClass] always true", "Connect to RightNet router using WebSocket for receiving events\n\n @param [Array, NilClass] routing_keys as strings to assist router in delivering\n   event to interested parties\n\n @yield [event] required block called when event received\n @yieldparam [Object] event received\n @yieldreturn [Hash, NilClass] event this is response to event received,\n   or nil meaning no response\n\n @return [Faye::WebSocket] WebSocket created\n\n @raise [ArgumentError] block missing", "Try to make long-polling request to receive events\n\n @param [Array, NilClass] routing_keys for event sources of interest with nil meaning all\n @param [Array, NilClass] event_uuids from previous poll\n\n @yield [event] required block called each time event received\n @yieldparam [Hash] event received\n\n @return [Array, NilClass, Exception] UUIDs of events received, or nil if none, or Exception if failed", "Try to make long-polling request to receive events using EM defer thread\n Repeat long-polling until there is an error or the stop time has been reached\n\n @param [Array, NilClass] routing_keys for event sources of interest with nil meaning all\n @param [Array, NilClass] event_uuids from previous poll\n\n @yield [event] required block called each time event received\n @yieldparam [Hash] event received\n\n @return [Array, NilClass] UUIDs of events received, or nil if none", "Make long-polling request to receive one or more events\n Do not return until an event is received or the polling times out or fails\n\n @param [Array, NilClass] routing_keys as strings to assist router in delivering\n   event to interested parties\n @param [Array, NilClass] ack UUIDs for events received on previous poll\n\n @yield [event] required block called for each event received\n @yieldparam [Object] event received\n\n @return [Array, NilClass] UUIDs of events received, or nil if none\n\n @raise [ArgumentError] block missing", "Process result from long-polling attempt\n Not necessary to log failure since should already have been done by underlying HTTP client\n\n @param [Array, NilClass] result from long-polling attempt\n\n @return [Array, NilClass] result for long-polling attempt", "Set configuration of this client and initialize HTTP access\n\n @param [Symbol] type of server for use in obtaining URL from auth_client, e.g., :router\n @param [AuthClient] auth_client providing authorization session for HTTP requests\n\n @option options [String] :server_name for use in reporting errors, e.g., RightNet\n @option options [String] :api_version of server for use in X-API-Version header\n @option options [Numeric] :open_timeout maximum wait for connection; defaults to DEFAULT_OPEN_TIMEOUT\n @option options [Numeric] :request_timeout maximum wait for response; defaults to DEFAULT_REQUEST_TIMEOUT\n @option options [Numeric] :retry_timeout maximum before stop retrying; defaults to DEFAULT_RETRY_TIMEOUT\n @option options [Array] :retry_intervals between successive retries; defaults to DEFAULT_RETRY_INTERVALS\n @option options [Boolean] :retry_enabled for requests that fail to connect or that return a retry result\n @option options [Numeric] :reconnect_interval for reconnect attempts after lose connectivity\n @option options [Boolean] :non_blocking i/o is to be used for HTTP requests by applying\n   EM::HttpRequest and fibers instead of RestClient; requests remain synchronous\n @option options [Array] :filter_params symbols or strings for names of request parameters\n   whose values are to be hidden when logging; also applied to contents of any parameters\n   named :payload; can be augmented on individual requests\n\n @return [Boolean] whether currently connected\n\n @raise [ArgumentError] auth client does not support this client type\n @raise [ArgumentError] :api_version missing", "Create HTTP client\n If there is an existing client, close it first\n\n @return [TrueClass] always true\n\n @return [BalancedHttpClient] client", "Close HTTP client persistent connections\n\n @param [String] reason for closing\n\n @return [Boolean] false if failed, otherwise true", "Check health of RightApi directly without applying RequestBalancer\n Do not check whether HTTP client exists\n\n @return [Symbol] RightApi client state", "If EventMachine reactor is running, begin attempting to periodically\n reconnect with server by checking health. Randomize initial attempt to\n reduce server spiking.\n\n If EventMachine reactor is NOT running, attempt to reconnect once\n and raise any exception that is encountered.\n\n @return [TrueClass] always true", "Make request via HTTP. Attempt to reconnect first if disconnected and EM reactor is not running.\n Rely on underlying HTTP client to log request and response.\n Retry request if response indicates to or if there are connectivity failures.\n\n There are also several timeouts involved:\n   - Underlying BalancedHttpClient connection open timeout (:open_timeout)\n   - Underlying BalancedHttpClient request timeout (:request_timeout)\n   - Retry timeout for this method and its handlers (:retry_timeout)\n   - Seconds before request expires and is to be ignored (:time_to_live)\n and if the target server is a RightNet router:\n   - Router response timeout (ideally > :retry_timeout and < :request_timeout)\n   - Router retry timeout (ideally = :retry_timeout)\n\n There are several possible levels of retry involved, starting with the outermost:\n   - This method will retry if the targeted server is not responding or if it receives\n     a retry response, but the total elapsed time is not allowed to exceed :request_timeout\n   - RequestBalancer in BalancedHttpClient will retry using other endpoints if it gets an error\n     that it considers retryable, and even if a front-end balancer is in use there will\n     likely be at least two such endpoints for redundancy\n and if the target server is a RightNet router:\n   - The router when sending a request via AMQP will retry if it receives no response,\n     but not exceeding its configured :retry_timeout; if the router's timeouts for retry\n     are consistent with the ones prescribed above, there will be no retry by the\n     RequestBalancer after router retries\n\n @param [Symbol] verb for HTTP REST request\n @param [String] path in URI for desired resource\n @param [Hash] params for HTTP request\n @param [String] type of request for use in logging; defaults to path\n @param [String, NilClass] request_uuid uniquely identifying this request;\n   defaults to randomly generated UUID\n @param [Numeric, NilClass] time_to_live seconds before request expires and is to be ignored;\n   non-positive value or nil means never expire; defaults to nil\n @param [Hash] options augmenting or overriding default options for HTTP request\n\n @return [Object, NilClass] result of request with nil meaning no result\n\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is out of service or too busy to respond\n @raise [Exceptions::RetryableError] request failed but if retried may succeed\n @raise [Exceptions::Terminating] closing client and terminating service\n @raise [Exceptions::InternalServerError] internal error in server being accessed", "Examine exception to determine whether to setup retry, raise new exception, or re-raise\n\n @param [StandardError] exception raised\n @param [String] action from request type\n @param [String] type of request for use in logging\n @param [String] request_uuid originally created for this request\n @param [Time] expires_at time for request\n @param [Integer] attempts to make request\n\n @return [String, NilClass] request UUID to be used on retry or nil if to raise instead\n\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is out of service or too busy to respond\n @raise [Exceptions::RetryableError] request failed but if retried may succeed\n @raise [Exceptions::InternalServerError] internal error in server being accessed", "Treat redirect response as indication that no longer accessing the correct shard\n Handle it by informing auth client so that it can re-authorize\n Do not retry, but tell client to with the expectation that re-auth will correct the situation\n\n @param [RestClient::MovedPermanently, RestClient::Found] redirect exception raised\n @param [String] type of request for use in logging\n @param [String] request_uuid originally created for this request\n\n @return [TrueClass] never returns\n\n @raise [Exceptions::RetryableError] request redirected but if retried may succeed\n @raise [Exceptions::InternalServerError] no redirect location provided", "Handle retry response by retrying it only once\n This indicates the request was received but a retryable error prevented\n it from being processed; the retry responsibility may be passed on\n If retrying, this function does not return until it is time to retry\n\n @param [RestClient::RetryWith] retry_result exception raised\n @param [String] type of request for use in logging\n @param [String] request_uuid originally created for this request\n @param [Time] expires_at time for request\n @param [Integer] attempts to make request\n\n @return [String] request UUID to be used on retry\n\n @raise [Exceptions::RetryableError] request failed but if retried may succeed", "Handle not responding response by determining whether okay to retry\n If request is being retried, this function does not return until it is time to retry\n\n @param [BalancedHttpClient::NotResponding] not_responding exception\n   indicating targeted server is too busy or out of service\n @param [String] type of request for use in logging\n @param [String] request_uuid originally created for this request\n @param [Time] expires_at time for request\n @param [Integer] attempts to make request\n\n @return [TrueClass] always true\n\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is out of service or too busy to respond", "Determine time interval before next retry\n\n @param [Time] expires_at time for request\n @param [Integer] attempts so far\n @param [Integer] max_retries\n\n @return [Integer, NilClass] retry interval with 0 meaning no try and nil meaning retry disabled", "Wait the specified interval in non-blocking fashion if possible\n\n @param [Numeric] interval to wait\n\n @return [TrueClass] always true", "Process request response and retry if needed\n\n === Parameters\n r(Result):: Request result\n\n === Return\n true:: Always return true", "Initialize serializer, must be called prior to using it\n\n === Parameters\n serializer(Serializer):: Object serializer\n identity(String):: Serialized identity associated with serialized messages\n store(Object):: Credentials store exposing certificates used for\n   encryption (:get_target), signature validation (:get_signer), and\n   certificate(s)/key(s) used for decryption (:get_receiver)\n encrypt(Boolean):: true if data should be signed and encrypted, otherwise\n   just signed, true by default\n Serialize, sign, and encrypt message\n Sign and encrypt using X.509 certificate\n\n === Parameters\n obj(Object):: Object to be serialized and encrypted\n encrypt(Boolean|nil):: true if object should be signed and encrypted,\n   false if just signed, nil means use class setting\n\n === Return\n (String):: MessagePack serialized and optionally encrypted object", "Decrypt, authorize signature, and unserialize message\n Use x.509 certificate store for decrypting and validating signature\n\n === Parameters\n msg(String):: Serialized and optionally encrypted object using MessagePack or JSON\n id(String|nil):: Optional identifier of source of data for use\n   in determining who is the receiver\n\n === Return\n (Object):: Unserialized object\n\n === Raise\n MissingCertificate:: If could not find certificate for message signer or receiver\n MissingPrivateKey:: If could not find private key for message receiver\n InvalidSignature:: If message signature check failed for message", "Fill out the session cookie appropriately for this attachment.", "Register callback block\n\n === Block\n Block that will get called back whenever a command is successfully parsed\n\n === Raise\n (ArgumentError): If block is missing\n Parse given input\n May cause multiple callbacks if multiple commands are successfully parsed\n Callback happens in next EM tick\n\n === Parameters\n chunk(String):: Chunck of serialized command(s) to be parsed\n\n === Return\n true:: If callback was called at least once\n false:: Otherwise", "Create test certificate", "Route request to appropriate actor for servicing\n Reject requests whose TTL has expired or that are duplicates of work already dispatched\n\n === Parameters\n request(Request|Push):: Packet containing request\n header(AMQP::Frame::Header|nil):: Request header containing ack control\n\n === Return\n (Result|nil):: Result of request, or nil if there is no result because request is a Push\n\n === Raise\n InvalidRequestType:: If the request cannot be routed to an actor\n DuplicateRequest:: If request rejected because it has already been processed", "Get dispatcher statistics\n\n === Parameters\n reset(Boolean):: Whether to reset the statistics after getting the current ones\n\n === Return\n stats(Hash):: Current statistics:\n   \"dispatched cache\"(Hash|nil):: Number of dispatched requests cached and age of youngest and oldest,\n     or nil if empty\n   \"dispatch failures\"(Hash|nil):: Dispatch failure activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per failure type, or nil if none\n   \"rejects\"(Hash|nil):: Request reject activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per reason (\"duplicate (<method>)\", \"retry duplicate (<method>)\", or\n     \"stale (<method>)\"), or nil if none\n   \"requests\"(Hash|nil):: Request activity stats with keys \"total\", \"percent\", \"last\", and \"rate\"\n     with percentage breakdown per request type, or nil if none", "Determine if request TTL has expired\n\n === Parameters\n request(Push|Request):: Request to be checked\n method(String):: Actor method requested to be performed\n\n === Return\n (OperationResult|nil):: Error result if expired, otherwise nil", "Determine whether this request is a duplicate\n\n === Parameters\n request(Request|Push):: Packet containing request\n method(String):: Actor method requested to be performed\n idempotent(Boolean):: Whether this method is idempotent\n\n === Return\n (String|nil):: Messaging describing who already serviced request if it is a duplicate, otherwise nil", "Use request type to route request to actor and an associated method\n\n === Parameters\n request(Push|Request):: Packet containing request\n\n === Return\n (Array):: Actor name, method name, and whether method is idempotent\n\n === Raise\n InvalidRequestType:: If the request cannot be routed to an actor", "Perform requested action\n\n === Parameters\n request(Push|Request):: Packet containing request\n token(String):: Unique identity token for request\n method(String):: Actor method requested to be performed\n idempotent(Boolean):: Whether this method is idempotent\n\n === Return\n (OperationResult):: Result from performing a request", "Save certificate to file in PEM format\n\n === Parameters\n file(String):: File path name\n\n === Return\n true:: Always return true", "Load events from history file\n\n === Return\n events(Array):: List of historical events with each being a hash of\n   :time(Integer):: Time in seconds in Unix-epoch when event occurred\n   :pid(Integer):: Process id of agent recording the event\n   :event(Object):: Event object in the form String or {String => Object},\n     where String is the event name and Object is any associated JSON-encodable data", "Convert request to RightApi form and then make request via HTTP\n\n @param [String] type of request as path specifying actor and action\n @param [Hash, NilClass] payload for request\n\n @option options [String] :request_uuid uniquely identifying this request\n @option options [Numeric] :time_to_live seconds before request expires and is to be ignored\n\n @return [Object, NilClass] response from request\n\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [Exceptions::ConnectivityFailure] cannot connect to server, lost connection\n   to it, or it is too busy to respond\n @raise [Exceptions::RetryableError] request failed but if retried may succeed\n @raise [Exceptions::Terminating] closing client and terminating service\n @raise [Exceptions::InternalServerError] internal error in server being accessed", "Convert response from request into required form where necessary\n\n @param [Object] response received\n @param [String] path in URI for desired resource\n\n @return [Object] converted response", "Convert tag query request into one or more API requests and then convert responses\n Currently only retrieving \"instances\" resources\n\n @param [Symbol] verb for HTTP REST request\n @param [Hash] params for HTTP request\n @param [String] action from request type\n @param [Hash] options augmenting or overriding default options for HTTP request\n\n @return [Hash] tags retrieved with resource href as key and tags array as value", "Query API for resources with specified tags\n\n @param [Symbol] verb for HTTP REST request\n @param [Array] tags that all resources retrieved must have\n @param [String] action from request type\n @param [Hash] options augmenting or overriding default options for HTTP request\n\n @return [Array] resource hrefs", "Query API for tags associated with a set of resources\n\n @param [Symbol] verb for HTTP REST request\n @param [Array] hrefs for resources whose tags are to be retrieved\n @param [String] action from request type\n @param [Hash] options augmenting or overriding default options for HTTP request\n\n @return [Hash] tags retrieved with resource href as key and tags array as value", "Convert payload to HTTP parameters\n\n @param [String] actor from request type\n @param [String] action from request type\n @param [Hash, NilClass] payload for request\n @param [String] path in URI for desired resource\n\n @return [Array] path string and parameters and options hashes", "Translate audit request payload to HTTP parameters\n Truncate audit summary to MAX_AUDIT_SUMMARY_LENGTH, the limit imposed by RightApi\n\n @param [String] action requested: create_entry or update_entry\n @param [Hash] payload from submitted request\n\n @return [Hash] HTTP request parameters\n\n @raise [ArgumentError] unknown request action", "Truncate string if it exceeds maximum length\n Do length check with bytesize rather than size since this method\n is only intended for use with ruby 1.9 and above, otherwise\n multi-byte characters could cause this code to be too lenient\n\n @param [String, NilClass] value to be truncated\n @param [Integer] max_length allowed; must be greater than 3\n\n @return [String, NilClass] truncated string or original value if it is not a string\n\n @raise [ArgumentError] max_length too small", "Create a new Image\n\n max_size - An ImageSize to specify the size and name of image.\n Cuts the File down to size! Creates a backup copy first, if required.", "if this change, update the regex that use the character directly in this mixin\n Generate a schema based on this collection's records.\n We evaluate the schema of each record and then merge all\n the information together.\n @param extended [Boolean] Set to true to keep each field as a basic type.\n        Set to false to reduce the terminal arrays to a single key (under the type array).\n @return [Hash] with one entry per 'column'/'field'. The values\n         contains information about the type and usage.", "Provides tips for the student for the given submission,\n based on the `rules`.", "ko_hash_merge! will merge and knockout elements prefixed with DEFAULT_FIELD_KNOCKOUT_PREFIX", "Works like with_scope, but discards any nested properties.", "Set a variable to the given value.  +Var+ must be a gnuplot variable and\n +value+ must be the value to set it to.  Automatic quoting will be\n performed if the variable requires it.\n\n This is overloaded by the +method_missing+ method so see that for more\n readable code.", "Merges object into current map.\n @param [JOSE::Map, Hash, String, JOSE::JWT] object\n @return [JOSE::JWT]", "Encrypts the `plain_text` using the `jwk` and algorithms specified by the `jwe`.\n\n @see JOSE::JWE.block_encrypt\n @param [String] plain_text\n @param [JOSE::JWE] jwe\n @return [JOSE::EncryptedMap]", "Key Agreement decryption of the `encrypted` binary or map using `my_private_jwk`.\n\n @see JOSE::JWK.box_encrypt\n @see JOSE::JWE.block_decrypt\n @param [JOSE::EncryptedBinary, JOSE::EncryptedMap] encrypted\n @param [JOSE::JWK] public_jwk\n @return [[String, JOSE::JWE]]", "Key Agreement encryption of `plain_text` by generating an ephemeral private key based on `other_public_jwk` curve.\n\n If no private key has been specified in `my_private_key`, it generates an ephemeral private key based on other public key curve.\n\n @see JOSE::JWK.box_decrypt\n @see JOSE::JWE.block_encrypt\n @param [String] plain_text\n @param [JOSE::JWK] jwk_secret\n @param [JOSE::JWE] jwe\n @return [JOSE::EncryptedMap, [JOSE::EncryptedMap, JOSE::JWK]]", "Computes the shared secret between two keys.\n\n Currently only works for `\"EC\"` keys and `\"OKP\"` keys with `\"crv\"` set to `\"X25519\"` or `\"X448\"`.\n\n @param [JOSE::JWK] other_jwk\n @return [String]", "Signs the `plain_text` using the `jwk` and the default signer algorithm `jws` for the key type.\n\n @see JOSE::JWS.sign\n @param [String] plain_text\n @param [JOSE::JWS] jws\n @param [JOSE::Map] header\n @return [JOSE::SignedMap]", "Signs the `plain_text` using the `jwk` and algorithm specified by the `jws`.\n @see JOSE::JWS.sign\n @param [JOSE::JWK] jwk\n @param [String] plain_text\n @param [JOSE::Map, Hash] header\n @return [JOSE::SignedMap]", "Verifies the `signature` using the `jwk`, `plain_text`, and `protected_binary`.\n @see JOSE::JWS.verify\n @see JOSE::JWS.verify_strict\n @param [JOSE::JWK] jwk\n @param [String] plain_text\n @param [String] signature\n @param [String] protected_binary\n @return [[Boolean, String, JOSE::JWS]]", "Returns the current listing of supported JOSE algorithms.\n\n     !!!ruby\n     JOSE::JWA.supports\n     # => {:jwe=>\n     #   {:alg=>\n     #     [\"A128GCMKW\",\n     #      \"A192GCMKW\",\n     #      \"A256GCMKW\",\n     #      \"A128KW\",\n     #      \"A192KW\",\n     #      \"A256KW\",\n     #      \"ECDH-ES\",\n     #      \"ECDH-ES+A128KW\",\n     #      \"ECDH-ES+A192KW\",\n     #      \"ECDH-ES+A256KW\",\n     #      \"PBES2-HS256+A128KW\",\n     #      \"PBES2-HS384+A192KW\",\n     #      \"PBES2-HS512+A256KW\",\n     #      \"RSA1_5\",\n     #      \"RSA-OAEP\",\n     #      \"RSA-OAEP-256\",\n     #      \"dir\"],\n     #    :enc=>\n     #     [\"A128GCM\",\n     #      \"A192GCM\",\n     #      \"A256GCM\",\n     #      \"A128CBC-HS256\",\n     #      \"A192CBC-HS384\",\n     #      \"A256CBC-HS512\"],\n     #    :zip=>\n     #     [\"DEF\"]},\n     #  :jwk=>\n     #   {:kty=>\n     #     [\"EC\",\n     #      \"OKP\",\n     #      \"RSA\",\n     #      \"oct\"],\n     #    :kty_EC_crv=>\n     #     [\"P-256\",\n     #      \"P-384\",\n     #      \"P-521\"],\n     #    :kty_OKP_crv=>\n     #     [\"Ed25519\",\n     #      \"Ed25519ph\",\n     #      \"Ed448\",\n     #      \"Ed448ph\",\n     #      \"X25519\",\n     #      \"X448\"]},\n     #  :jws=>\n     #   {:alg=>\n     #     [\"Ed25519\",\n     #      \"Ed25519ph\",\n     #      \"Ed448\",\n     #      \"Ed448ph\",\n     #      \"EdDSA\",\n     #      \"ES256\",\n     #      \"ES384\",\n     #      \"ES512\",\n     #      \"HS256\",\n     #      \"HS384\",\n     #      \"HS512\",\n     #      \"PS256\",\n     #      \"PS384\",\n     #      \"PS512\",\n     #      \"RS256\",\n     #      \"RS384\",\n     #      \"RS512\",\n     #      \"none\"]}}\n\n @return [Hash]", "Decrypts the `cipher_text` binary using the `key`, `aad`, `cipher_tag`, `encrypted_key`, and `iv`.\n @see JOSE::JWE.block_decrypt\n @param [JOSE::JWK, [JOSE::JWK, JOSE::JWK]] key\n @param [String] aad\n @param [String] cipher_text\n @param [String] cipher_tag\n @param [String] encrypted_key\n @param [String] iv\n @return [[String, JOSE::JWE]]", "Encrypts the `block` binary using the `key`, `cek`, and `iv`.\n @see JOSE::JWE.block_encrypt\n @param [JOSE::JWK, [JOSE::JWK, JOSE::JWK]] key\n @param [String, [String, String]] block\n @param [String] cek\n @param [String] iv\n @return [JOSE::EncryptedMap]", "Encrypts the `decrypted_key` using the `key` and the `\"alg\"` and `\"enc\"` specified by the `jwe`.\n\n @param [JOSE::JWK, [JOSE::JWK]] key\n @param [String] decrypted_key\n @return [[String, JOSE::JWE]]", "Returns the next `cek` using the `jwk` and the `\"alg\"` and `\"enc\"` specified by the `jwe`.\n\n @param [JOSE::JWK, [JOSE::JWK, JOSE::JWK]] key\n @return [[String, JOSE::JWE]]", "Create a new validator object.\n\n @param [~Class] klass\n   the class that created this validator\n @param [Symbol] id\n   the identifier or field this validator runs against\n @param [Proc] block\n   the block to execute to see if the validation passes\n\n\n Execute this validation in the context of the creating class, inside the\n given cookbook's path.\n\n @param [Cookbook]\n   the cookbook to run this validation against", "Create a tar file from the given root and packaging slip\n\n @param [String] root\n   the root where the tar files are being created\n @param [Hash<String, String>] slip\n   the map from physical file path to tarball file path\n\n @return [StringIO]\n   the io object that contains the tarball contents", "The option parser for handling command line flags.\n\n @return [OptionParser]", "The options to pass to the cookbook. Includes default values\n that are manipulated by the option parser.\n\n @return [Hash]", "Upload a cookbook to the community site.\n\n @param [Cookbook] cookbook\n   the cookbook to upload", "The ChefAPI connection object with lots of pretty middleware.", "Upload a cookbook to an Artifactory server.\n\n @param [Cookbook] cookbook\n   the cookbook to upload", "Create an HTTP connect to the Artifactory server.\n\n @return [Net::HTTP]", "Send an HTTP request to the Artifactory server.\n\n @param [Symbol] method\n   HTTP method to use\n\n @param [String] path\n   URI path to request\n\n @param [Proc] block\n   Optional block to set request values\n\n @return [Net::HTTPResponse]", "Deterine if this cookbook version is released on the Supermarket\n\n @warn\n   This is a fairly expensive operation and the result cannot be\n   reliably cached!\n\n @return [Boolean]\n   true if this cookbook at the current version exists on the community\n   site, false otherwise", "Create a new filter object.\n\n @param [~Plugin::Base] klass\n   the class that created this filter\n @param [String] message\n   the message given by the filter\n @param [Proc] block\n   the block captured by this filter\n\n\n Execute this filter in the context of the creating class, inside the\n given cookbook's path.\n\n @param [Cookbook]\n   the cookbook to run this filter against", "invoke context.instance_eval(@src)", "if object is an Class or Module then define instance method to it,\n else define singleton method to it.", "convert input string into target language", "detect spaces at beginning of line", "helper method to convert and evaluate input text with context object.\n context may be Binding, Hash, or Object.", "helper method evaluate Proc object with contect object.\n context may be Binding, Hash, or Object.", "Open the device and obtain a device handle.\n\n A handle allows you to perform I/O on the device in question.\n This is a non-blocking function; no requests are sent over the bus.\n\n If called with a block, the handle is passed to the block\n and is closed when the block has finished.\n\n You need proper device access:\n * Linux: read+write permissions to <tt>/dev/bus/usb/<bus>/<dev></tt>\n * Windows: by installing a WinUSB-driver for the device (see {file:README.rdoc#Usage_on_Windows} )\n\n @return [DevHandle] Handle to the device.", "Convenience function to retrieve the wMaxPacketSize value for a\n particular endpoint in the active device configuration.\n\n @param [Endpoint, Fixnum] endpoint  (address of) the endpoint in question\n @return [Fixnum]  the wMaxPacketSize value", "Calculate the maximum packet size which a specific endpoint is capable is\n sending or receiving in the duration of 1 microframe.\n\n Only the active configution is examined. The calculation is based on the\n wMaxPacketSize field in the endpoint descriptor as described in section 9.6.6\n in the USB 2.0 specifications.\n\n If acting on an isochronous or interrupt endpoint, this function will\n multiply the value found in bits 0:10 by the number of transactions per\n microframe (determined by bits 11:12). Otherwise, this function just returns\n the numeric value found in bits 0:10.\n\n This function is useful for setting up isochronous transfers, for example\n you might use the return value from this function to call\n IsoPacket#alloc_buffer in order to set the length field\n of an isochronous packet in a transfer.\n\n @param [Endpoint, Fixnum] endpoint  (address of) the endpoint in question\n @return [Fixnum] the maximum packet size which can be sent/received on this endpoint", "Obtain a config descriptor of the device.\n\n @param [Fixnum] index  number of the config descriptor\n @return Configuration", "Return configurations of the device.\n @return [Array<Configuration>]", "Register libusb's file descriptors and timeouts to EventMachine.\n\n @example\n   require 'libusb/eventmachine'\n   context = LIBUSB::Context.new\n   EventMachine.run do\n     context.eventmachine_register\n   end\n\n @see\n   DevHandle#eventmachine_bulk_transfer\n   DevHandle#eventmachine_control_transfer\n   DevHandle#eventmachine_interrupt_transfer", "Claim an interface on a given device handle.\n\n You must claim the interface you wish to use before you can perform I/O on any\n of its endpoints.\n\n It is legal to attempt to claim an already-claimed interface, in which case\n libusb just returns without doing anything.\n\n Claiming of interfaces is a purely logical operation; it does not cause any\n requests to be sent over the bus. Interface claiming is used to instruct the\n underlying operating system that your application wishes to take ownership of\n the interface.\n\n This is a non-blocking function.\n\n If called with a block, the device handle is passed through to the block\n and the interface is released when the block has finished.\n\n @param [Interface, Fixnum] interface  the interface or it's bInterfaceNumber you wish to claim", "Set the active configuration for a device.\n\n The operating system may or may not have already set an active configuration on\n the device. It is up to your application to ensure the correct configuration is\n selected before you attempt to claim interfaces and perform other operations.\n\n If you call this function on a device already configured with the selected\n configuration, then this function will act as a lightweight device reset: it\n will issue a SET_CONFIGURATION request using the current configuration, causing\n most USB-related device state to be reset (altsetting reset to zero, endpoint\n halts cleared, toggles reset).\n\n You cannot change/reset configuration if your application has claimed interfaces -\n you should free them with {DevHandle#release_interface} first. You cannot\n change/reset configuration if other applications or drivers have claimed\n interfaces.\n\n A configuration value of +nil+ will put the device in unconfigured state. The USB\n specifications state that a configuration value of 0 does this, however buggy\n devices exist which actually have a configuration 0.\n\n You should always use this function rather than formulating your own\n SET_CONFIGURATION control request. This is because the underlying operating\n system needs to know when such changes happen.\n\n This is a blocking function.\n\n @param [Configuration, Fixnum] configuration   the configuration or it's\n   bConfigurationValue you wish to activate, or +nil+ if you wish to put\n   the device in unconfigured state", "Activate an alternate setting for an interface.\n\n The interface must have been previously claimed with {DevHandle#claim_interface}.\n\n You should always use this function rather than formulating your own\n SET_INTERFACE control request. This is because the underlying operating system\n needs to know when such changes happen.\n\n This is a blocking function.\n\n @param [Setting, Fixnum] setting_or_interface_number  the alternate setting\n   to activate or the bInterfaceNumber of the previously-claimed interface\n @param [Fixnum, nil] alternate_setting  the bAlternateSetting of the alternate setting to activate\n   (only if first param is a Fixnum)", "Determine if a kernel driver is active on an interface.\n\n If a kernel driver is active, you cannot claim the interface,\n and libusb will be unable to perform I/O.\n\n @param [Interface, Fixnum] interface   the interface to check or it's bInterfaceNumber\n @return [Boolean]", "Detach a kernel driver from an interface.\n\n If successful, you will then be able to claim the interface and perform I/O.\n\n @param [Interface, Fixnum] interface    the interface to detach the driver\n   from or it's bInterfaceNumber", "Perform a USB bulk transfer.\n\n When called without a block, the transfer is done synchronously - so all events are handled\n internally and the sent/received data will be returned after completion or an exception will be raised.\n\n When called with a block, the method returns immediately after submitting the transfer.\n You then have to ensure, that {Context#handle_events} is called properly. As soon as the\n transfer is completed, the block is called with the sent/received data in case of success\n or the exception instance in case of failure.\n\n The direction of the transfer is inferred from the direction bits of the\n endpoint address.\n\n For bulk reads, the +:dataIn+ param indicates the maximum length of data you are\n expecting to receive. If less data arrives than expected, this function will\n return that data.\n\n You should check the returned number of bytes for bulk writes. Not all of the\n data may have been written.\n\n Also check {Error#transferred} when dealing with a timeout exception. libusb may have\n to split your transfer into a number of chunks to satisfy underlying O/S\n requirements, meaning that the timeout may expire after the first few chunks\n have completed. libusb is careful not to lose any data that may have been\n transferred; do not assume that timeout conditions indicate a complete lack of\n I/O.\n\n @param [Hash] args\n @option args [Endpoint, Fixnum] :endpoint  the (address of a) valid endpoint to communicate with\n @option args [String] :dataOut  the data to send with an outgoing transfer\n @option args [Fixnum] :dataIn   the number of bytes expected to receive with an ingoing transfer\n @option args [Fixnum] :timeout   timeout (in millseconds) that this function should wait before giving\n   up due to no response being received. For an unlimited timeout, use value 0. Defaults to 1000 ms.\n\n @return [Fixnum] Number of bytes sent for an outgoing transfer\n @return [String] Received data for an ingoing transfer\n @return [self]  When called with a block\n\n @yieldparam [String, Integer, LIBUSB::Error] result  result of the transfer is yielded to the block,\n   when the asynchronous transfer has finished\n @raise [ArgumentError, LIBUSB::Error] in case of failure", "Perform a USB control transfer.\n\n When called without a block, the transfer is done synchronously - so all events are handled\n internally and the sent/received data will be returned after completion or an exception will be raised.\n\n When called with a block, the method returns immediately after submitting the transfer.\n You then have to ensure, that {Context#handle_events} is called properly. As soon as the\n transfer is completed, the block is called with the sent/received data in case of success\n or the exception instance in case of failure.\n\n The direction of the transfer is inferred from the +:bmRequestType+ field of the\n setup packet.\n\n @param [Hash] args\n @option args [Fixnum] :bmRequestType   the request type field for the setup packet\n @option args [Fixnum] :bRequest  the request field for the setup packet\n @option args [Fixnum] :wValue  the value field for the setup packet\n @option args [Fixnum] :wIndex  the index field for the setup packet\n @option args [String] :dataOut  the data to send with an outgoing transfer, it\n   is appended to the setup packet\n @option args [Fixnum] :dataIn   the number of bytes expected to receive with an ingoing transfer\n   (excluding setup packet)\n @option args [Fixnum] :timeout   timeout (in millseconds) that this function should wait before giving\n   up due to no response being received. For an unlimited timeout, use value 0. Defaults to 1000 ms.\n\n @return [Fixnum] Number of bytes sent (excluding setup packet) for outgoing transfer\n @return [String] Received data (without setup packet) for ingoing transfer\n @return [self]  When called with a block\n\n @yieldparam [String, Integer, LIBUSB::Error] result  result of the transfer is yielded to the block,\n   when the asynchronous transfer has finished\n @raise [ArgumentError, LIBUSB::Error] in case of failure", "bNumDeviceCap Device Capability Descriptors\n\n @return [Array<Bos::DeviceCapability, Bos::Usb20Extension, Bos::SsUsbDeviceCapability, Bos::ContainerId>]", "Submit a transfer.\n\n This function will fire off the USB transfer and then return immediately.\n This method can be called with block. It is called when the transfer completes,\n fails, or is cancelled.", "Submit the transfer and wait until the transfer completes or fails.\n\n Inspect {#status} to check for transfer errors.", "Handle any pending events in blocking mode.\n\n This method must be called when libusb is running asynchronous transfers.\n This gives libusb the opportunity to reap pending transfers,\n invoke callbacks, etc.\n\n If a zero timeout is passed, this function will handle any already-pending\n events and then immediately return in non-blocking style.\n\n If a non-zero timeout is passed and no events are currently pending, this\n method will block waiting for events to handle up until the specified timeout.\n If an event arrives or a signal is raised, this method will return early.\n\n If the parameter completion_flag is used, then after obtaining the event\n handling lock this function will return immediately if the flag is set to completed.\n This allows for race free waiting for the completion of a specific transfer.\n See source of {Transfer#submit_and_wait} for a use case of completion_flag.\n\n @param [Integer, nil] timeout  the maximum time (in millseconds) to block waiting for\n                                events, or 0 for non-blocking mode\n @param [Context::CompletionFlag, nil] completion_flag  CompletionFlag to check\n\n @see interrupt_event_handler", "Obtain a list of devices currently attached to the USB system, optionally matching certain criteria.\n\n @param [Hash] filter_hash  A number of criteria can be defined in key-value pairs.\n   Only devices that equal all given criterions will be returned. If a criterion is\n   not specified or its value is +nil+, any device will match that criterion.\n   The following criteria can be filtered:\n   * <tt>:idVendor</tt>, <tt>:idProduct</tt> (+FixNum+) for matching vendor/product ID,\n   * <tt>:bClass</tt>, <tt>:bSubClass</tt>, <tt>:bProtocol</tt> (+FixNum+) for the device type -\n     Devices using CLASS_PER_INTERFACE will match, if any of the interfaces match.\n   * <tt>:bcdUSB</tt>, <tt>:bcdDevice</tt>, <tt>:bMaxPacketSize0</tt> (+FixNum+) for the\n     USB and device release numbers.\n   Criteria can also specified as Array of several alternative values.\n\n @example\n   # Return all devices of vendor 0x0ab1 where idProduct is 3 or 4:\n   context.device idVendor: 0x0ab1, idProduct: [0x0003, 0x0004]\n\n @return [Array<LIBUSB::Device>]", "Retrieve a list of file descriptors that should be polled by your main\n loop as libusb event sources.\n\n As file descriptors are a Unix-specific concept, this function is not\n available on Windows and will always return +nil+.\n\n @return [Array<Pollfd>]  list of Pollfd objects,\n   +nil+ on error,\n   +nil+ on platforms where the functionality is not available", "Determine the next internal timeout that libusb needs to handle.\n\n You only need to use this function if you are calling poll() or select() or\n similar on libusb's file descriptors yourself - you do not need to use it if\n you are calling {#handle_events} directly.\n\n You should call this function in your main loop in order to determine how long\n to wait for select() or poll() to return results. libusb needs to be called\n into at this timeout, so you should use it as an upper bound on your select() or\n poll() call.\n\n When the timeout has expired, call into {#handle_events} (perhaps\n in non-blocking mode) so that libusb can handle the timeout.\n\n This function may return zero. If this is the\n case, it indicates that libusb has a timeout that has already expired so you\n should call {#handle_events} immediately. A return code\n of +nil+ indicates that there are no pending timeouts.\n\n On some platforms, this function will always returns +nil+ (no pending timeouts).\n See libusb's notes on time-based events.\n\n @return [Float, nil]  the timeout in seconds", "Register a notification block for file descriptor additions.\n\n This block will be invoked for every new file descriptor that\n libusb uses as an event source.\n\n Note that file descriptors may have been added even before you register these\n notifiers (e.g. at {Context#initialize} time).\n\n @yieldparam [Pollfd] pollfd  The added file descriptor is yielded to the block", "Register a notification block for file descriptor removals.\n\n This block will be invoked for every removed file descriptor that\n libusb uses as an event source.\n\n Note that the removal notifier may be called during {Context#exit}\n (e.g. when it is closing file descriptors that were opened and added to the poll\n set at {Context#initialize} time). If you don't want this, overwrite the notifier\n immediately before calling {Context#exit}.\n\n @yieldparam [Pollfd] pollfd  The removed file descriptor is yielded to the block", "Register a hotplug event notification.\n\n Register a callback with the {LIBUSB::Context}. The callback will fire\n when a matching event occurs on a matching device. The callback is armed\n until either it is deregistered with {HotplugCallback#deregister} or the\n supplied block returns +:finish+ to indicate it is finished processing events.\n\n If the flag {Call::HotplugFlags HOTPLUG_ENUMERATE} is passed the callback will be\n called with a {Call::HotplugEvents :HOTPLUG_EVENT_DEVICE_ARRIVED} for all devices\n already plugged into the machine. Note that libusb modifies its internal\n device list from a separate thread, while calling hotplug callbacks from\n {#handle_events}, so it is possible for a device to already be present\n on, or removed from, its internal device list, while the hotplug callbacks\n still need to be dispatched. This means that when using\n {Call::HotplugFlags HOTPLUG_ENUMERATE}, your callback may be called twice for the arrival\n of the same device, once from {#on_hotplug_event} and once\n from {#handle_events}; and/or your callback may be called for the\n removal of a device for which an arrived call was never made.\n\n Since libusb version 1.0.16.\n\n @param [Hash] args\n @option args [Fixnum,Symbol] :events  bitwise or of events that will trigger this callback.\n   Default is +LIBUSB::HOTPLUG_EVENT_DEVICE_ARRIVED|LIBUSB::HOTPLUG_EVENT_DEVICE_LEFT+ .\n   See {Call::HotplugEvents HotplugEvents}\n @option args [Fixnum,Symbol] :flags hotplug callback flags. Default is 0. See {Call::HotplugFlags HotplugFlags}\n @option args [Fixnum] :vendor_id the vendor id to match. Default is {HOTPLUG_MATCH_ANY}.\n @option args [Fixnum] :product_id the product id to match. Default is {HOTPLUG_MATCH_ANY}.\n @option args [Fixnum] :dev_class the device class to match. Default is {HOTPLUG_MATCH_ANY}.\n @return [HotplugCallback]  The handle to the registered callback.\n\n @yieldparam [Device] device  the attached or removed {Device} is yielded to the block\n @yieldparam [Symbol] event  a {Call::HotplugEvents HotplugEvents} symbol\n @yieldreturn [Symbol] +:finish+ to deregister the callback, +:repeat+ to receive additional events\n @raise [ArgumentError, LIBUSB::Error] in case of failure", "Send text messages to a user or group chat.\n\n @param [Hash] params hash of paramers to send to the sendMessage API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [String] :text Required. Text of the message to be sent\n @option params [String] :parse_mode Optional. Send Markdown, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.\n @option params [Boolean] :disable_web_page_preview Optional. Disables link previews for links in this message\n @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message\n @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n\n     bot.send_message(\n       chat_id: 123456789,\n       text: \"Hello World!\"\n     )\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Forward message to a user or group chat.\n\n @param [Hash] params hash of paramers to send to the forwardMessage API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [Integer,String] :from_chat_id Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername).\n @option params [Integer] :message_id Required. Message id to be forwarded.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n\n     bot.forward_message(\n       chat_id: 123456789,\n       from_chat_id: 987654321\n       message_id: 111222333\n     )\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Sends a photo to a user or group chat.\n\n @param [Hash] params hash of paramers to send to the sendPhoto API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [File,String] :photo Required. Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data.\n @option params [String] :caption Optional. Photo caption (may also be used when resending photos by file_id).\n @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message\n @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     image_file = File.open(\"foo.jpg\")\n     bot.send_photo(chat_id: 123456789, photo: image_file)\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @see #send_document\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Sends audio file to a user or group chat.\n\n At this moment, Telegram only allows Ogg files encoded with the OPUS codec. If you need to send another file format, you must use #send_document.\n\n @param [Hash] params hash of paramers to send to the sendAudio API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [File,String] audio Required. Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data\n @option params [Integer] duration Optional. Duration of the audio in seconds.\n @option params [String] performer Optional. Performer.\n @option params [String] title Optional. Track name.\n @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message\n @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     audio_file = File.open(\"foo.ogg\")\n     bot.send_audio(chat_id: 123456789, audio: audio_file)\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @see #send_document\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Sends audio files file to a user or group chat that the users will see as a playable voice message.\n\n At this moment, Telegram only allows Ogg files encoded with the OPUS codec. If you need to send another file format, you must use #send_document.\n\n @param [Hash] params hash of paramers to send to the sendAudio API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [File,String] voice Required. Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data\n @option params [Integer] duration Optional. Duration of sent audio in seconds.\n @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message\n @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     voice_file = File.open(\"foo.ogg\")\n     bot.send_voice(chat_id: 123456789, voice: audio_file)\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @see #send_document\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Sends a document to a user or group chat.\n\n @param [Hash] params hash of paramers to send to the sendDocument API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [File,String] :document Required. File to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data.\n @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message\n @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     my_secret_file = File.open(\"secrets.doc\")\n     bot.send_document(chat_id: 123456789, document: my_secret_file)\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Send WebP images as stickers.\n\n @param [Hash] params hash of paramers to send to the sendSticker API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [File,String] :sticker Required. Sticker to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data.\n @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message\n @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     sticker_file = File.open(\"my-sticker.webp\")\n     bot.send_sticker(chat_id: 123456789, sticker: sticker_file)\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @see #send_document\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Sends a video file to a user or group chat.\n\n At this moment, Telegram only support mp4 videos. If you need to send other formats you must use #send_document.\n\n @param [Hash] params hash of paramers to send to the sendVideo API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [File,String] :video Required. Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file.\n @option params [Integer] :duration Optional. Duration of sent video in seconds.\n @option params [String] :caption Optional. Video caption (may also be used when resending videos by file_id).\n @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message\n @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     my_video = File.open(\"foo.mp4\")\n     bot.send_video(chat_id: 123456789, video: my_video)\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @see #send_document\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Sends point on the map to a user or group chat.\n\n @param [Hash] params hash of paramers to send to the sendAudio API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [Float] :latitude Required. Latitude of location.\n @option params [Float] :longitude Required. Longitude of location.\n @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message.\n @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     bot.send_location(chat_id: 123456789, latitude: 38.775539, longitude: -4.829988)\n\n @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat", "Sends a status action to a user or group chat.\n\n Used when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).\n\n @param [Hash] params hash of paramers to send to the sendChatAction API operation.\n @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).\n @option params [String] :action Required. Type of action to broadcast. Choose one, depending on what the user is about to receive: \"typing\" for text messages, \"upload_photo\" for photos, \"record_video\" or \"upload_video\" for videos, \"record_audio\" or \"upload_audio\" for audio files, \"upload_document\" for general files, \"find_location\" for location data.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     bot.send_chat_action(chat_id: 123456789, action: \"typing\")\n\n @raise [Telegrammer::Errors::BadRequestError]\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @return [Telegrammer::ApiResponse] Response from the API.", "Get a list of profile pictures for a user.\n\n @param [Hash] params hash of paramers to send to the getUserProfilePhotos API operation.\n @option params [Integer] :user_id Required. Unique identifier of the target user.\n @option params [Integer] :offset Optional. Sequential number of the first photo to be returned. By default, all photos are returned.\n @option params [Integer] :limit Optional. Limits the number of photos to be retrieved. Values between 1\u2014100 are accepted. Defaults to 100.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     bot.get_user_profile_photos(user_id: 123456789)\n\n @raise [Telegrammer::Errors::BadRequestError]\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @return [Telegrammer::DataTypes::UserProfilePhotos] Message object sent to the user or group chat", "Get basic info about a file and prepare it for downloading.\n\n @param [Hash] params hash of paramers to send to the getFile API operation.\n @option params [String] :file_id Required. File identifier to get info about.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n     bot.get_file(file_id: 123456789)\n\n @raise [Telegrammer::Errors::BadRequestError]\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @return [String] URL of the file (valid for one hour) or BadRequestError if the file_id is wrong", "Answer an inline query. On success, True is returned. No more than 50 results per query are allowed.\n\n @param [Hash] params hash of paramers to send to the answerInlineQuery API operation.\n @option params [String] :inline_query_id Required. Unique identifier for the answered query\n @option params [Array] :results Required. An array of InlineQueryResults objects for the inline query\n @option params [Fixnum] :cache_time Optional. The maximum amount of time the result of the inline query may be cached on the server\n @option params [TrueClass,FalseClass] :is_personal Optional. Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query\n @option params [String] :next_offset Optional. Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don\u2018t support pagination. Offset length can\u2019t exceed 64 bytes.\n\n @example\n     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')\n\n     bot.get_updates do |update|\n       if update.is_a?(Telegrammer::DataTypes::InlineQuery)\n         inline_query = message.inline_query\n\n         if inline_query\n           results = the_search_in_my_app(inline_query.query)\n\n           bot.answer_inline_query(\n             inline_query_id: \"my-internal-query-id\",\n             results: results\n           )\n         end\n       end\n     end\n\n @raise [Telegrammer::Errors::BadRequestError]\n @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down\n\n @return [TrueClass] True if all was OK", "Gets travel distance and time for a matrix of origins and destinations.\n\n @example Simple distance matrix\n   origins = [\"Perth, Australia\", \"Sydney, Australia\",\n              \"Melbourne, Australia\", \"Adelaide, Australia\",\n              \"Brisbane, Australia\", \"Darwin, Australia\",\n              \"Hobart, Australia\", \"Canberra, Australia\"]\n   destinations = [\"Uluru, Australia\",\n                   \"Kakadu, Australia\",\n                   \"Blue Mountains, Australia\",\n                   \"Bungle Bungles, Australia\",\n                   \"The Pinnacles, Australia\"]\n   matrix = client.distance_matrix(origins, destinations)\n\n @example Complex distance matrix\n   origins = [\"Bobcaygeon ON\", [41.43206, -81.38992]]\n   destinations = [[43.012486, -83.6964149], {lat: 42.8863855, lng: -78.8781627}]\n   matrix = client.distance_matrix(origins, destinations,\n       mode: 'driving',\n       language: 'en-AU',\n       avoid: 'tolls',\n       units: 'imperial')\n\n @param [Array] origins One or more addresses and/or lat/lon pairs,\n         from which to calculate distance and time. If you pass an address\n         as a string, the service will geocode the string and convert it to\n         a lat/lon coordinate to calculate directions.\n @param [Array] destinations One or more addresses and/or lat/lon pairs, to\n         which to calculate distance and time. If you pass an address as a\n         string, the service will geocode the string and convert it to a\n         lat/lon coordinate to calculate directions.\n @param [String] mode Specifies the mode of transport to use when calculating\n         directions. Valid values are `driving`, `walking`, `transit` or `bicycling`.\n @param [String] language The language in which to return results.\n @param [String] avoid Indicates that the calculated route(s) should avoid the\n     indicated features. Valid values are `tolls`, `highways` or `ferries`.\n @param [String] units Specifies the unit system to use when displaying results.\n     Valid values are `metric` or `imperial`.\n @param [Integer, DateTime] departure_time Specifies the desired time of departure.\n @param [Integer, DateTime] arrival_time Specifies the desired time of arrival for transit\n     directions. Note: you can not specify both `departure_time` and `arrival_time`.\n @param [String, Array<String>] transit_mode Specifies one or more preferred modes of transit.\n     This parameter may only be specified for requests where the mode is\n     transit. Valid values are `bus`, `subway`, `train`, `tram`, or `rail`.\n     `rail` is equivalent to `[\"train\", \"tram\", \"subway\"]`.\n @param [String] transit_routing_preference Specifies preferences for transit\n     requests. Valid values are `less_walking` or `fewer_transfers`.\n\n @return [Hash] Matrix of distances. Results are returned in rows, each row\n     containing one origin paired with each destination.", "Converts a dict of components to the format expected by the Google Maps\n server.\n\n @example\n   >> GoogleMapsService::Convert.components({\"country\": \"US\", \"postal_code\": \"94043\"})\n   => \"country:US|postal_code:94043\"\n\n @param [Hash] arg The component filter.\n\n @return [String]", "Converts a waypoints to the format expected by the Google Maps server.\n\n Accept two representation of waypoint:\n\n 1. String: Name of place or comma-separated lat/lon pair.\n 2. Hash/Array: Lat/lon pair.\n\n @param [Array, String, Hash] waypoint Path.\n\n @return [String]", "Reverse geocoding is the process of converting geographic coordinates into a\n human-readable address.\n\n @example Simple lat/lon pair\n   client.reverse_geocode({lat: 40.714224, lng: -73.961452})\n\n @example Multiple parameters\n   client.reverse_geocode([40.714224, -73.961452],\n       location_type: ['ROOFTOP', 'RANGE_INTERPOLATED'],\n       result_type: ['street_address', 'route'],\n       language: 'es')\n\n @param [Hash, Array] latlng The latitude/longitude value for which you wish to obtain\n                the closest, human-readable address.\n @param [String, Array<String>] location_type One or more location types to restrict results to.\n @param [String, Array<String>] result_type One or more address types to restrict results to.\n @param [String] language The language in which to return results.\n\n @return [Array] Array of reverse geocoding results.", "Get time zone for a location on the earth, as well as that location's\n time offset from UTC.\n\n @example Current time zone\n   timezone = client.timezone([39.603481, -119.682251])\n\n @example Time zone at certain time\n   timezone = client.timezone([39.603481, -119.682251], timestamp: Time.at(1608))\n\n @param [Hash, Array] location The latitude/longitude value representing the location to\n     look up.\n @param [Integer, DateTime] timestamp Timestamp specifies the desired time as seconds since\n     midnight, January 1, 1970 UTC. The Time Zone API uses the timestamp to\n     determine whether or not Daylight Savings should be applied. Times\n     before 1970 can be expressed as negative values. Optional. Defaults to\n     `Time.now`.\n @param [String] language The language in which to return results.\n\n @return [Hash] Time zone object.", "Returns a base64-encoded HMAC-SHA1 signature of a given string.\n\n @param [String] secret The key used for the signature, base64 encoded.\n @param [String] payload The payload to sign.\n\n @return [String] Base64-encoded HMAC-SHA1 signature", "Un-escape any percent-escape sequences in a URI that are unreserved\n characters. This leaves all reserved, illegal and non-ASCII bytes encoded.\n\n @param [String] uri\n\n @return [String]", "Create a new HTTP client.\n @return [Hurley::Client]", "Make API call.\n\n @param [String] path Url path.\n @param [String] params Request parameters.\n @param [String] base_url Base Google Maps Web Service API endpoint url.\n @param [Boolean] accepts_client_id Sign the request using API {#keys} instead of {#client_id}.\n @param [Method] custom_response_decoder Custom method to decode raw API response.\n\n @return [Object] Decoded response body.", "Returns the path and query string portion of the request URL,\n first adding any necessary parameters.\n\n @param [String] path The path portion of the URL.\n @param [Hash] params URL parameters.\n @param [Boolean] accepts_client_id Sign the request using API {#keys} instead of {#client_id}.\n\n @return [String]", "Extract and parse body response as hash. Throw an error if there is something wrong with the response.\n\n @param [Hurley::Response] response Web API response.\n\n @return [Hash] Response body as hash. The hash key will be symbolized.", "Check HTTP response status code. Raise error if the status is not 2xx.\n\n @param [Hurley::Response] response Web API response.", "Get directions between an origin point and a destination point.\n\n @example Simple directions\n   routes = client.directions('Sydney', 'Melbourne')\n\n @example Complex bicycling directions\n   routes = client.directions('Sydney', 'Melbourne',\n       mode: 'bicycling',\n       avoid: ['highways', 'tolls', 'ferries'],\n       units: 'metric',\n       region: 'au')\n\n @example Public transportation directions\n    an_hour_from_now = Time.now - (1.0/24)\n    routes = client.directions('Sydney Town Hall', 'Parramatta, NSW',\n        mode: 'transit',\n        arrival_time: an_hour_from_now)\n\n @example Walking with alternative routes\n    routes = client.directions('Sydney Town Hall', 'Parramatta, NSW',\n       mode: 'walking',\n       alternatives: true)\n\n @param [String, Hash, Array] origin The address or latitude/longitude value from which you wish\n         to calculate directions.\n @param [String, Hash, Array] destination The address or latitude/longitude value from which\n     you wish to calculate directions.\n @param [String] mode Specifies the mode of transport to use when calculating\n     directions. One of `driving`, `walking`, `bicycling` or `transit`.\n @param [Array<String>, Array<Hash>, Array<Array>] waypoints Specifies an array of waypoints. Waypoints alter a\n     route by routing it through the specified location(s).\n @param [Boolean] alternatives If True, more than one route may be returned in the\n     response.\n @param [Array, String] avoid Indicates that the calculated route(s) should avoid the\n     indicated features.\n @param [String] language The language in which to return results.\n @param [String] units Specifies the unit system to use when displaying results.\n     `metric` or `imperial`.\n @param [String] region The region code, specified as a ccTLD (_top-level domain_)\n     two-character value.\n @param [Integer, DateTime] departure_time Specifies the desired time of departure.\n @param [Integer, DateTime] arrival_time Specifies the desired time of arrival for transit\n     directions. Note: you can not specify both `departure_time` and\n     `arrival_time`.\n @param [Boolean] optimize_waypoints Optimize the provided route by rearranging the\n     waypoints in a more efficient order.\n @param [String, Array<String>] transit_mode Specifies one or more preferred modes of transit.\n     This parameter may only be specified for requests where the mode is\n     transit. Valid values are `bus`, `subway`, `train`, `tram` or `rail`.\n     `rail` is equivalent to `[\"train\", \"tram\", \"subway\"]`.\n @param [String] transit_routing_preference Specifies preferences for transit\n     requests. Valid values are `less_walking` or `fewer_transfers`.\n\n @return [Array] Array of routes.", "Provides elevation data sampled along a path on the surface of the earth.\n\n @example Elevation along path\n   locations = [[40.714728, -73.998672], [-34.397, 150.644]]\n   results = client.elevation_along_path(locations, 5)\n\n @param [String, Array] path A encoded polyline string, or a list of\n         latitude/longitude pairs from which you wish to calculate\n         elevation data.\n @param [Integer] samples The number of sample points along a path for which to\n         return elevation data.\n\n @return [Array] Array of elevation data responses", "Snaps a path to the most likely roads travelled.\n\n Takes up to 100 GPS points collected along a route, and returns a similar\n set of data with the points snapped to the most likely roads the vehicle\n was traveling along.\n\n @example Single point snap\n   results = client.snap_to_roads([40.714728, -73.998672])\n\n @example Multi points snap\n   path = [\n       [-33.8671, 151.20714],\n       [-33.86708, 151.20683000000002],\n       [-33.867070000000005, 151.20674000000002],\n       [-33.86703, 151.20625]\n   ]\n   results = client.snap_to_roads(path, interpolate: true)\n\n @param [Array] path The path to be snapped. Array of latitude/longitude pairs.\n @param [Boolean] interpolate Whether to interpolate a path to include all points\n         forming the full road-geometry. When true, additional interpolated\n         points will also be returned, resulting in a path that smoothly\n         follows the geometry of the road, even around corners and through\n         tunnels.  Interpolated paths may contain more points than the\n         original path.\n\n @return [Array] Array of snapped points.", "Returns the nearest road segments for provided points.\n The points passed do not need to be part of a continuous path.\n\n @example Single point snap\n   results = client.nearest_roads([40.714728, -73.998672])\n\n @example Multi points snap\n   points = [\n       [-33.8671, 151.20714],\n       [-33.86708, 151.20683000000002],\n       [-33.867070000000005, 151.20674000000002],\n       [-33.86703, 151.20625]\n   ]\n   results = client.nearest_roads(points)\n\n @param [Array] points The points to be used for nearest road segment lookup. Array of latitude/longitude pairs\n                       which do not need to be a part of continuous part.\n                       Takes up to 100 independent coordinates, and returns the closest road segment for each point.\n\n @return [Array] Array of snapped points.", "Extracts a result from a Roads API HTTP response.", "Encodes a list of points into a polyline string.\n\n See the developer docs for a detailed description of this encoding:\n https://developers.google.com/maps/documentation/utilities/polylinealgorithm\n\n @param [Array<Hash>, Array<Array>] points A list of lat/lng pairs.\n\n @return [String]", "Take a list of filters to be mapped so they can update the query\n used upon the fulltext search of the ngrams", "Lets be comparable!\n\n\n See if another Spec is the same as this spec", "Tell the remote repoistory to mirror the given gem from an upstream\n repository", "Convert to the array format used by gem servers\n everywhere", "Create a new client\n\n Takes an argv like array as a parameter.", "Finds attribute value in the JSON response by looking at the given locations.", "Shorthand for adding locations to multiple attributes at once.", "Wraps a VCR cassette around API calls with the same name as the Flickr\n method called. For example, the cassette for `Flickr.sets.create` will\n be called \"flickr.photosets.create\". Because we repeat the same API calls\n in different examples, we can just reuse those VCR cassettes rather than\n recording new ones.", "Displays all the attributes and their values.", "Extracts the tempfile, content type and path.", "Creates a link tag to a given url or path and ensures that the linke will be rendered\n as jquery modal dialog\n\n ==== Signatures\n\n   link_to(body, url, html_options = {})\n   link_to(body, url)", "Read data files within a theme gem and add them to internal data\n\n Returns a hash appended with new data", "Analyse deeper hashes and extract contents to output", "Prints label, keys and values of mappings", "Would return 'true' if ping requset should be sent and  'nil' if not", "Ported from activesupport gem", "Callback fro RSpec. Returns a human-readable failure message.\n\n @return [String]", "Do the file contents match?\n\n @return [Boolean]", "Create a file in the temporary directory for this example.\n\n @param path [String] Path within the temporary directory to write to.\n @param content [String] File data to write.\n @param block [Proc] Optional block to return file data to write.\n @example\n   describe 'myapp' do\n     command 'myapp read data.txt'\n     file 'data.txt', <<-EOH\n   a thing\n   EOH\n     its(:exitstatus) { is_expected.to eq 0 }\n   end", "Copy fixture data from the spec folder to the temporary directory for this\n example.\n\n @param path [String] Path of the fixture to copy.\n @param dest [String] Optional destination path. By default the destination\n   is the same as path.\n @example\n   describe 'myapp' do\n     command 'myapp run test/'\n     fixture_file 'test'\n     its(:exitstatus) { is_expected.to eq 0 }\n   end", "Set an environment variable for this example.\n\n @param variables [Hash] Key/value pairs to set.\n @example\n   describe 'myapp' do\n     command 'myapp show'\n     environment DEBUG: true\n     its(:stderr) { is_expected.to include('[debug]') }\n   end", "return a random value from an array or range", "return an element from the array.  The first request will return\n the first element, the second request will return the second,\n and so forth.", "Set clearance to perform actions over a resource.\n Clearance level and resource can be either plural or singular.\n\n == Examples:\n\n   let :user, :show, :profile\n   let :user, :show, @profile\n   let :user, :show, ProfilesController\n   # Any user can can access 'profiles#show'.\n\n   let :admins, [:edit, :update], :articles, namespace: :admin\n   let :admins, [:edit, :update], @admin_article\n   let :admins, [:edit, :update], Admin::ArticlesController\n   # Admins can access 'admin/articles#edit' and 'admin/articles#update'.", "Check if a given clearance level allows to perform an action on a resource.\n Clearance level and resource can be either plural or singular.\n\n == Examples:\n\n   lets? :users, :create, :profiles\n   lets? :users, :create, @profile\n   lets? :users, :create, ProfilesController\n   # True if users are allowed to access 'profiles#create'.\n\n   lets? :admin, :edit, :article, namespace: :admin\n   lets? :admin, :edit, @admin_article\n   lets? :admin, :edit, Admin::ArticlesController\n   # True if any admin is allowed to access 'admin/articles#edit'.", "Validate access to the current route.", "Redirect if not authorized.\n May be used inside action methods for finer control.", "Check if the user is authorized to perform a given action.\n Resource can be either plural or singular.\n\n == Examples:\n\n   user.can? :show, :articles\n   user.can? :show, @article\n   user.can? :show, ArticlesController\n   # True if any of the user's clearance levels allows to access 'articles#show'\n\n   user.can? :edit, :articles, namespace: :admin\n   user.can? :edit, @admin_article\n   user.can? :edit, Admin::ArticlesController\n   # True if any of the user's clearance levels allows to access 'admin/articles#edit'", "Send an image\n\n @param [String] path The absoulte path of the image you want to send\n @param [TelegramMessage] refer referral of the method call\n @param [Block] callback Callback block that will be called when finished\n @since [0.1.1]", "Send an image with given url, not implemen\n\n @param [String] url The URL of the image you want to send\n @param [TelegramMessage] refer referral of the method call\n @param [Block] callback Callback block that will be called when finished\n @since [0.1.1]", "Send a video\n\n @param [String] path The absoulte path of the video you want to send\n @param [TelegramMessage] refer referral of the method call\n @param [Block] callback Callback block that will be called when finished\n @since [0.1.1]", "Reply a message to the chat\n\n @param [Symbol] type Type of the message (either of :text, :sticker, :image)\n @param [String] content Content to send a message\n @param [TelegramChat] target Specify a TelegramChat to send\n @param [TelegramContact] target Specify a TelegramContact to send\n @param [Block] callback Callback block that will be called when finished\n @since [0.1.0]", "Update user profile, contacts and chats\n\n @api private", "Update user profile\n\n @api private", "Update user contacts\n\n @api private", "Update user chats\n\n @api private", "Send contact to peer chat\n\n @param [String] peer Target chat to which contact will be send\n @param [String] contact phone number\n @param [String] contact first name\n @param [String] contact last name\n @example\n   telegram.send_contact('chat#1234567', '9329232332', 'Foo', 'Bar')", "Download an attachment from a message\n\n @param [type] type The type of an attachment (:photo, :video, :audio)\n @param [String] seq Message sequence number\n @param [Block] callback Callback block that will be called when finished\n @yieldparam [Bool] success The result of the request (true or false)\n @yieldparam [Hash] data The raw data of the request\n @since [0.1.1]", "Process raw data in which event type is message given.\n\n @return [void]\n @api private", "Communicate telegram-rb with telegram-cli connection\n\n @param [Array<String>] messages Messages that will be sent\n @yieldparam [Block] callback Callback block that will be called when finished", "This method will be called by EventMachine when data arrived\n then parse given data and execute callback method if exists\n\n @api private", "Acquire available connection\n\n @see Connection\n @param [Block] callback This block will be called when successfully acquired a connection\n @yieldparam [Connection] connection acquired connection", "Initialize Telegram Client\n\n @yieldparam [Block] block\n @yield [config] Given configuration struct to the block\n Execute telegram-cli daemon and wait for the response\n\n @api private", "Do the long-polling from stdout of the telegram-cli\n\n @api private", "Start telegram-cli daemon\n\n @yield This block will be executed when all connections have responded", "Builds an array of Message objects from the MessageStruct objects.\n Decompressing messages if necessary.\n\n @return [Array<Message>]", "Add a messages for this broker", "Build protocol objects for this broker!", "Groups messages by broker and preps them for transmission.\n\n @return [Array<MessagesForBroker>]", "Execute a produce call\n\n @param [Integer] required_acks\n @param [Integer] timeout\n @param [Array<Protocol::MessagesForTopics>] messages_for_topics Messages to send\n @return [ProduceResponse]", "Execute a fetch call\n\n @param [Integer] max_wait_time\n @param [Integer] min_bytes\n @param [Integer] topic_fetches", "Fetch metadata for +topic_names+\n\n @param [Enumberable<String>] topic_names\n   A list of topics to retrive metadata for\n @return [TopicMetadataResponse] metadata for the topics", "Update what we know about the cluter based on MetadataResponse\n\n @param [MetadataResponse] topic_metadata_response\n @return nil", "Create a new message conductor\n\n @param [Hash<String,TopicMetadata>] topics_metadata\n   Metadata for all topics this conductor may receive.\n @param [Object] partitioner\n   Custom partitioner\n Determines which partition a message should be sent to.\n\n @param [String] topic\n   Topic we are sending this message to\n\n @param [Object] key\n   Key for this message, may be nil\n\n @return [Integer,Integer]\n   partition_id and broker_id to which this message should be sent", "Create a new consumer which reads the specified topic and partition from\n the host.\n\n @param [String] client_id  Used to identify this client should be unique.\n @param [String] host\n @param [Integer] port\n @param [String] topic Topic to read from\n @param [Integer] partition Partitions are zero indexed.\n @param [Integer,Symbol] offset\n   Offset to start reading from. A negative offset can also be passed.\n   There are a couple special offsets which can be passed as symbols:\n     :earliest_offset       Start reading from the first offset the server has.\n     :latest_offset         Start reading from the latest offset the server has.\n\n @param [Hash] options\n   Theses options can all be overridden in each individual fetch command.\n\n @option options [Integer] :max_bytes\n   Maximum number of bytes to fetch\n   Default: 1048576 (1MB)\n\n @option options [Integer] :max_wait_ms\n   How long to block until the server sends us data.\n   NOTE: This is only enforced if min_bytes is > 0.\n   Default: 100 (100ms)\n\n @option options [Integer] :min_bytes\n   Smallest amount of data the server should send us.\n   Default: 1 (Send us data as soon as it is ready)\n\n @option options [Integer] :socket_timeout_ms\n   How long to wait for reply from server. Should be higher than max_wait_ms.\n   Default: 10000 (10s)\n\n @api public\n Fetch messages from the broker.\n\n @param [Hash] options\n\n @option options [Integer] :max_bytes\n   Maximum number of bytes to fetch\n\n @option options [Integer] :max_wait_ms\n   How long to block until the server sends us data.\n\n @option options [Integer] :min_bytes\n   Smallest amount of data the server should send us.\n\n @api public", "Returns a new Producer.\n\n @param [Array<String>] brokers An array of brokers in the form \"host1:port1\"\n\n @param [String] client_id A client_id used to indentify the producer.\n\n @param [Hash] options\n\n @option options [:sync / :async] :type (:sync)\n   Whether we should send messages right away or queue them and send\n   them in the background.\n\n @option options [:gzip / :snappy / :none] :compression_codec (:none)\n   Type of compression to use.\n\n @option options [Enumberable<String>] :compressed_topics (nil)\n   Topics to compress.  If this is not specified we will compress all\n   topics provided that +:compression_codec+ is set.\n\n @option options [Integer: Milliseconds] :metadata_refresh_interval_ms (600_000)\n   How frequently we should update the topic metadata in milliseconds.\n\n @option options [#call, nil] :partitioner\n   Object which partitions messages based on key.\n   Responds to #call(key, partition_count).\n\n @option options [Integer] :max_send_retries (3)\n   Number of times to retry sending of messages to a leader.\n\n @option options [Integer] :retry_backoff_ms (100)\n   The amount of time (in milliseconds) to wait before refreshing the metadata\n   after we are unable to send messages.\n   Number of times to retry sending of messages to a leader.\n\n @option options [Integer] :required_acks (0)\n   The number of acks required per request.\n\n @option options [Integer] :ack_timeout_ms (1500)\n   How long the producer waits for acks.\n\n @option options [Integer] :socket_timeout_ms] (10000)\n   How long the producer socket waits for any reply from server.\n\n @api public\n Send messages to the cluster. Raises an exception if the producer fails to send the messages.\n\n @param [Enumerable<MessageToSend>] messages\n   Messages must have a +topic+ set and may have a +key+ set.\n\n @return [Boolean]\n\n @api public", "Get terminal rows and columns\n\n @return [Array[Integer, Integer]]\n   return rows & columns\n\n @api public", "Determine terminal size with a Windows native API\n\n @return [nil, Array[Integer, Integer]]\n\n @api private", "Determine terminal size on jruby using native Java libs\n\n @return [nil, Array[Integer, Integer]]\n\n @api private", "Read terminal size from Unix ioctl\n\n @return [nil, Array[Integer, Integer]]\n\n @api private", "Detect screen size using Readline\n\n @api private", "Detect terminal size from tput utility\n\n @api private", "Detect terminal size from stty utility\n\n @api private", "Runs command silently capturing the output\n\n @api private", "Ensures that required arguments are present and that optional arguments\n are recognized.\n\n @param [Hash] options arguments\n @raise [ArgumentError] if it can't find a required argument or can't\n   recognize an optional argument\n @see Fog::Service::validate_options", "Initializes a parser based on the given _input_, which may be a CSS string\n or an array of tokens.\n\n See {Tokenizer#initialize} for _options_.\n Consumes an at-rule and returns it.\n\n 5.4.2. http://dev.w3.org/csswg/css-syntax-3/#consume-at-rule", "Consumes a component value and returns it, or `nil` if there are no more\n tokens.\n\n 5.4.6. http://dev.w3.org/csswg/css-syntax-3/#consume-a-component-value", "Consumes a declaration and returns it, or `nil` on parse error.\n\n 5.4.5. http://dev.w3.org/csswg/css-syntax-3/#consume-a-declaration", "Consumes a list of declarations and returns them.\n\n By default, the returned list may include `:comment`, `:semicolon`, and\n `:whitespace` nodes, which is non-standard.\n\n Options:\n\n   * **:strict** - Set to `true` to exclude non-standard `:comment`,\n     `:semicolon`, and `:whitespace` nodes.\n\n 5.4.4. http://dev.w3.org/csswg/css-syntax/#consume-a-list-of-declarations", "Consumes a function and returns it.\n\n 5.4.8. http://dev.w3.org/csswg/css-syntax-3/#consume-a-function", "Consumes a qualified rule and returns it, or `nil` if a parse error\n occurs.\n\n 5.4.3. http://dev.w3.org/csswg/css-syntax-3/#consume-a-qualified-rule", "Consumes a list of rules and returns them.\n\n 5.4.1. http://dev.w3.org/csswg/css-syntax/#consume-a-list-of-rules", "Consumes and returns a simple block associated with the current input\n token.\n\n 5.4.7. http://dev.w3.org/csswg/css-syntax/#consume-a-simple-block", "Parses a single component value and returns it.\n\n 5.3.7. http://dev.w3.org/csswg/css-syntax-3/#parse-a-component-value", "Parses a list of component values and returns an array of parsed tokens.\n\n 5.3.8. http://dev.w3.org/csswg/css-syntax/#parse-a-list-of-component-values", "Parses a single declaration and returns it.\n\n 5.3.5. http://dev.w3.org/csswg/css-syntax/#parse-a-declaration", "Parses a list of declarations and returns them.\n\n See {#consume_declarations} for _options_.\n\n 5.3.6. http://dev.w3.org/csswg/css-syntax/#parse-a-list-of-declarations", "Parses a single rule and returns it.\n\n 5.3.4. http://dev.w3.org/csswg/css-syntax-3/#parse-a-rule", "Returns the unescaped value of a selector name or property declaration.", "Consumes the remnants of a bad URL and returns the consumed text.\n\n 4.3.15. http://dev.w3.org/csswg/css-syntax/#consume-the-remnants-of-a-bad-url", "Consumes comments and returns them, or `nil` if no comments were consumed.\n\n 4.3.2. http://dev.w3.org/csswg/css-syntax/#consume-comments", "Consumes an escaped code point and returns its unescaped value.\n\n This method assumes that the `\\` has already been consumed, and that the\n next character in the input has already been verified not to be a newline\n or EOF.\n\n 4.3.8. http://dev.w3.org/csswg/css-syntax/#consume-an-escaped-code-point", "Consumes an ident-like token and returns it.\n\n 4.3.4. http://dev.w3.org/csswg/css-syntax/#consume-an-ident-like-token", "Consumes a name and returns it.\n\n 4.3.12. http://dev.w3.org/csswg/css-syntax/#consume-a-name", "Consumes a numeric token and returns it.\n\n 4.3.3. http://dev.w3.org/csswg/css-syntax/#consume-a-numeric-token", "Consumes a string token that ends at the given character, and returns the\n token.\n\n 4.3.5. http://dev.w3.org/csswg/css-syntax/#consume-a-string-token", "Consumes a Unicode range token and returns it. Assumes the initial \"u+\" or\n \"U+\" has already been consumed.\n\n 4.3.7. http://dev.w3.org/csswg/css-syntax/#consume-a-unicode-range-token", "Consumes a URL token and returns it. Assumes the original \"url(\" has\n already been consumed.\n\n 4.3.6. http://dev.w3.org/csswg/css-syntax/#consume-a-url-token", "Converts a valid CSS number string into a number and returns the number.\n\n 4.3.14. http://dev.w3.org/csswg/css-syntax/#convert-a-string-to-a-number", "Preprocesses _input_ to prepare it for the tokenizer.\n\n 3.3. http://dev.w3.org/csswg/css-syntax/#input-preprocessing", "Returns `true` if the given three-character _text_ would start an\n identifier. If _text_ is `nil`, the current and next two characters in the\n input stream will be checked, but will not be consumed.\n\n 4.3.10. http://dev.w3.org/csswg/css-syntax/#would-start-an-identifier", "Returns `true` if the given three-character _text_ would start a number.\n If _text_ is `nil`, the current and next two characters in the input\n stream will be checked, but will not be consumed.\n\n 4.3.11. http://dev.w3.org/csswg/css-syntax/#starts-with-a-number", "Manually assign the next number to the passed autoinc field.\n\n @raise [ Mongoid::Autoinc::AutoIncrementsError ] When `auto: true` is set\n in the increments call for `field`\n @raise [ AlreadyAssignedError ] When called more then once.\n\n @return [ Fixnum ] The assigned number", "Sets autoincrement values for all autoincrement fields.\n\n @return [ true ]", "Set autoincrement value for the passed autoincrement field,\n using the passed options\n\n @param [ Symbol ] field Field to set the autoincrement value for.\n @param [ Hash ] options Options to pass through to the serializer.\n\n @return [ true ] The value of `write_attribute`", "Asserts the validity of the passed scope\n\n @param [ Object ] scope The +Symbol+ or +Proc+ to evaluate\n\n @raise [ ArgumentError ] When +scope+ is not a +Symbol+ or +Proc+\n\n @return [ Object ] The scope of the autoincrement call", "Returns the number to add to the current increment\n\n @param [ Object ] step The +Integer+ to be returned\n or +Proc+ to be evaluated\n\n @raise [ ArgumentError ] When +step+ is not an +Integer+ or +Proc+\n\n @return [ Integer ] The number to add to the current increment", "Executes a proc and returns its +Integer+ value\n\n @param [ Proc ] step_proc The +Proc+ to call\n\n @raise [ ArgumentError ] When +step_proc+ does not evaluate to +Integer+\n\n @return [ Integer ] The number to add to the current increment", "Determine if two nodes are in the same effective Namespace\n\n @param [Node OR String] node_1 The first node to test\n @param [Node OR String] node_2 The second node to test", "generate captcha image and return it as blob", "generate speech by captcha from session", "generate captcha code, save in session and return", "validate given captcha code and re", "generate an image_tag for captcha image", "A photo can contain a source set of other photos!", "make sure that sources are wrapped as Hashies to allow method access", "List of symbols naming modules to load.", "Initialize an Authenticate session.\n\n The presence of a session does NOT mean the user is logged in; call #logged_in? to determine login status.\n Finish user login process, *after* the user has been authenticated.\n The user is authenticated by Authenticate::Controller#authenticate.\n\n Called when user creates an account or signs back into the app.\n Runs all configured callbacks, checking for login failure.\n\n If login is successful, @current_user is set and a session token is generated\n and returned to the client browser.\n If login fails, the user is NOT logged in. No session token is set,\n and @current_user will not be set.\n\n After callbacks are finished, a {LoginStatus} is yielded to the provided block,\n if one is provided.\n\n @param [User] user login completed for this user\n @yieldparam [Success,Failure] status result of the sign in operation.\n @return [User]", "Use this filter as a before_action to control access to controller actions,\n limiting to logged in users.\n\n Placing in application_controller will control access to all controllers.\n\n Example:\n\n   class ApplicationController < ActionController::Base\n     before_action :require_login\n\n     def index\n       # ...\n     end\n   end", "User is not authorized, bounce 'em to sign in", "Allows to dynamically set config attributes.", "Transforms config to the hash with all keys symbolized.\n\n @return [Hash]", "Responds for preparing compilation options.\n\n The next steps are executed:\n - is merges options into the engine config\n - it camelizes and symbolizes every option key\n - it removes nil values from the options\n\n @param options [Hash]\n @return [Hash]", "Reads the compiler source from a file and returns it.\n\n @param path [String]\n @return [String]", "Returns version of engine installed system-wide.\n\n @return [String]", "Checks if engine NPM package is installed.\n\n @raise {JadePug::CompilerError}\n   If engine NPM package is not installed.\n @return [nil]", "This method holds the 'eval' mechanism.", "Returns a string representation of the state's stack.", "Given a Ruby instance, will attempt to push it on the Lua stack.", "Pushes a hash on top of the Lua stack.", "Pushes an array on top of the Lua stack.", "Set the read only connection for a block. Used to set the connection for a controller action.", "Calls the Lua function.", "Resumes the coroutine", "Sets a value in the table\n\n TODO : have something for adding in the array part...", "Returns a Ruby Hash instance representing this Lua table.", "Returns a Ruby Array instance representing this Lua table.\n\n Will raise an error if the 'rendering' is not possible.\n\n   s = Rufus::Lua::State.new\n\n   @s.eval(\"return { a = 'A', b = 'B', c = 3 }\").to_a\n     # => error !\n\n   @s.eval(\"return { 1, 2 }\").to_a\n     # => [ 1.0, 2.0 ]\n\n   @s.eval(\"return {}\").to_a\n     # => []\n\n   @s.eval(\"return { 1, 2, car = 'benz' }\").to_a\n     # => error !\n\n == to_a(false)\n\n Setting the optional argument 'pure' to false will manage any table :\n\n   s = Rufus::Lua::State.new\n\n   @s.eval(\"return { a = 'A', b = 'B', c = 3 }\").to_a(false)\n     # => [[\"a\", \"A\"], [\"b\", \"B\"], [\"c\", 3.0]]\n\n   @s.eval(\"return { 1, 2 }\").to_a(false)\n     # => [1.0, 2.0]\n\n   @s.eval(\"return {}\").to_a(false)\n     # => []\n\n   @s.eval(\"return { 1, 2, car = 'benz' }\").to_a(false)\n     # => [1.0, 2.0, [\"car\", \"benz\"]]", "Display an alert with a text and an optional title\n Default without an specific type\n\n @param [String] text Body of the alert (gets automatically the title if no title is specified)\n @param [String] title Title of the alert\n @param [Hash] opts Optional Parameters", "Flash the configuration as json\n If no title is specified, use the text as the title\n\n @param [Hash] opts\n @return [Void]", "Builds XML from elements and attributes", "Inserts a middleware at the given index or directly before the\n given middleware object.", "Replaces the given middleware object or index with the new\n middleware.", "Reloads the +Element+ attributes from Exchanger.", "Convert Ruby value to XML", "Convert XML to Ruby value", "Resets a changed field back to its old value.\n\n Example:\n\n   person = Person.new(:title => \"Sir\")\n   person.title = \"Madam\"\n   person.reset_attribute!(\"title\")\n   person.title # \"Sir\"\n\n Returns:\n\n The old field value.", "Audit the original value for a field that can be modified in place.\n\n Example:\n\n <tt>person.accessed(\"aliases\", [ \"007\" ])</tt>", "Get all normal modifications plus in place potential changes.\n Also checks changes in array attributes with +Element+ objects.\n\n Example:\n\n <tt>person.modifications</tt>\n\n Returns:\n\n All changes to the document.", "Audit the change of a field's value.\n\n Example:\n\n <tt>person.modify(\"name\", \"Jack\", \"John\")</tt>", "Used for allowing accessor methods for dynamic attributes", "Does the actual HTTP level interaction.", "Attempts to bind to Active Directory\n\n If it works it returns the connection\n\n If it fails it raises and exception", "Gathers credentials for communicating with Nextcloud instance\n\n @param [Hash] args authentication credentials.\n @option args [String] :url Nextcloud instance URL\n @option args [String] :username Nextcloud instance administrator username\n @option args [String] :password Nextcloud instance administrator password\n Sends API request to Nextcloud\n\n @param method [Symbol] Request type. Can be :get, :post, :put, etc.\n @param path [String] Nextcloud OCS API request path\n @param params [Hash, nil] Parameters to send\n @return [Object] Nokogiri::XML::Document", "Makes an array out of repeated elements\n\n @param doc [Object] Nokogiri::XML::Document\n @param xpath [String] Path to element that is being repeated\n @return [Array] Parsed array", "Parses meta information returned by API, may include a status, status code and a message\n\n @param doc [Object] Nokogiri::XML::Document\n @return [Hash] Parsed hash", "Converts document to hash\n\n @param doc [Object] Nokogiri::XML::Document\n @param xpath [String] Document path to convert to hash\n @return [Hash] Hash that was produced from XML document", "Adds meta method to an object\n\n @param doc [Object] Nokogiri::XML::Document to take meta information from\n @param obj [#define_singleton_method] Object to add meta method to\n @return [#define_singleton_method] Object with meta method defined", "Shows errors, or success message\n\n @param doc [Object] Nokogiri::XML::Document\n @return [Hash] State response", "Shows error or returns false\n\n @param doc [Object] Nokogiri::XML::Document\n @return [Hash,Boolean] Returns error message if found, false otherwise", "Handle the output for the given field", "The same as cn_groups, but with the parent groups included", "Returns all the ous the object is in", "Runs a modify action on the current object, takes an aray of operations", "Returns an array of member objects for this object", "Runs the monitor and collects changes for the specified amount of times\n on the given directory. It stops the monitor afterwards.\n\n @yield", "Helper method for running the monitor one time.\n\n @yield", "Helper method for using the run method with the fixture helper.\n\n @yield", "Runs the monitor recursively and collects changes for the specified amount of times\n on the given directory. It stops the monitor afterwards.\n\n @yield", "Helper method for running the monitor recursively one time.\n\n @yield", "Helper method for using the run method recursively with the fixture helper.\n\n @yield", "Very customizable method to watch directories and then run the monitor\n\n @yield", "Prepares the temporary fixture directory and\n cleans it afterwards.\n\n @yield [path] an empty fixture directory\n @yieldparam [String] path the path to the fixture directory", "Converts the RGB to a terminal colour equivalent.\n\n @note Accepts the following numbers: 256, 16, 8.\n @param [Integer] color_model\n @raise [ArgumentError] if +color_model+ parameter is incorrect\n @return [TERM] a TERM representation of the RGB", "Checks whether the +ary+ has correct number of elements and these elements\n are valid RGB numbers.\n\n @param [Array<Integer>] ary\n @raise [ArgumentError] if the +ary+ is invalid\n @return [void]", "Approximates the given +byte+ to a terminal colour value within range of\n 256 colours.\n\n @param [Integer] byte a number between 0 and 255\n @return [Integer] approximated number", "Finds an approximated +term+ colour among the colour numbers within the\n given +color_model+.\n\n @param [Integer] term a colour to be approximated\n @param [Integer] color_model possible values {#to_term}\n @return [Integer] approximated number, which fits in range of color_model", "Approximates +term+ in correspondence with +color_model+\n\n @see #nearest_term_16\n @see #nearest_term_8\n @param [Integer] term a colour to be approximated\n @param [Integer] color_model possible values {#to_term}\n @return [Integer] approximated number, which fits in range of color_model", "Define parameter for the endpoint", "Define fluent endpoint dispatcher\n @param params [Hash] the parameters", "Declare a response header", "Declare a response\n @param code [Integer] the response code\n @param type the type\n @param description [String] the description\n @param headers [Array<String>] the headers names", "Override Sinatra route method", "Call for each endpoint declaration\n @return [Sinatra::SwaggerExposer::Processing::SwaggerRequestProcessor]", "Check if a value does not exist in a hash and throw an Exception\n @param key the key to validate\n @param values [Hash] the existing keys\n @param name [String] the valud name for the error message", "Validates whether +value+ is a valid hex colour value.\n\n @param [String] value\n @raise [TypeError] if +value+ isn't String\n @raise [ArgumentError] if +value+ is malformed\n @return [void]", "Copy a default theme to theme directory, but only if it isn't there yet.", "Action method with search which returns array of files that match current input.", "Helper method which returns objects of a given class.", "Searches possible completions from the action which match the input.", "Calls the action to generate an array of possible completions.", "ensure this rect can be drawn at current position\n or shift position of it can't", "Decrement the token counter in a category\n If the counter is 0, delete the token.\n If the total number of tokens is 0, delete the category.", "Load class instance", "Creates a mission.", "Creates a mission and replaces the mission it matches if possible.", "Given a hypothetical user input, reports back what mission it would have\n found and executed.", "Validates and sets values in M.config.", "Finds the full path to a gem's file relative it's load path directory.\n Returns nil if not found.", "Loads a completion file in Rc namespace.", "Loads completion files in given directory.", "Find a user's home in a cross-platform way", "Add user to server\n\n returns: JSON parsed object\n\n Usage:\n\n  n=NessusREST::Client.new (:url=>'https://localhost:8834', :username=>'user', :password=> 'password')\n  pp n.user_add('user','password','16','local')\n\n Reference:\n https://localhost:8834/api#/resources/users/create", "change password for user_id\n\n returns: result code\n\n Usage:\n\n  n=NessusREST::Client.new (:url=>'https://localhost:8834', :username=>'user', :password=> 'password')\n  puts n.user_chpasswd(1,'newPassword')", "Perform HTTP delete method with uri, data and fields\n\n returns: HTTP result object\n\n Usage:\n\n  n=NessusREST::Client.new (:url=>'https://localhost:8834', :username=>'user', :password=> 'password')\n  res = n.http_delete(:uri=>\"/session\", :fields=>n.x_cookie)\n  puts res.code", "Perform HTTP get method with uri and fields\n\n returns: JSON parsed object (if JSON parseable)\n\n Usage:\n\n  n=NessusREST::Client.new (:url=>'https://localhost:8834', :username=>'user', :password=> 'password')\n  pp n.http_get(:uri=>\"/users\", :fields=>n.x_cookie)", "Perform HTTP post method with uri, data, body and fields\n\n returns: JSON parsed object (if JSON parseable)\n\n Usage:\n\n  n=NessusREST::Client.new (:url=>'https://localhost:8834', :username=>'user', :password=> 'password')\n  pp n.http_post(:uri=>\"/scans/#{scan_id}/launch\", :fields=>n.x_cookie)", "Perform JSON parsing of body\n\n returns: JSON parsed object (if JSON parseable)", "convenience method to build response URI", "generates a random key of up to +size+ bytes. The value returned is Base64 encoded with non-word\n characters removed.", "converts a hash to a URI query string\n @params [Hash] params URI parameters", "Get property value\n @param property_name [to_s]\n @return [*]", "Set property value\n @param property_name [to_s]\n @param value [*]", "Converts Entity to its XML representation.\n @return [String]", "Add a service to the Registry\n\n @param service [OData::Service] service to add to the registry", "Returns a hash of EntitySet names keyed to their respective EntityType name", "Returns the associations defined by the service\n @return [Hash<OData::Association>]", "Execute a request against the service\n\n @param url_chunk [to_s] string to append to service url\n @param additional_options [Hash] options to pass to Typhoeus\n @return [Typhoeus::Response]", "Find a specific node in the given result set\n\n @param results [Typhoeus::Response]\n @return [Nokogiri::XML::Element]", "Find entity entries in a result set\n\n @param results [Typhoeus::Response]\n @return [Nokogiri::XML::NodeSet]", "Get the property used as the title for an entity from metadata.\n\n @param entity_name [to_s] the name of the relevant entity\n @return [String] the name of the property used as the entity title", "Get the list of properties and their various options for the supplied\n Entity name.\n @param entity_name [to_s]\n @return [Hash]\n @api private", "Get list of properties and their various options for the supplied\n ComplexType name.\n @param type_name [to_s]\n @return [Hash]\n @api private", "Sets up the EntitySet to permit querying for the resources in the set.\n\n @param options [Hash] the options to setup the EntitySet\n @return [OData::EntitySet] an instance of the EntitySet\n Provided for Enumerable functionality\n\n @param block [block] a block to evaluate\n @return [OData::Entity] each entity in turn from this set", "Return the first n Entities for the set.\n If count is 1 it returns the single entity, otherwise its an array of entities\n @return [OData::EntitySet]", "Find the Entity with the supplied key value.\n @param key [to_s] primary key to lookup\n @return [OData::Entity,nil]", "split into groups this gives us 1234567 => 123 456 7\nso we need to reverse first\nin stages", "Create a new Query for the provided EntitySet\n @param entity_set [OData::EntitySet]\n Instantiates an OData::Query::Criteria for the named property.\n @param property [to_s]", "Execute the query.\n @return [OData::Query::Result]", "retrospec will initaialize this class so its up to you\n to set any additional variables you need in the context in feed the templates.\n returns the path to the templates\n first looks inside the external templates directory for specific file\n then looks inside the gem path templates directory, which is really only useful\n when developing new templates.", "returns the type file that the provider uses\n if the type file does not exist it assumes a core puppet type\n because we could potentially dealing with multiple", "puts a symlink in that module directory that points back to the user supplied module path", "creates a tmp module directory so puppet can work correctly", "creates a puppet resource request to be used indirectly", "this is made public for ec2admin usage", "Resolve security group names to their ids in the given VPC", "Use this function to run the command line tool, it will inherently use the options hash for all options\n That need to be specified on the command line", "The findfix method acts like a recursive method and applies fixes defined in the errorcodes\n If a fix is found it is applied to the options hash, and then the last run command is retried\n until all the fixes are exhausted or a error not defined in the errorcodes is found\n this must be overrided in the subclass, as there are no generic errors that fit both providers", "The findfix method acts like a recursive method and applies fixes defined in the errorcodes\n If a fix is found it is applied to the options hash, and then the last run command is retried\n until all the fixes are exhausted or a error not defined in the errorcodes is found", "set boot device from given boot device", "set boot device to pxe with option to reboot", "set boot device to disk with option to reboot", "set boot device to cdrom with option to reboot", "boot into bios setup with option to reboot", "A currently unsupported method to retrieve the led status", "parse the fru information that should be an array of lines", "Compute the filters to use in the html-pipeline based on the given options", "Update the preview file", "reset the bmc device, useful for debugging and troubleshooting", "reset the bmc device, useful for troubleshooting", "This function will get the bmcinfo and return a hash of each item in the info", "returns a hash of fan sensors where the key is fan name and value is the sensor", "returns a hash of sensors where each key is the name of the sensor and the value is the sensor", "This is the raw command to get the entire ipmi chassis configuration\n If you pass in a section you will get just the section", "parse the fru information", "Writes new spec or appends to the existing spec.", "Creates new spec.\n\n rubocop:disable Metrics/AbcSize", "Returns ERB instance for creating new spec", "Returns ERB instance for appeding lacking tests", "Returns ERB template", "Establishes a connection to the database that's used by all Active\n Record objects.", "Adds an index in the specified columns through ActiveRecord. Note you\n can provide a name as well\n\n @param columns [Array<String>, Array<Symbol>, String, Symbol]\n @param index_name [String]", "Removes the index in the given columns or by its name\n\n @param columns [Array<String>, Array<Symbol>, String, Symbol]\n @param index_name [String]", "Change the column to use the provided definition, through ActiveRecord\n\n @param column_name [String, Symbol]\n @param definition [String, Symbol]", "Adds a unique index on the given columns, with the provided name if passed\n\n @param columns [Array<String>, Array<Symbol>, String, Symbol]\n @param index_name [String]", "Returns the instance of ActiveRecord column with the given name and\n definition\n\n @param name [String, Symbol]\n @param definition [String]", "Returns the column instance with the provided data\n\n @return [column_factory]", "Gets the DEFAULT value the column takes as specified in the\n definition, if any\n\n @return [String, NilClass]", "Checks whether the column accepts NULL as specified in the definition\n\n @return [Boolean]", "Runs the command in a separate process, capturing its stdout and\n execution status", "Validates the status of the execution\n\n @raise [NoStatusError] if the spawned process' status can't be retrieved\n @raise [SignalError] if the spawned process received a signal\n @raise [CommandNotFoundError] if pt-online-schema-change can't be found", "Returns all the arguments to execute pt-online-schema-change with\n\n @return [String]", "Bias adaptation function", "Main encode function", "Returns the XML for a WSSE header.", "Returns the WSSE password, encrypted for digest authentication.", "Called by the logger to prepare a message for output.\n @return [String]", "Formats the severity indicator prefixed before each line when writing to\n the log.\n\n @param [String] the severity of the message (ex DEBUG, WARN, etc.)\n @return [String] formatted version of the severity", "Formats a time value expressed in ms, adding color to highlight times\n outside the expected range.\n\n If `time` is more than `expected` it's highlighted yellow. If it's more\n than double it's highlighted red.\n\n @param [String] time in ms.\n @param [Float] expected maximum amount of time it should have taken.\n @return [String] the formatted time.", "Create empty directories", "returns an array with each line following the current line, which is not a gem line", "Apply to a list of requirements\n @param requirements [Array<String>]\n @return [Array<String>]", "Get all the installed versions of the api-compatible executables.\n If a block is given, it yields once per found executable, lazily.\n @yieldparam executable_path [String]\n @yieldparam version [String]\n @yieldreturn [Boolean] - true if search should stop.\n @return [Hash<String,String>] executable_path, version", "Detects an installed version of the executable that matches the\n requirements.\n @return [String] path to an executable that meets the requirements\n @raise [Cliver::Dependency::NotMet] if no match found", "Check a single file", "Check an IO stream", "Output the lint errors", "Check file extension", "Check the data in the file or stream", "Check that the data is not empty", "Check that the data is valid YAML", "Check if there is overlapping key", "Returns an uncolored version of the string, that is all\n ANSI-Attributes are stripped from the string.", "Return +string+ or the result string of the given +block+ colored with\n color +name+. If string isn't a string only the escape sequence to switch\n on the color +name+ is returned.", "setup CLI options\n Run the CLI command", "Forgiving input, allows either argument if only one supplied.\n\n @overload initialize(*command_args)\n   @param command_args [Array<String>]\n @overload initialize(version_pattern)\n   @param version_pattern [Regexp]\n @overload initialize(*command_args, version_pattern)\n   @param command_args [Array<String>]\n   @param version_pattern [Regexp]\n @param executable_path [String] - the path to the executable to test\n @return [String] - should be contain {Gem::Version}-parsable\n                    version number.", "Render the chart", "Helper method that converts the constructor params into instance variables", "smooths the location data in the segment (by recalculating the location as an average of 20 neighbouring points.  Useful for removing noise from GPS traces.", "Crops any points falling within a rectangular area.  Identical to the\n delete_area method in every respect except that the points outside of\n the given area are deleted.  Note that this method automatically causes\n the meta data to be updated after deletion.", "Calculates and sets the duration attribute by subtracting the time on\n the very first point from the time on the very last point.", "Returns true if the pt is within these bounds.", "Returns true if the given time occurs within any of the segments of this track.", "Deletes all points within a given area and updates the meta data.", "Can be passed a float representing the polling frequency.\n The default is 5 seconds, but for a semi-active site you may\n want to use a smaller value.", "Log a message to STDOUT if we are verbose or very_verbose.", "custom modules to jekyll-typogrify\n surrounds two or more consecutive capital letters, perhaps with\n interspersed digits and periods in a span with a styled class.\n\n @param [String] text input text\n @return [String] input text with caps wrapped", "Performs a join to recursive subquery\n which should be built within a block.\n\n @example\n   MyModel.join_recursive do |query|\n     query.start_with(parent_id: nil)\n          .connect_by(id: :parent_id)\n          .where('depth < ?', 5)\n          .order_siblings(name: :desc)\n   end\n\n @param [Hash] join_options\n @option join_options [String, Symbol] :as aliased name of joined\n   table (`%table_name%__recursive` by default)\n @yield [query]\n @yieldparam [ActiveRecord::HierarchicalQuery::Query] query Hierarchical query\n @raise [ArgumentError] if block is omitted", "Mark the latest record with a tag in order to easily find and perform diff against later\n If there are no audits for this record, create a new audit with this tag", "Take a snapshot of the current state of the audited record's audited attributes", "Take a snapshot of and save the current state of the audited record's audited attributes\n\n Accept values for :tag, :action and :user in the argument hash. However, these are overridden by the values set by the auditable record's virtual attributes (#audit_tag, #audit_action, #changed_by) if defined", "Return last attribute's change\n\n This method may be slow and inefficient on model with lots of audit objects.\n Go through each audit in the reverse order and find the first occurrence when\n audit.modifications[attribute] changed", "Diffing two audits' modifications\n\n Returns a hash containing arrays of the form\n   {\n     :key_1 => [<value_in_other_audit>, <value_in_this_audit>],\n     :key_2 => [<value_in_other_audit>, <value_in_this_audit>],\n     :other_audit_own_key => [<value_in_other_audit>, nil],\n     :this_audio_own_key  => [nil, <value_in_this_audit>]\n   }", "Diff this audit with the latest audit created before the `time` variable passed", "Diff this audit with the latest audit created before this version", "Push a special key value list to the header", "Return the sample", "Returns an enum that can be used as an iterator.", "Returns the value of a field", "Return an integer list", "`be_json` checks if provided value is JSON, and optionally checks it contents.\n\n If you need to check against some hashes, it is more convenient to use `be_json_sym`, which\n parses JSON with `symbolize_names: true`.\n\n @example\n\n   expect('{}').to be_json # ok\n   expect('garbage').to be_json\n   # expected value to be a valid JSON string but failed: 765: unexpected token at 'garbage'\n\n   expect('{\"foo\": \"bar\"}').to be_json('foo' => 'bar') # ok\n   expect('{\"foo\": \"bar\"}').to be_json_sym(foo: 'bar') # more convenient\n\n   expect('{\"foo\": [1, 2, 3]').to be_json_sym(foo: array_including(3)) # nested matchers work\n   expect(something_large).to be_json_sym(include(meta: include(next_page: Integer)))\n\n @param expected Value or matcher to check JSON against. It should implement `#===` method,\n   so all standard and custom RSpec matchers work.", "Dumps available messages to headers and discards them to prevent appear\n it again after refreshing a page", "View helper method which renders flash messages to js variable if they\n weren't dumped to headers with XHR request", "Hash with available growl flash messages which contains a string object.", "Class method available in models\n\n == Example\n   class Order < ActiveRecord::Base\n      protokoll :number\n   end", "Tokenizes input and returns all tokens\n\n @param [String] input\n\n @return [Enumerator]\n   the tokens found\n\n @api public", "Advances through input and streams tokens\n\n @param [String] input\n\n @yield [Lex::Token]\n\n @api public", "Private User Trading", "Render with Nokogiri gem", "Render with plain strings", "Internal find_resource instance method\n\n @private\n @param [Symbol, String] resource name of resource to find\n @param [Hash] options finder options", "Internal authorize instance method\n\n @private\n @param [Symbol, String] one or more required roles\n @param [Hash] options authorizer options", "Initialize a new Index instance\n\n opts   - Index options\n\n opts[:secure] - Force HTTPS for all items. (default: false)\n\n Add map object to index\n\n map - XmlSitemap::Map instance", "Generate sitemap XML index", "Render XML sitemap index into the file\n\n path    - Output filename\n options - Options hash\n\n options[:ovewrite] - Overwrite file contents (default: true)", "Initializa a new Map instance\n\n domain - Primary domain for the map (required)\n opts   - Map options\n\n opts[:home]   - Automatic homepage creation. To disable set to false. (default: true)\n opts[:secure] - Force HTTPS for all items. (default: false)\n opts[:time]   - Set default lastmod timestamp for items (default: current time)\n opts[:group]  - Group name for sitemap index. (default: sitemap)\n opts[:root]   - Force all links to fall under the main domain.\n                 You can add full urls (not paths) if set to false. (default: true)\n\n Adds a new item to the map\n\n target - Path or url\n opts   - Item options\n\n opts[:updated]       - Lastmod property of the item\n opts[:period]        - Update frequency.\n opts[:priority]      - Item priority.\n opts[:validate_time] - Skip time validation if want to insert raw strings.", "Render XML sitemap into the file\n\n path    - Output filename\n options - Options hash\n\n options[:overwrite] - Overwrite the file contents (default: true)\n options[:gzip]      - Gzip file contents (default: false)", "Process target path or url", "Validate provided tokens\n\n @api private", "Validate provided state names\n\n @api private", "Automatically wraps the assigned value in an array if it doesn't respond to ``each``.\n Also filters out non-true values and empty strings.", "Override finish to avoid using BodyProxy", "Tries to dispatch to each eligable match. If the first match _passes_, tries the second match and so on.\n If there are no eligable matches, or all eligable matches pass, an appropriate 4xx response status is set.", "Dispatches the request to the matched target.\n Overriding this method provides the opportunity for one to have more control over how mapping targets are invoked.", "Finds mappings that match the unmatched portion of the request path, returning an array of `Match` objects, or an\n empty array if no matches were found.\n\n The `:eligable` attribute of the `Match` object indicates whether the conditions for that mapping passed.\n The result is cached for the life time of the controller instance, for the sake of effecient recalling.", "Returns an ordered list of eligable matches.\n Orders matches based on media_type, ensuring priority and definition order are respected appropriately.\n Sorts by mapping priority first, media type appropriateness second, and definition order third.", "Tests the given conditions, returning the name of the first failed condition, or nil otherwise.", "Test the given condition, returning true if the condition passes, or false otherwise.", "Redirects to the specified path or URL. An optional HTTP status is also accepted.", "Flash session storage helper.\n Stores session data until the next time this method is called with the same arguments, at which point it's reset.\n The typical use case is to provide feedback to the user on the previous action they performed.", "Returns false if any of the filters halted the request. True otherwise.", "The unescaped URL, excluding the escaped forward-slash and percent. The resulting string will always be safe\n to unescape again in situations where the forward-slash or percent are expected and valid characters.", "Construct a server from the given client using the network data found in +network_hash+\n\n Most users should not have to call this method directly. Instead you should access the\n servers property of an Account object, or use methods like BareMetalServer#find_servers\n or VirtualServer#find_servers\n\n\n Reboot the server.  This action is taken immediately.\n Servers can be rebooted in three different ways:\n :default_reboot - (Try soft, then hard) Attempts to reboot a server using the :os_reboot technique then, if that is not successful, tries the :power_cycle method\n :os_reboot - (aka. soft reboot) instructs the server's host operating system to reboot\n :power_cycle - (aka. hard reboot) The actual (for hardware) or metaphorical (for virtual servers) equivalent to pulling the plug on the server then plugging it back in.", "Change the notes of the server\n raises ArgumentError if you pass nil as the notes", "Change the hostname of this server\n Raises an ArgumentError if the new hostname is nil or empty", "Change the domain of this server\n\n Raises an ArgumentError if the new domain is nil or empty\n no further validation is done on the domain name", "Change the current port speed of the server\n\n +new_speed+ is expressed Mbps and should be 0, 10, 100, or 1000.\n Ports have a maximum speed that will limit the actual speed set\n on the port.\n\n Set +public+ to +false+ in order to change the speed of the\n private network interface.", "Begins an OS reload on this server.\n\n The OS reload can wipe out the data on your server so this method uses a\n confirmation mechanism built into the underlying SoftLayer API. If you\n call this method once without a token, it will not actually start the\n reload. Instead it will return a token to you. That token is good for\n 10 minutes. If you call this method again and pass that token **then**\n the OS reload will actually begin.\n\n If you wish to force the OS Reload and bypass the token safety mechanism\n pass the token 'FORCE' as the first parameter. If you do so\n the reload will proceed immediately.", "Initialize the plugin parser\n\n @param input [String] the JSON as a string to parse\n @return [Drone::Plugin] the instance of that class\n Parse the provided payload\n\n @return [Drone::Payload] the parsed payload within model\n @raise [Drone::InvalidJsonError] if the provided JSON is invalid", "Adds an object_filter to the result. An Object Filter allows you\n to specify criteria which are used to filter the results returned\n by the server.", "Create an upgrade order for the virtual server provided.\n\n\n Sends the order represented by this object to SoftLayer for validation.\n\n If a block is passed to verify, the code will send the order template\n being constructed to the block before the order is actually sent for\n validation.", "Places the order represented by this object.  This is likely to\n involve a change to the charges on an account.\n\n If a block is passed to this routine, the code will send the order template\n being constructed to that block before the order is sent", "Returns a list of the update item prices, in the given category, for the server", "Searches through the upgrade items prices known to this server for the one that is in a particular category\n and whose capacity matches the value given. Returns the item_price or nil", "construct an order object", "Assign an existing network storage credential specified by the username to the network storage instance", "Updates the password for the network storage instance.", "Remove an existing network storage credential specified by the username from the network storage instance", "Make an API request to SoftLayer and return the latest properties hash\n for this object.", "Updates the password for the network storage credential of the username specified.", "Returns the package items with the given description\n Currently this is returning the low-level hash representation directly from the Network API", "Returns an array of the datacenters that this image can be stored in.\n This is the set of datacenters that you may choose from, when putting\n together a list you will send to the datacenters= setter.", "Change the set of accounts that this image is shared with.\n The parameter is an array of account ID's.\n\n Note that this routine will \"unshare\" with any accounts\n not included in the list passed in so the list should\n be comprehensive", "Repeatedly poll the network API until transactions related to this image\n template are finished\n\n A template is not 'ready' until all the transactions on the template\n itself, and all its children are complete.\n\n At each trial, the routine will yield to a block if one is given\n The block is passed one parameter, a boolean flag indicating\n whether or not the image template is 'ready'.", "Create a new order for the given server\n\n Calls the SoftLayer API to verify that the template provided by this order is valid\n This routine will return the order template generated by the API or will throw an exception\n\n This routine will not actually create a Bare Metal Instance and will not affect billing.\n\n If you provide a block, it will receive the order template as a parameter and\n the block may make changes to the template before it is submitted.", "Cancel the firewall\n\n This method cancels the firewall and releases its\n resources. The cancellation is processed immediately!\n Call this method with careful deliberation!\n\n Notes is a string that describes the reason for the\n cancellation. If empty or nil, a default string will\n be added.", "This method asks the firewall to ignore its rule set and pass all traffic\n through the firewall. Compare the behavior of this routine with\n change_routing_bypass!\n\n It is important to note that changing the bypass to :bypass_firewall_rules\n removes ALL the protection offered by the firewall. This routine should be\n used with extreme discretion.\n\n Note that this routine queues a rule change and rule changes may take\n time to process. The change will probably not take effect immediately.\n\n The two symbols accepted as arguments by this routine are:\n :apply_firewall_rules - The rules of the firewall are applied to traffic. This is the default operating mode of the firewall\n :bypass_firewall_rules - The rules of the firewall are ignored. In this configuration the firewall provides no protection.", "This method allows you to route traffic around the firewall\n and directly to the servers it protects. Compare the behavior of this routine with\n change_rules_bypass!\n\n It is important to note that changing the routing to :route_around_firewall\n removes ALL the protection offered by the firewall. This routine should be\n used with extreme discretion.\n\n Note that this routine constructs a transaction. The Routing change\n may not happen immediately.\n\n The two symbols accepted as arguments by the routine are:\n :route_through_firewall - Network traffic is sent through the firewall to the servers in the VLAN segment it protects.  This is the usual operating mode of the firewall.\n :route_around_firewall - Network traffic will be sent directly to the servers in the VLAN segment protected by this firewall.  This means that the firewall will *NOT* be protecting those servers.", "Searches the set of access control lists for the firewall device in order to locate the one that\n sits on the \"outside\" side of the network and handles 'in'coming traffic.", "Calls the SoftLayer API to place an order for a new virtual server based on the template in this\n order. If this succeeds then you will be billed for the new Virtual Server.\n\n If you provide a block, it will receive the order template as a parameter and\n should return an order template, **carefully** modified, that will be\n sent to create the server", "Deletes specified username password from current software instance\n\n\n This is a final action and cannot be undone.\n the transaction will proceed immediately.\n\n Call it with extreme care!", "Adds a list of offending files to the danger comment\n\n @return [void]", "Construct and return a hash representing a +SoftLayer_Container_Product_Order_Virtual_Guest+\n based on the configuration options given.", "Capture a disk image of this virtual server for use with other servers.\n\n image_name will become the name of the image in the portal.\n\n If include_attached_storage is true, the images of attached storage will be\n included as well.\n\n The image_notes should be a string and will be added to the image as notes.\n\n The routine returns the instance of SoftLayer::ImageTemplate that is\n created.  That image template will probably not be available immediately, however.\n You may use the wait_until_ready routine of SoftLayer::ImageTemplate to\n wait on it.", "Repeatedly polls the API to find out if this server is 'ready'.\n\n The server is ready when it is provisioned and any operating system reloads have completed.\n\n If wait_for_transactions is true, then the routine will poll until all transactions\n (not just an OS Reload) have completed on the server.\n\n max_trials is the maximum number of times the routine will poll the API\n seconds_between_tries is the polling interval (in seconds)\n\n The routine returns true if the server was found to be ready. If max_trials\n is exceeded and the server is still not ready, the routine returns false\n\n If a block is passed to this routine it will be called on each trial with\n a boolean argument representing whether or not the server is ready\n\n Calling this routine will (in essence) block the thread on which the request is made.", "Searches the account's list of VLANs for the ones with the given\n vlan number. This may return multiple results because a VLAN can\n span different routers and you will get a separate segment for\n each router.\n\n The IDs of the different segments can be helpful for ordering\n firewalls.", "Returns a service with the given name.\n\n If a service has already been created by this client that same service\n will be returned each time it is called for by name. Otherwise the system\n will try to construct a new service object and return that.\n\n If the service has to be created then the service_options will be passed\n along to the creative function. However, when returning a previously created\n Service, the service_options will be ignored.\n\n If the service_name provided does not start with 'SoftLayer_' that prefix\n will be added", "Issue an HTTP request to call the given method from the SoftLayer API with\n the parameters and arguments given.\n\n Parameters are information _about_ the call, the object mask or the\n particular object in the SoftLayer API you are calling.\n\n Arguments are the arguments to the SoftLayer method that you wish to\n invoke.\n\n This is intended to be used in the internal\n processing of method_missing and need not be called directly.", "Set BIOS settings\n @param options [Hash] Hash of options to set\n @param system_id [Integer, String] ID of the system\n @raise [RuntimeError] if the request failed\n @return true", "Set the UEFI shell start up\n @param uefi_shell_startup [String, Symbol]\n @param uefi_shell_startup_location [String, Symbol]\n @param uefi_shell_startup_url [String, Symbol]\n @raise [RuntimeError] if the request failed\n @return true", "Get the BIOS DHCP\n @raise [RuntimeError] if the request failed\n @return [String] bios_dhcp", "Set the BIOS DHCP\n @param dhcpv4 [String, Symbol]\n @param ipv4_address [String, Symbol]\n @param ipv4_gateway [String, Symbol]\n @param ipv4_primary_dns [String, Symbol]\n @param ipv4_secondary_dns [String, Symbol]\n @param ipv4_subnet_mask [String, Symbol]\n @raise [RuntimeError] if the request failed\n @return true", "Set the URL boot file\n @param url_boot_file [String, Symbol]\n @raise [RuntimeError] if the request failed\n @return true", "Set the BIOS service\n @param name [String, Symbol]\n @param email [String, Symbol]\n @raise [RuntimeError] if the request failed\n @return true", "Clear the specified logs\n @param [String, Symbol] log_type\n @raise [RuntimeError] if the request failed\n @return true", "Get the specified logs\n @param [String, Symbol, NilClass] severity_level Set to nil to get all logs\n @param [String, Symbol] duration Up to this many hours ago\n @param [String, Symbol] log_type IEL or IML\n @raise [RuntimeError] if the request failed\n @return [Array] log entries", "Get all of the computer details\n @raise [RuntimeError] if the request failed\n @return [Hash] computer_details", "Get the general computer details\n @raise [RuntimeError] if the request failed\n @return [Fixnum] general_computer_details", "Get the computer network details\n @raise [RuntimeError] if the request failed\n @return [Hash] computer_network_details", "Set the Firmware Upgrade\n @param [String, Symbol] uri\n @raise [RuntimeError] if the request failed\n @return true", "Returns the path to an asset either in the Sprockets environment\n or the public directory. External URIs are untouched.\n\n ==== Options\n\n * <tt>:ext</tt> - The extension to append if the source does not have one.\n * <tt>:dir</tt> - The directory to prepend if the file is in the public directory.\n * <tt>:digest</tt> - Wether or not use the digest paths for assets. Set Sprockets::Helpers.digest for global configuration.\n * <tt>:prefix</tt> - Use a custom prefix for the Sprockets environment. Set Sprockets::Helpers.prefix for global configuration.\n * <tt>:body</tt> - Adds a ?body=1 flag that tells Sprockets to return only the body of the asset.\n\n ==== Examples\n\n For files within Sprockets:\n\n   asset_path 'xmlhr.js'                       # => '/assets/xmlhr.js'\n   asset_path 'xmlhr', :ext => 'js'            # => '/assets/xmlhr.js'\n   asset_path 'xmlhr.js', :digest => true      # => '/assets/xmlhr-27a8f1f96afd8d4c67a59eb9447f45bd.js'\n   asset_path 'xmlhr.js', :prefix => '/themes' # => '/themes/xmlhr.js'\n\n For files outside of Sprockets:\n\n   asset_path 'xmlhr'                                # => '/xmlhr'\n   asset_path 'xmlhr', :ext => 'js'                  # => '/xmlhr.js'\n   asset_path 'dir/xmlhr.js', :dir => 'javascripts'  # => '/javascripts/dir/xmlhr.js'\n   asset_path '/dir/xmlhr.js', :dir => 'javascripts' # => '/dir/xmlhr.js'\n   asset_path 'http://www.example.com/js/xmlhr'      # => 'http://www.example.com/js/xmlhr'\n   asset_path 'http://www.example.com/js/xmlhr.js'   # => 'http://www.example.com/js/xmlhr.js'", "Get the power metrics\n @raise [RuntimeError] if the request failed\n @return [Hash] power_metrics", "Get the thermal metrics\n @raise [RuntimeError] if the request failed\n @return [Hash] thermal_metrics", "Set the Time Zone\n @param [Fixnum] time_zone\n @raise [RuntimeError] if the request failed\n @return true", "Set whether or not ntp servers are being used\n @param [TrueClass, FalseClass] use_ntp\n @raise [RuntimeError] if the request failed\n @return true", "Set the NTP Servers\n @param [Fixnum] ntp_servers\n @raise [RuntimeError] if the request failed\n @return true", "Print output in a given format.", "Set the boot order\n @param [Fixnum] boot_order\n @raise [RuntimeError] if the request failed\n @return true", "Set the temporary boot order\n @param [Fixnum] boot_target\n @raise [RuntimeError] if the request failed\n @return true", "Get the schema information with given prefix\n @param [String, Symbol] schema_prefix\n @raise [RuntimeError] if the request failed\n @return [Array] schema", "Get the Registry with given registry_prefix\n @param [String, Symbol] registry_prefix\n @raise [RuntimeError] if the request failed\n @return [Array] registry", "Set the Session Timeout Minutes\n @param [Fixnum] timeout\n @raise [RuntimeError] if the request failed\n @return true", "Set EthernetInterface to obtain IPv4 settings from DHCP\n @param manager_id [Integer, String] ID of the Manager\n @param ethernet_interface [Integer, String] ID of the EthernetInterface\n @raise [RuntimeError] if the request failed\n @return true", "Set EthernetInterface to static IPv4 address\n @param ip [String] IPv4 address\n @param netmask [String] IPv4 subnet mask\n @param gateway [String] IPv4 default gateway\n @param manager_id [Integer, String] ID of the Manager\n @param ethernet_interface [Integer, String] ID of the EthernetInterface\n @raise [RuntimeError] if the request failed\n @return true", "Set EthernetInterface DNS servers\n @param dns_servers [Array] list of DNS servers\n @param manager_id [Integer, String] ID of the Manager\n @param ethernet_interface [Integer, String] ID of the EthernetInterface\n @raise [RuntimeError] if the request failed\n @return true", "Set iLO hostname and domain name\n @param hostname [String] iLO hostname\n @param domain_name [String] iLO domain name\n @param manager_id [Integer, String] ID of the Manager\n @param ethernet_interface [Integer, String] ID of the EthernetInterface\n @raise [RuntimeError] if the request failed\n @return true", "Make a restful API request to the iLO\n @param [Symbol] type the rest method/type Options are :get, :post, :put, :patch, and :delete\n @param [String] path the path for the request. Usually starts with \"/rest/\"\n @param [Hash] options the options for the request\n @option options [String] :body Hash to be converted into json and set as the request body\n @option options [String] :Content-Type ('application/json') Set to nil or :none to have this option removed\n @raise [InvalidRequest] if the request is invalid\n @raise [SocketError] if a connection could not be made\n @raise [OpenSSL::SSL::SSLError] if SSL validation of the iLO's certificate failed\n @return [NetHTTPResponse] The response object", "Handle the response for rest call.\n   If an asynchronous task was started, this waits for it to complete.\n @param [HTTPResponse] HTTP response\n @raise [ILO_SDK::BadRequest] if the request failed with a 400 status\n @raise [ILO_SDK::Unauthorized] if the request failed with a 401 status\n @raise [ILO_SDK::NotFound] if the request failed with a 404 status\n @raise [ILO_SDK::RequestError] if the request failed with any other status\n @return [Hash] The parsed JSON body", "Get the Privileges for a user\n @param [String, Symbol] username\n @raise [RuntimeError] if the request failed\n @return [Hash] privileges", "Set the privileges for a user\n @param [TrueClass, FalseClass] username\n @param [Hash] privileges\n @option privileges [TrueClass, FalseClass] :LoginPriv\n @option privileges [TrueClass, FalseClass] :RemoteConsolePriv\n @option privileges [TrueClass, FalseClass] :UserConfigPriv\n @option privileges [TrueClass, FalseClass] :VirtualMediaPriv\n @option privileges [TrueClass, FalseClass] :VirtualPowerAndResetPriv\n @option privileges [TrueClass, FalseClass] :iLOConfigPriv\n @raise [RuntimeError] if the request failed\n @return true", "Get the SSL Certificate\n @raise [RuntimeError] if the request failed\n @return [OpenSSL::X509::Certificate] x509_certificate\n rubocop:disable Style/SymbolProc", "Generate a Certificate Signing Request\n @param [String] country\n @param [String] state\n @param [String] city\n @param [String] orgName\n @param [String] orgUnit\n @param [String] commonName\n @raise [RuntimeError] if the request failed\n @return true", "Set the UEFI secure boot true or false\n @param [Boolean] secure_boot_enable\n @raise [RuntimeError] if the request failed\n @return true", "Set the Power State\n @param [String, Symbol] state\n @raise [RuntimeError] if the request failed\n @return true", "Set the SNMP Mode and Alerts Enabled value\n @param [String, Symbol] snmp_mode\n @param [Boolean] snmp_alerts\n @raise [RuntimeError] if the request failed\n @return true", "Get the Virtual Media Information\n @raise [RuntimeError] if the request failed\n @return [String] virtual_media", "Insert Virtual Media\n @param [String, Symbol] id\n @param [String, Symbol] image\n @return true", "Eject Virtual Media\n @param [String, Symbol] id\n @return true", "Set the Asset Tag\n @deprecated Use {#set_system_settings} instead\n @param asset_tag [String, Symbol]\n @raise [RuntimeError] if the request failed\n @return true", "Set the UID indicator LED\n @deprecated Use {#set_system_settings} instead\n @param state [String, Symbol]\n @raise [RuntimeError] if the request failed\n @return true", "Get the HREF for a user with a specific username\n @param [String, Symbol] uri\n @param [String, Symbol] username\n @raise [RuntimeError] if the request failed\n @return [String] userhref", "Create a user\n @param [String, Symbol] username\n @param [String, Symbol] password\n @raise [RuntimeError] if the request failed\n @return true", "Change the password for a user\n @param [String, Symbol] username\n @param [String, Symbol] password\n @raise [RuntimeError] if the request failed\n @return true", "Delete a specific user\n @param [String, Symbol] username\n @raise [RuntimeError] if the request failed\n @return true", "Get template list\n\n :call-seq:\n   templates -> Hash\n\n Return a Hash of all templates\n\n Example:\n\n   templates\n\n Example return:\n\n   {\n     'ubuntu-10.04-standard_10.04-4_i386' => {\n         'format' => 'tgz',\n         'content' => 'vztmpl',\n         'volid' => 'local:vztmpl/ubuntu-10.04-standard_10.04-4_i386.tar.gz',\n         'size' => 142126884\n     },\n     'ubuntu-12.04-standard_12.04-1_i386' => {\n         'format' => 'tgz',\n         'content' => 'vztmpl',\n         'volid' => 'local:vztmpl/ubuntu-12.04-standard_12.04-1_i386.tar.gz',\n          'size' => 130040792\n     }\n  }", "Get CT list\n\n :call-seq:\n   openvz_get -> Hash\n\n Return a Hash of all openvz container\n\n Example:\n\n   openvz_get\n\n Example return:\n   {\n     '101' => {\n           'maxswap' => 536870912,\n           'disk' => 405168128,\n           'ip' => '192.168.1.5',\n           'status' => 'running',\n           'netout' => 272,\n           'maxdisk' => 4294967296,\n           'maxmem' => 536870912,\n           'uptime' => 3068073,\n           'swap' => 0,\n           'vmid' => '101',\n           'nproc' => '10',\n           'diskread' => 0,\n           'cpu' => 0.00031670581100007,\n           'netin' => 0,\n           'name' => 'test2.domain.com',\n           'failcnt' => 0,\n           'diskwrite' => 0,\n           'mem' => 22487040,\n           'type' => 'openvz',\n           'cpus' => 1\n     },\n     [...]\n   }", "Create CT container\n\n :call-seq:\n   openvz_post(ostemplate, vmid) -> String\n   openvz_post(ostemplate, vmid, options) -> String\n\n Return a String as task ID\n\n Examples:\n\n   openvz_post('ubuntu-10.04-standard_10.04-4_i386', 200)\n   openvz_post('ubuntu-10.04-standard_10.04-4_i386', 200, {'hostname' => 'test.test.com', 'password' => 'testt' })\n\n Example return:\n\n   UPID:localhost:000BC66A:1279E395:521EFC4E:vzcreate:200:root@pam:", "Methods manages auth", "Method create ticket", "Extract data or return error", "Methods manage http dialogs", "Processes the next token in input\n\n This is the main interface to lexer. It returns next available token or **nil**\n if there are no more tokens available in the input string.\n\n {#each} Raises {LexError} if the input cannot be processed. This happens if\n there were no matches by 'token' rules and no matches by 'literals' rule.\n If the {.on_error} handler is not set, the exception will be raised immediately,\n however, if the handler is set, the eception will be raised only if the {#pos}\n after returning from error handler is still unchanged.\n\n @api public\n @raise [LexError] if the input cannot be processed\n @return [LexToken] if the next chunk of input was processed successfully\n @return [nil] if there are no more tokens available in input\n\n @example\n   lex = MyLexer.new(\"hello WORLD\")\n\n   t = lex.next\n   puts \"#{tok.type} -> #{tok.value}\" #=> \"LOWERS -> hello\"\n   t = lex.next\n   puts \"#{tok.type} -> #{tok.value}\" #=> \"UPPERS -> WORLD\"\n   t = lex.next # => nil", "Read the camera EXIF data to determine orientation and adjust accordingly", "Convert the file to a different format\n\n\n === Parameters\n [f (String)] the format for the file format (jpeg, png)\n [opts (Hash)] options to be passed to converting function (ie, :interlace => true for png)", "Resize the image to fit within the specified dimensions while retaining\n the aspect ratio of the original image. If necessary, crop the image in\n the larger dimension.\n\n\n === Parameters\n\n [width (Integer)] the width to scale the image to\n [height (Integer)] the height to scale the image to", "Resize the image to fit within the specified dimensions while retaining\n the original aspect ratio. Will only resize the image if it is larger than the\n specified dimensions. The resulting image may be shorter or narrower than specified\n in the smaller dimension but will not be larger than the specified values.\n\n === Parameters\n\n [width (Integer)] the width to scale the image to\n [height (Integer)] the height to scale the image to", "Overwrites the original method to optionally set the content of a\n file with no content in it to the content of a file with another\n language which does have content in it.", "Overwrites the original method to cater for language extension in output\n file name.", "Overwrites the original method to filter the language extension from\n basename", "Stop the server", "check the authentification on AUTH\n if any value returned, that will be used for ongoing processing\n otherwise the original value will be used for authorization_id", "Start the listeners for all hosts", "Start the listener thread on single host and port", "reset the context of current smtpd dialog", "handle plain authentification", "Subscribe the client to the given channel. This generates\n some JavaScript calling Danthes.sign with the subscription\n options.", "Sends url.purge command to varnish to clear cache.\n\n clear_cache_for(root_path, blog_posts_path, '/other/content/*')", "Callback to handle incoming Faye messages. This authenticates both\n subscribe and publish calls.", "Sends commands over telnet to varnish servers listed in the config.", "start ssl connection over existing tcpserver socket", "Create a image tag with our responsive image data attributes", "Loop over the images sizes and create our data attributes hash", "use ContinentDef Reader", "Retrieves all seats based on the stored relation conditions\n\n @return [Array<BracketTree::Node>]", "Retrieves an Array of Nodes for a given round on a given side\n\n @param [Fixnum] round to pull\n @param [Fixnum] side of the tree to pull from\n @return [Array] array of Nodes from the round", "Required method to configure slather. It's required at least the path\n to the project and the scheme used with code coverage enabled\n @return  [void]", "Total coverage of the project\n @return   [Float]", "Method to check if the coverage of the project is at least a minumum\n @param options [Hash] a hash with the options\n @option options [Float] :minimum_coverage the minimum code coverage required\n @option options [Symbol] :notify_level the level of notification\n @return [Array<String>]", "Method to check if the coverage of modified files is at least a minumum\n @param options [Hash] a hash with the options\n @option options [Float] :minimum_coverage the minimum code coverage required for a file\n @option options [Symbol] :notify_level the level of notification\n @return [Array<String>]", "Build a coverage markdown table of the modified files coverage\n @return [String]", "Show a header with the total coverage and coverage table\n @return [Array<String>]", "Array of files that we have coverage information and was modified\n @return [Array<File>]", "Run through all of the pixels on both org image, and fresh image. Change the pixel color accordingly.", "Changes the pixel color to be the opposite RGB value", "Interface to run the R, G, B methods on ChunkyPNG", "Returns the numeric results of the diff of 2 images", "Saves the visual diff as a separate file", "Retrives a key with its associated data, if key is not present it will\n return with message \"Key Not Found\"\n\n This method takes the following parameters as arguments\n * key - whose data is to be retrieved", "Create or update a new key\n\n This method takes the following parameters as arguments\n * key   - whose value to be set\n * value - value to be set for specified key\n * ttl   - shelf life of a key (in seconds) (optional)", "Set a new value for key if previous value of key is matched\n\n This method takes the following parameters as arguments\n * key       - whose value is going to change if previous value is matched\n * value     - new value to be set for specified key\n * prevValue - value of a key to compare with existing value of key\n * ttl       - shelf life of a key (in secsonds) (optional)", "Gives a notification when specified key changes\n\n This method takes the following parameters as arguments\n @ key   - key to be watched\n @options [Hash] additional options for watching a key\n @options [Fixnum] :index watch the specified key from given index\n @options [Fixnum] :timeout specify http timeout", "this has to be public so the websocket client thread sees it", "we validate our response here to make sure it is going to be\n raising exceptions in the right thread", "Requests a external payment\n\n @see http://api.yandex.com/money/doc/dg/reference/request-external-payment.xml\n @see https://tech.yandex.ru/money/doc/dg/reference/request-external-payment-docpage/\n\n @param payment_options [Hash] Method's parameters. Check out docs for more information.\n\n @raise [YandexMoney::InvalidRequestError] HTTP request does not conform to protocol format. Unable to parse HTTP request, or the Authorization header is missing or has an invalid value.\n @raise [YandexMoney::ServerError] A technical error occurs (the server responds with the HTTP code 500 Internal Server Error). The application should repeat the request with the same parameters later.\n\n @return [RecursiveOpenStruct] A struct, containing `payment_id` and additional information about a recipient and payer", "Confirms a payment that was created using the request-extenral-payment method\n\n @see http://api.yandex.com/money/doc/dg/reference/process-external-payment.xml\n @see https://tech.yandex.ru/money/doc/dg/reference/process-external-payment-docpage/\n\n @param payment_options [Hash] Method's parameters. Check out docs for more information.\n\n @raise [YandexMoney::InvalidRequestError] HTTP request does not conform to protocol format. Unable to parse HTTP request, or the Authorization header is missing or has an invalid value.\n @raise [YandexMoney::ServerError] A technical error occurs (the server responds with the HTTP code 500 Internal Server Error). The application should repeat the request with the same parameters later.\n\n @return [RecursiveOpenStruct] A status of payment and additional steps for authorization (if needed)", "Execute this migration in the named direction.\n\n The advantage of using this instead of directly calling up or down is that\n this method gives informative output and benchmarks the time taken.", "Generates output labeled with name of migration and a line that goes up\n to 75 characters long in the terminal", "Returns operation history of a user's wallet\n\n @see http://api.yandex.com/money/doc/dg/reference/operation-history.xml\n @see https://tech.yandex.ru/money/doc/dg/reference/operation-history-docpage/\n\n @param options [Hash] A hash with filter parameters according to documetation\n @return [Array<RecursiveOpenStruct>] An array containing user's wallet operations.\n\n @raise [YandexMoney::InvalidRequestError] HTTP request does not conform to protocol format. Unable to parse HTTP request, or the Authorization header is missing or has an invalid value.\n @raise [YandexMoney::UnauthorizedError] Nonexistent, expired, or revoked token specified.\n @raise [YandexMoney::InsufficientScopeError] The token does not have permissions for the requested operation.\n @raise [YandexMoney::ServerError] A technical error occurs (the server responds with the HTTP code 500 Internal Server Error). The application should repeat the request with the same parameters later.", "Returns details of operation specified by operation_id\n\n @see http://api.yandex.com/money/doc/dg/reference/operation-details.xml\n @see https://tech.yandex.ru/money/doc/dg/reference/operation-details-docpage/\n\n @param operation_id [String] A operation identifier\n @return [RecursiveOpenStruct] All details of requested operation.\n\n @raise [YandexMoney::InvalidRequestError] HTTP request does not conform to protocol format. Unable to parse HTTP request, or the Authorization header is missing or has an invalid value.\n @raise [YandexMoney::UnauthorizedError] Nonexistent, expired, or revoked token specified.\n @raise [YandexMoney::InsufficientScopeError] The token does not have permissions for the requested operation.\n @raise [YandexMoney::ServerError] A technical error occurs (the server responds with the HTTP code 500 Internal Server Error). The application should repeat the request with the same parameters later.", "Accepts incoming transfer with a protection code or deferred transfer\n\n @see http://api.yandex.com/money/doc/dg/reference/incoming-transfer-accept.xml\n @see https://tech.yandex.ru/money/doc/dg/reference/incoming-transfer-accept-docpage/\n\n @param operation_id [String] A operation identifier\n @param protection_code [String] Secret code of four decimal digits. Specified for an incoming transfer proteced by a secret code. Omitted for deferred transfers\n @return [RecursiveOpenStruct] An information about operation result.\n\n @raise [YandexMoney::InvalidRequestError] HTTP request does not conform to protocol format. Unable to parse HTTP request, or the Authorization header is missing or has an invalid value.\n @raise [YandexMoney::UnauthorizedError] Nonexistent, expired, or revoked token specified.\n @raise [YandexMoney::InsufficientScopeError] The token does not have permissions for the requested operation.\n @raise [YandexMoney::ServerError] A technical error occurs (the server responds with the HTTP code 500 Internal Server Error). The application should repeat the request with the same parameters later.", "This method sends api request to etcd server.\n\n This method has following parameters as argument\n * path    - etcd server path (etcd server end point)\n * method  - the request method used\n * options  - any additional parameters used by request method (optional)\n rubocop:disable MethodLength, CyclomaticComplexity", "need to have original request to process the response when it redirects", "List all pending requests.", "Show details for a single request.", "Open a browser window and review a specified request.", "Checkout a specified request's changes to your local repository.", "Add an approving comment to the request.", "Accept a specified request by merging it into master.", "Close a specified request.", "Create a new request.", "someone deleted the source repo", "Move uncommitted changes from original_branch to a feature_branch.\n @return [String] the new local branch uncommitted changes are moved to", "Returns cookie in a format appropriate to send to a server.\n\n @param [FixNum] 0 version, 0 for Netscape-style cookies, 1 for\n   RFC2965-style.\n @param [Boolean] true prefix, for RFC2965, whether to prefix with\n \"$Version=<version>;\". Ignored for Netscape-style cookies", "Return a hash representation of the cookie.", "Determine if a cookie should be sent given a request URI along with\n other options.\n\n This currently ignores domain.\n\n @param uri [String, URI] the requested page which may need to receive\n this cookie\n @param script [Boolean] indicates that cookies with the 'httponly'\n extension should be ignored\n @return [Boolean] whether this cookie should be sent to the server", "Create a Hash with all remotes as keys and their urls as values.", "Collect all remotes for a given url.", "Find or create the correct remote for a fork with a given owner name.", "Remove obsolete remotes with review prefix.", "Find all remotes which are currently referenced by local branches.", "Finds the correct remote for a given branch name.", "clean a single request's obsolete branch", "clean all obsolete branches", "if to send a pull request to upstream repo, get the parent as target\n @return [String] the name of the target repo", "Given a request URI and a literal Set-Cookie2 header value, attempt to\n add the cookie to the cookie store.\n\n @param [String, URI] request_uri the resource returning the header\n @param [String] cookie_header_value the contents of the Set-Cookie2\n @return [Cookie] which was created and stored\n @raise [InvalidCookieError] if the cookie header did not validate", "Return an array of all cookie objects in the jar\n\n @return [Array<Cookie>] all cookies. Includes any expired cookies\n which have not yet been removed with expire_cookies", "Look through the jar for any cookies which have passed their expiration\n date, or session cookies from a previous session\n\n @param session [Boolean] whether session cookies should be expired,\n   or just cookies past their expiration date.", "Given a request URI, return a sorted list of Cookie objects. Cookies\n will be in order per RFC 2965 - sorted by longest path length, but\n otherwise unordered.\n\n @param [String, URI] request_uri the address the HTTP request will be\n   sent to. This must be a full URI, i.e. must include the protocol,\n   if you pass digi.ninja it will fail to find the domain, you must pass\n   http://digi.ninja\n @param [Hash] opts options controlling returned cookies\n @option opts [Boolean] :script (false) Cookies marked HTTP-only will be\n   ignored if true\n @return [Array<Cookie>] cookies which should be sent in the HTTP request", "Given a request URI, return a string Cookie header.Cookies will be in\n order per RFC 2965 - sorted by longest path length, but otherwise\n unordered.\n\n @param [String, URI] request_uri the address the HTTP request will be\n   sent to\n @param [Hash] opts options controlling returned cookies\n @option opts [Boolean] :script (false) Cookies marked HTTP-only will be\n   ignored if true\n @return String value of the Cookie header which should be sent on the\n   HTTP request", "Store the value in memory\n\n @param [Symbol] name\n @param [Object] value\n\n @return [undefined]\n\n @api public", "Adds a new JsonPair for each attribute in attrs by taking attr as key and value of that attribute in object.\n\n @param object [Object] Object to take values from\n @param *attrs [Array<Symbol>] Array of attributes for JsonPair keys", "Creates array of json objects in current element from array passed to this method.\n Accepts block which yields each array element.\n\n @example Create array in root JSON element\n     json.array!(@links) do |link|\n       json.rel link.first\n       json.href link.last\n     end\n\n @example compiles to something like ...\n     [\n        {\n          \"rel\": \"self\",\n          \"href\": \"http://example.com/people/123\"\n        },\n        {\n          \"rel\": \"school\",\n          \"href\": \"http://gatech.edu\"\n        }\n     ]", "Format and raise an error", "Calls the given block for each ancestor node in the order from parent to root.\n If no block is given, an `Enumerator` is returned.\n\n @overload each_ancestor\n   Yield all nodes.\n @overload each_ancestor(type)\n   Yield only nodes matching the type.\n   @param [Symbol] type a node type\n @overload each_ancestor(type_a, type_b, ...)\n   Yield only nodes matching any of the types.\n   @param [Symbol] type_a a node type\n   @param [Symbol] type_b a node type\n @overload each_ancestor(types)\n   Yield only nodes matching any of types in the array.\n   @param [Array<Symbol>] types an array containing node types\n @yieldparam [Node] node each ancestor node\n @return [self] if a block is given\n @return [Enumerator] if no block is given", "Calls the given block for each child node.\n If no block is given, an `Enumerator` is returned.\n\n Note that this is different from `node.children.each { |child| ... }` which yields all\n children including non-node element.\n\n @overload each_child_node\n   Yield all nodes.\n @overload each_child_node(type)\n   Yield only nodes matching the type.\n   @param [Symbol] type a node type\n @overload each_child_node(type_a, type_b, ...)\n   Yield only nodes matching any of the types.\n   @param [Symbol] type_a a node type\n   @param [Symbol] type_b a node type\n @overload each_child_node(types)\n   Yield only nodes matching any of types in the array.\n   @param [Array<Symbol>] types an array containing node types\n @yieldparam [Node] node each child node\n @return [self] if a block is given\n @return [Enumerator] if no block is given", "Calls the given block for each descendant node with depth first order.\n If no block is given, an `Enumerator` is returned.\n\n @overload each_descendant\n   Yield all nodes.\n @overload each_descendant(type)\n   Yield only nodes matching the type.\n   @param [Symbol] type a node type\n @overload each_descendant(type_a, type_b, ...)\n   Yield only nodes matching any of the types.\n   @param [Symbol] type_a a node type\n   @param [Symbol] type_b a node type\n @overload each_descendant(types)\n   Yield only nodes matching any of types in the array.\n   @param [Array<Symbol>] types an array containing node types\n @yieldparam [Node] node each descendant node\n @return [self] if a block is given\n @return [Enumerator] if no block is given", "Calls the given block for the receiver and each descendant node with depth first order.\n If no block is given, an `Enumerator` is returned.\n\n This method would be useful when you treat the receiver node as a root of tree and want to\n iterate all nodes in the tree.\n\n @overload each_node\n   Yield all nodes.\n @overload each_node(type)\n   Yield only nodes matching the type.\n   @param [Symbol] type a node type\n @overload each_node(type_a, type_b, ...)\n   Yield only nodes matching any of the types.\n   @param [Symbol] type_a a node type\n   @param [Symbol] type_b a node type\n @overload each_node(types)\n   Yield only nodes matching any of types in the array.\n   @param [Array<Symbol>] types an array containing node types\n @yieldparam [Node] node each node\n @return [self] if a block is given\n @return [Enumerator] if no block is given", "Adds an ActiveRecord model with support for avatars", "Create a new memoized method\n\n @return [undefined]\n\n @api private", "Get all champion mastery entries sorted by number of champion points descending\n\n See: https://developer.riotgames.com/api-methods/#champion-mastery-v3/GET_getAllChampionMasteries\n @param [Integer] summoner_id Summoner ID associated with the player\n @return [Array<Lol::DynamicModel>] Champion Masteries", "Retrieve all champions\n\n See: https://developer.riotgames.com/api-methods/#champion-v3/GET_getChampions\n @param free_to_play [Boolean] filter param to retrieve only free to play champions\n @return [Array<Lol::DynamicModel>] an array of champions", "Given a key, convert to symbol, removing XML namespace, if any.\n @param [String] key - a key, either \"abc\" or \"abc:def\"\n @return [Symbol]", "Recursively transforms a hash\n @param [Hash] hash\n @return [Hash]", "Like Object.to_s, except excludes BLACKLISTed instance vars", "Creates a tournament and returns its ID.\n @param [Integer] provider_id The provider ID to specify the regional registered provider data to associate this tournament.\n @param [String] name Name of the tournament\n @return [Integer] Tournament ID", "Create a tournament code for the given tournament.\n @param [Integer] count The number of codes to create (max 1000)\n @param [Integer] tournament_id The tournament ID\n @param [String] spectator_type The spectator type of the game. Valid values are NONE, LOBBYONLY, ALL.\n @param [Integer] team_size The team size of the game. Valid values are 1-5.\n @param [String] pick_type The pick type of the game. Valid values are BLIND_PICK, DRAFT_MODE, ALL_RANDOM, TOURNAMENT_DRAFT.\n @param [String] map_type The map type of the game. Valid values are SUMMONERS_RIFT, TWISTED_TREELINE, CRYSTAL_SCAR, and HOWLING_ABYSS.\n @param [Array<Integer>] allowed_participants List of participants in order to validate the players eligible to join the lobby.\n @param [String] metadata Optional string that may contain any data in any format, if specified at all. Used to denote any custom information about the game.\n @return [Array<String>] generated tournament codes", "Update the pick type, map, spectator type, or allowed summoners for a code.\n @param [String] tournament_code The tournament code to update\n @param [Array<Integer>] allowed_participants List of participants in order to validate the players eligible to join the lobby.\n @param [String] map_type The map type of the game. Valid values are SUMMONERS_RIFT, TWISTED_TREELINE, CRYSTAL_SCAR, and HOWLING_ABYSS.\n @param [String] pick_type The pick type of the game. Valid values are BLIND_PICK, DRAFT_MODE, ALL_RANDOM, TOURNAMENT_DRAFT.\n @param [String] spectator_type The spectator type of the game. Valid values are NONE, LOBBYONLY, ALL.", "Gets a list of lobby events by tournament code\n @param [String] tournament_code the tournament code string\n @return [Array<DynamicModel>] List of lobby events", "Get a summoner by summoner name.\n @param [String] name Summoner name\n @return [DynamicModel] Summoner representation", "Put the settings from this object in effect.\n\n This function will distribute the configuration to the\n appropriate objects and modules.", "Returns a full url for an API call\n @param path [String] API path to call\n @return [String] full fledged url", "Returns just a path from a full api url\n @return [String]", "Calls the API via HTTParty and handles errors caching it if a cache is\n enabled and rate limiting it if a rate limiter is configured\n @param url [String] the url to call\n @param verb [Symbol] HTTP verb to use. Defaults to :get\n @param body [Hash] Body for POST request\n @param options [Hash] Options passed to HTTParty\n @return [String] raw response of the call", "Execute the command and collect all the data from it.\n\n The function will block until the command has finished.", "Get mastery pages for a given summoner ID\n @param [Integer] summoner_id Summoner ID\n @return [Array<DynamicModel>] Mastery pages", "Helper for dynamically defining writer method\n @param [Symbol] k - name of attribute\n @param [Hash] definition - See docstring for schema above", "Given a schema and a value which may be a single record or collection,\n collect and return any errors.\n @param [SchemaModel] child_schema - A schema object class\n @param [Object] value - Array of models or single model\n @return [Object] Array of errors hashes, or one hash.\n                   Structure matches 'value' input", "Checks that required field meets validation\n @param [Boolean or Callable] valid - callable validation fn or boolean\n                               function will be called with value\n @param [Object] value - value to check\n @return [Maybe String] error message", "Mutates errors, adding in error messages scoped to the attribute and key\n @param [Maybe Hash] errors -\n @param [Symbol] attr - name of attribute under check\n @param [Symbol] key - name of validation step\n @param [Object] val - data to append", "Attributes used for serialization", "Updates an existing webhook", "Update a mailing list with a given address\n with an optional new address, name or description", "Creates a new cipher that uses an asymmetric encryption strategy.\n\n Configuration options:\n * <tt>:private_key_file</tt> - Encrypted private key file\n * <tt>:public_key_file</tt> - Public key file\n * <tt>:password</tt> - The password to use in the symmetric cipher\n * <tt>:algorithm</tt> - Algorithm to use symmetrically encrypted strings\n Encrypts the given data. If no public key file has been specified, then\n a NoPublicKeyError will be raised.", "Decrypts the given data. If no private key file has been specified, then\n a NoPrivateKeyError will be raised.", "Retrieves the private RSA from the private key", "Returns the encrypted value of the data", "Builds the value to hash based on the data being encrypted and the salt\n being used to seed the encryption algorithm", "check request auth", "Dump as json", "Creates a new cipher that uses a symmetric encryption strategy.\n\n Configuration options:\n * <tt>:algorithm</tt> - The algorithm to use for generating the encrypted string\n * <tt>:password</tt> - The secret value to use for generating the\n   key/initialization vector for the algorithm\n Decrypts the current string using the current key and algorithm specified", "Encrypts the current string using the current key and algorithm specified", "Add domain to account", "A simple hashing", "Adds a mailing list member with a given address\n NOTE Use create instead of add?", "Update a mailing list member with a given address", "This method can be used to cancel a pairing\n operation initiated by the Pair method.\n @return [Boolean]", "Indicates if the remote device is paired", "Indicates if the remote is seen as trusted. This\n setting can be changed by the application.\n @param val [Boolean]\n @return [void]", "If set to true any incoming connections from the\n device will be immediately rejected. Any device\n drivers will also be removed and no new ones will\n be probed as long as the device is blocked\n @param val [Boolean]\n @return [void]", "Refresh list of services and characteristics\n @raise [NotConnected] if device is not in a connected state\n @return [self]", "Sets up the action bar for this screen.\n\n Example:\n   action_bar true, back: true, icon: true,\n     custom_icon: \"resourcename\", custom_back: \"custombackicon\"", "Recursively escape anything in a primitive, array, or hash, in\n preparation for jsonifying it", "Returns a partial ActiveRecord configuration hash for the given SSL CA certificate.\n Checks to make sure the given filename actually exists, and raises an error if it\n does not.", "Returns an ActiveRecord configuration hash based on the environment variables.", "Registers current device for notifications of the given _characteristic_.\n Synonym for 'subscribe' or 'activate'.\n This step is required in order to later receive notifications.\n @param service [String, Symbol]\n @param characteristic [String, Symbol]", "Registers the callback to be invoked when a notification from the given _characteristic_ is received.\n\n NOTE: Requires the device to be subscribed to _characteristic_ notifications.\n @param service [String, Symbol]\n @param characteristic [String, Symbol]\n @param raw [Boolean] When raw is true the value (set/get) is a binary string, instead of an object corresponding to the decoded characteristic (float, integer, array, ...)\n @param callback [Proc] This callback will have the notified value as argument.", "overriding the get method of Faraday to make things simpler.\n @param [String] resource the resource you're targeting\n @param [Hash] params Hash of parameters to pass to the resource\n @param [String] key Steam API key", "Creates a simple bootstrap tab navigation.\n\n ==== Signatures\n\n   bootstrap_tab_nav_tag(title, linkto, active = false)\n\n ==== Examples\n\n   <%= bootstrap_tab_nav_tag(\"Fruits\", \"#fruits\", true) %>\n   # => <li class=\"active\"><a href=\"#fruits\" data-toggle=\"tab\">Fruits</a></li>", "Convenience wrapper for a bootstrap_list_link_to with badge", "Creates a Boostrap progress bar.\n\n ==== Signatures\n\n   bootstrap_progressbar_tag(options)\n\n ==== Examples\n\n   <%= bootstrap_progressbar_tag(40) %>\n   # => <div class=\"progress progress-striped active\" title=\"40%\"><div class=\"progress-bar\"\n   style=\"width:40%\"></div></div>\n\n   <%= bootstrap_progressbar_tag(40), type: :danger %>\n   # => <div class=\"progress progress-striped active\" title=\"40%\"><div\n   class=\"progress-bar progress-bar-danger\" style=\"width:40%\"></div></div>\n\n ==== Browser compatibility\n\n Bootstrap Progress bars use CSS3 gradients, transitions, and animations to achieve all their\n effects. These features are not supported in IE7-9 or older versions of Firefox.\n Versions earlier than Internet Explorer 10 and Opera 12 do not support animations.", "This helper produces a pair of HTML dt, dd tags to display name and value pairs.\n If a blank_value_placeholder is not defined then the pair are not shown if the\n value is blank. Otherwise the placeholder is shown in the text-muted style.\n\n ==== Signature\n\n   description_list_name_value_pair(name, value, blank_value_placeholder = nil)\n\n ==== Examples\n\n   <%= description_list_name_value_pair(\"Pear\", \"Value\") %>\n   # => <dt>Pear</dt><dd>Value</dd>\n\n   <%= description_list_name_value_pair(\"Pear\", nil, \"[none]\") %>\n   # => <dt>Pear</dt><dd><span class=\"text-muted\">[none]</span></dd>", "Creates a Boostrap 'Details' link.\n\n ==== Signatures\n\n   details_link(path, options = {})\n\n ==== Examples\n\n   <%= details_link('#') %>\n   # => <a title=\"Details\" class=\"btn btn-default btn-xs\" href=\"#\">\n          <span class=\"glyphicon glyphicon-share-alt\"></span>\n        </a>", "Creates a Boostrap 'Edit' link.\n\n ==== Signatures\n\n   edit_link(path, options = {})\n\n ==== Examples\n\n   <%= edit_link(#) %>\n   # => <a title=\"Edit\" class=\"btn btn-default btn-xs\" href=\"#\">\n          <span class=\"glyphicon glyphicon-pencil\"></span>\n        </a>", "Creates a Boostrap 'Delete' link.\n\n ==== Signatures\n\n   delete_link(path, options = {})\n\n ==== Examples\n\n   <%= delete_link('#') %>\n   # => <a title=\"Delete\" class=\"btn btn-xs btn-danger\" rel=\"nofollow\" href=\"#\"\n           data-method=\"delete\" data-confirm=\"Are you sure?\">\n          <span class=\"glyphicon glyphicon-trash icon-white\"></span>\n        </a>'", "Creates a Boostrap link with icon.\n\n ==== Signatures\n\n   link_to_with_icon(options)\n\n ==== Examples\n\n   <%= link_to_with_icon( { icon: 'trash icon-white', title: 'Delete', path: '#' } ) %>\n   # => <a title=\"Delete\" class=\"btn btn-default btn-xs\" href=\"#\">\n          <span class=\"glyphicon glyphicon-trash icon-white\"></span>\n        </a>'", "round to nearest step size, making sure we curtail precision to same order of magnitude as the step size to avoid 0.4 + 0.2 = 0.6000000000000001", "Convert Arrays of bytes returned by DBus to Strings of bytes.", "This method merges the specified css_classes into the options hash", "This method sets the device discovery filter for the caller.\n When this method is called with +nil+ or an empty list of UUIDs,\n filter is removed.\n\n @todo Need to sync with the adapter-api.txt\n\n @param uuids     a list of uuid to filter on\n @param rssi      RSSI threshold\n @param pathloss  pathloss threshold\n @param transport [:auto, :bredr, :le]\n                  type of scan to run (default: :le)\n @return [self]", "Create a stub using the information in the provided filename.", "Create a stub using the erb template provided.  The +Hash+ second\n parameter contains the values to be inserted into the +ERB+.", "Get the count for the request criteria", "Get the count for the request criteria in the provided filename.", "Get the count for the request criteria using the erb template\n provided.  The +Hash+ second parameter contains the values to be\n inserted into the +ERB+.", "Clears the buffer, optionally to a specific color.\n\n @option options :color [Gosu::Color, Array<Float>] (transparent)", "Writes data to the TCP server socket\n\n @param data the data to write\n @param fire_and_forget if true, no response response is expected from server,\n           when false, a response from the server will be returned.\n\n @return the server response data if there is one", "Reads data from the TCP server\n\n @param timeout read timeout value for a read operation.\n                If omited the configured value or DEFAULT_READ_TIMEOUT will be used.\n\n\n @return [String] the data", "Full screen post-processing using a fragment shader.\n\n Variables set for you in the fragment shader:\n   uniform sampler2D in_Texture; // Texture containing the screen image.", "Override this for custom storage or prioritization of crawled URLs.\n Iterates through URL queue, yielding the URL, handler, and default data.", "Draw a list of centred sprites by position.\n\n @param points [Array<Array>] Array of [x, y] positions\n @param z [Float] Z-order to draw - Ignored if shader is used.\n @option options :scale [Float] (1.0) Relative size of the sprites\n @option options :shader [Ashton::Shader] Shader to apply to all sprites.\n\n TODO: Need to use point sprites here, but this is still much faster than individual #draws if using shaders and comparable if not.", "If positive, distance, in pixels, to the nearest opaque pixel.\n If negative, distance in pixels to the nearest transparent pixel.", "Gets the gradient of the field at a given point.\n @return [Float, Float] gradient_x, gradient_y", "Get the normal at a given point.\n @return [Float, Float] normal_x, normal_y", "Returns blocking position, else nil if line of sight isn't blocked.", "Update the SDF should the image have changed.\n Draw the mask in the passed block.", "Draw the field, usually for debugging purposes.\n @see Ashton::Texture#draw", "Convert into a nested array of sample values.\n @return [Array<Array<Integer>>]", "Starts a VLC instance in a subprocess\n\n @param [Boolean] detached if true VLC will be started as a deamon process.\n                     Defaults to false.\n\n @return [Integer] the subprocess PID\n\n @see #daemonize", "For ruby 1.8", "Overwrite defaults with supplied config", "Copy the window contents into the buffer.", "Set the value of a uniform.\n\n @param uniform [String, Symbol] If a Symbol, :frog_paste is looked up as \"in_FrogPaste\", otherwise the Sting is used directly.\n @param value [Any] Value to set the uniform to\n\n @raise ShaderUniformError unless requested uniform is defined in vertex or fragment shaders.", "Set uniform without trying to force use of the program.", "Symbol => load a built-in\n Filename => load file\n Source => use directly.\n\n Also recursively replaces #include\n TODO: What about line numbers getting messed up by #include?", "Ensure symbol keys, even in nested hashes\n\n @param [Hash] config the hash to set (key: value) on\n @param [#to_sym] k the key\n @param [Object] v the value\n @return [Hash] an updated hash", "Assumes that defaults already has symbolized keys", "Wait until either the timeout occurs or one of the given patterns is seen\n in the input.  Upon a match, the property before is assigned all input in\n the accumulator before the match, the matched string itself is assigned to\n the match property and an optional block is called\n\n The method will return the index of the matched pattern or nil if no match\n has occurred during the timeout period\n\n +patterns+::\n   list of patterns to look for.  These can be either literal strings or\n   Regexp objects\n\n +block+::\n   An optional block to be called if one of the patterns matches\n\n == Example\n\n    exp = Expect.new(io)\n    exp.expect('Password:') do\n      send(\"12345\")\n    end", "This method will convert any strings in the argument list to regular\n expressions that search for the literal string\n\n +patterns+::\n   List of patterns to escape", "{\"-db\"=>\"mydb\", \"-lay\"=>\"mylay\", \"email\"=>\"a@b.com\", \"updated_at\": Date}\n Take Ruby type and serialize into a form FileMaker can understand", "As defined in Node.", "Called by the test suite to ensure all invariants are true.", "Yield each child in field order.", "Swap this node with `node' in their trees.  If either node is\n detached, the other will become detached as a result of calling\n this method.", "Return the Node that comes before the given Node in tree\n preorder.", "Remove the given Node.", "Replace `node' with `newnode'.", "Link up `nodes' between `a' and `b'.", "Special case for 2", "Return the `i'th Node.  Assume `i' is in 0...length.", "Configure a new listener object.\n\n Runs in the master process.\n Public: As an alternative to #run, exec a new ruby instance for this listener.\n\n Runs in the master process.", "allow this object to be set with arbitrary key value data", "Fetches the place information for input parameters from the Yahoo Placemaker service", "Ensures all the resolver information is set in the template.", "Extract handles from mentioner\n\n @param [Mentioner] mentioner - the {Mentioner} to extract handles from\n @return [Array]", "Process after callbacks\n\n @param [Mentioner] mentioner - the mentioner of the callback\n @param [Mentionee] mentionee - the mentionee of the callback", "Gets the headers that will be sent with this request.", "Gets a HTTP connection for this request. If you pass in a block, it will\n be run on that HTTP connection.", "Users shouldn't need to call the following methods directly", "Generic get\n params are NOT read only", "Determine whether an exception can be fixed by logging in again.\n\n @param e [ApiError] the exception to check\n\n @return [Boolean] true if re-login is appropriate", "At least puppet-extlib has malformed metadata", "Overwrites the original method to use the configured rendering engine.", "Create a io watcher\n @param [Socket]  io An IO-able object\n @param [Symbol]  interests :r, :w, :rw - Is io readable? writeable? or both\n @return [LightIO::Watchers::IO]\n NIO::Monitor", "Blocking until io interests is satisfied", "This lets us skip to the confirmed workflow for an admin...", "Update stripe customer card", "The stripe metadata limit is 500 characters", "Recursively converts CamelCase and camelBack JSON-style hash keys to\n Rubyish snake_case, suitable for use during instantiation of Ruby\n model attributes.", "If you want to use the Add to Cart -> Checkout flow\n Add one or more items however you do.\n redirect_to effective_orders.new_order_path, which is here.\n This is the entry point for any Checkout button.\n It displayes an order based on the cart\n Always step1", "Confirms an order from the cart.", "Confirms the order from existing order", "My Orders History", "Thank you for Purchasing this Order. This is where a successfully purchased order ends up", "cart.add(@product, unique: -> (a, b) { a.kind_of?(Product) && b.kind_of?(Product) && a.category == b.category })\n cart.add(@product, unique: :category)\n cart.add(@product, unique: false) # Add as many as you want", "This is sent when someone chooses to Pay by Cheque", "Sent by the invoice.payment_succeeded webhook event", "Receive list of parsed MediaWiki pages for list of titles provided.\n All pages are received with single query to MediaWiki API.\n\n **NB**: if you are requesting more than 50 titles at once\n (MediaWiki limitation for single request), Infoboxer will do as\n many queries as necessary to extract them all (it will be like\n `(titles.count / 50.0).ceil` requests)\n\n @param titles [Array<String>] List of page titles to get.\n @param interwiki [Symbol] Identifier of other wiki, related to current, to fetch pages from.\n @param processor [Proc] Optional block to preprocess MediaWiktory query. Refer to\n   [MediaWiktory::Actions::Query](http://www.rubydoc.info/gems/mediawiktory/MediaWiktory/Wikipedia/Actions/Query)\n   for its API. Infoboxer assumes that the block returns new instance of `Query`, so be careful\n   while using it.\n\n @return [Page, Tree::Nodes<Page>] array of parsed pages. Notes:\n   * if you call `get` with only one title, one page will be\n     returned instead of an array\n   * if some of pages are not in wiki, they will not be returned,\n     therefore resulting array can be shorter than titles array;\n     you can always check `pages.map(&:title)` to see what you've\n     really received; this approach allows you to write absent-minded\n     code like this:\n\n     ```ruby\n     Infoboxer.wp.get('Argentina', 'Chile', 'Something non-existing').\n        infobox.fetch('some value')\n     ```\n     and obtain meaningful results instead of `NoMethodError` or\n     `SomethingNotFound`.", "Receive list of parsed MediaWiki pages from specified category.\n\n @param title [String] Category title. You can use namespaceless title (like\n     `\"Countries in South America\"`), title with namespace (like\n     `\"Category:Countries in South America\"`) or title with local\n     namespace (like `\"Cat\u00e9gorie:Argentine\"` for French Wikipedia)\n @param limit [Integer, \"max\"]\n @param processor [Proc] Optional block to preprocess MediaWiktory query. Refer to\n   [MediaWiktory::Actions::Query](http://www.rubydoc.info/gems/mediawiktory/MediaWiktory/Wikipedia/Actions/Query)\n   for its API. Infoboxer assumes that the block returns new instance of `Query`, so be careful\n   while using it.\n\n @return [Tree::Nodes<Page>] array of parsed pages.", "Block and wait beam dead\n\n @param [Numeric]  limit wait limit seconds if limit > 0, return nil if beam still alive, else return beam self\n @return [Beam, nil]", "Fiber not provide raise method, so we have to simulate one\n @param [BeamError]  error currently only support raise BeamError", "wait io nonblock method\n\n @param [Symbol]  method method name, example: wait_nonblock\n @param [args] args arguments pass to method", "Process array of strings", "Process data value for the format", "Creates a new merchant account locator.\n\n @param store_account_map [Hash] a hash mapping store codes to merchant accounts\n @param default_account [String] the default merchant account to use\n Tries to find a store that has a payment with the given psp reference. If\n one exists, returns the merchant account for that store. Otherwise, returns\n the default merchant acount.\n\n @param psp_reference [String] the psp reference for the payment\n @return merchant account [String] the name of the merchant account", "PostMessage SC_CLOSE and optionally wait for the window to close\n\n @param [Hash] options\n @option options [Boolean] :wait_for_close (true) sleep while waiting for timeout or close\n @option options [Boolean] :timeout (5) wait_for_close timeout in seconds", "Wait for the window to close\n\n @param [Hash] options\n @option options [Boolean] :timeout (5) timeout in seconds", "Brings the window into the foreground and activates it.\n Keyboard input is directed to the window, and various visual cues\n are changed for the user.\n\n A process can set the foreground window only if one of the following conditions is true:\n\n    * The process is the foreground process.\n    * The process was started by the foreground process.\n    * The process received the last input event.\n    * There is no foreground process.\n    * The foreground process is being debugged.\n    * The foreground is not locked.\n    * The foreground lock time-out has expired.\n    * No menus are active.\n\n @return [Number] nonzero number if sucessful, nil or zero if failed", "The window text including all child windows\n joined together with newlines. Faciliates matching text.\n Text from any given window is limited to 2048 characters\n\n @example partial match of the Window's calulator's about dialog copywrite text\n\n   dialog_about = @calculator.dialog_about\n   dialog_about.title.should == \"About Calculator\"\n   dialog_about.combined_text.should match(/Microsoft . Calculator/)\n\n @return [String] with newlines", "This is the entry point after returning from the 3DS page for credit cards\n that support it. MD is a unique payment session identifier returned\n by the card issuer.", "If an authorization notification is received before the redirection the\n payment is created there. In this case we just need to assign the addition\n parameters received about the source.\n\n We do this because there is a chance that we never get redirected back\n so we need to make sure we complete the payment and order.", "We pass the guest token and payment method id in, pipe seperated in the\n merchantReturnData parameter so that we can recover the session.", "can't scroll past ends of page, so sometimes position won't be accurate", "Sends Card Message\n @since 0.0.4\n @param header [Hash] card header content\n @param sections [Array<Hash>] card widgets array\n @return [Net::HTTPResponse] response object", "Sends payload and check response\n @param payload [Hash] data to send by POST\n @return [Net::HTTPResponse] response object\n @raise [APIError] if got unsuccessful response", "Prevent Rails from loading a table column.\n Useful for legacy database schemas with problematic column names,\n like 'class' or 'attributes'.\n\n   class Topic < ActiveRecord::Base\n     ignore_columns :attributes, :class\n   end\n\n   Topic.new.respond_to?(:attributes) => false", "Send keystroke to the focused window, keystrokes are virtual keycodes\n\n @example send 2+2<CR>\n\n     keystroke(VK_2, VK_ADD, VK_2, VK_RETURN)", "convert a single character to a virtual keycode\n\n @param [Char] char is the character to convert\n\n @return [Array] of virtual keycodes", "Change hash format to process rules", "Returns rules according to given filters", "Generate a credit card number", "Returns information about a number", "Validates a number", "Clipboard text setter\n\n @param [String] str text to load onto the clipboard", "Submits a comment that has been identified as spam.\n @!macro akismet_method\n @return [void]", "Initialise a new build.\n\n @param env [Boxes::Environment] environment to operate in.\n @param args [Hash]\n @param template [String] the name of the template.\n @param scripts [Array] scripts to include in the build.\n Run the build.", "Renders an `EmojiChar` to its string glyph representation, suitable for\n printing to screen.\n\n @option opts [Boolean] :variant_encoding specify whether the variant\n   encoding selector should be used to hint to rendering devices that\n   \"graphic\" representation should be used. By default, we use this for all\n   Emoji characters that contain a possible variant.\n\n @return [String] the emoji character rendered to a UTF-8 string", "Returns a list of all possible UTF-8 string renderings of an `EmojiChar`.\n\n E.g., normal, with variant selectors, etc. This is useful if you want to\n have all possible values to match against when searching for the emoji in\n a string representation.\n\n @return [Array<String>] all possible UTF-8 string renderings", "Load a template with a given name.\n\n @param env [Boxes::Environment] the environment to source templates.\n @param name [String] the name of the template.\n\n @return [Boxes::Template] a template instance.\n Render the template.\n\n @param args [Hash] the values to set.\n\n @return [String] the rendered template.", "If +x+ is a Numeric value, create a new Date object that is +x+ days\n earlier than the current one.\n\n If +x+ is a Date, return the number of days between the two dates; or,\n more precisely, how many days later the current date is than +x+.\n\n If +x+ is neither Numeric nor a Date, a TypeError is raised.", "Return a new Date object that is +n+ months later than the current one.\n\n If the day-of-the-month of the current Date is greater than the last day of\n the target month, the day-of-the-month of the returned Date will be the last\n day of the target month.", "Adds a new Config item and yields it, so it can be configured in\n a block.\n @param name [String] name for new config item\n @param value [String] value for new config item\n @yieldparam config [Config] the new config item, if block was given\n @return [Config] the new config item", "Enables CURVE security and makes this socket a CURVE client.\n @param client_cert [Certificate] client's certificate, to secure\n   communication (and be authenticated by the server)\n @param server_cert [Certificate] the remote server's certificate, so\n   this socket is able to authenticate the server\n @return [void]\n @raise [SecurityError] if the server's secret key is set in server_cert,\n   which means it's not secret anymore\n @raise [SystemCallError] if there's no secret key in client_cert", "Connects to an endpoint.\n @param endpoint [String]\n @return [void]\n @raise [ArgumentError] if the endpoint is incorrect", "Disconnects from an endpoint.\n @param endpoint [String]\n @return [void]\n @raise [ArgumentError] if the endpoint is incorrect", "Binds to an endpoint.\n @note When binding to an automatically selected TCP port, this will set\n   {#last_tcp_port}.\n @param endpoint [String]\n @return [void]\n @raise [SystemCallError] in case of failure", "Unbinds from an endpoint.\n @param endpoint [String]\n @return [void]\n @raise [ArgumentError] if the endpoint is incorrect", "Get single resource by id\n @return Resource the resource", "Get childrens of a resource\n @return Children of a resource", "Get parent of a resource\n @return Resource the parent resource, or nil if the provided ID referred to a root resource", "Run the beacon on the specified UDP port.\n\n @param port [Integer] port number to\n @return [String] hostname, which can be used as endpoint for incoming\n   connections\n @raise [Interrupt] if the context was terminated or the process\n   interrupted\n @raise [NotImplementedError] if the system doesn't support UDP broadcasts", "Start broadcasting a beacon.\n @param data [String] data to publish\n @param interval [Integer] interval in msec\n @raise [ArgumentError] if data is longer than {MAX_BEACON_DATA} bytes\n @return [void]", "Create a new Secret Store client\n @param entrypoint [String] base url of Hawkular - e.g http://localhost:8080\n @param credentials [Hash{String=>String}] Hash of username, password\n @param options [Hash{String=>String}] Additional rest client options\n Retrieve the tenant id for the passed credentials.\n If no credentials are passed, the ones from the constructor are used\n @param credentials [Hash{String=>String}] Hash of username, password, token(optional)\n @return [String] tenant id", "Encodes to Z85.\n @param input [String] possibly binary input data\n @return [String] Z85 encoded data as ASCII string\n @raise [ArgumentError] if input length isn't divisible by 4 with no\n   remainder\n @raise [SystemCallError] if this fails", "Decodes from Z85.\n @param input [String] Z85 encoded data\n @return [String] original data as binary string\n @raise [ArgumentError] if input length isn't divisible by 5 with no\n   remainder\n @raise [SystemCallError] if this fails", "Concatenates a method signature as ruby code to the +result+ string and\n returns it.", "Check class +klass+ against this Message instance, and raise a CheckError\n exception if necessary.", "Check object +object+ against this Message instance, and raise a\n CheckError exception if necessary.", "List of markdown files from argument list.", "Sets up our Linting behaviour\n\n @param config_path [String] The absolute path to a configuration YAML file\n @return [void]\n Runs JSHint over each file in our search path\n\n @return [void]", "Generate a query string from the passed hash, starting with '?'\n Values may be an array, in which case the array values are joined together by `,`.\n @param params [Hash] key-values pairs\n @return [String] complete query string to append to a base url, '' if no valid params", "Append a frame to this message.\n @param frame [String, Frame] what to append\n @raise [ArgumentError] if frame has an invalid type\n @raise [SystemCallError] if this fails\n @note If you provide a {Frame}, do NOT use that frame afterwards\n   anymore, as its native counterpart will have been destroyed.\n @return [self] so it can be chained", "Prepend a frame to this message.\n @param frame [String, Frame] what to prepend\n @raise [ArgumentError] if frame has an invalid type\n @raise [SystemCallError] if this fails\n @note If you provide a {Frame}, do NOT use that frame afterwards\n   anymore, as its native counterpart will have been destroyed.\n @return [void]", "Removes first part from message and returns it as a string.\n @return [String, nil] first part, if any, or nil", "Returns all frames as strings in an array. This is useful if for quick\n inspection of the message.\n @note It'll read all frames in the message and turn them into Ruby\n   strings. This can be a problem if the message is huge/has huge frames.\n @return [Array<String>] all frames", "Sets a new routing ID.\n @note This is used when the message is sent to a {CZTop::Socket::SERVER}\n   socket.\n @param new_routing_id [Integer] new routing ID\n @raise [ArgumentError] if new routing ID is not an Integer\n @raise [RangeError] if new routing ID is out of +uint32_t+ range\n @return [new_routing_id]", "finds the first constraint from constraints that makes the problem infeasible", "add siblings by assigning same parents to individuals passed as arguments\n @overload add_siblings(*siblings,options={})\n   @param [Object] siblings list of siblings\n   @param [Hash] options\n   @option options [Symbol] half :father for paternal half siblings and :mother for maternal half siblings\n   @option options [Object] spouse if specified, passed individual will be used as mother in case of half sibling\n @return [Boolean]", "remove siblings by nullifying parents of passed individuals\n @overload remove_siblings(*siblings,options={})\n   @param [Object] siblings list of siblings\n   @param [Hash] options\n   @option options [Symbol] half :father for paternal half siblings and :mother for maternal half siblings\n   @option options [Boolean] remove_other_parent if specified, passed individuals' mother will also be nullified\n @return [Boolean] true if at least one sibling was affected, false otherwise", "add children by assigning self as parent\n @overload add_children(*children,options={})\n   @param [Object] children list of children\n   @param [Hash] options\n   @option options [Object] spouse if specified, children will have that spouse\n @return [Boolean]", "remove children by nullifying the parent corresponding to self\n @overload remove_children(*children,options={})\n   @param [Object] children list of children\n   @param [Hash] options\n   @option options [Boolean] remove_other_parent if specified, passed individuals' mother will also be nullified\n @return [Boolean] true if at least one child was affected, false otherwise", "add current spouse updating receiver and argument individuals foreign_key in a transaction\n @param [Object] spouse\n @return [Boolean]", "remove current spouse resetting receiver and argument individuals foreign_key in a transaction\n @return [Boolean]", "Initializes the Poller. At least one reader has to be given.\n @param reader [Socket, Actor] socket to poll for input\n @param readers [Socket, Actor] any additional sockets to poll for input\n Adds another reader socket to the poller.\n @param reader [Socket, Actor] socket to poll for input\n @return [void]\n @raise [SystemCallError] if this fails", "Removes a reader socket from the poller.\n @param reader [Socket, Actor] socket to remove\n @return [void]\n @raise [ArgumentError] if socket was invalid, e.g. it wasn't registered\n   in this poller\n @raise [SystemCallError] if this fails for another reason", "Waits and returns the first socket that becomes readable.\n @param timeout [Integer] how long to wait in ms, or 0 to avoid\n   blocking, or -1 to wait indefinitely\n @return [Socket, Actor] first socket of interest\n @return [nil] if the timeout expired or\n @raise [Interrupt] if the timeout expired or", "Create a new instance from specified file.\n @param filename [String] a name of file to load.\n Returns found spelling errors.", "Retrieve all types of metrics datapoints by tags\n @param tags [Hash]\n @param buckets [Integer] optional number of buckets\n @param bucketDuration [String] optional interval (default no aggregation)\n @param starts [Integer] optional timestamp (default now - 8h)\n @param ends [Integer] optional timestamp (default now)\n @return [Array[Hash]] datapoints", "Push data for multiple metrics of all supported types\n @param gauges [Array]\n @param counters [Array]\n @param availabilities [Array]\n @example push datapoints of 2 counter metrics\n    client = Hawkular::Metrics::client::new\n    client.push_data(counters: [{:id => \"counter1\", :data => [{:value => 1}, {:value => 2}]},\n                        {:id => \"counter2\", :data => [{:value => 1}, {:value => 3}]}])\n @example push gauge and availability datapoints\n    client.push_data(gauges: [{:id => \"gauge1\", :data => [{:value => 1}, {:value => 2}]}],\n                           availabilities: [{:id => \"avail1\", :data => [{:value => \"up\"}]}])", "Fetch stats for multiple metrics of all supported types\n @param gauge_ids [Array[String]] list of gauge ids\n @param counter_ids [Array[String]] list of counter ids\n @param avail_ids [Array[String]] list of availability ids\n @param rates [Boolean] flag to include rates for gauges and counters metrics\n @param starts [Integer] optional timestamp (default now - 8h)\n @param ends [Integer] optional timestamp (default now)\n @param bucket_duration [String] optional interval (default 3600s)\n @return [Hash] stats grouped per type\n @example\n   client = Hawkular::Metrics::client::new\n   client.query_stats(\n     gauge_ids: ['G1', 'G2'],\n     counter_ids: ['C2', 'C3'],\n     avail_ids: ['A2', 'A3'],\n     starts: 200,\n     ends: 500,\n     bucket_duration: '150ms'\n   )", "Fetch all tags for metrics definitions\n @return [Hash{String=>String}]", "Vertex bisectors suitable for outsetting\n @param [Number] length    The distance to offset by\n @return [Array<Edge>]\t{Edge}s representing the bisectors", "Evaluate defaults and merge given_options into them.", "Set metadata.\n @param key [String] metadata key\n @param value [String] metadata value\n @return [value]", "Returns meta keys set.\n @return [Array<String>]", "Returns a new array containing elements common to the two arrays,\n excluding any duplicates.\n\n Any matching keys at matching indexes with the same order will have the\n order reversed.\n\n   a = Sorted::Set.new([['email', 'asc'], ['name', 'asc']])\n   b = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])\n   s = a.direction_intersect(b)\n   s.to_a #=> [['email', 'desc'], ['phone', 'asc'], ['name', 'asc']]", "Array Difference - Returns a new set that is a copy of the original set,\n removing any items that also appear in +other_set+. The order is preserved\n from the original set.\n\n   set = Sorted::Set.new(['email', 'desc'])\n   other_set = Sorted::Set.new(['phone', 'asc'])\n   set - other_set #=> #<Sorted::Set:0x007fafde1ead80>", "If the order of keys match upto the size of the set then flip them", "Add items from other that are common and not already added", "Add items not in memo", "Add items from other not in memo", "Lists defined triggers in the system\n @param [Array] ids List of trigger ids. If provided, limits to the given triggers\n @param [Array] tags List of tags. If provided, limits to the given tags. Individual\n tags are of the format # key|value. Tags are OR'd together. If a tag-key shows up\n more than once, only the last one is accepted\n @return [Array<Trigger>] Triggers found", "Obtains one Trigger definition from the server.\n @param [String] trigger_id Id of the trigger to fetch\n @param full If true then conditions and dampenings for the trigger are also fetched\n @return [Trigger] the selected trigger", "Creates the trigger definition.\n @param [Trigger] trigger The trigger to be created\n @param [Array<Condition>] conditions Array of associated conditions\n @param [Array<Dampening>] dampenings Array of associated dampenings\n @return [Trigger] The newly created trigger", "Creates the group conditions definitions.\n @param [String] trigger_id ID of the group trigger to set conditions\n @param [String] trigger_mode Mode of the trigger where conditions are attached (:FIRING, :AUTORESOLVE)\n @param [GroupConditionsInfo] group_conditions_info the conditions to set into the group trigger with the mapping\n                                                    with the data_id members map\n @return [Array<Condition>] conditions Array of associated conditions", "Lists members of a group trigger\n @param [String] trigger_id ID of the group trigger to list members\n @param [boolean] orphans flag to include orphans\n @return [Array<Trigger>] Members found", "Creates a dampening for a group trigger\n @param [Dampening] dampening the dampening to create\n @return [Dampening] the newly created dampening", "Updates a dampening for a group trigger\n @param [Dampening] dampening the dampening to update\n @return [Dampening] the updated dampening", "Creates the action.\n @param [String] plugin The id of action definition/plugin\n @param [String] action_id The id of action\n @param [Hash] properties Troperties of action\n @return [Action] The newly created action", "Obtains one action of given action plugin from the server.\n @param [String] plugin Id of the action plugin\n @param [String] action_id Id of the action\n @return [Action] the selected trigger", "Deletes the action of given action plugin.\n @param [String] plugin Id of the action plugin\n @param [String] action_id Id of the action", "Obtain the alerts for the Trigger with the passed id\n @param [String] trigger_id Id of the trigger that has fired the alerts\n @return [Array<Alert>] List of alerts for the trigger. Can be empty", "List fired alerts\n @param [Hash] criteria optional query criteria\n @param [Array] tenants optional list of tenants. The elements of the array can be any object\n   convertible to a string\n @return [Array<Alert>] List of alerts in the system. Can be empty", "Retrieve a single Alert by its id\n @param [String] alert_id id of the alert to fetch\n @return [Alert] Alert object retrieved", "Mark one alert as resolved\n @param [String] alert_id Id of the alert to resolve\n @param [String] by name of the user resolving the alert\n @param [String] comment A comment on the resolution", "Inject an event into Hawkular-alerts\n @param [String] id Id of the event must be unique\n @param [String] category Event category for further distinction\n @param [String] text Some text to the user\n @param [Hash<String,Object>] extras additional parameters", "Add tags to existing Alerts.\n @param [Array<numeric>] alert_ids List of alert IDs\n @param [Array<String>] tags List of tags. Each tag of format 'name|value'.", "Remove tags from existing Alerts.\n @param [Array<numeric>] alert_ids List of alert IDs\n @param [Array<String>] tag_names List of tag names.", "Initializes a new certificate store.\n\n @param location [String, #to_s, nil] location the path to the\n   directories to load certificates from, or nil if no certificates need\n   to be loaded from the disk\n Looks up a certificate in the store by its public key.\n\n @param pubkey [String] the public key in question, in Z85 format\n @return [Certificate] the matching certificate, if found\n @return [nil] if no matching certificate was found", "Inserts a new certificate into the store.\n\n @note The same public key must not be inserted more than once.\n @param cert [Certificate] the certificate to insert\n @return [void]\n @raise [ArgumentError] if the given certificate is not a Certificate\n   object or has been inserted before already", "Record inheritable assignments for replay in an inheriting class.", "This Method tries to find the first module that implements the method\n named +methodname+ in the array of +ancestors+. If this fails nil is\n returned.", "Configure monitor to listen for specific events.\n @param events [String] one or more events from {EVENTS}\n @return [void]", "Appends new error elements to the Report output\n\n @example\n  <testcase classname=\"JUnitXmlReporter.constructor\" name=\"should default path to an empty string\" time=\"0.006\">\n    <failure message=\"test failure\">Assertion failed</failure>\n </testcase>\n\n @param code [String] The error code\n @param errors [Array] The errors for the code\n @return [void]", "Concatenates the protocol as Ruby code to the +result+ string and return\n it. At the moment this method only supports method signatures with\n generic argument names.", "Returns true if it is required to understand the", "Return all messages for whick a check failed.", "Inherit a method signature from an instance method named +methodname+ of\n +modul+. This means that this protocol should understand these instance\n methods with their arity and block expectation. Note that automatic\n detection of blocks does not work for Ruby methods defined in C. You can\n set the +block_expected+ argument if you want to do this manually.", "Capture all added methods and either leave the implementation in place or\n add them to the protocol description.", "Creates a new actor. Either pass a callback directly or a block. The\n block will be called for every received message.\n\n In case the given callback is an FFI::Pointer (to a C function), it's\n used as-is. It is expected to do the handshake (signal) itself.\n\n @param callback [FFI::Pointer, Proc, #call] pointer to a C function or\n   just anything callable\n @param c_args [FFI::Pointer, nil] args, only useful if callback is an\n   FFI::Pointer\n @yieldparam message [Message]\n @yieldparam pipe [Socket::PAIR]\n @see #process_messages\n Send a message to the actor.\n @param message [Object] message to send to the actor, see {Message.coerce}\n @return [self] so it's chainable\n @raise [DeadActorError] if actor is terminated\n @raise [IO::EAGAINWaitWritable, RuntimeError] anything that could be\n   raised by {Message#send_to}\n @note Normally this method is asynchronous, but if the message is\n   \"$TERM\", it blocks until the actor is terminated.", "Sends a message according to a \"picture\".\n @see zsock_send() on http://api.zeromq.org/czmq3-0:zsock\n @note Mainly added for {Beacon}. If implemented there, it wouldn't be\n   thread safe. And it's not that useful to be added to\n   {SendReceiveMethods}.\n @param picture [String] message's part types\n @param args [String, Integer, ...] values, in FFI style (each one\n   preceeded with it's type, like <tt>:string, \"foo\"</tt>)\n @return [void]", "Tells the actor to terminate and waits for it. Idempotent.\n @return [Boolean] whether it died just now (+false+ if it was dead\n   already)", "get list of known ancestrors iterateing over parents\n @param [Hash] options\n @option options [Symbol] generations lets you limit how many generations will be included in the output.\n @return [ActiveRecord::Relation] list of ancestors (limited by a number of generations if so indicated)", "get list of known descendants iterateing over children ...\n @param [Hash] options\n @option options [Symbol] generations lets you limit how many generations will be included in the output.\n @return [ActiveRecord::Relation] list of descendants (limited by a number of generations if so indicated)", "list of uncles and aunts iterating through parents' siblings\n @param [Hash] options\n @option options [Symbol] lineage to filter by lineage: :paternal or :maternal\n @option options [Symbol] half to filter by half siblings (see #siblings)\n @return [ActiveRecord::Relation] list of uncles and aunts", "Modifies the events of interest for the given socket.\n @param socket [Socket, Actor] the socket\n @param events [Integer] events you're interested in (see constants in\n   {ZMQ}\n @return [void]\n @raise [ArgumentError] if it's not a socket", "Removes a previously registered socket. Won't raise if you're\n trying to remove a socket that's not registered.\n @param socket [Socket, Actor] the socket\n @return [void]\n @raise [ArgumentError] if it's not a socket", "Removes a reader socket that was registered for readability only.\n\n @param socket [Socket, Actor] the socket\n @raise [ArgumentError] if it's not registered, not registered for\n   readability, or registered for more than just readability", "Removes a reader socket that was registered for writability only.\n\n @param socket [Socket, Actor] the socket\n @raise [ArgumentError] if it's not registered, not registered for\n   writability, or registered for more than just writability", "Waits for registered sockets to become readable or writable, depending\n on what you're interested in.\n\n @param timeout [Integer] how long to wait in ms, or 0 to avoid blocking,\n   or -1 to wait indefinitely\n @return [Event] the first event of interest\n @return [nil] if the timeout expired or\n @raise [SystemCallError] if this failed", "Invokes operation on the WildFly agent that has it's own message type\n @param operation_payload [Hash{String=>Object}] a hash containing: resourceId [String] denoting\n the resource on which the operation is about to run, feedId [String]\n @param operation_name [String] the name of the operation. This must correspond with the message type, they can be\n found here https://git.io/v2h1a (Use only the first part of the name without the Request/Response suffix), e.g.\n RemoveDatasource (and not RemoveDatasourceRequest)\n @param callback [Block] callback that is run after the operation is done", "Deploys an archive file into WildFly\n\n @param [Hash] hash Arguments for deployment\n @option hash [String]  :resource_id ID of the WildFly server into which we deploy\n                        or of the domain controller if we deploy into a server group (in case of domain mode)\n @option hash [String]  :feed_id feed containing this resource\n @option hash [String]  :destination_file_name resulting file name\n @option hash [String]  :binary_content binary content representing the war file\n @option hash [String]  :enabled whether the deployment should be enabled immediately, or not (default = true)\n @option hash [String]  :force_deploy whether to replace existing content or not (default = false)\n @option hash [String]  :server_groups comma-separated list of server groups for the operation (default = ignored)\n\n @param callback [Block] callback that is run after the operation is done", "Undeploy a WildFly deployment\n\n @param [Hash] hash Arguments for deployment removal\n @option hash [String]  :resource_id ID of the WildFly server from which to undeploy the deployment\n @option hash [String]  :feed_id feed containing this resource\n @option hash [String]  :deployment_name name of deployment to undeploy\n @option hash [String]  :remove_content whether to remove the deployment content or not (default = true)\n @option hash [String]  :server_groups comma-separated list of server groups for the operation (default = ignored)\n\n @param callback [Block] callback that is run after the operation is done", "Enable a WildFly deployment\n\n @param [Hash] hash Arguments for enable deployment\n @option hash [String]  :resource_id ID of the WildFly server from which to enable the deployment\n @option hash [String]  :feed_id feed containing this resource\n @option hash [String]  :deployment_name name of deployment to enable\n @option hash [String]  :server_groups comma-separated list of server groups for the operation (default = ignored)\n\n @param callback [Block] callback that is run after the operation is done", "Exports the JDR report\n\n @param [String] resource_id ID of the WildFly server\n @param [String] feed_id ID of the feed containing the WildFly server\n @param [Boolean] delete_immediately specifies whether the temporary file at the remote\n server should be deleted. False, by default.\n @param callback [Block] callback that is run after the operation is done", "Updates the collection intervals.\n\n @param [Hash] hash Arguments for update collection intervals\n @option hash {resourceId} a resource managed by the target agent\n @option hash {feedId} the related feed ID\n @option hash {metricTypes} A map with key=MetricTypeId, value=interval (seconds).\n MetricTypeId must be of form MetricTypeSet~MetricTypeName\n @option hash {availTypes} A map with key=AvailTypeId, value=interval (seconds).\n AvailTypeId must be of form AvailTypeSet~AvailTypeName\n\n @param callback [Block] callback that is run after the operation is done", "Close the receiver and return it\n @return [Polyline]\tthe receiver after closing", "Generate bisectors and k values with an optional mapping block\n @note If the {Polyline} isn't closed (the normal case), then the first and\n   last vertices will be given bisectors that are perpendicular to themselves.\n @return [Array<Vector>]   the unit {Vector}s representing the angle bisector of each vertex", "Generate the tangents and fake a circular buffer while accounting for closedness\n @return [Array<Vector>]   the tangents", "Find the next edge that intersects with e, starting at index i", "Find the last edge that intersects with e, starting at index i", "Get the value of the current config item.\n @param path [String, #to_s] path to config item\n @param default [String, #to_s] default value to return if config item\n   doesn't exist\n @return [String]\n @return [default] if config item doesn't exist\n @note The default value is not returned when the config item exists but\n   just doesn't have a value. In that case, it'll return the empty\n   string.", "generates a XML-RPC methodResponse document\n\n if is_ret == false then the params array must\n contain only one element, which is a structure\n of a fault return-value.\n\n if is_ret == true then a normal\n return-value of all the given params is created.", "List nesting is implicit given the level of\n Make it explicit, just to make life a tad\n easier for the output processors", "Create a Package Task with the given name and version.\n Initialization that bypasses the \"yield self\" and \"define\" step.", "Create a Virtual Machine\n\n Requires a Hash with the following keys:\n\n {\n   :vm_name => name, (string, required)\n   :cpus => 1, #(int, optional)\n   :guest_id => 'otherGuest', #(string, optional)\n   :disk_size => 4096,  #(in MB, optional)\n   :memory => 128, #(in MB, optional)\n   :datastore => datastore1 #(string, optional)\n   :disk_file => path to vmdk inside datastore (optional)\n   :disk_type => flat, sparse (default flat)\n   :hw_version => 8 #(int, optional)\n }\n\n supported guest_id list:\n http://pubs.vmware.com/vsphere-50/index.jsp?topic=/com.vmware.wssdk.apiref.doc_50/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html\n\n Default values above.", "Return product info as an array of strings containing\n\n fullName, apiType, apiVersion, osType, productLineId, vendor, version", "Run a command in the ESX host via SSH", "Expects vmdk source file path and destination path\n\n copy_from_template \"/home/fooser/my.vmdk\", \"/vmfs/volumes/datastore1/foovm/foovm.vmdk\"\n\n Destination directory must exist otherwise rises exception", "Imports a VMDK\n\n if params has :use_template => true, the disk is saved as a template in\n @templates_dir and cloned from there.\n\n Destination directory must exist otherwise rises exception", "This method does all the heavy lifting when importing the disk.\n It also converts the imported VMDK to thin format", "disk_file\n datastore\n disk_size\n disk_type", "Destroy the VirtualMaching removing it from the inventory\n and deleting the disk files", "overridden in specific formatters", "draw a string in bold", "Place heading level indicators inline with heading.", "Returns the data recieved in the request body.\n\n This method support both application/x-www-form-urlencoded and\n multipart/form-data.", "Tries to return a remake of the original request URL as a string.", "Open a client connection to +uri+ with the configuration +config+.\n\n The DRbProtocol module asks each registered protocol in turn to\n try to open the URI.  Each protocol signals that it does not handle that\n URI by raising a DRbBadScheme error.  If no protocol recognises the\n URI, then a DRbBadURI error is raised.  If a protocol accepts the\n URI, but an error occurs in opening it, a DRbConnError is raised.", "Open a server listening for connections at +uri+ with\n configuration +config+.\n\n The DRbProtocol module asks each registered protocol in turn to\n try to open a server at the URI.  Each protocol signals that it does\n not handle that URI by raising a DRbBadScheme error.  If no protocol\n recognises the URI, then a DRbBadURI error is raised.  If a protocol\n accepts the URI, but an error occurs in opening it, the underlying\n error is passed on to the caller.", "On the client side, send a request to the server.", "Routes method calls to the referenced object.", "Stop this server.", "Convert a dRuby reference to the local object it refers to.", "Check that a method is callable via dRuby.\n\n +obj+ is the object we want to invoke the method on. +msg_id+ is the\n method name, as a Symbol.\n\n If the method is an insecure method (see #insecure_method?) a\n SecurityError is thrown.  If the method is private or undefined,\n a NameError is thrown.", "The main loop performed by a DRbServer's internal thread.\n\n Accepts a connection from a client, and starts up its own\n thread to handle it.  This thread loops, receiving requests\n from the client, invoking them on a local object, and\n returning responses, until the client closes the connection\n or a local method call fails.", "Does PostgreSQL support standard conforming strings?", "Create an RDoc task with the given name. See the RDocTask class overview\n for documentation.\n Create the tasks defined by this task lib.", "To deal with the fact that RubyUnit does not check that the\n regular expression is, indeed, a regular expression, if it is\n not, we do our own assertion using the same semantics as\n RubyUnit", "Create a GEM Package task library.  Automatically define the gem\n if a block is given.  If no block is supplied, then +define+\n needs to be called to define the task.\n Initialization tasks without the \"yield self\" or define\n operations.", "Parse an XML Document string into a simple hash\n\n Same as XmlSimple::xml_in but doesn't shoot itself in the foot,\n and uses the defaults from ActiveSupport\n\n string::\n   XML Document string to parse", "Set up the standard mapping of attributes to HTML tags", "Add a new set of HTML tags for an attribute. We allow\n separate start and end tags for flexibility", "Set header fields and a body from HTML form data.\n +params+ should be a Hash containing HTML form data.\n Optional argument +sep+ means data record separator.\n\n This method also set Content-Type: header field to\n application/x-www-form-urlencoded.", "Iterate through the tuple, yielding the index or key, and the\n value, thus ensuring arrays are iterated similarly to hashes.", "Munges +ary+ into a valid Tuple.", "Ensures +hash+ is a valid Tuple.", "Convert to single-precision 32-bit floating point value.", "String in Ruby could be a binary.", "Tries to rescue the exception by looking up and calling a registered handler.", "Look for common options in a chunk of text. Options that\n we don't handle are passed back to our caller\n as |directive, param|", "Include a file, indenting it correctly", "Look for the given file in the directory containing the current\n file, and then in each of the directories specified in the\n RDOC_INCLUDE path", "End of parse_program_or_module\n\n Parse arguments, comment, code of subroutine and function.\n Return AnyMethod object.", "Collect comment for file entity", "Return comments of definitions of namelists", "Comments just after module or subprogram, or arguments are\n returned. If \"COMMENTS_ARE_UPPER\" is true, comments just before\n modules or subprograms are returned", "Create method for internal alias", "Create method for external alias\n\n If argument \"internal\" is true, file is ignored.", "Check external aliases", "Continuous lines are united.\n\n Comments in continuous lines are removed.", "Continuous line checker", "Comment out checker", "Semicolons are replaced to line feed.", "Empty lines in header are removed", "Closes the stream. All operations on the closed stream will raise an\n exception.", "Resets and initializes the stream. All data in both input and output\n buffer are discarded.", "Performs the deflate operation and leaves the compressed data in the\n output buffer", "Changes the parameters of the deflate stream. See zlib.h for details.\n The output from the stream by changing the params is preserved in output\n buffer.", "HACK use a buffer class\n\n Creates a GzipReader object associated with +io+. The GzipReader object\n reads gzipped data from +io+, and parses/decompresses them.  At least,\n +io+ must have a +read+ method that behaves same as the +read+ method in\n IO class.\n\n If the gzip file header is incorrect, raises an Zlib::GzipFile::Error\n exception.", "Writes out a gzip header", "Writes out a gzip footer", "Same as IO.", "Creates a new inflate stream for decompression. See zlib.h for details\n of the argument.  If +window_bits+ is +nil+, the default value is used.\n\n Inputs +string+ into the inflate stream just like Zlib::Inflate#inflate,\n but returns the Zlib::Inflate object itself.  The output from the stream\n is preserved in output buffer.", "A private helper method", "returns true, if the arity of \"obj\" matches", "Verify that the gem data with the given signature and signing chain\n matched this security policy at the specified time.", "Transform this node fully into a native type", "Look for the first comment in a file that isn't\n a shebang line.", "Capture the method's parameters. Along the way,\n look for a comment containing\n\n    # yields: ....\n\n and add this as the block_params for the method", "while, until, and for have an optional", "Return a superclass, which can be either a constant\n of an expression", "Parse a constant, which might be qualified by\n one or more class or module names", "Get a constant that may be surrounded by parens", "Directives are modifier comments that can appear after class, module,\n or method names. For example\n\n   def fred    # :yields:  a, b\n\n or\n\n   class SM  # :nodoc:\n\n we return the directive name and any parameters as a two element array", "depricated old interface", "Convert a string in markup format into HTML. We keep a cached\n SimpleMarkup object lying around after the first time we're\n called per object.", "Build an array of arrays of method details. The outer array has up\n to six entries, public, private, and protected for both class\n methods, the other for instance methods. The inner arrays contain\n a hash for each method", "Build the structured list of classes and modules contained\n in this context.", "Load up the HTML template specified in the options.\n If the template name contains a slash, use it literally", "Write out the style sheet used by the main frames", "return the url of the main page", "Generate all the HTML. For the one-file case, we generate\n all the information in to one big hash", "Pass in the set of top level objects. The method also creates the\n subdirectory to hold the images\n\n Draw the diagrams. We traverse the files, drawing a diagram for each. We\n also traverse each top-level class and module in that file drawing a\n diagram for these too.", "allow us to sort modules by name\n Look up the given symbol. If method is non-nil, then\n we assume the symbol references a module that\n contains that method", "constant-time comparison algorithm to prevent timing attacks", "Extract the first name=\"value\" pair from content.\n Works with single quotes according to the constant\n CONTENT_PATTERN. Return a Hash.", "Try to get the XML associated with +rss+.\n Return +rss+ if it already looks like XML, or treat it as a URI,\n or a file to get the XML,", "Create a testing task.\n Create the tasks defined by this task lib.", "Update the flag file in an output directory.", "Given a list of files and directories, create a list of all the Ruby\n files they contain.\n\n If +force_doc+ is true we always add the given files, if false, only\n add files that we guarantee we can parse.  It is true when looking at\n files given on the command line, false when recursing through\n subdirectories.\n\n The effect of this is that if you want a file with a non-standard\n extension parsed, you must name it explicitly.", "Return a list of the files to be processed in a directory. We know that\n this directory doesn't have a .document file, so we're looking for real\n files. However we may well contain subdirectories which must be tested\n for .document files.", "Parse each file on the command line, recursively entering directories.", "Format up one or more files according to the given arguments.\n\n For simplicity, _argv_ is an array of strings, equivalent to the strings\n that would be passed on the command line. (This isn't a coincidence, as\n we _do_ pass in ARGV when running interactively). For a list of options,\n see rdoc/rdoc.rb. By default, output will be stored in a directory\n called +doc+ below the current directory, so make sure you're somewhere\n writable before invoking.\n\n Throws: RDoc::Error on error", "If +value+ is an instance of class +klass+, return it, else\n create a new instance of +klass+ with value +value+.", "Yields Method and Attr entries matching the list of names in +methods+.\n Attributes are only returned when +singleton+ is false.", "Find a named module", "Adding a class or module to a TopLevel is special, as we only want one\n copy of a particular top-level class. For example, if both file A and\n file B implement class C, we only want one ClassModule object for C.\n This code arranges to share classes and modules between files.", "Get the superclass of this class.  Attempts to retrieve the superclass'\n real name by following module nesting.", "Append to body and update Content-Length.\n\n NOTE: Do not mix #write and direct #body access!", "Returns the attribute value, with entities replaced", "Returns the UNNORMALIZED value of this attribute.  That is, entities\n have been expanded to their values", "Resolve task arguments for a task or rule when there are\n dependencies declared.\n\n The patterns recognized by this argument resolving function are:\n\n   task :t => [:d]\n   task :t, [a] => [:d]\n   task :t, :needs => [:d]                 (deprecated)\n   task :t, :a, :needs => [:d]             (deprecated)", "Run the top level tasks of a Rake application.", "return a list of class and instance methods that we'll be\n documenting", "Remove the data collected so far. Further collection will start from\n scratch.", "Transfers +localfile+ to the server in binary mode, storing the result in\n +remotefile+. If a block is supplied, calls it, passing in the transmitted\n data in +blocksize+ chunks.", "read in our methods and any classes\n and modules in our namespace. Methods are\n stored in files called name-c|i.yaml,\n where the 'name' portion is the external\n form of the method name and the c|i is a class|instance\n flag", "Find methods matching 'name' in ourselves and in\n any classes we contain", "Return a list of all out method names", "Return a list of all our methods matching a given string.\n Is +is_class_methods+ if 'nil', we don't care if the method\n is a class method or not, otherwise we only return\n those methods that match", "Convert a string in markup format into HTML.", "Returns a reference to outselves to be used as an href= the form depends\n on whether we're all in one file or in multiple files", "Create a list of Method objects for each method in the corresponding\n context object. If the @options.show_all variable is set (corresponding\n to the <tt>--all</tt> option, we include all methods, otherwise just the\n public ones.", "create table of contents if we contain sections", "Returns the relative file name to store this class in, which is also its\n url", "Outputs values for discovered constants.  If the constant's value was\n not discovered it is not omitted.", "merge in another class desscription into this one", "error message manipulator", "return the MethodDescription for a given MethodEntry\n by deserializing the YAML", "Return a class description", "Parse command line options.", "Parse each file on the command line, recursively entering\n directories", "Taken from SQLite adapter", "Search for YPath entry and return\n qualified nodes.", "Search for YPath entry and return\n transformed nodes.", "Search for YPath entry and return a list of\n qualified paths.", "YPath search returning a complete depth array", "Search a node for a single YPath segment", "We want the node to act like as Hash\n if it is.", "Escape a LaTeX string", "Attach C function +name+ to this module.\n\n If you want to provide an alternate name for the module function, supply\n it after the +name+, otherwise the C function name will be used.\n\n After the +name+, the C function argument types are provided as an Array.\n\n The C function return type is provided last.", "Is the provided constant path defined?", "Search for a file in load_paths matching the provided suffix.", "Attempt to autoload the provided module name by searching for a directory\n matching the expect path suffix. If found, the module is created and assigned\n to +into+'s constants with the name +const_name+. Provided that the directory\n was loaded from a reloadable base path, it is added to the set of constants\n that are to be unloaded.", "Return the constant path for the provided parent and constant name.", "Load the constant named +const_name+ which is missing from +from_mod+. If\n it is not possible to load the constant into from_mod, try its parent module\n using const_missing.", "Remove the constants that have been autoloaded, and those that have been\n marked for unloading.", "Determine if the given constant has been automatically loaded.", "Mark the provided constant name for unloading. This constant will be\n unloaded on each request, not just the next one.", "Write a text block with the current indent", "Write a current indent", "Retrieves +remotefile+ in binary mode, storing the result in +localfile+.\n If a block is supplied, it is passed the retrieved data in +blocksize+\n chunks.", "Extracts the response URI from +msg+ and adds it to TupleSpace where it\n will be picked up by +reply_service+ for notification.", "Looks up RingServers waiting +timeout+ seconds.  RingServers will be\n given +block+ as a callback, which will be called with the remote\n TupleSpace.", "The project file links together all the various\n files that go to make up the help.", "The contents is a list of all files and modules.\n For each we include  as sub-entries the list\n of methods they contain. As we build the contents\n we also build an index file", "Returns a valid argument to make_expires and the renewer or nil.\n\n Given +true+, +nil+, or Numeric, returns that value and +nil+ (no actual\n renewer).  Otherwise it returns an expiry value from calling +it.renew+\n and the renewer.", "Add +tuple+ to the TupleBag.", "Removes +tuple+ from the TupleBag.", "Finds all live tuples that match +template+.", "Finds a live tuple that matches +template+.", "Delete tuples which dead tuples from the TupleBag, returning the deleted\n tuples.", "Creates a new TupleSpace.  +period+ is used to control how often to look\n for dead tuples after modifications to the TupleSpace.\n\n If no dead tuples are found +period+ seconds after the last\n modification, the TupleSpace will stop looking for dead tuples.\n\n Adds +tuple+", "Moves +tuple+ to +port+.", "Reads +tuple+, but does not remove it.", "Returns all tuples matching +tuple+.  Does not remove the found tuples.", "Registers for notifications of +event+.  Returns a NotifyTemplateEntry.\n See NotifyTemplateEntry for examples of how to listen for notifications.\n\n +event+ can be:\n 'write'::  A tuple was added\n 'take'::   A tuple was taken or moved\n 'delete':: A tuple was lost after being overwritten or expiring\n\n The TupleSpace will also notify you of the 'close' event when the\n NotifyTemplateEntry has expired.", "Removes dead tuples.", "Notifies all registered listeners for +event+ of a status change of\n +tuple+.", "Return entries just like running `history` in your shell.\n @return [String] pretty representation of the entries", "Creates an object for tracking a single Fog collection in a single account\n @param [String] resource_type the Fog collection name for this resource type\n @param [AccountTracker] account_tracker the AccountTracker for this tracker's\n       account. Usually the AccountTracker that created this object\n Polls the {AccountTracker}'s connection for updated info on all existing\n instances of this tracker's resource_type", "Creates an object for tracking all collections in a single Fog account\n @param [String] account_name a human-readable name for the account\n @param [Hash] account a Hash of account configuration data\n @param [Hash] options optional additional parameters:\n  - :delay (Integer) - Default time between polling of accounts\n  - :callback (Proc) - A Method or Proc to call each time an account is polled.\n    (should take an Array of resources as its only required parameter)\n  - :error_callback (Proc) - A Method or Proc to call if polling errors occur.\n    (should take a single Exception as its only required parameter)\n  - :logger - a Ruby Logger-compatible object\n Starts a background thread, which periodically polls for all the\n resource collections for this tracker's account", "Polls once for all the resource collections for this tracker's account", "Run the command and capture the output", "cbz all subdirectories in a directory", "yield successive arg, parameter pairs", "If present, parses data from the signed request and inserts it into the fbparams\n object for use during requests", "Stores a file.\n\n   hash = Digest::SHA1.file(file.path).hexdigest\n   layer.store(\"documents\", hash, path)\n\n Hash must be a hex digest of the file content. If an object with the\n supplied hash already exists, no action will be performed. In other\n words, no data will be overwritten if a hash collision occurs.\n\n Returns an instance of Fog::Model, or raises an error if the layer\n is readonly.", "Returns true if a object with the given hash exists.\n\n    layer.exists?(\"documents\", hash)", "Retrieves a file from the store.\n\n    layer.get(\"documents\", hash)", "Deletes a file from the store.\n\n   layer.delete(\"documents\", hash)\n\n Returns true if the file was deleted, or false if it could not be found.\n Raises an error if the layer is readonly.", "Create a thread to periodically renew the lock session", "Verify wheather the session exists after a period of time", "Does the session exist", "Arrays start with the minus on each line \"-\"\n and each line has the value", "Get a list with payment issuers.", "Setup a new transaction.", "Checks if a transaction is refundable.", "Refund a transaction.", "Checks if a transaction is cancellable.", "Cancel a transaction.", "Validate required parameters.", "Validate params for setup transaction.", "Validate the payment issuer when iDEAL is selected as payment method.", "Validate params for recurrent transaction.", "Build and execute a request.", "Factory method for constructing a request.", "helper function to return the output as a string\n ie creates stringio, calls out and returns the string", "attributes hold key value pairs", "Saves the cache as a YAML file.", "stringifies and sorts hashes by key at all levels.", "Find an existing build, duplicate the sane parts of it.", "Run the double.\n\n This will append the call to the doubles history, display any\n outputs if defined and exit.", "Create the executable double.\n\n @return [String] full path to the double.", "Export the double to executable Ruby code.\n\n @return [String] serialized double", "Delete the executable double.", "Set the new filter at the given `index`. You can specify any existing\n filter or an index one above the highest index.\n\n @param index [Integer, Class, String, Object] The existing filter which\n   should be overwritten with `filter`. It can be described in different\n   ways: When given an `Integer`, we expect it to be the index number; when\n   given a `Class`, we try to find the first filter being of that type;\n   when given a `String`, we try to find the first filter being of a type\n   named like that; when given any other object, we assume it is a filter\n   and search for that.\n @param filter [#call, nil] the filter to set at `index`\n @raise [ArgumentError] if no existing filter could be found at `index`\n @raise [TypeError] if the given filter is not callable\n @return [#call] the given `filter`", "Filter the given event by calling each defined filter with it. Each filter\n will be called with the current event and can manipulate it in any way.\n\n If any of the filters returns `false`, no further filter will be applied\n and we also return `false`. This behavior can be used by filters to cancel\n the writing of an individual event. Any other return value of filters is\n ignored.\n\n @param event [Hash] an event hash, see {Buffer#event} for details\n @return [Hash, false] the filtered event or `false` if any of the\n   filters returned `false`", "Insert a new filter before an existing filter in the filter chain.\n\n @param index [Integer, Class, String, Object] The existing filter before\n   which the new one should be inserted. It can be described in different\n   ways: When given an `Integer`, we expect it to be the index number; when\n   given a `Class`, we try to find the first filter being of that type;\n   when given a `String`, we try to find the first filter being of a type\n   named like that; when given any other object, we assume it is a filter\n   and search for that.\n @param filter_spec (see #build_filter)\n @raise [ArgumentError] if no existing filter could be found at `index`\n @raise [TypeError] if we could not build a filter from the given\n   `filter_spec`\n @return [self]", "Build a new filter instance from the given specification.\n\n @param filter_spec [Array] the description of a filter to create. If you\n   give a single `Proc` (or any other object which responds to `#call`) or\n   simply a proc, we will directly return it. If you give a `Class` plus\n   any optional initializer arguments, we will return a new instance of\n   that class. When giving a `String` or `Symbol`, we first use the\n   {Filter.registry} to find the matching filter class. With that class,\n   we then create a filter object as before using the additional arguments\n   given to `initialize`.\n @return [#call] a filter instance", "Start the service\n @return [nil]", "Retrieve the registered class for a given name. If the argument is already\n a class, we return it unchanged.\n\n @param spec [Class,String,Symbol] either a class (in which case it is\n   returned directly) or the name of a registered class\n @param default [Object] the default value that is returned if no\n   registered class could be found for the given `spec` and no block was\n   given.\n @yield if no registered class could be found for the given `spec`, we will\n   run the optional block and return its result\n @yieldparam spec [Symbol] the requested class specification as a `Symbol`\n @raise [KeyError] when giving a `String` or `Symbol` but no registered\n   class was found for it and no default was specified\n @raise [TypeError] when giving an invalid `spec` object\n @return [Class] the registered class (when giving a `String` or `Symbol`)\n   or the given class (when giving a `Class`)", "Register a class for the given name.\n\n @param name [String, Symbol] the name at which the class should be\n   registered\n @param registered_class [Class] the class to register at `name`\n @raise [TypeError] if `name` is not a `String` or `Symbol`, or if\n   `registered_class` is not a `Class`\n @return [Class] the `registered_class`", "Emit a new event with given arguments.\n\n @param name [Symbol] The event name.\n @param args [optional, Array] The list of arguments to pass.\n @return [true, false] True if any callbacks were invoked, nil otherwise", "Two models are equal if their attributes are equal.\n Recursively convert all attributes to hash pairs.", "Extract model attributes into a hash.", "Validate \"many\" associations and import errors.", "Merge associated errors using the current validation context.", "Export each value with the provided options.", "Export the value with the provided options.", "Create a contender key", "Get the current semaphore state by fetching all\n conterder keys and the lock key", "Write a new lock file if the number of contenders is less than `limit`\n @return [Boolean] `true` if the lock was written succesfully", "Start a blocking query on the prefix, if there are changes\n we need to try to obtain the lock again.\n\n @return [Boolean] `true` if there are changes,\n  `false` if the request has timed out", "Decode raw response from Consul\n Set `@lock_modify_index`, `@lock_content`, and `@members`\n @returns [Array] List of members", "Get the active members from the lock file, removing any _dead_ members.\n This is accomplished by using the contenders keys(`@members`) to get the\n list of all alive members.  So we can easily remove any nodes that don't\n appear in that list.", "Add our session.id to the holders list if holders is less than limit", "Format the list of holders for the lock file", "Generate JSON formatted lockfile content, only if the content has changed", "Magic hook that starts a process if there's a good reason to.\n Stopgap measure that means you can knock on this if there's a chance we\n should start a process", "Forwards the received message to the client instance.\n\n Called when the network connection has enough data to form a command.", "Called when the connection was closed.", "Transmit a command to the server.\n\n @param [Symbol, String] name the command name.\n @param [...] arguments all the prepended parameters.", "Locking mechanisem is based on sorted set, sorted set is used to allow a simulation\n of expiration time on the keys in the map", "Instantiates the client, stores the options, instantiates the networks\n and then loads available scripts.\n\n @param [Hash] options the options for the client.\n @option options [String] :config_path path to a configuration file.\n @option options [String] :environment the client environment.\n Connect to each network available that is not already connected, then\n proceed to start the run-loop.", "Try to gracefully disconnect from each network, unload all scripts and\n exit properly.\n\n @param [optional, Symbol] signal The signal received by the system, if any.", "Loads all scripts in the script directory.", "Loads the given +file_path+ as a Ruby script, wrapping it in an anonymous\n module to protect our global namespace.\n\n @param [String] file_path the path to the ruby script.\n\n @raise [Exception] if there was any problems loading the file", "Unloads initialized scripts and superscripts.\n\n This method will call #unloaded on the instance of each loaded script to\n give it a chance to clean up any resources.", "Load the user-specified configuration file.\n\n @returns true on success, false otherwise.", "Set path of page to file path if a file exists or to path\n without file extension if file is not found. File extensions\n are appended only after the file has been downloaded.", "Check that the text 'content' is on the page, set flag to check that it isn't", "Check that the text 'content' is within a particular css section, set flag to check that it isn't", "XXX This is spectacular.\n Not in the good way", "Returns the time of the current buffer as an ISO 8601 formatted string.\n If the timestamp was not yet set on the buffer, it is is set to the\n the passed `time` or the current time.\n\n @example\n   buffer.timestamp\n   # => \"2016-10-17T13:37:00.234Z\"\n @param time [Time] an optional time object. If no timestamp was set yet,\n   this time is used\n @return [String] an ISO 8601 formatted UTC timestamp.", "Create an event hash from `self`.\n\n * It contains the all of the current buffer's logged fields\n * We add the buffer's tags and add them as an array of strings to the\n   `event['tags']` field.\n * We add the buffer's list of messages to `event['message']`. This field\n   thus contains an array of {Message} objects.\n * We add the buffer's timestamp to the `event['@timestamp]` as a `Time`\n   object in UTC.\n\n The typical event emitted here looks like this:\n\n     {\n       \"beep\" => \"boop\",\n       \"foo\" => [\"bar\", \"baz\"],\n       \"tags\" => [\"request\", \"controller#action\"],\n       \"message\" => [\n         #<Rackstash::Message:0x007f908b4414c0 ...>,\n         #<Rackstash::Message:0x007f908d14aee0 ...>\n       ],\n       \"@timestamp\" => 2016-10-17 13:37:42 UTC\n     }\n\n Note that the resulting hash still contains an Array of {Message}s in the\n `\"message\"` field and a `Time` object in the '@timestamp' field. This\n allows the {Flow}'s components (usually a {Filter} or the {Flow#encoder})\n to reject or adapt some messages based on their original attributes, e.g.,\n their severity or timestamp. It is the responsibility of the\n {Flow#encoder} to correctly format the `\"@timestamp\"` field.\n\n All other fields in the event Hash besides `\"message\"` and `@timestamp\"`\n are either `Hash`, `Array`, frozen `String`, `Integer` or `Float` objects.\n All hashes (including nested hashes) use `String` keys.\n\n @return [Hash] the event expected by the event {Filter}s.", "Creates a new HTTP instance which will automatically handle authenting to the RETS server.", "Creates and manages the HTTP digest auth\n if the WWW-Authorization header is passed, then it will overwrite what it knows about the auth data.", "Creates a HTTP digest header.", "Finds the ReplyText and ReplyCode attributes in the response\n\n @param [Nokogiri::XML::NodeSet] rets <RETS> attributes found\n\n @return [String] RETS ReplyCode\n @return [String] RETS ReplyText", "Creates an instance of Group or calls an existing\n\n @param name [Symbol, String] the prefix of the Groups object class\n @param opts [Hash] optional arguments\n @param args [Any] extra arguments\n @param block [Block] that yields to self\n @return [GroupObject]\n @example\n   groups(:login, {}, 'Main').complete", "Creates an instance of Step or calls an existing\n\n @param name [Symbol, String] the prefix of the Step object class\n @param opts [Hash] optional arguments\n @param args [Any] extra arguments\n @param block [Block] that yields to self\n @return [StepObject]\n @example\n   steps(:calculator, page: :demo).verify_result", "Creates an instance of Page or calls an existing\n\n @param name [Symbol, String] the prefix of the Page object class\n @param opts [Hash] optional arguments\n @param args [Any] extra arguments\n @param block [Block] that yields to self\n @return [PageObject]\n @example\n   pages(:home).click_element", "Returns a string representing the matcher.\n\n @example The readable definition of a FooBar matcher.\n   matcher = Matchi::Matchers::FooBar::Matcher.new(42)\n   matcher.to_s # => \"foo_bar 42\"\n\n @return [String] A string representing the matcher.", "Returns an array of Resources matching the query_string.\n Calls any block passed for each resulting resource.\n @param [String] query_string a string used to filter for matching resources\n          it might look like: \"Account Name::Compute::AWS::servers\"\n @return [Array <Fog::Model>] an Array of Resources, filtered by query", "Sets the account information.\n If any account info has changed, all trackers are restarted.\n @param [Hash] accounts a Hash of account information\n    (see accounts.example.yml)", "Creates a Hash of AccountTracker objects, indexed by account name", "Create a new Logger instance.\n\n We mostly follow the common interface of Ruby's core Logger class with the\n exception that you can give one or more flows to write logs to. Each\n {Flow} is responsible to write a log event (e.g. to a file, STDOUT, a TCP\n socket, ...). Each log event is written to all defined {#flows}.\n\n When giving the flows here, you can given them in one of varous\n representations, all of which we will transform into an actual {Flow}:\n\n * A {Rackstash::Flow} object. For the most control over the flow, you can\n   create the {Flow} object on your own and pass it here\n * A {Rackstash::Adapter::Adapter}. When passing an adapter, we will\n   create a new {Flow} from this adapter, using its default encoder and\n   without any defined filters.\n * An log device from which we can create an adapter. In this case, we\n   first attempt to build an adapter from it using {Rackstash::Adapter.[]}.\n   After that, we use it to create a {Flow} as above.\n\n When passing a block to this initializer, we will yield the last created\n flow object to it. If you pass multiple log devices / adapters / flows,\n only the last one will be yielded. If the block doesn't expect an argument,\n we run the block in the instance scope of the flow.\n\n The following three example to create a custom Logger are thus equivalent:\n\n     logger = Rackstash::Logger.new(STDOUT) do\n       encoder Rackstash::Encoder::Message.new\n     end\n\n     logger = Rackstash::Logger.new(Rackstash::Adapter::IO.new(STDOUT)) do\n       encoder Rackstash::Encoder::Message.new\n     end\n\n     adapter = Rackstash::Adapter::IO.new(STDOUT)\n     flow = Rackstash::Flows.new(adapter) do\n       encoder Rackstash::Encoder::Message.new\n     end\n     logger = Rackstash::Logger.new(flow)\n\n To create a simple Logger which logs to `STDOUT` using the default JSON\n format, you can just use\n\n     logger = Rackstash::Logger.new(STDOUT)\n\n @param flows [Array<Flow, Object>, Flow, Adapter::Adapter, Object]\n   an array of {Flow}s or a single {Flow}, respectivly object which can be\n   used as a {Flow}'s adapter. See {Flow#initialize}.\n @param level [Integer] a numeric log level. Normally you'd use one of the\n   {SEVERITIES} constants, i.e., an integer between 0 and 5. We will only\n   log messages with a severity above the configured level.\n @param progname [String] the logger's progname, used as the default for\n   log messages if none is passed to {#add} and passed to the {#formatter}.\n   By default we use {PROGNAME}.\n @param formatter [#call] the log formatter for each individual buffered\n   line. See {#formatter} for details.\n @yieldparam flow [Rackstash::Flow] if the given block accepts an argument,\n   we yield the last {Flow} as a parameter. Without an expected argument,\n   the block is directly executed in the context of the last {Flow}.\n Add a message to the current {Buffer} without any further formatting. If\n the current buffer is bufering, the message will just be added. Else,\n it will be flushed to the configured {#flows} directly.\n\n @param msg [Object]\n @return [String] the passed `msg`", "Capture all messages and fields logged for the duration of the provided\n block in the current thread.\n\n Create a new {Buffer} and put in on the {BufferStack} for the current\n thread. For the duration of the block, all new logged messages and any\n access to fields and tags will be sent to this new buffer. Previous\n buffers created in the same thread will only be visible after the\n execution left the block.\n\n Note that the created {Buffer} is only valid for the current thread. In\n other threads, it not visible and will thus not be used.\n\n @param buffer_args [Hash<Symbol => Object>] optional arguments for the new\n   {Buffer}. See {Buffer#initialize} for allowed values.\n @yield During the duration of the block, all logged messages, fields and\n   tags are set on the new buffer. After the block returns, the {Buffer} is\n   removed from the {BufferStack} again and is always flushed\n   automatically.\n @return [Object] the return value of the block", "Populate the configuration (@config) from the YAML file.\n @param [None]\n @example\n   settings.load\n @return Unspecified", "Check that a css element is on the page, set flag to check that it isn't", "Check that a css element is nested within another css element, set flag to check that it isn't", "Add its method to the DSL.\n\n @api public\n\n @example Its absolute value must equal 42\n   its(:abs) { MUST equal 42 }\n\n @param method [Symbol] The identifier of a method.\n @param spec   [Proc]   A spec to compare against the computed value.\n\n @return [Array] List of results.\n\n rubocop:disable AbcSize", "Se ejecuta antes de serializar los datos\n\n @param [Object] value valor del objeto a serializar original\n\n @return [Array] nuevo valor del objeto a serializar", "Run a command in a new process group, thus ignoring any furthur\n updates about the status of the process\n @return [Fixnum] process id", "Returns a copy of the Message with all occurances of `pattern` in the\n `message` attribute substituted for the second argument.\n\n This works very similar to\n [`String#gsub`](https://ruby-doc.org/core/String.html#method-i-gsub). We\n are returning a new Message object herre with the `message` attribute\n being updated. Please see the documentation of the String method for how\n to use this.\n\n Note that when supplying a block for replacement, the current match string\n is passed in as a parameter. Differing from `String#gsub`, the special\n variables `$1`, `$2`, `$``, `$&`, and `$'` will *not* be set here.\n\n @param pattern [String, Regexp] the search pattern\n @param replacement [String, Hash] the replacement definition\n @yield match If `replacement` is not given, we yield each match to the\n   supplied block and use its return value for the replacement\n @return [Message, Enumerator] a new frozen Message object or an Enumerator\n   if neither a block nor a `replacement` were given.", "Returns a copy of the Message with the first occurance of `pattern` in the\n `message` attribute substituted for the second argument.\n\n This works very similar to\n [`String#sub`](https://ruby-doc.org/core/String.html#method-i-sub). We\n are returning a new Message object herre with the `message` attribute\n being updated. Please see the documentation of the String method for how\n to use this.\n\n Note that when supplying a block for replacement, the current match string\n is passed in as a parameter. Differing from `String#gsub`, the special\n variables `$1`, `$2`, `$``, `$&`, and `$'` will *not* be set here.\n\n @param pattern [String, Regexp] the search pattern\n @param replacement [String, Hash] the replacement definition\n @yield match If `replacement` is not given, we yield the match (if any) to\n   the supplied block and use its return value for the replacement.\n @return [Message, Enumerator] a new frozen Message object or an Enumerator\n   if neither a block nor a `replacement` were given.", "After the Rack implementation", "notify to Slack\n\n @param   [String] channel\n          It is channel to be notified, defaults to '#general'\n @param   [String] text\n          text message posted to slack, defaults to nil.\n          if nil, this method post danger reports to slack.\n @param   [Hash] **opts\n @return [void]", "get status_report text\n @return [[Hash]]", "get markdown fields\n @return [[Hash]]", "Wrapper for Rails fields_for\n\n @see http://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-fields_for", "Time how long the block takes to run, and output it with the message.", "Inserts or removes a row into the `migration_info` table, so we can mark this migration as run, or un-done", "Sets up the migration.\n\n @since 1.0.1", "Creates a new migration, and adds it to the list of migrations to be run.\n Migrations can be defined in any order, they will be sorted and run in the\n correct order.\n\n The order that migrations are run in is set by the first argument. It is not\n neccessary that this be unique; migrations with the same version number are\n expected to be able to be run in any order.\n\n The second argument is the name of the migration. This name is used internally\n to track if the migration has been run. It is required that this name be unique\n across all migrations.\n\n Addtionally, it accepts a number of options:\n * <tt>:database</tt> If you defined several DataMapper::database instances use this\n   to choose which one to run the migration gagainst. Defaults to <tt>:default</tt>.\n   Migrations are tracked individually per database.\n * <tt>:verbose</tt> true/false, defaults to true. Determines if the migration should\n   output its status messages when it runs.\n\n Example of a simple migration:\n\n   migration( 1, :create_people_table ) do\n     up do\n       create_table :people do\n         column :id,   Integer, :serial => true\n         column :name, String, :size => 50\n         column :age,  Integer\n       end\n     end\n     down do\n       drop_table :people\n     end\n   end\n\n Its recommended that you stick with raw SQL for migrations that manipulate data. If\n you write a migration using a model, then later change the model, there's a\n possibility the migration will no longer work. Using SQL will always work.", "Run all migrations that need to be run. In most cases, this would be called by a\n rake task as part of a larger project, but this provides the ability to run them\n in a script or test.\n\n has an optional argument 'level' which if supplied, only performs the migrations\n with a position less than or equal to the level.", "Run all the down steps for the migrations that have already been run.\n\n has an optional argument 'level' which, if supplied, only performs the\n down migrations with a postion greater than the level.", "Copy a file or folder to a different location in the user's Dropbox.\n\n @param [String] from_path\n @param [String] to_path\n @return [Dropbox::Metadata]", "Get a copy reference to a file or folder.\n\n @param [String] path\n @return [Dropbox::Metadata] metadata\n @return [String] copy_reference", "Save a copy reference to the user's Dropbox.\n\n @param [String] copy_reference\n @param [String] path\n @return [Dropbox::Metadata] metadata", "Download a file from a user's Dropbox.\n\n @param [String] path\n @return [Dropbox::FileMetadata] metadata\n @return [HTTP::Response::Body] body", "Get a preview for a file.\n\n @param [String] path\n @return [Dropbox::FileMetadata] metadata\n @return [HTTP::Response::Body] body", "Get a temporary link to stream content of a file.\n\n @param [String] path\n @return [Dropbox::FileMetadata] metadata\n @return [String] link", "Get a thumbnail for an image.\n\n @param [String] path\n @param [String] format\n @param [String] size\n @return [Dropbox::FileMetadata] metadata\n @return [HTTP::Response::Body] body", "Get the contents of a folder.\n\n @param [String] path\n @return [Array<Dropbox::Metadata>]", "Get the contents of a folder that are after a cursor.\n\n @param [String] cursor\n @return [Array<Dropbox::Metadata>]", "Get the revisions of a file.\n\n @param [String] path\n @return [Array<Dropbox::FileMetadata>] entries\n @return [Boolean] is_deleted", "Move a file or folder to a different location in the user's Dropbox.\n\n @param [String] from_path\n @param [String] to_path\n @return [Dropbox::Metadata]", "Restore a file to a specific revision.\n\n @param [String] path\n @param [String] rev\n @return [Dropbox::FileMetadata]", "Save a specified URL into a file in user's Dropbox.\n\n @param [String] path\n @param [String] url\n @return [String] the job id, if the processing is asynchronous.\n @return [Dropbox::FileMetadata] if the processing is synchronous.", "Search for files and folders.\n\n @param [String] path\n @param [String] query\n @param [Integer] start\n @param [Integer] max_results\n @param [String] mode\n @return [Array<Dropbox::Metadata>] matches", "Create a new file.\n\n @param [String] path\n @param [String, Enumerable] body\n @option options [String] :mode\n @option options [Boolean] :autorename\n @option options [Boolean] :mute\n @return [Dropbox::FileMetadata]", "Start an upload session to upload a file using multiple requests.\n\n @param [String, Enumerable] body\n @param [Boolean] close\n @return [Dropbox::UploadSessionCursor] cursor", "Append more data to an upload session.\n\n @param [Dropbox::UploadSessionCursor] cursor\n @param [String, Enumerable] body\n @param [Boolean] close\n @return [Dropbox::UploadSessionCursor] cursor", "Finish an upload session and save the uploaded data to the given file path.\n\n @param [Dropbox::UploadSessionCursor] cursor\n @param [String] path\n @param [String, Enumerable] body\n @param [Hash] options\n @option (see #upload)\n @return [Dropbox::FileMetadata]", "Get information about multiple user accounts.\n\n @param [Array<String>] account_ids\n @return [Array<Dropbox::BasicAccount>]", "Create tempfile with content\n\n @param [String] content\n\n @return [String]\n @api private", "Inovke editor command in a shell\n\n @raise [TTY::CommandInvocationError]\n\n @api private", "Enable or disable the rvm gem global cache.", "Returns scope to which record should be applied", "Returns all nodes that are lower than current position", "Closes the connection to the service.\n\n @see    Connection#disconnect\n\n @return [void]", "Use this to group a batch of requests and halt the caller thread until all of the requests in the group have been\n performed.\n\n It proxies {RequestGroup#send_notification} to {Client#send_notification}, but, unlike the latter, the request\n callbacks are provided in the form of a block.\n\n @note   Do **not** share the yielded group across threads.\n\n @see    RequestGroup#send_notification\n @see    Connection::Monitor\n\n @param  [Numeric] timeout\n         the maximum amount of time to wait for a request group to halt the caller thread. Defaults to 1 hour.\n\n @yieldparam [RequestGroup] group\n         the request group object.\n\n @raise  [Exception]\n         if a connection in the pool has died during the execution of this group, the reason for its death will be\n         raised.\n\n @return [void]", "Registers a condition object with the connection pool, for the duration of the given block. It either returns an\n exception that caused a connection to die, or whatever value you signal to it.\n\n This is automatically used by {#group}.\n\n @yieldparam [Connection::Monitor::Condition] condition\n         the monitor condition object.\n\n @return [void]", "Verifies the `notification` is valid and then sends it to the remote service. Response feedback is provided via\n a delegate mechanism.\n\n @note   In general, you will probably want to use {#group} to be able to use {RequestGroup#send_notification},\n         which takes a traditional blocks-based callback approach.\n\n @see    Connection#post\n\n @param  [Notification] notification\n         the notification object whose data to send to the service.\n\n @param  [Connection::DelegateProtocol] delegate\n         an object that implements the connection delegate protocol.\n\n @param  [Object, nil] context\n         any object that you want to be passed to the delegate once the response is back.\n\n @raise  [ArgumentError]\n         raised if the Notification is not {Notification#valid?}.\n\n @return [void]", "call remote service via rabbitmq rpc\n @param name route_key for service\n @param message\n @param options{timeout} [int] timeout. seconds.   optional\n @return result of service\n @raise RemoteCallTimeoutError if timeout", "Creates an image tag that links directly to image data.  Recommended for displays of a\n temporary upload that is not saved to a record in the databse yet.", "Creates a link that opens an image for editing in Aviary.\n\n Options:\n\n * image_url: url to the master image used by Aviary for editing.  Defauls to <tt>url_for(:action => 'aviary_image', :id => model, :only_path => false)</tt>\n * post_url:  url where Aviary will post the updated image.  Defauls to <tt>url_for(:action => 'aviary_image_update', :id => model, :only_path => false)</tt>\n\n All other options are passed directly to the @link_to@ helper.", "Returns a hash of aliases.", "Sends the provided data as a `POST` request to the service.\n\n @note   It is strongly advised that the delegate object is a Celluloid actor and that you pass in an async proxy\n         of that object, but that is not required. If you do not pass in an actor, then be advised that the\n         callback will run on this connection\u2019s private thread and thus you should not perform long blocking\n         operations.\n\n @param  [String] path\n         the request path, which should be `/3/device/<device-token>`.\n\n @param  [Hash] headers\n         the additional headers for the request. By default it sends `:method`, `:path`, and `content-length`.\n\n @param  [String] body\n         the (JSON) encoded payload data to send to the service.\n\n @param  [DelegateProtocol] delegate\n         an object that implements the delegate protocol.\n\n @param  [Object, nil] context\n         any object that you want to be passed to the delegate once the response is back.\n\n @return [void]", "Passed either something containing ruby code or\n a path to a ruby file, will attempt to exectute\n it in the current environment.", "Like Kernel.system, but evaluates it within the environment.\n Also note that it doesn't support redirection etc.", "From an options hash, extract the environment identifier.", "Shorthand to extra an identifier from args.\n Since we", "Run commands inside the given directory.", "Normalizes an array, removing blank lines.", "Converts a hash of options to an array of command line argumets.\n If the value is false, it wont be added but if it is true only the\n key will be added. Lastly, when the value is neither true or false,\n to_s will becalled on it and it shall be added to the array.", "Recursively normalize options.", "Gets the identifier after cd'ing to a path, no destructive.", "Changes the ruby string for the current environment.\n\n env.use '1.9.2' # => true\n env.use 'ree' # => true\n env.use 'foo' # => false", "Automatically load rvm config from the multiple sources.", "Unless the payload contains an `aps` entry, the payload is assumed to be a mix of APN defined attributes and\n custom attributes and re-organized according to the specifications.\n\n @see https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/TheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH107-SW1\n\n @return [Hash]\n         the payload organized according to the APN specification.", "Starts persevering transaction", "Returns true if the the bcrypted value of a is equal to b", "Clear attributes and changed_attributes", "Searches for images\n @!macro general\n @option opts [Integer] :minimum_height\n   In pixels; ANDed with other filters\n @option opts [Integer] :minimum_width\n   In pixels; ANDed with other filters\n @option opts [Array<ImageFilter>] :filters\n   Multiple filters are ANDed\n @return [Array<ImageResult>]", "Searches for videos\n @!macro general\n @option opts [Array<VideoFilter>] :filters\n   Multiple filters are ANDed. At most one duration is allowed.\n @option opts [VideoSort] :sort\n @return [Array<VideoResult>]", "Searches for news\n @!macro general\n @option opts [Boolean] :highlighting (false)\n   Whether to surround query terms in {NewsResult#description} with the\n   delimiter {BingSearch::HIGHLIGHT_DELIMITER}.\n @option opts [NewsCategory] :category\n   Only applies in the en-US market. If no news matches the category, Bing\n   returns results from a mix of categories.\n @option opts [String] :location_override\n   Overrides Bing's location detection. Example: +US.WA+\n @option opts [NewsSort] :sort\n @return [Array<NewsResult>]", "Check to make sure a valid password and confirmation were set", "Returns all valid values for this setting, which is based on the presence of an inclusion validator.\n Will return nil if no valid values could be determined.", "Finds logical path across all `paths`", "Checks if the path is actually on the file system and performs\n any syscalls if necessary.", "Sorts candidate matches by their extension\n priority. Extensions in the front of the `extensions` carry\n more weight.", "If password or username was changed, update the authorization record", "Allow for dynamic setting of instance variables.\n also allows for variable? to see if it was provided", "Try and authenticate against the various auth techniques. If one\n technique works, then just exit and make the session active.", "depth_limit is not needed as it's evident in key.to_s", "Register a new plugin.", "A look for the possible places that various qualified names could be\n\n @note The Lookup Rules:\n   - all resources are plural\n   - file_names can either be named after the type or traditional ruby/rails nameing\n     i.e.: posts_controller.rb vs controller.rb\n   - regular namespacing still applies.\n     i.e: Api::V2::CategoriesController should be in\n          api/v2/categories/controller.rb\n\n @note The Pattern:\n  - namespace_a                        - api\n    - namespace_b                        - v2\n      - resource_name (plural)             - posts\n        - file_type.rb                       - controller.rb (or posts_controller.rb)\n                                             - operations.rb (or post_operations.rb)\n        - folder_type                        - operations/   (or post_operations/)\n          - related namespaced classes         - create.rb\n\n All examples assume default resource directory (\"resources\")\n and show the order of lookup\n\n @example Api::PostsController\n   Possible Locations\n    - api/posts/controller.rb\n    - api/posts/posts_controller.rb\n\n @example Api::PostSerializer\n   Possible Locations\n    - api/posts/serializer.rb\n    - api/posts/post_serializer.rb\n\n @example Api::PostOperations::Create\n   Possible Locations\n    - api/posts/operations/create.rb\n    - api/posts/post_operations/create.rb\n\n @example Api::V2::CategoriesController\n   Possible Locations\n    - api/v2/categories/controller.rb\n    - api/v2/categories/categories_controller.rb\n\n @param [String] qualified_name fully qualified class/module name to find the file location for", "Do the cookies exist, and are they valid?", "grab the params we want from this request\n if we can successfully authenticate, return a User instance, otherwise nil", "A version of `Dir.entries` that filters out `.` files and `~` swap files.\n Returns an empty `Array` if the directory does not exist.", "Called automatically by ActiveModel validation..", "Generic authentication method. By default, this just checks to see if the password\n given matches this user. You can also pass in the first parameter as the method\n to use for a different type of authentication.", "Called when a +Session+ validation is successful, and this user has\n been authenticated.", "Converts the mlc_lp_a & mlc_lp_b attributes to a proper DICOM formatted string.\n\n @param [Symbol] scale if set, relevant device parameters are converted from native readout format to IEC1217 (supported values are :elekta & :varian)\n @return [String] the DICOM-formatted leaf pair positions", "Converts the collimator1 attribute to proper DICOM format.\n\n @param [Symbol] scale if set, relevant device parameters are converted from a native readout format to IEC1217 (supported values are :elekta & :varian)\n @return [Float] the DICOM-formatted collimator_x1 attribute", "The hash that gets serialized into the `object_changes` column.\n\n This takes the `changes` hash and processes the associations to be\n human-readable objects.", "The object's versioned attributes as a hash.", "Returns a thread associated with the given URL.\n\n A thread will only have an associated URL if it was automatically\n created by Disqus javascript embedded on that page.", "The attribute diffs for this version", "Rails 4.2 adds \"set_attribute_was\" which must be used, so we'll\n check for it.", "Encodes a string from the contents of this instance.\n\n This produces the full record string line, including a computed CRC checksum.\n\n @param [Hash] options an optional hash parameter\n @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output\n @return [String] a proper RTPConnect type CSV string", "Follows the tree of parents until the appropriate parent of the requesting record is found.\n\n @param [Record] last_parent the previous parent (the record from the previous line in the RTP file)\n @param [Record] klass the expected parent record class of this record (e.g. Plan, Field)", "Sets up a record by parsing a RTPConnect string line.\n\n @param [#to_s] string the extended treatment field definition record string line\n @return [Record] the updated Record instance\n @raise [ArgumentError] if given a string containing an invalid number of elements", "Encodes the record + any hiearchy of child objects,\n to a properly formatted RTPConnect ascii string.\n\n @param [Hash] options an optional hash parameter\n @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output\n @return [String] an RTP string with a single or multiple lines/records", "Removes the reference of the given instance from the attribute of this record.\n\n @param [Symbol] attribute the name of the child attribute from which to remove a child\n @param [Record] instance a child record to be removed from this instance", "Removes all child references of the given type from this instance.\n\n @param [Symbol] attribute the name of the child attribute to be cleared", "Sets the attributes of the record instance.\n\n @param [Array<String>] values the record attributes (as parsed from a record string)", "Removes any attributes that are newer than the given compatibility target version.\n E.g. if a compatibility version of Mosaiq 2.4 is specified, attributes that were\n introduced in Mosaiq 2.5 or later is removed before the RTP string is created.\n\n @param [Array<String>] values the complete set of values of this record\n @param [Hash] options an optional hash parameter\n @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output\n @return [Array<String>] an array of attributes where some of the recent attributes may have been removed", "Includes config code from one or more files, and evals it in the context of this stack.\n Filenames are relative to the file containing the invocation of this method.", "Writes the Plan object, along with its hiearchy of child objects,\n to a properly formatted RTPConnect ascii file.\n\n @param [String] file a path/file string\n @param [Hash] options an optional hash parameter\n @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output", "Yields to the given block for each CloudFormation event that qualifies, given the specified options.\n @param options [Hash] The options hash\n @option options [Fixnum] :number The maximum number of already-existing CloudFormation events to yield.\n @option options [Boolean] :follow Set to true to wait until the stack enters a `COMPLETE` or `FAILED` state, yielding events as they occur.\n @option options [Boolean] :no_sleep Don't pause between polling. This is used for tests, and shouldn't be when polling the AWS API.\n @option options [Fixnum] :backoff The exponential backoff factor (default 1.5)\n @option options [Fixnum] :backoff_max_wait The maximum amount of time that exponential backoff will wait before polling agian (default 15s)", "Evaluates a DSL directly from a Ruby block, calling pre- and post- hooks.\n @param args [Array<Object>] Extra arguments to be passed into the block.", "Adds an angular type value to a Control Point Item, by creating the\n necessary DICOM elements.\n Note that the element is only added if there is no 'current' attribute\n defined, or the given value is different form the current attribute.\n\n @param [DICOM::Item] item the DICOM control point item in which to create the elements\n @param [String] angle_tag the DICOM tag of the angle element\n @param [String] direction_tag the DICOM tag of the direction element\n @param [String, NilClass] angle the collimator angle attribute\n @param [String, NilClass] direction the collimator rotation direction attribute\n @param [Symbol] current_angle the instance variable that keeps track of the current value of this attribute", "Adds a Table Top Position element to a Control Point Item.\n Note that the element is only added if there is no 'current' attribute\n defined, or the given value is different form the current attribute.\n\n @param [DICOM::Item] item the DICOM control point item in which to create the element\n @param [String] tag the DICOM tag of the couch position element\n @param [String, NilClass] value the couch position\n @param [Symbol] current the instance variable that keeps track of the current value of this attribute", "Adds a Dose Rate Set element to a Control Point Item.\n Note that the element is only added if there is no 'current' attribute\n defined, or the given value is different form the current attribute.\n\n @param [String, NilClass] value the doserate attribute\n @param [DICOM::Item] item the DICOM control point item in which to create an element", "Creates a control point item in the given control point sequence, based\n on an RTP control point record.\n\n @param [ControlPoint] cp the RTP ControlPoint record to convert\n @param [DICOM::Sequence] sequence the DICOM parent sequence of the item to be created\n @param [Hash] options the options to use for creating the control point\n @option options [Boolean] :dose_ref if set, a Referenced Dose Reference sequence will be included in the generated control point item\n @return [DICOM::Item] the constructed control point DICOM item", "Creates a beam limiting device sequence in the given DICOM object.\n\n @param [DICOM::Item] beam_item the DICOM beam item in which to insert the sequence\n @param [Field] field the RTP field to fetch device parameters from\n @return [DICOM::Sequence] the constructed beam limiting device sequence", "Creates an ASYMX or ASYMY item.\n\n @param [ControlPoint] cp the RTP control point to fetch device parameters from\n @param [DICOM::Sequence] dcm_parent the DICOM sequence in which to insert the item\n @param [Symbol] axis the axis for the item (:x or :y)\n @return [DICOM::Item] the constructed ASYMX or ASYMY item", "Creates a dose reference sequence in the given DICOM object.\n\n @param [DICOM::DObject] dcm the DICOM object in which to insert the sequence\n @param [String] description the value to use for Dose Reference Description\n @return [DICOM::Sequence] the constructed dose reference sequence", "Creates a referenced dose reference sequence in the given DICOM object.\n\n @param [DICOM::Item] cp_item the DICOM item in which to insert the sequence\n @return [DICOM::Sequence] the constructed referenced dose reference sequence", "Saved YamlRecord instance to file\n Executes save and create callbacks\n Returns true if record saved; false otherwise\n\n === Example:\n\n   @post.save => true", "Remove a persisted YamlRecord object\n Returns true if destroyed; false otherwise\n\n === Example:\n\n   @post = Post.create(:foo => \"bar\", :miso => \"great\")\n   Post.all.size => 1\n   @post.destroy  => true\n   Post.all.size => 0", "Sets a tag on this resource. The resource must support the CloudFormation `Tags` property.\n @param k [String] The name of the tag to set\n @param v [String] The value for this tag\n @param options [Hash] An arbitrary set of additional properties to be added to this tag, for example `PropagateOnLaunch` on `AWS::AutoScaling::AutoScalingGroup`", "Declares a CloudFormation parameter\n\n @param name [String] The parameter name\n @param options [Hash]\n @option options [String] :type The type for the CloudFormation parameter\n @option options [String] :default A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.\n @option options [String] :no_echo Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to `true`, the parameter value is masked with asterisks (*****).\n @option options [String] :allowed_values An array containing the list of values allowed for the parameter.\n @option options [String] :allowed_pattern A regular expression that represents the patterns you want to allow for String types.\n @option options [Number] :max_length An integer value that determines the largest number of characters you want to allow for String types.\n @option options [Number] :min_length An integer value that determines the smallest number of characters you want to allow for String types.\n @option options [Number] :max_value A numeric value that determines the largest numeric value you want to allow for Number types.\n @option options [Number] :min_value A numeric value that determines the smallest numeric value you want to allow for Number types.\n @option options [String] :description A string of up to 4000 characters that describes the parameter.\n @option options [String] :constraint_description A string that explains the constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of `[A-Za-z0-9]+` displays the following error message when the user specifies an invalid value:\n\n     ```Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+```\n\n     By adding a constraint description, such as must only contain upper- and lowercase letters, and numbers, you can display a customized error message:\n\n     ```Malformed input-Parameter MyParameter must only contain upper and lower case letters and numbers```", "Creates a CloudFormation resource\n @param name [String] The name of the resource (must be alphanumeric)\n @param type [String] The type of CloudFormation resource to create.\n @param options [Hash] Additional attributes to add to the resource block (such as the `UpdatePolicy` for an `AWS::AutoScaling::AutoScalingGroup`)", "Includes template code from one or more files, and evals it in the context of this stack.\n Filenames are relative to the file containing the invocation of this method.", "Looks up a hash of all outputs from another CloudFormation stack in the same region.\n @param stack [String] The name of the stack to fetch outputs from", "Return back a set of matches based on the passed in options\n\n options:\n\n :marker : a string to start the lexographical search (it is not included\n           in the result)\n :max_keys  : a maximum number of results\n :prefix    : a string to filter the results by\n :delimiter : not supported yet", "Node attributes get deep-merged with the environment ones\n Node run_list overrides the environment one\n Environment before hooks override global ones", "This method takes a rack request and generates a normalized RackFakeS3 request", "Creates a new report for the given repository and commit range\n\n @param [Repository] repository The repository to analyze\n @param [String, Range] range The commit range to analyze\n Generates this report's output into the given target directory\n\n This will generate individual HTML files for the main views of the\n report.\n\n @param [String] target_dir The target directory of the report\n @param [Boolean] with_assets If `false` the report's assets will not be\n        copied to the target directory", "Copies the assets coming with this report to the given target directory\n\n This will copy the files and directories that have been specified for the\n report from the report's path (or the report's ancestors) into the target\n directory.\n\n @param [String] target_dir The target directory of the report\n @see .assets", "Creates a new repository instance with the given file system path\n\n @param [String] path The file system path of the repository\n Returns a single VCS specific actor object from the raw data of the actor\n provided by the VCS implementation\n\n The actor object is either created from the given raw data or retrieved\n from the cache using the VCS specific unique identifier of the actor.\n\n @param [Object] actor The raw data of the actor provided by the VCS\n @return [Actor] A object representing the actor\n @see Actor.id_for", "Loads all commits including their committers and authors from the given\n commit range\n\n @param [String, Range] range The range of commits for which the commits\n        should be retrieved. This may be given as a string\n        (`'master..development'`), a range (`'master'..'development'`) or\n        as a single ref (`'master'`). A single ref name means all commits\n        reachable from that ref.\n @return [CommitCollection] All commits from the given commit range", "This evaluates basic statistics about the files in a given commit range.\n\n @example\n  repo.file_stats\n  => {\n       'a_file.rb' => {\n         :added_date => Tue Mar 29 16:13:47 +0200 2011,\n         :deleted_date => Sun Jun 05 12:56:18 +0200 2011,\n         :last_modified_date => Thu Apr 21 20:08:00 +0200 2011,\n         :modifications => 9\n       }\n     }\n @param [String, Range] range The range of commits for which the file\n        stats should be retrieved. This may be given as a string\n        (`'master..development'`), a range (`'master'..'development'`) or\n        as a single ref (`'master'`). A single ref name means all commits\n        reachable from that ref.\n @return [Hash<String, Hash<Symbol, Object>>] Each file is returned as a\n         key in this hash. The value of this key is another hash\n         containing the stats for this file. Depending on the state of the\n         file this includes `:added_date`, `:last_modified_date`,\n         `:last_modified_date` and `'master..development'`.\n @see Commit#added_files\n @see Commit#deleted_files\n @see Commit#modified_files", "Builds VCS specific commit objects for each given commit's raw data that\n is provided by the VCS implementation\n\n The raw data will be transformed into commit objects that will also be\n saved into the commit cache. Authors and committers of the given commits\n will be created and stored into the cache or loaded from the cache if\n they already exist. Additionally this method will establish an\n association between the commits and their children.\n\n @param [Array<Object>] raw_commits The commits' raw data provided by the\n        VCS implementation\n @return [Array<Commit>] The commit objects representing the given commits\n @see Commit\n @see Commit#add_child", "Tries to retrieve as many commits as possible in the given commit range\n from the commit cache\n\n This method calls itself recursively to walk the given commit range\n either from the start to the end or vice versa depending on which commit\n could be found in the cache.\n\n @param [Range] range The range of commits which should be retrieved from\n        the cache. This may be given a range of commit IDs\n        (`'master'..'development'`).\n @return [Array<Commit>] A list of commit objects that could be retrieved\n         from the cache\n @see Commit#children", "Parses a string or range of commit IDs or ref names into the coresponding\n range of unique commit IDs\n\n @param [String, Range] range The string that should be parsed for a range\n        or an existing range\n @return [Range] The range of commit IDs parsed from the given parameter\n @see #id_for_ref", "Registers this adapter with a VCS\n\n @param [Symbol] vcs_name The name of the VCS to register this adapter\n        with", "If the input is not marked html_safe?, just return it. Otherwise\n strip html tags from it AND replace HTML char entities", "Need to modify to a param hash", "Returns the raw array so the developer can update large batches manually\nNeed to modify to a param hash", "Returns up to the given number of actors in this collection with the\n biggest impact on the repository, i.e. changing the most code\n\n @param [Numeric] count The number of actors to return\n @return [ActorCollection] The given number of actors ordered by impact\n @see Actor#modifications", "Returns up to the given number of actors in this collection with the\n most commits\n\n @param [Numeric] count The number of actors to return\n @return [ActorCollection] The given number of actors ordered by commit\n         count\n @see Actor#commits", "Loads the commits authored or committed by all actors in this collection\n or a specific actor\n\n @param [:authored_commits, :committed_commits] commit_type The type of\n        commits to load\n @param [Object] actor_id The ID of the actor, if only the commits of a\n        specific actor should be returned\n @return [CommitCollection] All commits authored or committed by the\n         actors in this collection or by a specific actor", "This method uses Octokit to load all commits from the given commit range\n\n @note GitHub API is currently limited to 60 calls a minute, so you won't\n       be able to query branches with more than 2100 commits (35 commits\n       per call).\n @param [String, Range] range The range of commits for which the commits\n        should be loaded. This may be given as a string\n        (`'master..development'`), a range (`'master'..'development'`)\n        or as a single ref (`'master'`). A single ref name means all\n        commits reachable from that ref.\n @return [Hashie::Mash, nil] The base commit of the requested range or\n         `nil` if the the range starts at the beginning of the history\n @return [Array<Hashie::Mash>] All commits in the given commit range\n @see Octokit::Commits#commits", "wrapper method that wraps input validation and logging around the perform_validation method.\n Do not override or use this class in child classes. This is the class that gets called\n on validator objects.", "provide a merged settings hash of default settings for a validator,\n config file settings for the validator, and override settings defined in\n the validator.\n\n Do not override this in child classes. If you need to set\n custom config settings, override the get_override_settings method.\n The section of the config file this reads from is the same as the name\n method returns.\n\n @return [Hash] of config settings", "load any required configuration from the config file.\n Do not override this in child classes.\n @return [Hash] configuration settings from the validator's section of the config file", "SOME of the elements of Results to be returned that SearchEngine implementation\n fills in automatically post-search. Extracted into a method for DRY in\n error handling to try to fill these in even in errors. Also can be used\n as public method for de-serialized or mock results.", "Convert the parameters to a Hash for Faraday with all possible dates\n converted to the Organization's localtime.", "GetEncounterList helper method.\n @param [Object] userid\n @param [Object] patientid\n @param [String, nil] encounter_type encounter type to filter\n   on. A value of `nil` filters nothing. Defaults to `nil`.\n @param [Object] when_param\n @param [Fixnum, nil] nostradamus how many days to look into the\n   future. Defaults to `0`.\n @param [Object] show_past_flag whether to show previous\n   encounters. All truthy values aside from the string `\"N\"` are\n   considered to be true (or `\"Y\"`) all other values are\n   considered to be false (or `\"N\"`). Defaults to `true`.\n @param [Object] billing_provider_user_name filter by user\n   name. Defaults to `nil`.\n @param [Object] show_all\n @return [Array<Hash>] the filtered encounter list.", "delegated is an undocumented parameter", "For modifying multiple or single records within a single transaction", "Performs post-parse processing on options", "Setup the arguments", "Return a partial JSON without resolved references and all the keys.", "Fetch the partial JSON and materialize all JSON references.", "Expire all JSON entries for this class.", "Create a new journal file, or load an existing one if it already exists.\n @return [YAML::Store] instance of YAML::Store using the configured journal file.", "Verify that a string is a V4 UUID\n\n @param uuid [String] RFC4122 v4 UUID\n @return [Boolean] true if the uuid string is a valid UUID, false if not a valid UUID", "Creates a new collection with the given commits\n\n @param [Array<Commit>] commits The commits that should be initially\n        inserted into the collection\n Adds a commit to this collection\n\n @param [Commit] commit The commit to add to this collection\n @return [CommitCollection] The collection itself", "Calculate some predefined activity statistics for the commits in this\n collection\n\n @return [Hash<Symbol, Object>] The calculated statistics for the commits\n         in this collection\n @see Commit#committed_date", "Returns the authors of all or a specific commit in this collection\n\n @param [Object] commit_id The ID of the commit, if only the author of a\n        specific commit should be returned\n @return [ActorCollection] All authors of the commits in this collection\n         or the author of a specific commit\n @see Commit#author", "Returns the commits in this collection that have been committed before\n the given time\n\n @param [Time, Date, DateTime, String] date The time to use as the upper\n        limit to filter the commits\n @return [CommitCollection] The commits that have been committed after the\n         given date\n @see Commit#committed_date\n @see Time.parse", "Returns the list of commits that have been authored by the given authors\n\n @param [Array<Actor, Object>] author_ids One or more actual `Actor`\n        instances or IDs of the authors that the commits should be\n        filtered by\n @return [CommitCollection] The commits that have been authored by the\n         given authors\n @see Commit#author", "Returns the commits in this collection that change any of the given files\n\n @param [Array<String>] files The path of the files to filter commits by\n @return [CommitCollection] The commits that contain changes to the given\n         files\n @see Commit#added_files\n @see Commit#deleted_files\n @see Commit#modified_files", "Returns the committers of all or a specific commit in this collection\n\n @param [Object] commit_id The ID of the commit, if only the committer of\n        a specific commit should be returned\n @return [ActorCollection] All committers of the commits in this\n         collection or the committer of a specific commit\n @see Commit#committer", "This evaluates the changed lines in each commit of this collection\n\n For easier use, the values are stored in separate arrays where each\n number represents the number of changed (i.e. added or deleted) lines in\n one commit.\n\n @example\n  commits.line_history\n  => { :additions => [10, 5, 0], :deletions => [0, -2, -1] }\n @return [Hash<Symbol, Array>] Added lines are returned in an `Array`\n         assigned to key `:additions`, deleted lines are assigned to\n         `:deletions`\n @see Commit#additions\n @see Commit#deletions", "Returns the given number of commits with most line changes on the\n repository\n\n @param [Numeric] count The number of commits to return\n @return [CommitCollection] The given number of commits ordered by impact\n @see Commit#modifications", "Returns the commits in this collection that change at least the given\n number of lines\n\n @param [Numeric] line_count The number of lines that should be\n        changed at least by the commits\n @return [CommitCollection] The commits that change at least the given\n         number of lines\n @see Commit#modifications", "Loads the line stats for the commits in this collection\n\n For collections holding a specific range of commits, this always gets the\n line stats for all commits. For other, lets say fragmented, collections\n this loads the line stats for all commits that are missing their stats.\n\n @see Commit#additions\n @see Commit#deletions\n @see Commit#line_stats?\n @see Repository#line_stats", "This checks if all required VCS features of this view are available for\n this report's repository\n\n @param [Object, ...] args The arguments expected by {Mustache#render}\n @see .requires\n @see http://rubydoc.info/gems/mustache/Mustache#render-instance_method\n      Mustache#render", "returns partial HTML results, suitable for\n AJAX to insert into DOM.\n arguments for engine.search are taken from URI request params, whitelisted", "Creates a new Git repository based on the given path\n\n This creates a new `Grit::Repo` instance to interface with the\n repository.\n\n @param [String] path The file system path of the repository\n Returns the current branch of the repository\n\n This is the target ref of Git's HEAD, i.e. the currently checked out\n branch. For a detached HEAD this may also be the commit ID of the checked\n out commit.\n\n @see Grit::Repo#head", "Loads the line stats for the commits given by a set of commit IDs\n\n @param [Array<String>] ids The IDs of the commits to load line stats for\n @return [Hash<String, Array<Fixnum>] An array of two number (line\n         additions and deletions) for each of the given commit IDs", "Loads all branches and the corresponding commit IDs of this repository\n\n @return [Hash<String, String>] The names of all branches and the\n         corresponding commit IDs\n @see Grit::Repo#branches", "This method uses Grit to load all commits from the given commit range\n\n Because of some Grit internal limitations, the commits have to be loaded\n in batches of up to 300 commits.\n\n @note Grit will choke on huge repositories, like Homebrew or the Linux\n       kernel. You will have to raise the timeout limit using\n       `Grit.git_timeout=`.\n @param [String, Range] range The range of commits for which the commits\n        should be loaded. This may be given as a string\n        (`'master..development'`), a range (`'master'..'development'`)\n        or as a single ref (`'master'`). A single ref name means all\n        commits reachable from that ref.\n @return [Grit::Commit, nil] The base commit of the requested range or\n         `nil` if the the range starts at the beginning of the history\n @return [Array<Grit::Commit>] All commits in the given commit range\n @see Grit::Repo#commits", "Loads both the name and description of the project contained in the\n repository from the description file in `GIT_DIR`. The first line of that\n file is used as the project's name, the remaining text is used as a\n description of the project.\n\n @see #description\n @see #name\n @see Grit::Repo#name", "Loads all tags and the corresponding commit IDs of this repository\n\n @return [Hash<String, String>] The names of all tags and the\n         corresponding commit IDs\n @see Grit::Repo#tags", "Defines an area of content in your layout that can be modified or replaced by child layouts\n that extend it. You can optionally add content to an area using either a String, or a block.\n\n Areas are declared in a parent layout and modified by a child layout, but since Nestive\n allows for multiple levels of inheritance, a child layout can also declare an area for it's\n children to modify.\n\n @example Define an area without adding content to it:\n     <%= area :sidebar %>\n\n @example Define an area and add a String of content to it:\n     <%= area :sidebar, \"Some content.\" %>\n\n @example Define an area and add content to it with a block:\n     <%= area :sidebar do %>\n       Some content.\n     <% end %>\n\n @example Define an area in a child layout:\n     <%= extends :global do %>\n       <%= area :sidebar do %>\n         Some content.\n       <% end %>\n     <% end %>\n\n @param [Symbol] name\n   A unique name to identify this area of content.\n\n @param [String] content\n   An optional String of content to add to the area as you declare it.", "Take the instructions we've gathered for the area and replay them one after the other on\n an empty array. These instructions will push, unshift or replace items into our output array,\n which we then join and mark as html_safe.\n\n These instructions are reversed and replayed when we render the block (rather than as they\n happen) due to the way they are gathered by the layout extension process (in reverse).", "take a hash from Google json response, representing a single\n item, return a ResultItem obj. Used internally.", "Our own implementation code\n\n takes a normalized #search arguments hash from SearchEngine\n turns it into a URL for Google API. Factored out to make testing\n possible.", "display multiple authors, with HTML markup, returns html_safe string.\n experimentally trying this as a decorator helper method rather\n than a view partial, not sure which is best.\n\n Will limit to first three authors, with elipsis if there are more.\n\n Over-ride if you want to format authors names differently, or\n show more or less than first 3, etc.", "volume, issue, and page numbers. With prefixed labels from I18n.\n That's it.", "A summary. If config.for_dispaly.prefer_snippets_as_summary is set to true\n then prefers that, otherwise abstract.\n\n Truncates for display.", "Locate the configuration file, parse it from INI-format, and return\n the results as a hash. Returns an empty hash if no config file is found.\n\n @return [Hash] configuration settings loaded from INI file", "Validate configuration file\n Raises an exception if the config file cannot be validated\n\n @param configfile [String] the absolute path of the config file to validate\n @return [String] the absolute path of the config file", "RIS wants `Last, First M.`, we'll do what we can.", "Sends the specified email with any optional arguments\n\n * *Args*    :\n   - +email_id+ -> ID of the email to send\n   - +to+ -> Hash of recipient details\n * *Options*    :\n   - +:data+ -> Hash of email data\n   - +:from+ -> Hash of sender details\n   - +:cc+ -> Array of CC recipients\n   - +:bcc+ -> Array of BCC recipients\n   - +:files+ -> Array of attachments\n   - +:esp_account+ -> The ESP account to use\n   - +:version_name+ -> The specific email version to use\n   - +:headers+ -> Hash of headers\n   - +:tags+ -> Array of tags\n   - +:locale+ -> Localization string\n * *Notes*    :\n   - \"send\" is already a ruby-defined method on all classes", "Enables resource duplication via new form.\n\n - Adds a duplicate action button.\n - Preloads a duplicated resource on `:new` to pre-fill the form fields.\n\n No return.", "Enables resource duplication via save.\n\n - Adds a duplicate action button.\n - Duplicates a resource, persists it, and redirects the user to edit\n   the newly duplicated resource.\n\n No return.", "Enables resource duplication via a custom method\n\n - Adds a duplicate action button.\n - Calls a custom duplication method on the model. The method should\n   handle any copying of data and persistence of the new record.\n - Redirects the user to edit the newly duplicated resource.\n\n No return.", "Check if there were errors in previous commands.\n Throws GnuplotError in case of any errors.", "Start new thread that will read stderr given as stream\n and add errors into @err_array.", "Return current option value if no value given. Create new\n object with given option set if value given.", "Index a given record.\n\n @param db_name The name of the data store being targeted. Required\n @param needle The string you wish to index. Must not contain tabs. Required\n @param ref The indentifying value of the record being indexed. Must be numeric. Required\n @param weight Weight of this particular reference. Default 0. Don't change unless you know what you're doing. Optional.\n\n Examples\n\n ```\n @client.put('location_en', 'London', 123, 0)\n # => OK\n ```\n\n @returns something to let you know that all is well.", "Lock the given content\n\n @param content [Hash] content to lock\n @return [Hash] locked content", "Unlock given content\n\n @param content [Hash] content to unlock\n @return [Hash] unlocked content", "Check the remaining credit for this account.\n @raise Clockwork::Error::Authentication - if API login details are incorrect\n @return [integer] Number of messages remaining", "Takes all options and splits them into specific and\n others. Requires a block where this two classes should\n be mixed.", "This will generate the schedule based on the various parameters", "human readable schedule", "get the next gameday", "return matchups between two teams", "Array of game times where games are played. Must be valid DateTime objects in the string form", "Convert given options to gnuplot format.\n\n For \"{ opt1: val1, .. , optN: valN }\" it returns\n   set opt1 val1\n   ..\n   set optN valN\n\n @param ptions [Hash] options to convert\n @return [String] options in Gnuplot format", "Convenience function for calculating a forward projection with degrees instead of radians.\n This version works in-place, i.e. the point objects content is overwritten.\n\n call-seq: forwardDeg!(point) -> point", "Convenience function for calculating an inverse projection with the result in degrees instead of radians.\n This version works in-place, i.e. the point objects content is overwritten.\n\n call-seq: inverseDeg!(point) -> point", "Transforms all points in a collection 'in place' from one projection\n to another. The +collection+ object must implement the +each+\n method for this to work.\n\n call-seq: transform_all!(destinationProjection, collection) -> collection", "Initialize the middleware\n\n @param [Type] app describe app\n @param [Hash] options = {}\n @return void\n @param [Faraday::Env] no idea what this does\n @return [Faraday::Response] response from the middleware", "Create new dataset with updated data and merged options.\n\n Given data is appended to existing.\n Data is updated only if Dataset stores it in Datablock.\n Method does nothing if no options given and data isn't stored\n in in-memory Datablock.\n\n @param data [#to_gnuplot_points] data to append to existing\n @param options [Hash] new options to merge with existing options\n @return self if dataset corresponds to math formula or file\n   (filename or temporary file if datablock)\n @return [Dataset] new dataset if data is stored in 'in-memory' Datablock\n @example Updating dataset with Math formula or filename given:\n   dataset = Dataset.new('file.data')\n   dataset.update(data: 'asd')\n   #=> nothing updated\n   dataset.update(data: 'asd', title: 'File')\n   #=> Dataset.new('file.data', title: 'File')\n @example Updating dataset with data stored in Datablock (in-memory):\n   in_memory_points = Dataset.new(points, title: 'Old one')\n   in_memory_points.update(data: some_update, title: 'Updated')\n   #=> Dataset.new(points + some_update, title: 'Updated')\n @example Updating dataset with data stored in Datablock (in-file):\n   temp_file_points = Dataset.new(points, title: 'Old one', file: true)\n   temp_file_points.update(data: some_update)\n   #=> data updated but no new dataset created\n   temp_file_points.update(data: some_update, title: 'Updated')\n   #=> data updated and new dataset with title 'Updated' returned", "Create string from own options\n @return [String] options converted to Gnuplot format", "Initialize Dataset from given String", "Create new value for 'using' option based on column count", "Checks several conditions and set options needed\n to handle DateTime indexes properly.", "Check if given args is a dataset and returns it. Creates\n new dataset from given args otherwise.", "Send the headers out in alpha-sorted order. This will degrade performance to some\n degree, and is intended only to simplify the construction of unit tests.", "Provide a headers_orig method in your wrapper to allow this to work", "This method creates a gif animation where frames are plots\n already contained by Animation object.\n\n Options passed in #plot have priority over those which were set before.\n\n Inner options of Plots have the highest priority (except\n :term and :output which are ignored).\n\n @param path [String] path to new gif file that will be created as a result\n @param options [Hash] see note about available options in top class documentation\n @return [nil] if path to output file given\n @return [String] gif file contents if no path to output file given", "This plot have some specific options which\n should be handled different way than others.\n Here are keys of this options.", "Fit given data with function.\n\n Fit waits for output from gnuplot Settings.max_fit_delay and throw exception if gets nothing.\n One can change this value in order to wait longer (if huge datasets is fitted).\n\n @param data [#to_gnuplot_points] method accepts the same sources as Dataset.new\n   and Dataset object\n @param :function [String] function to fit data with\n @param :initials [Hash] initial values for coefficients used in fitting\n @param :term_options [Hash] terminal options that should be setted to terminal before fit.\n   You can see them in Plot's documentation (or even better in gnuplot doc)\n   Most useful here are ranges (xrange, yrange etc) and fit option which tunes fit parameters\n   (see {gnuplot doc}[http://www.gnuplot.info/docs_5.0/gnuplot.pdf] p. 122)\n @param options [Hash] options passed to Gnuplot's fit such as *using*. They are covered in\n   {gnuplot doc}[http://www.gnuplot.info/docs_5.0/gnuplot.pdf] (pp. 69-74)\n\n @return [Hash] hash with four elements:\n   - :formula_ds - dataset with best fit curve as data\n   - :coefficients - hash of calculated coefficients. So if you gave\n     ``{ initials: {a: 1, b: 1, c: 1} }`` it will return hash with keys :a, :b, :c and its values\n   - :deltas - Gnuplot calculates possible deltas for coefficients during fitting and\n     deltas hash contains this deltas\n   - :data - pointer to Datablock with given data\n @example\n   fit(some_data, function: 'exp(a/x)', initials: {a: 10}, term_option: { xrange: 1..100 })\n   fit(some_dataset, using: '1:2:3')", "It takes some time to produce output so here we need\n to wait for it.\n\n Max time to wait is stored in Settings.max_fit_delay, so one\n can change it in order to wait longer.", "Make fit command and send it to gnuplot", "We want a unique map for each place in the original number", "Reverse the scatter", "Recursively converts Rubyish snake_case hash keys to camelBack JSON-style\n hash keys suitable for use with a JSON API.", "Recursively converts Rubyish snake_case hash keys to CamelCase JSON-style\n hash keys suitable for use with a JSON API.", "Returns the next state for the subject for event_name", "Returns the error state for the subject for event_name and error", "Transitions to the next state if next_state exists.\n When an error occurs, it uses the error to determine next state.\n If no next state can be determined it transitions to the default error\n state if defined, otherwise the error is re-raised.\n Calls illegal_event_callback event_name if no next_state is found", "Define compare method in class.\n\n @param column     [Symbol]      Binding column name.\n @param enum_class [Inum::Base]  Binding Enum.\n @param options    [Hash]        option\n @option options [Symbol]    :prefix     Prefix. (default: column)", "Receives message from i3-ipc server socket.\n\n @param [Integer] type expected type of the message.\n\n @return [String] unpacked response from i3 server.\n\n @raise [NotConnected] if protocol is not connected.\n @raise [WrongMagicString] if got message with wrong magic string.\n @raise [WrongType] if got message with not expected type.", "returns true if it's a error transition for event_name and error", "support for newer ICU normalization API", "Using validates_formatting_of is as simple as using Rails' built-in\n validation methods in models.\n\n class User < ActiveRecord::Base\n   validates_formatting_of :email, :using => :email\n end\n\n If your column name is idencital to any of the built-in methods, you\n may leave off the `:using` option and validates_formatting_of will\n automatically use the validation with the matching name.\n\n class User < ActiveRecord::Base\n   validates_formatting_of :email\n end\n\n You can also pass conditions and options for Rails to use\n * :if\n * :unless\n * :allow_nil\n * :allow_blank\n * :on", "Initializes the middleware with options.\n\n @param [Hash] options The options to initialize the StatsD client.\n @option options [Statsd] :statsd Existing statsd client.\n @option options [String] :env (\"production\") The env to segment the metric key (e.g. env.prefix.worker_name.success|failure).\n @option options [String] :prefix (\"worker\") The prefix to segment the metric key (e.g. env.prefix.worker_name.success|failure).\n @option options [String] :host (\"localhost\") The StatsD host.\n @option options [String] :port (\"8125\") The StatsD port.\n @option options [String] :sidekiq_stats (\"true\") Send Sidekiq global stats e.g. total enqueued, processed and failed.\n\n Pushes the metrics in a batch.\n\n @param worker [Sidekiq::Worker] The worker the job belongs to.\n @param msg [Hash] The job message.\n @param queue [String] The current queue.", "Sets selection according to string in a ListBox or ComboBox\n @param: title: The title of the window to access.\n @param: text: The text of the window to access.\n @param: control: The control to interact with.\n @param: string: The string.", "Sets text of a control.\n Sends a string of characters to a control.\n @param: title: The title of the window to access.\n @param: text: The text of the window to access.\n @param: control: The control to interact with.\n @param: string: The string.\n @return True if success, false otherwise", "Sends a mouse click command to a given control.\n @param: title: The title of the window to access.\n @param: text: The text of the window to access.\n @param: controlID: The control to interact with.\n @param: button: The button to click, \"left\", \"right\" or \"middle\".\n @param: clicks: The number of times to click the mouse. Default is center.\n @param: x: The x position to click within the control. Default is center.\n @param: y: The y position to click within the control. Default is center.\n @return: True if success, false otherwise.", "Sets selection to occurrence ref in a ListBox or ComboBox.\n @param: title: The title of the window to access.\n @param: text: The text of the window to access.\n @param: control: The control to interact with.\n @param: occurrance: the value.", "IE conditional comments", "replace PREs with placeholders", "remove whitespaces outside of block elements", "convert bitcoin address to open assets address\n @param [String] btc_address The Bitcoin address.\n @return [String] The Open Assets Address.", "convert open assets address to bitcoin address\n @param [String] oa_address The Open Assets Address.\n @return [String] The Bitcoin address.", "validate asset ID", "read variable integer\n @param [String] data reading data\n @param [Integer] offset the position when reading from data.\n @return [[Integer, Integer]]  decoded integer value and the reading byte length.\n https://en.bitcoin.it/wiki/Protocol_documentation#Variable_length_integer", "read leb128 value\n @param [String] data reading data\n @param [Integer] offset start position when reading from data.\n @return [[Integer, Integer]]  decoded integer value and the reading byte length.", "Create a new scan report, passing in every attribute. The best way to do\n this is with the ScanResultProcessor module.\n\n Returns an array representation of the ScanReport. Metadata about the\n scan, and an array of Host arrays comprise the array.", "Use this method to receive incoming updates using long polling.\n An Array of Update objects is returned.\n\n Note:\n 1. This method will not work if an outgoing webhook is set up.\n 2. In order to avoid getting duplicate updates, recalculate offset after each server response.\n\n @param offset [Integer]\n   Identifier of the first update to be returned.\n   Must be greater by one than the highest among the identifiers of\n   previously received updates. By default, updates starting with the\n   earliest unconfirmed update are returned. An update is considered\n   confirmed as soon as getUpdates is called with an offset higher\n   than its update_id.\n @param limit [Integer]\n   Limits the number of updates to be retrieved. Values between 1\u2014100 are accepted.\n   Defaults to 100\n @param timeout [Integer]\n   Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling.\n\n @return [Array<Telebot::Update>]", "Send text message.\n\n @param chat_id [Integer] Unique identifier for the message recipient - User or GroupChat id\n @param text [String] Text of the message to be sent\n @param disable_web_page_preview [Boolean] Disables link previews for links in this message\n @param reply_to_message_id [Integer] If the message is a reply, ID of the original message\n @param reply_markup [ReplyKeyboardMarkup, ReplyKeyboardHide, ForceReply] Additional interface options\n @param parse_mode [String] \"Markdown\" or \"HTML\", Optional\n\n @return [Telebot::Message]", "Use this method to forward messages of any kind.\n\n @param chat_id [Integer] Unique identifier for the message recipient - User or GroupChat id\n @param from_chat_id [Integer] Unique identifier for the chat where the original message was sent - User or GroupChat id\n @param message_id [Integer] Unique message identifier\n\n @return [Telebot::Message]", "Send a picture.\n\n @param chat_id [Integer] Unique identifier for the message recipient - User or GroupChat id\n @param photo [InputFile, String] Photo to send. You can either pass a\n   file_id as String to resend a photo that is already on the Telegram servers,\n   or upload a new photo using multipart/form-data.\n @param caption [String] Photo caption (may also be used when resending photos by file_id)\n @param reply_to_message_id [Integer] If the message is a reply, ID of the original message\n @param reply_markup [ReplyKeyboardMarkup, ReplyKeyboardHide, ForceReply] Additional interface options\n\n @return [Telebot::Message]", "Send general file.\n\n @param chat_id [Integer]\n @param document [Telebot::InputFile, String] document to send (file or file_id)\n @param reply_to_message_id [Integer] If the message is a reply, ID of the original message\n @param reply_markup [ReplyKeyboardMarkup, ReplyKeyboardHide, ForceReply] Additional interface options\n\n @return [Telebot::Message]", "Use this method to send .webp stickers.\n\n @param chat_id [Integer]\n @param sticker [Telebot::InputFile, String] sticker to send (file or file_id)\n @param reply_to_message_id [Integer] If the message is a reply, ID of the original message\n @param reply_markup [ReplyKeyboardMarkup, ReplyKeyboardHide, ForceReply] Additional interface options\n\n @return [Telebot::Message]", "Send a point on the map.\n\n @param chat_id [Integer]\n @param latitude [Integer]\n @param longitude [Integer]\n @param reply_to_message_id [Integer]\n @param reply_markup [ReplyKeyboardMarkup, ReplyKeyboardHide, ForceReply]\n\n @return [Telebot::Message]", "Use this method to get a list of profile pictures for a user.\n\n @param user_id [Integer]\n @param offset [Integer]\n @param limit [Integer]\n\n @return [Telebot::UserProfilePhotos]", "Constructor for the high level API Manager class.\n\n @param [Hash] options The Options to configure the API.\n @option options [String] :access_key_id The AWS Access Key Id to communicate with AWS. Will also check the\n   environment variables for this value.\n @option options [String] :secret_access_key The AWS Secret Access Key to communicate with AWS. Also checks\n   environment variables for this value.\n @option options [String] :region The AWS Region to deploy API to. Also checks environment variables for this\n   value.\n\n @todo Allow clients to pass in a YAML file for all construction.\n Add Lambda Object(s) to the API.\n\n @param [LambdaWrap::Lambda Array<LambdaWrap::Lambda>] new_lambda Splat of LambdaWrap Lambda\n  objects to add to the API. Overloaded as:\n  add_lambda(lambda1) OR  add_lambda([lambda1, lambda2]) OR add_lambda(lambda1, lambda2)", "Deploys all services to the specified environment.\n\n @param [LambdaWrap::Environment] environment_options the Environment to deploy", "Deletes all services from the cloud.", "Initializes a Lambda Manager. Frontloaded configuration.\n\n @param [Hash] options The Configuration for the Lambda\n @option options [String] :lambda_name The name you want to assign to the function you are uploading. The function\n  names appear in the console and are returned in the ListFunctions API. Function names are used to specify\n  functions to other AWS Lambda API operations, such as Invoke. Note that the length constraint applies only to\n  the ARN. If you specify only the function name, it is limited to 64 characters in length.\n @option options [String] :handler The function within your code that Lambda calls to begin execution.\n @option options [String] :role_arn The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it\n  executes your function to access any other Amazon Web Services (AWS) resources.\n @option options [String] :path_to_zip_file The absolute path to the Deployment Package zip file\n @option options [String] :runtime The runtime environment for the Lambda function you are uploading.\n @option options [String] :description ('Deployed with LambdaWrap') A short, user-defined function description.\n  Lambda does not use this value. Assign a meaningful description as you see fit.\n @option options [Integer] :timeout (30) The function execution time at which Lambda should terminate the function.\n @option options [Integer] :memory_size (128) The amount of memory, in MB, your Lambda function is given. Lambda\n  uses this memory size to infer the amount of CPU and memory allocated to your function. The value must be a\n  multiple of 64MB. Minimum: 128, Maximum: 3008.\n @option options [Array<String>] :subnet_ids ([]) If your Lambda function accesses resources in a VPC, you provide\n  this parameter identifying the list of subnet IDs. These must belong to the same VPC. You must provide at least\n  one security group and one subnet ID to configure VPC access.\n @option options [Array<String>] :security_group_ids ([]) If your Lambda function accesses resources in a VPC, you\n  provide this parameter identifying the list of security group IDs. These must belong to the same VPC. You must\n  provide at least one security group and one subnet ID.\n @option options [Boolean] :delete_unreferenced_versions (true) Option to delete any Lambda Function Versions upon\n  deployment that do not have an alias pointing to them.\n @option options [String] :dead_letter_queue_arn ('') The ARN of the SQS Queue for failed async invocations.\n Deploys the Lambda to the specified Environment. Creates a Lambda Function if one didn't exist.\n Updates the Lambda's configuration, Updates the Lambda's Code, publishes a new version, and creates\n an alias that points to the newly published version. If the @delete_unreferenced_versions option\n is enabled, all Lambda Function versions that don't have an alias pointing to them will be deleted.\n\n @param environment_options [LambdaWrap::Environment] The target Environment to deploy\n @param client [Aws::Lambda::Client] Client to use with SDK. Should be passed in by the API class.\n @param region [String] AWS Region string. Should be passed in by the API class.", "Deletes the Lambda Object with associated versions, code, configuration, and aliases.\n\n @param client [Aws::Lambda::Client] Client to use with SDK. Should be passed in by the API class.\n @param region [String] AWS Region string. Should be passed in by the API class.", "Tearsdown environment for API Gateway. Deletes stage.\n\n @param environment_options [LambdaWrap::Environment] The environment to teardown.\n @param client [Aws::APIGateway::Client] Client to use with SDK. Should be passed in by the API class.\n @param region [String] AWS Region string. Should be passed in by the API class.", "Deletes all stages and API Gateway object.\n @param client [Aws::APIGateway::Client] Client to use with SDK. Should be passed in by the API class.\n @param region [String] AWS Region string. Should be passed in by the API class.", "Sets up the DynamoTable for the Dynamo DB Manager. Preloading the configuration in the constructor.\n\n @param [Hash] options The configuration for the DynamoDB Table.\n @option options [String] :table_name The name of the DynamoDB Table. A \"Base Name\" can be used here where the\n  environment name can be appended upon deployment.\n\n @option options [Array<Hash>] :attribute_definitions ([{ attribute_name: 'Id', attribute_type: 'S' }]) An array of\n  attributes that describe the key schema for the table and indexes. The Hash must have symbols: :attribute_name &\n  :attribute_type. Please see AWS Documentation for the {http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html\n  Data Model}.\n\n @option options [Array<Hash>] :key_schema ([{ attribute_name: 'Id', key_type: 'HASH' }]) Specifies the attributes\n  that make up the primary key for a table or an index. The attributes in key_schema must also be defined in the\n  AttributeDefinitions array. Please see AWS Documentation for the {http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html\n  Data Model}.\n\n  Each element in the array must be composed of:\n  * <tt>:attribute_name</tt> - The name of this key attribute.\n  * <tt>:key_type</tt> - The role that the key attribute will assume:\n    * <tt>HASH</tt> - partition key\n    * <tt>RANGE</tt> - sort key\n\n  The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from\n  DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their\n  partition key values.\n\n  The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way\n  DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key\n  value.\n\n  For a simple primary key (partition key), you must provide exactly one element with a <tt>KeyType</tt> of\n  <tt>HASH</tt>.\n\n  For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order:\n  The first element must have a <tt>KeyType</tt> of <tt>HASH</tt>, and the second element must have a\n  <tt>KeyType</tt> of <tt>RANGE</tt>.\n\n  For more information, see {http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key\n  Specifying the Primary Key} in the <em>Amazon DynamoDB Developer Guide</em>.\n\n @option options [Integer] :read_capacity_units (1) The maximum number of strongly consistent reads consumed per\n  second before DynamoDB returns a <tt>ThrottlingException</tt>. Must be at least 1. For current minimum and\n  maximum provisioned throughput values, see {http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\n  Limits} in the <em>Amazon DynamoDB Developer Guide</em>.\n\n @option options [Integer] :write_capacity_units (1) The maximum number of writes consumed per second before\n  DynamoDB returns a <tt>ThrottlingException</tt>. Must be at least 1. For current minimum and maximum\n  provisioned throughput values, see {http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\n  Limits} in the <em>Amazon DynamoDB Developer Guide</em>.\n\n @option options [Array<Hash>] :local_secondary_indexes ([]) One or more local secondary indexes (the maximum is\n  five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size\n  limit per partition key value; otherwise, the size of a local secondary index is unconstrained.\n\n  Each element in the array must be a Hash with these symbols:\n  * <tt>:index_name</tt> - The name of the local secondary index. Must be unique only for this table.\n  * <tt>:key_schema</tt> - Specifies the key schema for the local secondary index. The key schema must begin with\n    the same partition key as the table.\n  * <tt>:projection</tt> - Specifies attributes that are copied (projected) from the table into the index. These\n    are in addition to the primary key attributes and index key attributes, which are automatically projected. Each\n    attribute specification is composed of:\n    * <tt>:projection_type</tt> - One of the following:\n      * <tt>KEYS_ONLY</tt> - Only the index and primary keys are projected into the index.\n      * <tt>INCLUDE</tt> - Only the specified table attributes are projected into the index. The list of projected\n        attributes are in <tt>non_key_attributes</tt>.\n      * <tt>ALL</tt> - All of the table attributes are projected into the index.\n    * <tt>:non_key_attributes</tt> - A list of one or more non-key attribute names that are projected into the\n      secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the\n      secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this\n      counts as two distinct attributes when determining the total.\n\n @option options [Array<Hash>] :global_secondary_indexes ([]) One or more global secondary indexes (the maximum is\n  five) to be created on the table. Each global secondary index (Hash) in the array includes the following:\n  * <tt>:index_name</tt> - The name of the global secondary index. Must be unique only for this table.\n  * <tt>:key_schema</tt> - Specifies the key schema for the global secondary index.\n  * <tt>:projection</tt> - Specifies attributes that are copied (projected) from the table into the index. These\n    are in addition to the primary key attributes and index key attributes, which are automatically projected. Each\n    attribute specification is composed of:\n    * <tt>:projection_type</tt> - One of the following:\n      * <tt>KEYS_ONLY</tt> - Only the index and primary keys are projected into the index.\n      * <tt>INCLUDE</tt> - Only the specified table attributes are projected into the index. The list of projected\n        attributes are in <tt>NonKeyAttributes</tt>.\n      * <tt>ALL</tt> - All of the table attributes are projected into the index.\n    * <tt>non_key_attributes</tt> - A list of one or more non-key attribute names that are projected into the\n      secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the\n      secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this\n      counts as two distinct attributes when determining the total.\n  * <tt>:provisioned_throughput</tt> - The provisioned throughput settings for the global secondary index,\n    consisting of read and write capacity units.\n\n @option options [Boolean] :append_environment_on_deploy (false) Option to append the name of the environment to\n  the table name upon deployment and teardown. DynamoDB Tables cannot shard data in a similar manner as how Lambda\n  aliases and API Gateway Environments work. This option is supposed to help the user with naming tables instead\n  of managing the environment names on their own.\n Deploys the DynamoDB Table to the target environment. If the @append_environment_on_deploy option is set, the\n table_name will be appended with a hyphen and the environment name. This will attempt to Create or Update with\n the parameters specified from the constructor. This may take a LONG time for it will wait for any new indexes to\n be available.\n\n @param environment_options [LambdaWrap::Environment] Target environment to deploy.\n @param client [Aws::DynamoDB::Client] Client to use with SDK. Should be passed in by the API class.\n @param region [String] AWS Region string. Should be passed in by the API class.", "Waits for the table to be available", "Looks through the list current of Global Secondary Indexes and builds an array if the Provisioned Throughput\n in the intended Indexes are higher than the current Indexes.", "Assign Array of Array of PhotoSize\n\n @param values [Array<Array<PhotoSize>>]", "Quick and dirty hash function", "get UTXO for colored coins.\n @param [Array] oa_address_list Obtain the balance of this open assets address only, or all addresses if unspecified.\n @return [Array] Return array of the unspent information Hash.", "Returns the balance in both bitcoin and colored coin assets for all of the addresses available in your Bitcoin Core wallet.\n @param [String] address The open assets address. if unspecified nil.", "Creates a transaction for issuing an asset.\n @param[String] from The open asset address to issue the asset from.\n @param[Integer] amount The amount of asset units to issue.\n @param[String] to The open asset address to send the asset to; if unspecified, the assets are sent back to the issuing address.\n @param[String] metadata The metadata to embed in the transaction. The asset definition pointer defined by this metadata.\n @param[Integer] fees The fess in satoshis for the transaction.\n @param[String] mode Specify the following mode.\n 'broadcast' (default) for signing and broadcasting the transaction,\n 'signed' for signing the transaction without broadcasting,\n 'unsigned' for getting the raw unsigned transaction without broadcasting\"\"\"='broadcast'\n @param[Integer] output_qty The number of divides the issue output. Default value is 1.\n Ex. amount = 125 and output_qty = 2, asset quantity = [62, 63] and issue TxOut is two.\n @return[Bitcoin::Protocol::Tx] The Bitcoin::Protocol::Tx object.", "Creates a transaction for sending an asset from an address to another.\n @param[String] from The open asset address to send the asset from.\n @param[String] asset_id The asset ID identifying the asset to send.\n @param[Integer] amount The amount of asset units to send.\n @param[String] to The open asset address to send the asset to.\n @param[Integer] fees The fess in satoshis for the transaction.\n @param[String] mode 'broadcast' (default) for signing and broadcasting the transaction,\n 'signed' for signing the transaction without broadcasting,\n 'unsigned' for getting the raw unsigned transaction without broadcasting\"\"\"='broadcast'\n @return[Bitcoin::Protocol:Tx] The resulting transaction.", "Creates a transaction for sending multiple asset from an address to another.\n @param[String] from The open asset address to send the asset from when send_asset_param hasn't from.\n to send the bitcoins from, if needed. where to send bitcoin change, if any.\n @param[Array[OpenAssets::SendAssetParam]] send_asset_params The send Asset information(asset_id, amount, to, from).\n @param[Integer] fees The fess in satoshis for the transaction.\n @param[String] mode 'broadcast' (default) for signing and broadcasting the transaction,\n 'signed' for signing the transaction without broadcasting,\n 'unsigned' for getting the raw unsigned transaction without broadcasting\"\"\"='broadcast'\n @return[Bitcoin::Protocol:Tx] The resulting transaction.", "Creates a transaction for sending bitcoins from an address to another.\n @param[String] from The address to send the bitcoins from.\n @param[Integer] amount The amount of satoshis to send.\n @param[String] to The address to send the bitcoins to.\n @param[Integer] fees The fess in satoshis for the transaction.\n @param[String] mode 'broadcast' (default) for signing and broadcasting the transaction,\n 'signed' for signing the transaction without broadcasting,\n 'unsigned' for getting the raw unsigned transaction without broadcasting\"\"\"='broadcast'\n @param [Integer] output_qty The number of divides the issue output. Default value is 1.\n Ex. amount = 125 and output_qty = 2, asset quantity = [62, 63] and issue TxOut is two.\n @return[Bitcoin::Protocol:Tx] The resulting transaction.", "Creates a transaction for sending multiple bitcoins from an address to others.\n @param[String] from The address to send the bitcoins from.\n @param[Array[OpenAssets::SendBitcoinParam]] send_params The send information(amount of satoshis and to).\n @param[Integer] fees The fees in satoshis for the transaction.\n @param[String] mode 'broadcast' (default) for signing and broadcasting the transaction,\n 'signed' for signing the transaction without broadcasting,\n 'unsigned' for getting the raw unsigned transaction without broadcasting\"\"\"='broadcast'\n @return[Bitcoin::Protocol:Tx] The resulting transaction.", "Creates a transaction for burn asset.\n @param[String] oa_address The open asset address to burn asset.\n @param[String] asset_id The asset ID identifying the asset to burn.\n @param[Integer] fees The fess in satoshis for the transaction.\n @param[String] mode 'broadcast' (default) for signing and broadcasting the transaction,\n 'signed' for signing the transaction without broadcasting,\n 'unsigned' for getting the raw unsigned transaction without broadcasting\"\"\"='broadcast'", "Get unspent outputs.\n @param [Array] addresses The array of Bitcoin address.\n @return [Array[OpenAssets::Transaction::SpendableOutput]] The array of unspent outputs.", "Get tx outputs.\n @param[String] txid Transaction ID.\n @param[Boolean] use_cache If specified true use cache.(default value is false)\n @return[Array] Return array of the transaction output Hash with coloring information.", "parse issuance p2sh which contains asset definition pointer", "Merge in extra options data.", "Install all Rake tasks.\n\n @return [void]", "Remove everything in a path, but not the directory itself", "Throws exception if timeout occurs", "Search a directory for a .gemspec file to determine the gem name.\n Returns nil if no gemspec is found.\n\n @param base [String] Folder to search.\n @return [String, nil]", "Gem specification for the current gem.\n\n @return [Gem::Specification]", "Return the number of bytes of the metainfo that we have downloaded so far.", "Save the specified piece to disk asynchronously.", "Read a piece from disk. This method is asynchronous; it returns a handle that can be later\n used to retreive the result.", "Check the results of savePiece and readPiece. This method returns a list\n of the PieceManager results.", "Return a list of torrent pieces that can still be requested. These are pieces that are not completed and are not requested.", "Return a list of peers from whom we can request pieces. These are peers for whom we have an established connection, and\n are not marked as bad. See markPeerBad.", "Set whether the piece with the passed pieceIndex is requested or not.", "Remove any pending requests after a timeout.", "Schedule a timer.\n @param duration  The duration of the timer in seconds\n @param metainfo  The metainfo to associate with the timer\n @param recurring If true when the timer duration expires, the timer will be rescheduled. If false the timer\n                     will not be rescheduled.\n @param immed     If true then the timer will expire immediately (the next pass through the event loop). If the timer\n                     is also recurring it will then be rescheduled according to it's duratoin.", "Create a TCP connection to the specified host and port. Associate the passed metainfo with the IO representing the connection.", "Read `length` bytes.", "Create a TCP connection to the specified host.\n Note that this method may raise exceptions. For example 'Too many open files' might be raised if\n the process is using too many file descriptors", "Create a TCP server that listens for connections on the specified\n port", "Open the specified file for the specified mode.", "Run event loop", "Meant to be called from the handler. Find an IO by metainfo. The == operator is used to\n match the metainfo.", "Given the ioInfo for a listening socket, call accept and return the new ioInfo for the\n client's socket", "Call the passed block in the context of the read Fiber. Basically the\n passed block is run as normal, but if the block performs a read from an io and that\n read would block, the block is paused, and withReadFiber returns. The next time withReadFiber\n is called the block will be resumed at the point of the read.", "Determine if we need to connect to more peers.\n Returns a list of peers to connect to.", "Choose a peer that we will optimistically unchoke.", "Gets init and end lines of each comment block", "Trying to create a snapshot.", "Dispatch received droplets, each by each.", "Preparing droplet to take a snapshot.\n Droplet instance must be powered off first!", "Cleanup our snapshots.", "The Search method handles the searching of both local and toll-free\n numbers.", "Add a new tracker client. This effectively adds a new torrent to download. Returns the TorrentData object for the\n new torrent.", "Remove a torrent.", "Set the download rate limit. Pass nil as the bytesPerSecond to disable the limit.", "Set the upload rate limit. Pass nil as the bytesPerSecond to disable the limit.", "Adjust the bytesDownloaded property of the specified torrent by the passed amount.\n Adjustment should be an integer. It is added to the current bytesDownloaded amount.", "Update the data stored in a TorrentDataDelegate to the latest information.", "REACTOR METHODS \n Reactor method called when a peer has connected to us.", "Reactor method called when we have connected to a peer.", "Reactor method called when there is data ready to be read from a socket", "Reactor method called when a scheduled timer expires.", "For a torrent where we don't have the metainfo, request metainfo pieces from peers.", "Find the io associated with the peer and yield it to the passed block.\n If no io is found an error is logged.", "Update our internal peer list for this torrent from the tracker client", "Remove a torrent that we are downloading.", "Pause or unpause a torrent that we are downloading.", "Queue a torrent", "Dequeue any torrents that can now run based on available space", "Freeze or unfreeze a torrent. If value is true, then we disconnect from all peers for this torrent and forget\n the peers. If value is false, we start reconnecting to peers.\n Parameter torrent can be an infoHash or TorrentData", "Add a new torrent to manage described by a Metainfo object. This is generally the\n method to call if you have a .torrent file.\n Returns the infoHash of the newly added torrent.", "Add a new torrent to manage given an announceUrl and an infoHash. The announceUrl may be a list.\n Returns the infoHash of the newly added torrent.", "Add a new torrent to manage given a MagnetURI object. This is generally the\n method to call if you have a magnet link.\n Returns the infoHash of the newly added torrent.", "Adjust the bytesDownloaded property of the specified torrent by the passed amount.\n Adjustment should be an integer. It is added to the current bytesUploaded amount.", "Helper method for adding a torrent.", "return the directory where rapidoc generates the doc", "returns the directory where rapidoc searches for examples", "The Say verb converts text to speech that is read back to the caller.\n Say is useful for dynamic text that is difficult to prerecord.\n\n Examples:\n   Twilio::Verb.say 'The time is 9:35 PM.'\n   Twilio::Verb.say 'The time is 9:35 PM.', :loop => 3\n\n With numbers, 12345 will be spoken as \"twelve thousand three hundred forty five\" while\n 1 2 3 4 5 will be spoken as \"one two three four five.\"\n\n   Twilio::Verb.say 'Your PIN is 1234', :loop => 4\n   Twilio::Verb.say 'Your PIN is 1 2 3 4', :loop => 4\n\n If you need a longer pause between each loop, instead of explicitly calling the Pause\n verb within a block, you can set the convenient pause option:\n\n   Twilio::Verb.say 'Your PIN is 1 2 3 4', :loop => 4, :pause => true\n\n Options (see http://www.twilio.com/docs/api_reference/TwiML/say) are passed in as a hash:\n\n   Twilio::Verb.say 'The time is 9:35 PM.', :voice => 'woman'\n   Twilio::Verb.say 'The time is 9:35 PM.', :voice => 'woman', :language => 'es'", "The Gather verb collects digits entered by a caller into their telephone keypad.\n When the caller is done entering data, Twilio submits that data to a provided URL,\n as either a HTTP GET or POST request, just like a web browser submits data from an HTML form.\n\n Options (see http://www.twilio.com/docs/api_reference/TwiML/gather) are passed in as a hash\n\n Examples:\n   Twilio::Verb.gather\n   Twilio::Verb.gather :action => 'http://foobar.com'\n   Twilio::Verb.gather :finishOnKey => '*'\n   Twilio::Verb.gather :action => 'http://foobar.com', :finishOnKey => '*'\n\n Gather also lets you nest the Play, Say, and Pause verbs:\n\n   verb = Twilio::Verb.new { |v|\n     v.gather(:action => '/process_gather', :method => 'GET) {\n       v.say 'Please enter your account number followed by the pound sign'\n     }\n     v.say \"We didn't receive any input. Goodbye!\"\n   }\n   verb.response # represents the final xml output", "The Dial verb connects the current caller to an another phone. If the called party picks up,\n the two parties are connected and can communicate until one hangs up. If the called party does\n not pick up, if a busy signal is received, or the number doesn't exist, the dial verb will finish.\n\n If an action verb is provided, Twilio will submit the outcome of the call attempt to the action URL.\n If no action is provided, Dial will fall through to the next verb in the document.\n\n Note: this is different than the behavior of Record and Gather. Dial does not submit back to the\n current document URL if no action is provided.\n\n Options (see http://www.twilio.com/docs/api_reference/TwiML/dial) are passed in as a hash\n\n Examples:\n   Twilio::Verb.dial '415-123-4567'\n   Twilio::Verb.dial '415-123-4567', :action => 'http://foobar.com'\n   Twilio::Verb.dial '415-123-4567', :timeout => 10, :callerId => '858-987-6543'\n\n Twilio also supports an alternate form in which a Number object is nested inside Dial:\n\n   verb = Twilio::Verb.new { |v|\n     v.dial { |v|\n       v.number '415-123-4567'\n       v.number '415-123-4568'\n       v.number '415-123-4569'\n     }\n   }\n   verb.response # represents the final xml output", "Create description and actions_doc", "Return a list of FileRegion objects. The FileRegion offsets specify\n in order which regions of files the piece covers.", "Write a block to an in-progress piece. The block is written to\n piece 'peiceIndex', at offset 'offset'. The block data is in block.\n Throws exceptions on failure.", "Pass an ordered list of FileRegions to load.", "Read a block from the torrent asynchronously. When the operation\n is complete the result is stored in the 'results' list.\n This method returns an id that can be used to match the response\n to the request.\n The readBlock and writeBlock methods are not threadsafe with respect to callers;\n they shouldn't be called by multiple threads concurrently.", "Write a block to the torrent asynchronously.", "Read a block of the torrent asynchronously.", "Validate that the hash of the downloaded piece matches the hash from the metainfo.\n The result is successful? if the hash matches, false otherwise. The data of the result is\n set to the piece index.", "License header extacted from the gemspec. Suitable for inclusion in other\n Ruby source files.\n\n @return [String]", "URL to the issue tracker for this project.\n\n @return [String, nil]", "Platform support to be used in the Chef metadata.\n\n @return [Array<Array<String>>]", "Search for a file like README.md or LICENSE.txt in the gem.\n\n @param name [String] Basename to search for.\n @return [String, Array<String>]\n @example\n   gem.misc_file('Readme') => /path/to/readme.txt", "Find a spec given a dependency.\n\n @since 1.0.1\n @param dep [Gem::Dependency] Dependency to solve.\n @return [Gem::Specificiation]", "Writes a new file 'resize.rrd'\n\n You will need to know the RRA number, starting from 0:\n\n  rrd.resize(0, :grow => 10.days)", "Convert the gem.\n\n @see BaseLocation#install", "Add a peer to the PeerHolder.", "Set the id for a peer. This peer, which previously had no id, has finished handshaking and now has an ID.", "Delete the specified peer from the PeerHolder.", "Output a string representation of the PeerHolder, for debugging purposes.", "Return the first Bittorrent info hash found in the magnet URI. The returned\n info hash is in binary format.", "Reads 'rake routes' output and gets the routes info\n @return [RoutesDoc] class with routes info", "Create new ResourceDoc for each resource extracted from RoutesDoc\n @return [Array] ResourceDoc array", "Evaluate the file in the context of the cleanroom.\n\n @param [Class] instance\n   the instance of the class to evaluate against\n @param [String] filepath\n   the path of the file to evaluate", "Evaluate the string or block in the context of the cleanroom.\n\n @param [Class] instance\n   the instance of the class to evaluate against\n @param [Array<String>] args\n   the args to +instance_eval+\n @param [Proc] block\n   the block to +instance_eval+", "The cleanroom instance for this class. This method is intentionally\n NOT cached!\n\n @return [Class]", "Add new route info to resource routes array with correct format", "Extract resource name from url", "Determine the class associated with the message type passed.", "Return a new Bittorrent Request message that requests this block.", "Return a list of BlockInfo objects representing blocjs that should be requested from peers.", "Set whether the block represented by the passed BlockInfo is requested or not.", "Set whether the piece is completed or not.", "Number of bytes we have downloaded and verified.", "Create a new BlockInfo object using the specified information.", "Return an array indexed by piece index where each element\n is a list of peers with that piece.", "Given an integer value, find which region it falls in and return the object associated with that region.", "Check if exist a block with resource information 'rapidoc resource block'\n\n @param lines [Array] lines that contain comments\n @param blocks [Hash] lines of blocks, example: { init: 1, end: 4 }\n @return [Hash] resource info", "Check all blocks and load those that are 'rapidoc actions block'\n\n @param lines [Array] lines that contain comments\n @param blocks [Hash] lines of blocks, example: { init: 1, end: 4 }\n @return [Array] all actions info", "Creates a phone number in Twilio. You must first find an existing number using\n the AvailablePhoneNumber class before creating one here.\n\n Required: you must either set PhoneNumber or AreaCode as a required option\n For additional options, see http://www.twilio.com/docs/api/rest/incoming-phone-numbers", "Return a hashtable keyed by class where the value is the number of that class of object still reachable.", "Returns an array with all keys from all locales", "Returns true if key exists in the given locale", "Serialize this PeerHandshake message to the passed io object. Throws exceptions on failure.", "Start the worker thread", "Adjust the length of the bitfield. This might be necessary if we had to unserialize the bitfield from\n a serialized array of bytes.", "Set the bit at index 'bit' to 1.", "Clear the bit at index 'bit' to 0.", "Are all bits in the Bitfield set?", "Calculate the union of this bitfield and the passed bitfield, and\n return the result as a new bitfield.", "Calculate the intersection of this bitfield and the passed bitfield, and\n return the result as a new bitfield.", "Update this bitfield to be the intersection of this bitfield and the passed bitfield.", "Set the contents of this bitfield to be the same as the passed bitfield. An exception is\n thrown if the passed bitfield is smaller than this.", "Return a display string representing the bitfield.", "Equate peers.\n Update the upload rate of the peer from the passed PeerWireMessage.", "Update the download rate of the peer from the passed PeerWireMessage.", "request_connection => specific to file conversion\nconvert request for file", "returns all possible conversions and options", "building params for local file", "Helper method for HAML to return a neat hash to be used as attributes in an image tag.\n\n Now it's as simple as doing something like:\n\n    %img{ gravatar_attrs(@user.mail, :size => 20) }/\n\n This is also the base method for +gravatar_tag+.\n\n @param [String, #email, #mail, #gravatar_url] email a string or an object used\n        to generate to gravatar url for.\n @param [Symbol, Hash] *params other gravatar or html options for building the resulting\n        hash.\n @return [Hash] all html attributes required to build an +img+ tag.", "Compute the diffs between two `Gemfile.lock`.\n\n @return [Hash] gems for which there are differences.", "Add changes to between two versions of a gem\n\n @param old_gem [Bundler::LazySpecification]\n @param new_gem [Bundler::LazySpecification]", "Creates a socket object which does speedy, non-blocking reads\n and can perform reliable read timeouts.\n\n Raises Timeout::Error on timeout.\n\n   +host+ String address of the target TCP server\n   +port+ Integer port of the target TCP server\n   +timeout+ Optional Integer (in seconds) of the read timeout", "the fastest way to prune this is to use the local find command", "Attempts to set the power state to `state` asynchronously.\n This method cannot guarantee the message was received.\n @param state [:on, :off]\n @return [Light, LightCollection] self for chaining", "Attempts to set the site id of the light.\n Will clear label and tags. This method cannot guarantee message receipt.\n @note Don't use this unless you know what you're doing.\n @api private\n @param site_id [String] Site ID\n @return [void]", "Attempts to set the device time on the targets\n @api private\n @param time [Time] The time to set\n @return [void]", "Make the real query to rubygems\n It may fail in case we trigger too many requests\n\n @param tries [Integer|nil] (optional) how many times we tried", "Look if gem can be found in another remote\n\n @return [String|nil] uri of source code\n rubocop:disable Metrics/MethodLength", "Generate a string key from an array of identifiers", "Return graph as graphml text", "Returns a struct for use by the protocol\n @api private\n @return [Protocol::Light::Hsbk]", "0.1% variance\n Checks if colours are equal to 0.1% variance\n @param other [Color] Color to compare to\n @param threshold: [Float] 0..1. Threshold to consider it similar\n @return [Boolean]", "Returns search result or nil if no results received.", "Sign the request with the given token, and return the computed\n authentication parameters", "Authenticates the request with a token\n\n Raises an AuthenticationError if the request is invalid.\n AuthenticationError exception messages are designed to be exposed to API\n consumers, and should help them correct errors generating signatures\n\n Timestamp: Unless timestamp_grace is set to nil (which allows this check\n to be skipped), AuthenticationError will be raised if the timestamp is\n missing or further than timestamp_grace period away from the real time\n (defaults to 10 minutes)\n\n Signature: Raises AuthenticationError if the signature does not match\n the computed HMAC. The error contains a hint for how to sign.", "Authenticate a request\n\n Takes a block which will be called with the auth_key from the request,\n and which should return a Signature::Token (or nil if no token can be\n found for the key)\n\n Raises errors in the same way as authenticate_by_token!", "Authenticate a request asynchronously\n\n This method is useful it you're running a server inside eventmachine and\n need to lookup the token asynchronously.\n\n The block is passed an auth key and a deferrable which should succeed\n with the token, or fail if the token cannot be found\n\n This method returns a deferrable which succeeds with the valid token, or\n fails with an AuthenticationError which can be used to pass the error\n back to the user", "Constant time string comparison", "Script's commands", "This will clear out tags that currently do not resolve to any devices.\n If used when devices that are tagged with a tag that is not attached to an\n active device, it will effectively untag them when they're back on.", "Format the diff to get human readable information\n on the gems that were updated.", "For each gem, retrieve its changelog", "Find where is hosted the source of a gem\n\n @param gem [String] the name of the gem\n @param source [Bundler::Source] gem's source\n @return [String] url where gem is hosted", "Get the template for gem's diff.\n It can use a custom template.\n\n @return [ERB] the template", "nodoc\n Changes classifier strategy and train new strategy if needed", "Method for adding new score to result\n\n ==== Parameters\n\n * +score+ - OmniCat::Score", "Adds a block to be run when a payload of class `payload_class` is received\n @param payload_class [Class] Payload type to execute block on\n @param &hook [Proc] Hook to run\n @api private\n @return [void]", "Returns the color of the device.\n @param refresh: [Boolean] If true, will request for current color\n @param fetch: [Boolean] If false, it will not request current color if it's not cached\n @return [Color] Color", "Sets the label of the light\n @param label [String] Desired label\n @raise [LabelTooLong] if label is greater than {MAX_LABEL_LENGTH}\n @return [Light] self", "Set the power state to `state` synchronously.\n @param state [:on, :off]\n @return [Light, LightCollection] self for chaining", "Returns the local time of the light\n @return [Time]", "Pings the device and measures response time.\n @return [Float] Latency from sending a message to receiving a response.", "Returns the mesh firmware details\n @api private\n @return [Hash] firmware details", "Returns the wifi firmware details\n @api private\n @return [Hash] firmware details", "Returns the temperature of the device\n @return [Float] Temperature in Celcius", "Returns mesh network info\n @api private\n @return [Hash] Mesh network info", "Returns wifi network info\n @api private\n @return [Hash] wifi network info", "Returns version info\n @api private\n @return [Hash] version info", "Return device uptime\n @api private\n @return [Float] Device uptime in seconds", "Return device last downtime\n @api private\n @return [Float] Device's last downtime in secodns", "Compare current Light to another light\n @param other [Light]\n @return [-1, 0, 1] Comparison value\n Queues a message to be sent the Light\n @param payload [Protocol::Payload] the payload to send\n @param acknowledge: [Boolean] whether the device should respond\n @param at_time: [Integer] Unix epoch in milliseconds to run the payload. Only applicable to certain payload types.\n @return [Light] returns self for chaining", "Queues a message to be sent to the Light and waits for a response\n @param payload [Protocol::Payload] the payload to send\n @param wait_for: [Class] the payload class to wait for\n @param wait_timeout: [Numeric] wait timeout\n @param block: [Proc] the block that is executed when the expected `wait_for` payload comes back. If the return value is false or nil, it will try to send the message again.\n @return [Object] the truthy result of `block` is returned.\n @raise [MessageTimeout] if the device doesn't respond in time", "retrieves the attributes of the gav", "returns the sha1 of the file", "sha_match? returns bool by comparing the sha1 of the nexus gav artifact and the local file", "writes the sha1 a file if and only if the contents of the file do not match", "Some uris are not https, but we know they should be,\n in which case we have an https redirection\n which is not properly handled by open-uri\n\n @param uri [URI::HTTP]\n @return [URI::HTTPS|URI::HTTP]", "List possible names for a changelog\n since humans may have many many ways to call it.\n\n @return [Array] list of possible names", "Generates a styleguide block. A little bit evil with @_out_buf, but\n if you're using something like Rails, you can write a much cleaner helper\n very easily.", "Appends an argument of type array\n @param [String] name argument name\n @param [Array] values\n @return [SoapBody]", "Checks the status of the requested associated with the given argument\n @return [Response] an object detailing the response\n @raise [AkamaiApi::CCU::PurgeStatus::NotFound] when the request cannot be found\n @raise [AkamaiApi::CCU::Error] when there is an error in the request\n @raise [AkamaiApi::Unauthorized] when login credentials are invalid", "Returns the details of an ECCU request\n @param [true,false] retrieve_content set to true if you want to retrieve request content too\n @return [FindResponse]", "Clean the requested resources.\n @param [Array<String>] items One or more resources to clean\n @return [Response] an object representing the received response\n @raise [AkamaiApi::CCU::Error] when there is an error in the request\n @raise [AkamaiApi::Unauthorized] when login credentials are invalid\n @example Clean a single resource\n   request.execute 'http://foo.bar/t.txt'\n @example Clean multiple resources\n   request.execute '12345', '12346'", "Request body to send to the API.\n @param [Array<String>] items resources to clean\n @return [String] request body in JSON format", "Purges one or more resources\n @param [String,Symbol] action type of clean action. Allowed values are:\n   - :invalidate\n   - :remove\n   Check {AkamaiApi::CCU::Purge::Request#action} for more details\n @param [String,Symbol] type type of resource to clean. Allowed values are:\n   - :cpcode\n   - :arl\n   Check {AkamaiApi::CCU::Purge::Request#type} for more details\n @param [String, Array] items resource(s) to clean\n @param [Hash] opts additional options\n @option opts [String] :domain domain type where to act. Allowed values are:\n   - :production\n   - :staging\n   Check {AkamaiApi::CCU::Purge::Request#domain} for more details\n @return [AkamaiApi::CCU::Purge::Response] an object representing the received response\n @raise [AkamaiApi::CCU::Error] when there is an error in the request\n @raise [AkamaiApi::Unauthorized] when login credentials are invalid", "Get the number of ltr and rtl characters in the supplied string and infer\n direction from the most common type. For this strategy the direction can\n be ltr or rtl, but never bidi. In case of draw it returns nil.\n\n params [String] The string to inspect\n @return [String, nil]", "Uploaded file details\n @return [Hash] file details\n   - :content [String] file content\n   - :size [Fixnum] file size\n   - :name [String] file name\n   - :md5 [String] MD5 digest of the file content", "Digital property details\n @return [Hash] property details\n   - :name [String]\n   - :exact_match [true,false]\n   - :type [String]", "This method is used because, for nil values, savon will respond with an hash containing all other attributes.\n If we check that the expected type is matched, we can\n prevent to retrieve wrong values", "Look for the presence of unicode marks in given string and infers from them its direction\n\n params [String] The string to inspect\n @return [String, nil]", "Creates an empty AhoC Trie with only a root node\n\n Accepts an optional argument (either :DFA or :NFA)\n indicating the type of automaton to build. If no\n argument is passed an NFA will be built.\n Add a pattern to the Trie.\n\n Accepts an optional block that can be used\n to modify the node output.", "actually don't need any code in my gem's namespace ..", "Dynamically get element attributes.\n\n @see ATTRIBUTES constant for a list of valid methods for a given element.\n\n @return [String] The resulting attribute.\n @raise  [NoMethodError] if the element doesn't support this attribute.", "return a Color object of a given x and y coord", "Creates a duplicate of the image\n set a color value for a image", "Visit event. The visitor is about to visit the subnodes of a non\n terminal node.\n @param aParentNode [NonTeminalNode] the (non-terminal) parent node.", "Send a notification to all subscribers.\n @param msg [Symbol] event to notify\n @param args [Array] arguments of the notification.", "Goto the given URL\n\n @param [String] uri The url.\n @param [Hash] (optional) a Hash of HTTP headers to use for the request.\n\n @return [String] The url.", "experimental - should be removed?", "Allows you to temporarily switch to HtmlUnit's NicelyResynchronizingAjaxController\n to resynchronize ajax calls.\n\n   @browser.resynchronized do |b|\n     b.link(:id, 'trigger_ajax_call').click\n   end\n\n @yieldparam [Celerity::Browser] browser The current browser object.\n @see Celerity::Browser#new for how to configure the browser to always use this.", "Specify a boolean value to click either 'OK' or 'Cancel' in any confirm\n dialogs that might show up during the duration of the given block.\n\n (Celerity only)\n\n @param [Boolean] bool true to click 'OK', false to click 'cancel'\n @param [Proc] block A block that will trigger the confirm() call(s).", "Add a 'checker' proc that will be run on every page load\n\n @param [Proc] checker The proc to be run (can also be given as a block)\n @yieldparam [Celerity::Browser] browser The current browser object.\n @raise [ArgumentError] if no Proc or block was given.", "Sets the current page object for the browser\n\n @param [HtmlUnit::HtmlPage] value The page to set.\n @api private", "Enable Celerity's internal WebWindowEventListener\n\n @api private", "Render the current page on the connected viewer.\n @api private", "Returs the color of a pixel locate in the given x and y coordinates\n or a rectangle section of the image if a range is specified\n\n Example\n\n   image[0,0] # return a Color object representing the color of the pixel at 0,0\n   image[0..20,10..30] # return a image object with the cropped rectagle with x between 0 and 20 and y between 10 and 30\n   image[0..20,20] # return a image object cropped rectagle with x between 0 and 20 and y equals 15", "Set the color of a pixel locate in the given x and y coordinates\n or replace a rectangle section of the image with other image of equal dimensions\n if a range is specified\n\n Example\n\n   image[0,0] = Color.red # set the color of pixel at 0,0 to Color.red\n   image[0..20,10..30] = other_image # replace the rectagle with x between 0 and 20 and y between 10 and 30 with other_image", "Walks each pixel on the image, block is mandantory to call this function and return\n as yield block calls x,y and pixel color for each pixel of the image\n\n This function does not allow to modify any color information of the image (use map_pixel for that)\n\n Examples:\n\n   image.each_pixel do |x,y,color|\n     print \"pixel at (#{x},#{y}): #{color.inspect}\\n\"\n   end", "Creates a new image of same dimensions in which each pixel is replaced with the value returned\n by the block passed as parameter, the block receives the coordinates and color of each pixel\n\n Example\n\n   image_without_red = image.map_pixel{|x,y,color| color.r = 0; color } # remove color channel of all pixels", "Replace each pixel of the image with the value returned\n by the block passed as parameter, the block receives the coordinates and color of each pixel\n\n Example\n\n   image.map_pixel!{|x,y,color| color.r = 0; color } # remove color channel of all pixels", "Duplicate the image and then call color_replace! method with the given parameters", "Replace the color given in the first argument by the color given in the second with alpha values\n\n Examples\n\n   image.color_replace!(Color.red, Color.black) # replace red with black\n   image.color_replace!(Color.black, Color.coerce([0,0,0,128]) ) # replace black with %50 transparent black", "Replace a color with %100 transparency, useful for mask drawing\n\n Example\n\n   masked = other_image.mask(Color.black)\n   image.draw(0,0,masked) # draw the image without the black pixels", "Finds the differences between `self` and another tree, not respecting\n the order of the nodes.\n\n @param [#tdiff_each_child] tree\n   The other tree.\n\n @yield [change, node]\n   The given block will be passed the added or removed nodes.\n\n @yieldparam [' ', '+', '-'] change\n   The state-change of the node.\n\n @yieldparam [Object] node\n   A node from one of the two trees.\n\n @return [Enumerator]\n   If no block is given, an Enumerator object will be returned.\n\n @since 0.2.0", "Recursively compares the differences between the children nodes,\n without respecting the order of the nodes.\n\n @param [#tdiff_each_child] tree\n   The other tree.\n\n @yield [change, node]\n   The given block will be passed the added or removed nodes.\n\n @yieldparam [' ', '+', '-'] change\n   The state-change of the node.\n\n @yieldparam [Object] node\n   A node from one of the two trees.\n\n @since 0.3.2", "Get a drive by ID", "Get a user's OneDrive", "Get a current user's OneDrive", "Get the document library for a site", "Get a special folder by name", "Get the child cell at the given index", "Returns the text of each cell in the the table as a two-dimensional array.\n @return [Array<Array<String>>]", "Start the websocket connection", "This is for post-hixie-76 versions only", "Finish the connection read for closing", "Get all the elements matching the given XPath.\n\n @param [String] xpath\n @return [Array<Celerity::Element>] array of elements", "Convert the given HtmlUnit DomNode to a Celerity object", "Check if the given text fields contains the given String or Regexp.", "Merges an array of coverage results with self", "returns the file created date of the image", "Saves the image to the given file", "Used internally.\n\n @param [String] string The string to match against.\n @param [Regexp, String, #to_s] what The match we're looking for.\n @return [Fixnum, true, false, nil]\n\n @api private", "Add a listener block for one of the available types.\n @see Celerity::Browser#add_listener", "Visit event. The visitor is about to visit the children of a non\n terminal node.\n @param aParentNode [NonTeminalNode] the (non-terminal) parent node.", "Get the element at the given index.\n By default, this is 1-indexed to keep compatibility with Watir.\n\n Also note that because of Watir's lazy loading, this will return an Element\n instance even if the index is out of bounds.\n\n @param [Fixnum] n Index of wanted element, 1-indexed unless Celerity.index_offset is changed.\n @return [Celerity::Element] Returns a subclass of Celerity::Element", "Returns true if any of the selected options match the given value.\n\n @param [String, Regexp] value A value.\n @raise [Celerity::Exception::UnknownObjectException] if the value does not exist.\n @return [true, false]", "Check if the element contains the given text.\n\n @param  [String, Regexp] expected_text The text to look for.\n @return [Fixnum, nil]  The index of the matched text, or nil if it doesn't match.", "Parse the sequence of tokens produced by the given tokenizer object.\n @param aTokenizer [#each]\n @return [Parser::GFGParsing]", "Convert raw parse result into a parse tree representation\n @param aRawParse [Parser::GFGParsing]\n @return [Rley::PTree::ParseTree]", "Convert raw parse result into a parse forest representation\n @param aRawParse [Parser::GFGParsing]\n @return [Rley::SPPF::ParseForest]", "HtmlUnit throws NPEs sometimes when we're locating elements\n Retry seems to work fine.", "Click the element and return a new Browser instance with the resulting page.\n This is useful for elements that trigger popups when clicked.\n\n @return [Celerity::Browser]", "Return `true` if this `Map` has one or more keys which map to the provided value.\n\n @example\n   Erlang::Map[\"A\" => 1, \"B\" => 2, \"C\" => 3].value?(2)  # => true\n\n @param value [Object] The value to check for\n @return [Boolean]", "Retrieve the value corresponding to the provided key object. If not found, and\n this `Map` has a default block, the default block is called to provide the\n value. Otherwise, return `nil`.\n\n @example\n   m = Erlang::Map[\"A\" => 1, \"B\" => 2, \"C\" => 3]\n   m[\"B\"]             # => 2\n   m.get(\"B\")         # => 2\n   m.get(\"Elephant\")  # => nil\n\n   # Erlang Map with a default proc:\n   m = Erlang::Map.new(\"A\" => 1, \"B\" => 2, \"C\" => 3) { |key| key.size }\n   m.get(\"B\")         # => 2\n   m.get(\"Elephant\")  # => 8\n\n @param key [Object] The key to look up\n @return [Object]", "Retrieve the value corresponding to the given key object, or use the provided\n default value or block, or otherwise raise a `KeyError`.\n\n @overload fetch(key)\n   Retrieve the value corresponding to the given key, or raise a `KeyError`\n   if it is not found.\n   @param key [Object] The key to look up\n @overload fetch(key) { |key| ... }\n   Retrieve the value corresponding to the given key, or call the optional\n   code block (with the missing key) and get its return value.\n   @yield [key] The key which was not found\n   @yieldreturn [Object] Object to return since the key was not found\n   @param key [Object] The key to look up\n @overload fetch(key, default)\n   Retrieve the value corresponding to the given key, or else return\n   the provided `default` value.\n   @param key [Object] The key to look up\n   @param default [Object] Object to return if the key is not found\n\n @example\n   m = Erlang::Map[\"A\" => 1, \"B\" => 2, \"C\" => 3]\n   m.fetch(\"B\")         # => 2\n   m.fetch(\"Elephant\")  # => KeyError: key not found: \"Elephant\"\n\n   # with a default value:\n   m.fetch(\"B\", 99)         # => 2\n   m.fetch(\"Elephant\", 99)  # => 99\n\n   # with a block:\n   m.fetch(\"B\") { |key| key.size }         # => 2\n   m.fetch(\"Elephant\") { |key| key.size }  # => 8\n\n @return [Object]", "Return a new `Map` with only the associations for the `wanted` keys retained.\n\n @example\n   m = Erlang::Map[\"A\" => 1, \"B\" => 2, \"C\" => 3]\n   m.slice(\"B\", \"C\")  # => Erlang::Map[\"B\" => 2, \"C\" => 3]\n\n @param wanted [::Enumerable] The keys to retain\n @return [Map]", "The main worker process loop\n Check the queues for work", "Try to find and reserve a job", "Diagnostics function to be extended in child class, as required", "Upload any files from the test", "Get a checkout of the repository", "Glyphs and Alternate Names", "Return specific objects from the `Bitstring`. All overloads return `nil` if\n the starting index is out of range.\n\n @overload bitslice(index)\n   Returns a single bit at the given `index`. If `index` is negative,\n   count backwards from the end.\n\n   @param index [Integer] The index to retrieve. May be negative.\n   @return [Integer, nil]\n   @example\n     b = Erlang::Bitstring[2, bits: 2]\n     b.bitslice(0)  # => 1\n     b.bitslice(1)  # => 0\n     b.bitslice(-1) # => 0\n     b.bitslice(2)  # => nil\n\n @overload bitslice(index, length)\n   Return a bitstring starting at `index` and continuing for `length`\n   bits or until the end of the `Bitstring`, whichever occurs first.\n\n   @param start [Integer] The index to start retrieving bits from. May be\n                          negative.\n   @param length [Integer] The number of bits to retrieve.\n   @return [Bitstring, Binary]\n   @example\n     b = Erlang::Bitstring[1, 117, bits: 7]\n     b.bitslice(0, 11) # => Erlang::Bitstring[1, 7, bits: 3]\n     b.bitslice(11, 4) # => Erlang::Bitstring[5, bits: 4]\n     b.bitslice(16, 1) # => nil\n\n @overload bitslice(index..end)\n   Return a bitstring starting at `index` and continuing to index\n   `end` or the end of the `Bitstring`, whichever occurs first.\n\n   @param range [Range] The range of bits to retrieve.\n   @return [Bitstring, Binary]\n   @example\n     b = Erlang::Bitstring[1, 117, bits: 7]\n     b.bitslice(0...11)  # => Erlang::Bitstring[1, 7, bits: 3]\n     b.bitslice(11...15) # => Erlang::Bitstring[5, bits: 4]\n     b.bitslice(16..-1)  # => nil\n\n @see Erlang::Binary#bitslice", "Call the given block once for each bit in the `Bitstring`, passing each\n bit from first to last successively to the block. If no block is given,\n returns an `Enumerator`.\n\n @return [self]\n @yield [Integer]", "Starts crmux and adds debuggerAddress to opts that points to crmux listen address.", "Initialise the device\n Start the worker process", "Terminate the worker process", "Initialize a new Printer.\n\n @param options [Hash] the options for the instantiating Tqdm::Decorator\n\n @see Tqdm::Decorator#initialize\n Pads a status line so that it is long enough to overwrite the previously written line\n\n @param iteration [Integer] number of iterations, out of the total, that are completed\n @param elapsed_time [Float] number of seconds passed since start\n @return [String] the padded line", "Return a new `Tuple` with a new value at the given `index`. If `index`\n is greater than the length of the tuple, the returned tuple will be\n padded with `nil`s to the correct size.\n\n @overload put(index, element)\n   Return a new `Tuple` with the element at `index` replaced by `element`.\n\n   @param element [Object] The object to insert into that position\n   @example\n     Erlang::Tuple[1, 2, 3, 4].put(2, 99)\n     # => Erlang::Tuple[1, 2, 99, 4]\n     Erlang::Tuple[1, 2, 3, 4].put(-1, 99)\n     # => Erlang::Tuple[1, 2, 3, 99]\n     Erlang::Tuple[].put(2, 99)\n     # => Erlang::Tuple[nil, nil, 99]\n\n @overload put(index)\n   Return a new `Tuple` with the element at `index` replaced by the return\n   value of the block.\n\n   @yield (existing) Once with the existing value at the given `index`.\n   @example\n     Erlang::Tuple[1, 2, 3, 4].put(2) { |v| v * 10 }\n     # => Erlang::Tuple[1, 2, 30, 4]\n\n @param index [Integer] The index to update. May be negative.\n @return [Tuple]", "Retrieve the value at `index` with optional default.\n\n @overload fetch(index)\n   Retrieve the value at the given index, or raise an `IndexError` if not\n   found.\n\n   @param index [Integer] The index to look up\n   @raise [IndexError] if index does not exist\n   @example\n     t = Erlang::Tuple[\"A\", \"B\", \"C\", \"D\"]\n     t.fetch(2)       # => \"C\"\n     t.fetch(-1)      # => \"D\"\n     t.fetch(4)       # => IndexError: index 4 outside of tuple bounds\n\n @overload fetch(index) { |index| ... }\n   Retrieve the value at the given index, or return the result of yielding\n   the block if not found.\n\n   @yield Once if the index is not found.\n   @yieldparam [Integer] index The index which does not exist\n   @yieldreturn [Object] Default value to return\n   @param index [Integer] The index to look up\n   @example\n     t = Erlang::Tuple[\"A\", \"B\", \"C\", \"D\"]\n     t.fetch(2) { |i| i * i }   # => \"C\"\n     t.fetch(4) { |i| i * i }   # => 16\n\n @overload fetch(index, default)\n   Retrieve the value at the given index, or return the provided `default`\n   value if not found.\n\n   @param index [Integer] The index to look up\n   @param default [Object] Object to return if the key is not found\n   @example\n     t = Erlang::Tuple[\"A\", \"B\", \"C\", \"D\"]\n     t.fetch(2, \"Z\")  # => \"C\"\n     t.fetch(4, \"Z\")  # => \"Z\"\n\n @return [Object]", "Return specific objects from the `Tuple`. All overloads return `nil` if\n the starting index is out of range.\n\n @overload tuple.slice(index)\n   Returns a single object at the given `index`. If `index` is negative,\n   count backwards from the end.\n\n   @param index [Integer] The index to retrieve. May be negative.\n   @return [Object]\n   @example\n     t = Erlang::Tuple[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"]\n     t[2]  # => \"C\"\n     t[-1] # => \"F\"\n     t[6]  # => nil\n\n @overload tuple.slice(index, length)\n   Return a subtuple starting at `index` and continuing for `length`\n   elements or until the end of the `Tuple`, whichever occurs first.\n\n   @param start [Integer] The index to start retrieving elements from. May be\n                          negative.\n   @param length [Integer] The number of elements to retrieve.\n   @return [Tuple]\n   @example\n     t = Erlang::Tuple[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"]\n     t[2, 3]  # => Erlang::Tuple[\"C\", \"D\", \"E\"]\n     t[-2, 3] # => Erlang::Tuple[\"E\", \"F\"]\n     t[20, 1] # => nil\n\n @overload tuple.slice(index..end)\n   Return a subtuple starting at `index` and continuing to index\n   `end` or the end of the `Tuple`, whichever occurs first.\n\n   @param range [Range] The range of indices to retrieve.\n   @return [Tuple]\n   @example\n     t = Erlang::Tuple[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"]\n     t[2..3]    # => Erlang::Tuple[\"C\", \"D\"]\n     t[-2..100] # => Erlang::Tuple[\"E\", \"F\"]\n     t[20..21]  # => nil", "Return a new `Tuple` with the given values inserted before the element\n at `index`. If `index` is greater than the current length, `nil` values\n are added to pad the `Tuple` to the required size.\n\n @example\n   Erlang::Tuple[\"A\", \"B\", \"C\", \"D\"].insert(2, \"X\", \"Y\", \"Z\")\n   # => Erlang::Tuple[\"A\", \"B\", \"X\", \"Y\", \"Z\", \"C\", \"D\"]\n   Erlang::Tuple[].insert(2, \"X\", \"Y\", \"Z\")\n   # => Erlang::Tuple[nil, nil, \"X\", \"Y\", \"Z\"]\n\n @param index [Integer] The index where the new elements should go\n @param elements [Array] The elements to add\n @return [Tuple]\n @raise [IndexError] if index exceeds negative range.", "Return a new `Tuple` with the element at `index` removed. If the given `index`\n does not exist, return `self`.\n\n @example\n   Erlang::Tuple[\"A\", \"B\", \"C\", \"D\"].delete_at(2)\n   # => Erlang::Tuple[\"A\", \"B\", \"D\"]\n\n @param index [Integer] The index to remove\n @return [Tuple]", "Return a new `Tuple` containing all elements for which the given block returns\n true.\n\n @example\n   Erlang::Tuple[\"Bird\", \"Cow\", \"Elephant\"].select { |e| e.size >= 4 }\n   # => Erlang::Tuple[\"Bird\", \"Elephant\"]\n\n @return [Tuple]\n @yield [element] Once for each element.", "Return a new `Tuple` with the same elements as this one, but randomly permuted.\n\n @example\n   Erlang::Tuple[1, 2, 3, 4].shuffle  # => Erlang::Tuple[4, 1, 3, 2]\n\n @return [Tuple]", "Return a new `Tuple` with the same elements as this one, but in reverse order.\n\n @example\n   Erlang::Tuple[\"A\", \"B\", \"C\"].reverse  # => Erlang::Tuple[\"C\", \"B\", \"A\"]\n\n @return [Tuple]", "Return a new `Tuple` with the same elements, but rotated so that the one at\n index `count` is the first element of the new tuple. If `count` is positive,\n the elements will be shifted left, and those shifted past the lowest position\n will be moved to the end. If `count` is negative, the elements will be shifted\n right, and those shifted past the last position will be moved to the beginning.\n\n @example\n   t = Erlang::Tuple[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"]\n   t.rotate(2)   # => Erlang::Tuple[\"C\", \"D\", \"E\", \"F\", \"A\", \"B\"]\n   t.rotate(-1)  # => Erlang::Tuple[\"F\", \"A\", \"B\", \"C\", \"D\", \"E\"]\n\n @param count [Integer] The number of positions to shift elements by\n @return [Tuple]", "Return a new `Tuple` with the same elements, but sorted.\n\n @overload sort\n   Compare elements with their natural sort key (`#<=>`).\n\n   @example\n     Erlang::Tuple[\"Elephant\", \"Dog\", \"Lion\"].sort\n     # => Erlang::Tuple[\"Dog\", \"Elephant\", \"Lion\"]\n\n @overload sort\n   Uses the block as a comparator to determine sorted order.\n\n   @yield [a, b] Any number of times with different pairs of elements.\n   @yieldreturn [Integer] Negative if the first element should be sorted\n                          lower, positive if the latter element, or 0 if\n                          equal.\n   @example\n     Erlang::Tuple[\"Elephant\", \"Dog\", \"Lion\"].sort { |a,b| a.size <=> b.size }\n     # => Erlang::Tuple[\"Dog\", \"Lion\", \"Elephant\"]\n\n @return [Tuple]", "Drop the first `n` elements and return the rest in a new `Tuple`.\n\n @example\n   Erlang::Tuple[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"].drop(2)\n   # => Erlang::Tuple[\"C\", \"D\", \"E\", \"F\"]\n\n @param n [Integer] The number of elements to remove\n @return [Tuple]\n @raise ArgumentError if `n` is negative.", "Repetition. Return a new `Tuple` built by concatenating `times` copies\n of this one together.\n\n @example\n   Erlang::Tuple[\"A\", \"B\"] * 3\n   # => Erlang::Tuple[\"A\", \"B\", \"A\", \"B\", \"A\", \"B\"]\n\n @param times [Integer] The number of times to repeat the elements in this tuple\n @return [Tuple]", "When invoked with a block, yields all combinations of length `n` of elements\n from the `Tuple`, and then returns `self`. There is no guarantee about\n which order the combinations will be yielded.\n\n If no block is given, an `Enumerator` is returned instead.\n\n @example\n   t = Erlang::Tuple[5, 6, 7, 8]\n   t.combination(3) { |c| puts \"Combination: #{c}\" }\n\n   Combination: [5, 6, 7]\n   Combination: [5, 6, 8]\n   Combination: [5, 7, 8]\n   Combination: [6, 7, 8]\n   #=> Erlang::Tuple[5, 6, 7, 8]\n\n @return [self, Enumerator]", "When invoked with a block, yields all repeated combinations of length `n` of\n tuples from the `Tuple`, and then returns `self`. A \"repeated combination\" is\n one in which any tuple from the `Tuple` can appear consecutively any number of\n times.\n\n There is no guarantee about which order the combinations will be yielded in.\n\n If no block is given, an `Enumerator` is returned instead.\n\n @example\n   t = Erlang::Tuple[5, 6, 7, 8]\n   t.repeated_combination(2) { |c| puts \"Combination: #{c}\" }\n\n   Combination: [5, 5]\n   Combination: [5, 6]\n   Combination: [5, 7]\n   Combination: [5, 8]\n   Combination: [6, 6]\n   Combination: [6, 7]\n   Combination: [6, 8]\n   Combination: [7, 7]\n   Combination: [7, 8]\n   Combination: [8, 8]\n   # => Erlang::Tuple[5, 6, 7, 8]\n\n @return [self, Enumerator]", "Yields all permutations of length `n` of elements from the `Tuple`, and then\n returns `self`. If no length `n` is specified, permutations of all elements\n will be yielded.\n\n There is no guarantee about which order the permutations will be yielded in.\n\n If no block is given, an `Enumerator` is returned instead.\n\n @example\n   t = Erlang::Tuple[5, 6, 7]\n   t.permutation(2) { |p| puts \"Permutation: #{p}\" }\n\n   Permutation: [5, 6]\n   Permutation: [5, 7]\n   Permutation: [6, 5]\n   Permutation: [6, 7]\n   Permutation: [7, 5]\n   Permutation: [7, 6]\n   # => Erlang::Tuple[5, 6, 7]\n\n @return [self, Enumerator]", "Cartesian product or multiplication.\n\n @overload product(*tuples)\n   Return a `Tuple` of all combinations of elements from this `Tuple` and each\n   of the given tuples or arrays. The length of the returned `Tuple` is the product\n   of `self.size` and the size of each argument tuple or array.\n   @example\n     t1 = Erlang::Tuple[1, 2, 3]\n     t2 = Erlang::Tuple[\"A\", \"B\"]\n     t1.product(t2)\n     # => [[1, \"A\"], [1, \"B\"], [2, \"A\"], [2, \"B\"], [3, \"A\"], [3, \"B\"]]\n @overload product\n   Return the result of multiplying all the elements in this `Tuple` together.\n\n   @example\n     Erlang::Tuple[1, 2, 3, 4, 5].product  # => 120\n\n @return [Tuple]", "Find the index of an element, starting from the end of the tuple.\n Returns `nil` if no element is found.\n\n @overload rindex(obj)\n   Return the index of the last element which is `#==` to `obj`.\n\n   @example\n     t = Erlang::Tuple[7, 8, 9, 7, 8, 9]\n     t.rindex(8) # => 4\n\n @overload rindex\n   Return the index of the last element for which the block returns true.\n\n   @yield [element] Once for each element, last to first, until the block\n                    returns true.\n   @example\n     t = Erlang::Tuple[7, 8, 9, 7, 8, 9]\n     t.rindex { |e| e.even? }  # => 4\n\n @return [Integer]", "Return 2 collections, the first containing all the elements for which the block\n evaluates to true, the second containing the rest.", "Convert this collection to a programmer-readable `String` representation.", "Call the given block once for each item in the list, passing each\n item from first to last successively to the block. If no block is given,\n returns an `Enumerator`.\n\n @return [self]\n @yield [item]", "Return a `List` which is realized by transforming each item into a `List`,\n and flattening the resulting lists.\n\n @example\n   Erlang::List[1, 2, 3].flat_map { |x| Erlang::List[x, 100] }\n   # => Erlang::List[1, 100, 2, 100, 3, 100]\n\n @return [List]", "Return a `List` which contains all the items for which the given block\n returns true.\n\n @example\n   Erlang::List[\"Bird\", \"Cow\", \"Elephant\"].select { |e| e.size >= 4 }\n   # => Erlang::List[\"Bird\", \"Elephant\"]\n\n @return [List]\n @yield [item] Once for each item.", "Return a `List` which contains all elements starting from the\n first element for which the block returns `nil` or `false`.\n\n @example\n   Erlang::List[1, 3, 5, 7, 6, 4, 2].drop_while { |e| e < 5 }\n   # => Erlang::List[5, 7, 6, 4, 2]\n\n @return [List, Enumerator]\n @yield [item]", "Return a `List` containing all but the last item from this `List`.\n\n @example\n   Erlang::List[\"A\", \"B\", \"C\"].pop  # => Erlang::List[\"A\", \"B\"]\n\n @return [List]", "Return a `List` containing all items after the first `number` items from\n this `List`.\n\n @example\n   Erlang::List[1, 3, 5, 7, 6, 4, 2].drop(3)\n   # => Erlang::List[7, 6, 4, 2]\n\n @param number [Integer] The number of items to skip over\n @return [List]", "Return a `List` with all items from this `List`, followed by all items from\n `other`.\n\n @example\n   Erlang::List[1, 2, 3].append(Erlang::List[4, 5])\n   # => Erlang::List[1, 2, 3, 4, 5]\n\n @param other [List] The list to add onto the end of this one\n @return [List]", "Gather the first element of each nested list into a new `List`, then the second\n element of each nested list, then the third, and so on. In other words, if each\n nested list is a \"row\", return a `List` of \"columns\" instead.\n\n @return [List]", "Return a new `List` with the same elements, but rotated so that the one at\n index `count` is the first element of the new list. If `count` is positive,\n the elements will be shifted left, and those shifted past the lowest position\n will be moved to the end. If `count` is negative, the elements will be shifted\n right, and those shifted past the last position will be moved to the beginning.\n\n @example\n   l = Erlang::List[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"]\n   l.rotate(2)   # => Erlang::List[\"C\", \"D\", \"E\", \"F\", \"A\", \"B\"]\n   l.rotate(-1)  # => Erlang::List[\"F\", \"A\", \"B\", \"C\", \"D\", \"E\"]\n\n @param count [Integer] The number of positions to shift items by\n @return [List]\n @raise [TypeError] if count is not an integer.", "Return a new `List` with the same items, but sorted.\n\n @overload sort\n   Compare elements with their natural sort key (`#<=>`).\n\n   @example\n     Erlang::List[\"Elephant\", \"Dog\", \"Lion\"].sort\n     # => Erlang::List[\"Dog\", \"Elephant\", \"Lion\"]\n\n @overload sort\n   Uses the block as a comparator to determine sorted order.\n\n   @yield [a, b] Any number of times with different pairs of elements.\n   @yieldreturn [Integer] Negative if the first element should be sorted\n                          lower, positive if the latter element, or 0 if\n                          equal.\n   @example\n     Erlang::List[\"Elephant\", \"Dog\", \"Lion\"].sort { |a,b| a.size <=> b.size }\n     # => Erlang::List[\"Dog\", \"Lion\", \"Elephant\"]\n\n @return [List]", "Return a new `List` with `sep` inserted between each of the existing elements.\n\n @example\n   Erlang::List[\"one\", \"two\", \"three\"].intersperse(\" \")\n   # => Erlang::List[\"one\", \" \", \"two\", \" \", \"three\"]\n\n @return [List]", "Return a `List` with all the elements from both this list and `other`,\n with all duplicates removed.\n\n @example\n   Erlang::List[1, 2].union(Erlang::List[2, 3]) # => Erlang::List[1, 2, 3]\n\n @param other [List] The list to merge with\n @return [List]", "Return a `List` with all elements except the last one.\n\n @example\n   Erlang::List[\"a\", \"b\", \"c\"].init # => Erlang::List[\"a\", \"b\"]\n\n @return [List]", "Return the last item in this list.\n @return [Object]", "Return a `List` of all suffixes of this list.\n\n @example\n   Erlang::List[1,2,3].tails\n   # => Erlang::List[\n   #      Erlang::List[1, 2, 3],\n   #      Erlang::List[2, 3],\n   #      Erlang::List[3]]\n\n @return [List]", "Return a `List` of all prefixes of this list.\n\n @example\n   Erlang::List[1,2,3].inits\n   # => Erlang::List[\n   #      Erlang::List[1],\n   #      Erlang::List[1, 2],\n   #      Erlang::List[1, 2, 3]]\n\n @return [List]", "Return a `List` of all combinations of length `n` of items from this `List`.\n\n @example\n   Erlang::List[1,2,3].combination(2)\n   # => Erlang::List[\n   #      Erlang::List[1, 2],\n   #      Erlang::List[1, 3],\n   #      Erlang::List[2, 3]]\n\n @return [List]", "Split the items in this list in groups of `number`. Return a list of lists.\n\n @example\n   (\"a\"..\"o\").to_list.chunk(5)\n   # => Erlang::List[\n   #      Erlang::List[\"a\", \"b\", \"c\", \"d\", \"e\"],\n   #      Erlang::List[\"f\", \"g\", \"h\", \"i\", \"j\"],\n   #      Erlang::List[\"k\", \"l\", \"m\", \"n\", \"o\"]]\n\n @return [List]", "Return a new `List` with all nested lists recursively \"flattened out\",\n that is, their elements inserted into the new `List` in the place where\n the nested list originally was.\n\n @example\n   Erlang::List[Erlang::List[1, 2], Erlang::List[3, 4]].flatten\n   # => Erlang::List[1, 2, 3, 4]\n\n @return [List]", "Return specific objects from the `List`. All overloads return `nil` if\n the starting index is out of range.\n\n @overload list.slice(index)\n   Returns a single object at the given `index`. If `index` is negative,\n   count backwards from the end.\n\n   @param index [Integer] The index to retrieve. May be negative.\n   @return [Object]\n   @example\n     l = Erlang::List[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"]\n     l[2]  # => \"C\"\n     l[-1] # => \"F\"\n     l[6]  # => nil\n\n @overload list.slice(index, length)\n   Return a sublist starting at `index` and continuing for `length`\n   elements or until the end of the `List`, whichever occurs first.\n\n   @param start [Integer] The index to start retrieving items from. May be\n                          negative.\n   @param length [Integer] The number of items to retrieve.\n   @return [List]\n   @example\n     l = Erlang::List[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"]\n     l[2, 3]  # => Erlang::List[\"C\", \"D\", \"E\"]\n     l[-2, 3] # => Erlang::List[\"E\", \"F\"]\n     l[20, 1] # => nil\n\n @overload list.slice(index..end)\n   Return a sublist starting at `index` and continuing to index\n   `end` or the end of the `List`, whichever occurs first.\n\n   @param range [Range] The range of indices to retrieve.\n   @return [Vector]\n   @example\n     l = Erlang::List[\"A\", \"B\", \"C\", \"D\", \"E\", \"F\"]\n     l[2..3]    # => Erlang::List[\"C\", \"D\"]\n     l[-2..100] # => Erlang::List[\"E\", \"F\"]\n     l[20..21]  # => nil", "Return a `List` of indices of matching objects.\n\n @overload indices(object)\n   Return a `List` of indices where `object` is found. Use `#==` for\n   testing equality.\n\n   @example\n     Erlang::List[1, 2, 3, 4].indices(2)\n     # => Erlang::List[1]\n\n @overload indices\n   Pass each item successively to the block. Return a list of indices\n   where the block returns true.\n\n   @yield [item]\n   @example\n     Erlang::List[1, 2, 3, 4].indices { |e| e.even? }\n     # => Erlang::List[1, 3]\n\n @return [List]", "Merge all the nested lists into a single list, using the given comparator\n block to determine the order which items should be shifted out of the nested\n lists and into the output list.\n\n @example\n   list_1 = Erlang::List[1, -3, -5]\n   list_2 = Erlang::List[-2, 4, 6]\n   Erlang::List[list_1, list_2].merge { |a,b| a.abs <=> b.abs }\n   # => Erlang::List[1, -2, -3, 4, -5, 6]\n\n @return [List]\n @yield [a, b] Pairs of items from matching indices in each list.\n @yieldreturn [Integer] Negative if the first element should be selected\n                        first, positive if the latter element, or zero if\n                        either.", "Return a new `List` with the given items inserted before the item at `index`.\n\n @example\n   Erlang::List[\"A\", \"D\", \"E\"].insert(1, \"B\", \"C\") # => Erlang::List[\"A\", \"B\", \"C\", \"D\", \"E\"]\n\n @param index [Integer] The index where the new items should go\n @param items [Array] The items to add\n @return [List]", "Return a `List` containing the same items, minus the one at `index`.\n If `index` is negative, it counts back from the end of the list.\n\n @example\n   Erlang::List[1, 2, 3].delete_at(1)  # => Erlang::List[1, 3]\n   Erlang::List[1, 2, 3].delete_at(-1) # => Erlang::List[1, 2]\n\n @param index [Integer] The index of the item to remove\n @return [List]", "Yields all permutations of length `n` of the items in the list, and then\n returns `self`. If no length `n` is specified, permutations of the entire\n list will be yielded.\n\n There is no guarantee about which order the permutations will be yielded in.\n\n If no block is given, an `Enumerator` is returned instead.\n\n @example\n   Erlang::List[1, 2, 3].permutation.to_a\n   # => [Erlang::List[1, 2, 3],\n   #     Erlang::List[2, 1, 3],\n   #     Erlang::List[2, 3, 1],\n   #     Erlang::List[1, 3, 2],\n   #     Erlang::List[3, 1, 2],\n   #     Erlang::List[3, 2, 1]]\n\n @return [self, Enumerator]\n @yield [list] Once for each permutation.", "Return two `List`s, the first containing all the elements for which the\n block evaluates to true, the second containing the rest.\n\n @example\n   Erlang::List[1, 2, 3, 4, 5, 6].partition { |x| x.even? }\n   # => Erlang::Tuple[Erlang::List[2, 4, 6], Erlang::List[1, 3, 5]]\n\n @return [Tuple]\n @yield [item] Once for each item.", "Return the contents of this `List` as a programmer-readable `String`. If all the\n items in the list are serializable as Ruby literal strings, the returned string can\n be passed to `eval` to reconstitute an equivalent `List`.\n\n @return [::String]", "Returns a new `Binary` containing `n` copies of itself. `n` must be greater than or equal to 0.\n @param n [Integer] The number of copies\n @return [Binary]\n @raise [ArgumentError] if `n` is less than 0", "Call the given block once for each bit in the `Binary`, passing each\n bit from first to last successively to the block. If no block is given,\n returns an `Enumerator`.\n\n @return [self]\n @yield [Integer]", "Returns the section of this `Binary` starting at `position` of `length`.\n\n @param position [Integer] The starting position\n @param length [Integer] The non-negative length\n @return [Binary]\n @raise [ArgumentError] if `position` is not an `Integer` or `length` is not a non-negative `Integer`", "Calls the block until it returns true or +time_to_wait+ is reached.\n +time_to_wait+ is 30 seconds by default\n\n Returns true upon success\n Raises RuntimeError when +time_to_wait+ is reached.", "Specify whether to accept or reject all confirm js dialogs\n for the code in the block that's run.", "Bind +self+ to +client+\n @api private\n @return self", "A new instance of Client, logged in with the given credentials\n @overload initialize(pixiv_id, password)\n   @param [String] pixiv_id\n   @param [String] password\n   @yield [agent] (optional) gives a chance to customize the +agent+ before logging in\n @overload initialize(agent)\n   @param [Mechanize::HTTP::Agent] agent\n @return [Pixiv::Client]\n Log in to Pixiv\n @param [String] pixiv_id\n @param [String] password", "Downloads the image to +io_or_filename+\n @param [Pixiv::Illust] illust\n @param [#write, String, Array<String, Symbol, #call>] io_or_filename io or filename or pattern for {#filename_from_pattern}\n @param [Symbol] size image size (+:small+, +:medium+, or +:original+)", "Downloads the images to +pattern+\n @param [Pixiv::Illust] illust the manga to download\n @param [Array<String, Symbol, #call>] pattern pattern for {#filename_from_pattern}\n @note +illust#manga?+ must be +true+\n @todo Document +&block+", "Generate filename from +pattern+ in context of +illust+ and +url+\n\n @api private\n @param [Array<String, Symbol, #call>] pattern\n @param [Pixiv::Illust] illust\n @param [String] url\n @return [String] filename\n\n The +pattern+ is an array of string, symbol, or object that responds to +#call+.\n Each component of the +pattern+ is replaced by the following rules and then\n the +pattern+ is concatenated as the returning +filename+.\n\n * +:image_name+ in the +pattern+ is replaced with the base name of the +url+\n * Any other symbol is replaced with the value of +illust.send(the_symbol)+\n * +#call+-able object is replaced with the value of +the_object.call(illust)+\n * String is left as-is", "Create an empty instance of a DNS zone that you can drive programmatically.\n\n @api public\n Helper method to access the zones SOA RR.\n\n @api public", "Generates pretty output of the zone and its records.\n\n @api public", "Records sorted with more important types being at the top.\n\n @api private", "Return a new container with a deeply nested value modified to the result\n of the given code block.  When traversing the nested containers\n non-existing keys are created with empty `Hash` values.\n\n The code block receives the existing value of the deeply nested key/index\n (or `nil` if it doesn't exist). This is useful for \"transforming\" the\n value associated with a certain key/index.\n\n Naturally, the original container and sub-containers are left unmodified;\n new data structure copies are created along the path as needed.\n\n @example\n   t = Erlang::Tuple[123, 456, 789, Erlang::Map[\"a\" => Erlang::Tuple[5, 6, 7]]]\n   t.update_in(3, \"a\", 1) { |value| value + 9 }\n   # => Erlang::Tuple[123, 456, 789, Erlang::Map[\"a'\" => Erlang::Tuple[5, 15, 7]]]\n   map = Erlang::Map[\"a\" => Erlang::Map[\"b\" => Erlang::Map[\"c\" => 42]]]\n   map.update_in(\"a\", \"b\", \"c\") { |value| value + 5 }\n   # => Erlang::Map[\"a\" => Erlang::Map[\"b\" => Erlang::Map[\"c\" => 47]]]\n\n @param key_path [Object(s)] List of keys/indexes which form the path to the key to be modified\n @yield [value] The previously stored value\n @yieldreturn [Object] The new value to store\n @return [Associable]", "Return the value of successively indexing into a collection.\n If any of the keys is not present in the collection, return `nil`.\n keys that the Erlang type doesn't understand, raises an argument error\n\n @example\n   m = Erlang::Map[:a => 9, :b => Erlang::Tuple['a', 'b'], :e => nil]\n   m.dig(:b, 0)    # => \"a\"\n   m.dig(:b, 5)    # => nil\n   m.dig(:b, 0, 0) # => nil\n   m.dig(:b, :a)   # ArgumentError\n @param key to fetch from the collection\n @return [Object]", "Downloads all data given a starting URL. Some Pandora feeds only return\n 5 - 10 items per page but contain a link to the next set of data. Threads\n cannot be used because page A be must visited to know how to obtain page B.\n @param url [String]", "Grabs a URL from DATA_FEED_URLS and formats it appropriately.\n @param data_name [Symbol]\n @param next_data_indices [Symbol] query parameters to get the next set of data", "Is the Yubico OTP valid and belongs to this account?", "The value of the first field named +name+, or nil if no\n match is found.", "Push +field+ onto the fields, unless there is already a field\n with this name.", "Delete +field+.\n\n Warning: You can't delete BEGIN: or END: fields, but other\n profile-specific fields can be deleted, including mandatory ones. For\n vCards in particular, in order to avoid destroying them, I suggest\n creating a new Vcard, and copying over all the fields that you still\n want, rather than using #delete. This is easy with Vcard::Maker#copy, see\n the Vcard::Maker examples.", "n can be an Integer or a Range.  If it is an Integer, it just returns a random\nnumber greater than or equal to 0 and less than n.  If it is a Range, it\nreturns a random number within the range\n Examples\n\n >> Random.number(5)\n => 4\n >> Random.number(5)\n => 2\n >> Random.number(5)\n => 1", "Take css module code as input, and rewrite it as\n browser-friendly CSS code. Apply opaque transformations\n so that selectors can only be accessed programatically,\n not by class name literals.", "Returns simple sentences based on a supplied grammar, which must be a hash, the\n keys of which are symbols.  The values are either an array of successive values or a grammar\n (i.e, hash with symbols as keys, and hashes or arrays as values.  The arrays contain symbols\n referencing the keys in the present grammar, or strings to be output. The keys are always symbols.\n\n Example:\n Random.grammatical_construct({:story => [:man, \" bites \", :dog], :man => { :bob => \"Bob\"}, :dog => {:a =>\"Rex\", :b =>\"Rover\"}}, :story)\n => \"Bob bites Rover\"", "Returns ends poionts which will make up a circle around current location and have given radius", "Returns a random company name\n\n >> Random.company_name\n\n \"Harris & Thomas\"", "Create a new builder.\n\n @param [Parser] parser\n @see Parser#graph\n @see Parser#additional_namespaces\n Build and return the base.\n\n @return [Base]", "Renders a navigation element and marks it as active where\n appropriate. See active_page? for details", "Takes a hash with pages and tells whether the current page is among them.\n The keys must be controller names and their value must be an array of\n action names. If the array is empty, every action is supposed to be valid.", "Get the webnames from a user ID search.\n @param html [String]\n @return [Array] array of webnames", "Get the query parameters necessary to get the next page of data from Pandora.\n @param html [String]\n @return [Hash, False]", "Loops over each .infobox container and yields the title and subtitle.\n @param html [String]", "Loops over each .double-link container and yields the title and subtitle.\n Encountered on mobile pages.\n @param html [String]", "Loops over each .follow_section container.\n @param html [String]\n @return [Hash] with keys :name, :webname and :href", "Infer system properties from architecture information\n\n @return [Array[String, String String]]\n\n @api private", "Displays the decision page on that the user can confirm the request and\n choose which data should be transfered to the relying party.", "This action is called by submitting the decision form, the information entered by\n the user is used to answer the request. If the user decides to always trust the\n relying party, a new site according to the release policies the will be created.", "Decides how to process an incoming checkid request. If the user is\n already logged in he will be forwarded to the proceed action. If\n the user is not logged in and the request is immediate, the request\n cannot be answered successfully. In case the user is not logged in,\n the request will be stored and the user is asked to log in.", "Stores the current OpenID request.\n Returns the OpenIdRequest", "Use this as before_filter for every CheckID request based action.\n Loads the current openid request and cancels if none can be found.\n The user has to log in, if he has not verified his ownership of\n the identifier, yet.", "Transforms the parameters from the form to valid AX response values", "Renders the exception message as text output", "If you need to add an option that affects processing of input files,\n you can use this method.", "Crop to a square, using the specified gravity.", "Makes the found root objects available.\n @return [Object]", "Returns a string providing something in the general form of a UK post code.  Like the zip codes, this might\n not actually be valid. Doesn't cover London whose codes are like \"SE1\".", "Creates a new Map object\n\n <tt>:options</tt>::   The options available are the same as described in\n                       Google's API documentation[http://code.google.com/apis/maps/documentation/staticmaps/#Usage].\n                       In short, valid options are:\n                       <tt>:size</tt>::      The size of the map. Can be a \"wxh\", [w,h] or {:width => x, :height => y}\n                       <tt>:sensor</tt>::    Set to true if your application is using a sensor. See the API doc.\n                       <tt>:center</tt>::    The center point of your map. Optional if you add markers or path to the map\n                       <tt>:zoom</tt>::      The zoom level you want, also optional as center\n                       <tt>:format</tt>::    Defaults to png\n                       <tt>:maptype</tt>::   Defaults to roadmap\n                       <tt>:mobile</tt>::    Returns map tiles better suited for mobile devices with small screens.\n                       <tt>:language</tt>::  The language used in the map\n\n\n Builds up a URL representing the state of this Map object", "Returns the markers grouped by it's label, color and size.\n\n This is handy when building the URL because the API wants us to\n group together equal markers and just list the position of the markers thereafter in the URL.", "Sets the size of the map\n\n <tt>size</tt>::   Can be a \"wxh\", [w,h] or {:width => x, :height => y}", "Methods to create random strings and paragraphs.\n Returns a string of random upper- and lowercase alphanumeric characters.  Accepts a size parameters, defaults to 16 characters.\n\n >> Random.alphanumeric\n\n \"Ke2jdknPYAI8uCXj\"\n\n >> Random.alphanumeric(5)\n\n \"7sj7i\"", "given the next token of input add it to the\n table", "get list of codes and names sorted by country name", "get list of codes and names sorted by language name", "With no block, returns an Array of Line. If +name+ is specified, the\n Array will only contain the +Line+s with that +name+. The Array may be\n empty.\n\n If a block is given, each Line will be yielded instead of being returned\n in an Array.", "Delete +line+ if block yields true.", "Add a breadcrumb to breadcrumb trail.\n @param trail_index index of breadcrumb trail\n @example\n   add_breadcrumb_to(\"level 1\", \"level 1 url\", 0)", "Store the given account id in the session.", "Redirect as appropriate when an access request fails.\n\n The default action is to redirect to the login screen.\n\n Override this method in your controllers if you want to have special\n behavior in case the account is not authorized\n to access the requested action.  For example, a popup window might\n simply close itself.", "Set the property to the given value.\n\n @api private\n @param [#to_s] name\n @param [String, Object] value\n @raise [UndefinedPropertyError] If the requested property is undefined.", "Returns a date within a specified range of days.  If dayrange is an Integer, then the date\n returned will be plus or minus half what you specify.  The default is ten days, so by default\n you will get a date within plus or minus five days of today.\n\n If dayrange is a Range, then you will get a date the falls between that range\n\n Example:\n\n Random.date # => a Date +/- 5 days of today\n Random.date(20) # => a Date +/- 10 days of today\n Random.date(-60..-30) # => a Date between 60 days ago and 30 days ago", "Returns a date within the specified Range. The Range can be Date or String objects.\n\nExample:\n min = Date.parse('1966-11-15')\n max = Date.parse('1990-01-01')\n Random.date(min..max) # => a Date between 11/15/1996 and 1/1/1990\n Random.date('1966-11-15'..'1990-01-01') # => a Date between 11/15/1996 and 1/1/1990", "Creates a new Path which you can push points on to to make up lines or polygons\n\n The following options are available, for more information see the\n Google API documentation[http://code.google.com/apis/maps/documentation/staticmaps/#Paths].\n\n <tt>:weight</tt>::    The weight is the thickness of the line, defaults to 5\n <tt>:color</tt>::     The color of the border can either be a textual representation like red, green, blue, black etc\n                       or as a 24-bit (0xAABBCC) or 32-bit hex value (0xAABBCCDD). When 32-bit values are\n                       given the two last bits will represent the alpha transparency value.\n <tt>:fillcolor</tt>:: With the fill color set you'll get a polygon in the map. The color value can be the same\n                       as described in the <tt>:color</tt>. When used, the static map will automatically create\n                       a closed shape.\n <tt>:points</tt>::    An array of points. You can mix objects responding to lng and lat, and a Hash with lng and lat keys.\n <tt>:encode_points::  A flag which tells us if we should encode the points in this path or not. Defaults to <tt>true</tt>\n\n\n Returns a string representation of this Path\n Used by the Map when building the URL", "Sets the points of this Path.\n\n *WARNING* Using this method will clear out any points which might be set.", "Adds PAPE information for your server to an OpenID response.", "Renders the final response output", "Returns the personas attribute for the given SReg name or AX Type URI", "Formats data as a string list or JSON.\n @param data [Hash]\n @param json [Boolean]\n @return [String]", "Downloads the user's desired data.\n @return [Hash]", "Returns a scraper for the user's id.\n @param user_id [String] webname or email\n @return [Pandata::Scraper]", "Generates a release policy for each property that has a value.\n This setter is used in the server controllers complete action\n to set the attributes recieved from the decision form.", "Returns a hash with all released SReg properties. SReg properties\n have a type_identifier matching their property name", "Returns a hash with all released AX properties.\n AX properties have an URL as type_identifier.", "Sorts alphabetically ignoring the initial 'The' when sorting strings.\n Also case-insensitive to prevent lowercase names from being sorted last.\n @param enumerable [Array, Hash]\n @return [Array, Hash]", "Takes an array of non-negative weights\n and returns the index selected by a\n roulette wheel weighted according to those\n weights.\n If a block is given then k is used to determine\n how many times the block is called.  In this\n case nil is returned.", "Retrieve the body\n\n @todo Custom error class\n @raise [ArgumentError] The received content does not seems to be HTML.\n @return [String]", "Whether the target URI seems to return HTML\n\n @return [Bool]", "Redefines an object's method with a Command of the same name.", "The actual method which redefines a command's original method", "Runs a command given its object and arguments", "Generates one-line usage of all options.", "More verbose option help in the form of a table.", "Creates a Hash with indifferent access", "Loads a library and its dependencies and returns true if library loads\n correctly.", "Wraps around module loading for unexpected additions", "Prepares for command loading, loads commands and rescues certain errors.", "Symbolizes keys of a hash", "Ensure the input string buffer ends with two newlines.\n\n @param buffer [String] a buffer to check\n   If the buffer does not ends with two newlines the newlines are added.", "Filter collection keys\n\n @return [Array<Hash>] collection without ignored keys", "Command objects of library's commands", "Creates a module under a given base module and possible name. If the\n module already exists, it attempts to create one with a number appended to\n the name.", "Called by Rack when a request comes through", "HTTP connection for the Particle API\n\n @return [Faraday::Connection]", "The method_added used while scraping method attributes.", "Parses arguments and returns global options, local options and leftover\n arguments.", "modifies args for edge cases", "raises CommandArgumentError if argument size is incorrect for given args", "Adds default args as original method would", "delete record.\n\n @param options [Hash] options.\n @option options [Boolean] hard (false) if hard-delete.", "destroy record and run callbacks.\n\n @param options [Hash] options.\n @option options [Boolean] hard (false) if hard-delete.\n\n @return [Boolean, self] if action is cancelled, return false.", "restore record.\n\n @param options [Hash] options.\n @option options [Boolean] recursive (true) if restore recursive.\n\n @return [Boolean, self] if action is cancelled, return false.", "All Scope of dependent association.\n\n @return [Array<ActiveRecord::Relation>] array of dependent association.", "Set the altitude mode", "Render the object and all of its sub-elements.", "Perform saved searches actions to provide full functionality with one method", "Return params of Saved Search or search form params", "Save or update Saved Search", "Start the sudo-ed Ruby process.", "Load needed libraries in the DRb server. Usually you don't need", "=> Facilitate Dynamic Addition of Configuration Values\n\n => @return [class_variable]", "=> Delete a Node Object", "Run method. Call this to run the octofacts updater with the object that was\n previously construcuted.", "Get the index file from the options or configuration file. Raise error if it does not exist or\n was not specified.", "Print or write to file depending on whether or not the output file was set.\n\n data - Data to print or write.", "Raises an error if there are missing headers", "Source files found in source_search_paths", "Wrap the original attribute method with appropriate notification while leaving the functionality\n of the original method unchanged.", "Rebuild an index with a specified list of facts. This will remove any indexed facts that\n are not on the list of facts to use.\n\n facts_to_index - An Array of Strings with facts to index\n fixtures       - An Array with fact fixtures (must respond to .facts and .hostname)", "Write the fact index out to a YAML file.\n\n filename - A String with the file to write (defaults to filename from constructor if available)", "Use the current configured publisher to send this job into a queue.", "The feed validator uses a different response type, so we have to override these here.", "Missing method - this is used to dispatch to manipulators or to call a Hash method in the facts.\n\n Try calling a Manipulator method, delegate to the facts hash or else error out.\n\n Returns this object (so that calls to manipulators can be chained).", "=> Launch the Application", "authenticate by operator_id and user_name and password", "Set the value of the fact. If the name is specified, this will dig into a structured fact to set\n the value within the structure.\n\n new_value - An object with the new value for the fact\n name_in   - An optional String to dig into the structure (formatted with :: indicating hash delimiters)", "Set a value in the data structure of a structured fact. This is intended to be\n called recursively.\n\n subhash - The Hash, part of the fact, being operated upon\n parts   - The Array to dig in to the hash\n value   - The value to set the ultimate last part to\n\n Does not return anything, but modifies 'subhash'", "Recursively diff common files between dir1 and dir2", "Find all files in a given directory", "Find files which aren't common to both directories", "YAML representation of the fact fixture.\n\n Returns a String containing the YAML representation of the fact fixture.", "Another way to implement covariance", "Return the file name no matter if the actual SRTM file exists.", "If approximate is True then only the points from SRTM grid will be\n used, otherwise a basic aproximation of nearby points will be calculated.", "Loads a value from the n-th position in the EGM file. Every position\n is a 4-byte real number.", "Unpacks a number from the EGM file", "=> Add Node to the State", "=> Remove Node from the State", "Replaces emoji characters in a given string with a given block result\n @param string [String] a string that to be replaced\n @return [String] a replaced result\n @example\n   Somemoji.emoji_collection.replace_character(\"I \u2764 Emoji\") do |emoji|\n     %(<img alt=\"#{emoji.character}\" class=\"emoji\" src=\"/images/emoji/#{emoji.base_path}.png\">)\n   end\n   #=> 'I <img alt=\"\u2764\" class=\"emoji\" src=\"/images/emoji/unicode/2764.png\"> Emoji'", "Replaces emoji codes in a given string with a given block result\n @param string [String] a string that to be replaced\n @return [String] a replaced result\n @example\n   Somemoji.emoji_collection.replace_code(\"I :heart: Emoji\") do |emoji|\n     %(<img alt=\"#{emoji.character}\" class=\"emoji\" src=\"/images/emoji/#{emoji.base_path}.png\">)\n   end\n   #=> 'I <img alt=\"\u2764\" class=\"emoji\" src=\"/images/emoji/unicode/2764.png\"> Emoji'", "Searches emojis that match with given pattern\n @param pattern [Object]\n @return [Somemoji::EmojiCollection]\n @example\n   Somemoji.emoji_collection.search_by_code(/^cus/).map(&:code)\n   #=> [\"custard\", \"customs\"]", "Inject given `object` with its expected dependencies.\n @param [Scorpion::Object] object to be injected.\n @return [Scorpion::Object] the injected object.", "Define a single attribute with the given name that expects food that will\n satisfy the contract.\n @param [String] name of the attribute.\n @param [Class,Module,Symbol] contract that describes the desired behavior\n   of the injected object.\n @return [Attribute] the attribute that was created.", "provide extra map of plugins with symbolized names as keys\n\n @param type [String] name of type to generate the map for\n @return [Hash] map of the names and plugin classes", "start the socket server and the web server, and launch a browser to fetch the view from the web server", "Find first plugin whose class matches the given name.\n Behaves like `first_class` but throws exceptions if can not find anything.\n @param type  [String] name of type to search for plugins\n @param klass [Symbol|String] name of the searched class\n @return      [Class] The first plugin that matches the klass\n @raise [Pluginator::MissingPlugin] when can not find plugin", "Removes the root from the response and hands it off to the class to process it\n Processes an array response by delegating to the includer's self.from_response\n @param [Faraday::Response] response The response\n @return [Object] The result of the parsed response.", "Feed dependencies from a hash into their associated attributes.\n @param [Hash] dependencies hash describing attributes to inject.\n @param [Boolean] overwrite existing attributes with values in in the hash.", "Injects dependenices from the hash and removes them from the hash.\n @see #inject_from", "Allows method-style access to the attributes.", "Runs a callback after voltage changes by specified amount.\n This creates a new thread that runs in the background and polls at specified interval.\n\n @param callback A method to call when the change is detected\n This method should take 4 arguments: the pin, the previous voltage, the current voltage, and the counter\n @param mv_change an integer specifying the required change in mv\n @param interval a number representing the wait time between polling\n @param repeats is optional and specifies the number of times the callback will be run\n\n @example\n   # This polls every 0.1 seconds and will run after a 10mv change is detected\n   callback = lambda { |pin, mv_last, mv, count| puts \"[#{count}] #{pin} #{mv_last} -> #{mv}\" }\n   p9_33 = AINPin.new(:P9_33)\n   p9_33.run_on_change(callback, 10, 0.1)", "Runs a callback after voltage changes beyond a certain threshold.\n This creates a new thread that runs in the background and polls at specified interval.\n When the voltage crosses the specified thresholds the callback is run.\n\n @param callback A method to call when the change is detected. This method should take 6 arguments: the pin, the previous voltage, the current voltage, the previous state, the current state, and the counter\n @param mv_lower an integer specifying the lower threshold voltage\n @param mv_upper an integer specifying the upper threshold voltage\n @param mv_reset an integer specifying the range in mv required to reset the threshold trigger\n @param interval a number representing the wait time between polling\n @param repeats is optional and specifies the number of times the callback will be run\n\n @example\n   # This polls every 0.01 seconds and will run after a the voltage crosses 400mv or 1200mv.\n   # Voltage will have to cross a range by at least 5mv to prevent rapidly triggering events\n   callback = lambda { |pin, mv_last, mv, state_last, state, count|\n     puts \"[#{count}] #{pin} #{state_last} -> #{state}     #{mv_last} -> #{mv}\"\n   }\n   p9_33 = AINPin.new(:P9_33)\n   p9_33.run_on_threshold(callback, 400, 1200, 5, 0.01)", "Runs a callback once after voltage crosses a specified threshold.\n Convenience method for run_on_threshold", "Command a resource to populate its ViolationSet with any violations of\n its validation Rules in +context_name+\n\n @api public", "Register a new plugin, can be used to load custom plugins\n\n @param type [String] type for the klass\n @param klass [Class] klass of the plugin to add", "Find any explicitly defined dependencies that can satisfy the hunt.\n @param [Hunt] hunt being resolved.\n @return [Dependency] the matching dependency if found", "Call a method on plugin and return first one that returns `true`.\n Behaves like `first_ask` but throws exceptions if can not find anything.\n @param type [String] name of type to search for plugins\n @param method_name [Symbol] name of the method to execute\n @param params [Array] params to pass to the called method\n @return [Class] The first plugin that method call returns true\n @raise [Pluginator::MissingPlugin] when can not find plugin", "Runs a callback on an edge trigger event.\n This creates a new thread that runs in the background\n\n @param callback A method to call when the edge trigger is detected.  This method should take 3 arguments, the pin, the edge, and the counter\n @param edge should be a symbol representing the trigger type, e.g. :RISING, :FALLING, :BOTH\n @param timeout is optional and specifies a time window to wait\n @param repeats is optional and specifies the number of times the callback will be run\n\n @example\n   p9_11 = GPIOPin.new(:P9_11, :IN)\n   p9_11.run_on_edge(lambda { |pin,edge,count| puts \"[#{count}] #{pin} -- #{edge}\" }, :P9_11, :RISING)    def run_on_edge(callback, edge, timeout=nil, repeats=nil)", "Default Resource Name\n @return [String] generated resource name from class name \"e.g. ZerigoDNS::ZoneTemplate -> zone_template\"", "Set the offset of the dataspace. offsets should be an ndims-sized array\n of zero-based integer offsets.", "Sets a PRIVATE-TOKEN header for requests.\n @raise [Error::MissingCredentials] if api_token not set.", "full_name => class", "Sting an object so that it will be injected with the scorpion and use it\n to resolve all dependencies.\n @param [#scorpion] object to sting.\n @return [object] the object that was stung.", "Map array of names to available plugins.\n\n @param type [String] name of type to search for plugins\n @param list [Array]  list of plugin names to load\n @return     [Array]  list of loaded plugins", "Map array of names to available plugins.\n Behaves like `matching` but throws exceptions if can not find anything.\n @param type [String] name of type to search for plugins\n @param list [Array]  list of plugin names to load\n @return     [Array]  list of loaded plugins\n @raise [Pluginator::MissingPlugin] when can not find plugin", "Turn a hash into an object for easy accessibility.\n\n @note This method will objectify nested hashes/arrays.\n\n @param  [Hash, Array] result An array or hash of results to turn into\n   an object\n @return [Rundeck::ObjectifiedHash] if +result+ was a hash\n @return [Rundeck::ObjectifiedHash] if +result+ was an array\n @raise  [Array<Rundeck::Error::Parsing>] Error objectifying array or hash", "Converts a resource object to a hash.\n @param [Object] object to convert to a hash\n @raise [ArgumentError] if the object given does not respond to to_hash", "sorts records alphabetically", "read and cleanup response headers\n returns Hash", "replace each first occurrence of param's value in the request path\n\n Example:\n   request path = /api/users/123\n   id = 123\n   symbolized path => /api/users/:id", "Captures a single dependency and returns the same instance fore each request\n for the resource.\n @see #hunt_for\n @return [Dependency] the dependency to be hunted for.", "Replicates the dependency in `other_map` into this map.\n @param [Scorpion::DependencyMap] other_map to replicate from.\n @return [self]", "Initialize an SPI device.  Returns an SPIDevice object\n\n @param spi should be a symbol representing the SPI device\n @param mode optional, default 0, specifies the SPI mode :SPI_MODE_0 through 3\n @param speed optional, specifies the SPI communication speed\n @param bpw optional, specifies the bits per word\n\n @example\n   spi = SPIDevice.new(:SPI0, SPI_MODE_0)\n Transfer data to and from the SPI device\n\n @return String data read from SPI device\n\n @param tx_data data to transmit\n @param readbytes bytes to read, otherwise it sizeof tx_data is used\n @param speed optional, speed to xfer at\n @param delay optional delay\n @param bpw optional bits per word\n\n @example\n   # communicate with MCP3008\n   # byte 1: start bit\n   # byte 2: single(1)/diff(0),3 bites for channel, null pad\n   # byte 3: don't care\n   spi = SPIDevice.new(:SPI0)\n   raw = spi.xfer([ 0b00000001, 0b10000000, 0].pack(\"C*\"))\n   data = raw.unpack(\"C*\")\n   val = ((data[1] & 0b00000011) << 8 ) | data[2]", "Creates a hash of options and their values.", "Check for any replies that have been received.\n Replies are messages that have been sent from a handset in response to a\n message sent by an\n application or messages that have been sent from a handset to a inbound\n number associated with\n an account, known as a dedicated inbound number (contact\n <support@messagemedia.com> for more\n information on dedicated inbound numbers).\n Each request to the check replies endpoint will return any replies\n received that have not yet\n been confirmed using the confirm replies endpoint. A response from the\n check replies endpoint\n will have the following structure:\n ```json\n {\n     \"replies\": [\n         {\n             \"metadata\": {\n                 \"key1\": \"value1\",\n                 \"key2\": \"value2\"\n             },\n             \"message_id\": \"877c19ef-fa2e-4cec-827a-e1df9b5509f7\",\n             \"reply_id\": \"a175e797-2b54-468b-9850-41a3eab32f74\",\n             \"date_received\": \"2016-12-07T08:43:00.850Z\",\n             \"callback_url\": \"https://my.callback.url.com\",\n             \"destination_number\": \"+61491570156\",\n             \"source_number\": \"+61491570157\",\n             \"vendor_account_id\": {\n                 \"vendor_id\": \"MessageMedia\",\n                 \"account_id\": \"MyAccount\"\n             },\n             \"content\": \"My first reply!\"\n         },\n         {\n             \"metadata\": {\n                 \"key1\": \"value1\",\n                 \"key2\": \"value2\"\n             },\n             \"message_id\": \"8f2f5927-2e16-4f1c-bd43-47dbe2a77ae4\",\n             \"reply_id\": \"3d8d53d8-01d3-45dd-8cfa-4dfc81600f7f\",\n             \"date_received\": \"2016-12-07T08:43:00.850Z\",\n             \"callback_url\": \"https://my.callback.url.com\",\n             \"destination_number\": \"+61491570157\",\n             \"source_number\": \"+61491570158\",\n             \"vendor_account_id\": {\n                 \"vendor_id\": \"MessageMedia\",\n                 \"account_id\": \"MyAccount\"\n             },\n             \"content\": \"My second reply!\"\n         }\n     ]\n }\n ```\n Each reply will contain details about the reply message, as well as\n details of the message the reply was sent\n in response to, including any metadata specified. Every reply will have a\n reply ID to be used with the\n confirm replies endpoint.\n *Note: The source number and destination number properties in a reply are\n the inverse of those\n specified in the message the reply is in response to. The source number of\n the reply message is the\n same as the destination number of the original message, and the\n destination number of the reply\n message is the same as the source number of the original message. If a\n source number\n wasn't specified in the original message, then the destination number\n property will not be present\n in the reply message.*\n Subsequent requests to the check replies endpoint will return the same\n reply messages and a maximum\n of 100 replies will be returned in each request. Applications should use\n the confirm replies endpoint\n in the following pattern so that replies that have been processed are no\n longer returned in\n subsequent check replies requests.\n 1. Call check replies endpoint\n 2. Process each reply message\n 3. Confirm all processed reply messages using the confirm replies endpoint\n *Note: It is recommended to use the Webhooks feature to receive reply\n messages rather than polling\n the check replies endpoint.*\n @return CheckRepliesResponse response from the API call", "retrieve heartrate time series", "retrieve intraday series for heartrate", "The constructor.\n Method overridden from HttpClient.", "Method overridden from HttpClient.", "clone object without associations", "clone has_one associations", "clone has_many associations", "Returns the text of the button.\n\n For input elements, returns the \"value\" attribute.\n For button elements, returns the inner text.\n\n @return [String]", "retrieves intraday activity time series.\n @param resource (required) for which the intrady series is retrieved. one of 'calories', 'steps', 'distance', 'floors', 'elevation'\n @param start_date (required) start date for the series\n @param end_date (optional) end date for the series, if not specified, the series is for 1 day\n @param detail_level (required) level of detail for the series\n @param start_time (optional)start time for the series\n @param end_time the (optional)end time for the series. specify both start_time and end_time, if using either", "retrieves activity list for the user", "update activity goals\n @param period period for the goal ('weekly' or 'daily')\n @param params the POST params for the request. Refer to Fitbit documentation for accepted format", "retrieve time series data for sleep\n @param resource sleep resource to be requested\n @param start_date starting date for sleep time series\n @param end_date ending date for sleep time series\n @param period period for sleep time series", "Returns the text of option.\n\n Note that the text is either one of the following respectively:\n   * label attribute\n   * text attribute\n   * inner element text\n\n @return [String]", "Returns given style property of this element.\n\n @example\n html.a(:id => \"foo\").style\n #=> \"display: block\"\n html.a(:id => \"foo\").style \"display\"\n #=> \"block\"\n\n @param [String] property\n @return [String]", "Returns parent element of current element.", "Convert to sensor reading to hash", "Print to stdout, taking the various output options into account", "Returns table cell.\n\n @return [TableCell]", "Returns table cells collection.\n\n @return [TableCell]", "Returns a Hash representation of the current object.", "Reads the given file as HTML.\n\n @example\n   browser.goto \"www.google.com\"\n\n @param [String] uri The url.\n @return [String] The url you end up at.", "Starts a new job.\n\n A job requires at least one file you {Have} and one file you {Want}\n in order to be runable. Use {Job#have} and {Job#want} to add\n and obtain specification interfaces for the job.\n\n Runs the job.\n\n @return [Boolean] true if the job succeeds, false if it fails.\n   {Job#report} provides information in case of failure.", "Cleans out subtitles that fell out of the usable time range\n\n @params have [Have] What we {Have}", "Rescales timecodes based on two differing framerates.\n\n @param have [Have] the subtitles we {Have}\n @param want [Want] the subtitles we {Want}", "Get a GET HttpRequest object.\n @param [String] The URL to send the request to.\n @param [Hash, Optional] The headers for the HTTP Request.", "Get a HEAD HttpRequest object.\n @param [String] The URL to send the request to.\n @param [Hash, Optional] The headers for the HTTP Request.", "Get a POST HttpRequest object.\n @param [String] The URL to send the request to.\n @param [Hash, Optional] The headers for the HTTP Request.\n @param [Hash, Optional] The parameters for the HTTP Request.", "Get a PUT HttpRequest object.\n @param [String] The URL to send the request to.\n @param [Hash, Optional] The headers for the HTTP Request.\n @param [Hash, Optional] The parameters for the HTTP Request.", "Get a PATCH HttpRequest object.\n @param [String] The URL to send the request to.\n @param [Hash, Optional] The headers for the HTTP Request.\n @param [Hash, Optional] The parameters for the HTTP Request.", "Get a DELETE HttpRequest object.\n @param [String] The URL to send the request to.\n @param [Hash, Optional] The headers for the HTTP Request.", "Log and do awesome things\n I wish there was a nicer way to do this. Hax on device.puts, maybe?", "runs across all records yielding those to be indexed when the index is rebuilt", "yields the records with the given ids, in batches of batch_size", "When already handling a method call, we don't need to recur on\n some items.", "Enable colourized IRb results.", "Colourize the results of inspect", "Iterates over the pages at the specified indices.\n\n @param [Array, Range] indices\n   The indices.\n\n @yield [page]\n   The given block will be passed each page.\n\n @yieldparam [Page] page\n   A page at one of the given indices.", "Iterates over all the pages of the query, until an empty page is\n encountered.\n\n @yield [page]\n   A page with results from the query.\n\n @yieldparam [Page] page\n   A non-empty page from the query.", "The cache of previously requested pages.\n\n @return [Hash]", "Switches the index to a new index directory.\n Used by the DRb server when switching to a new index version.", "Initialize a new file with given path\n\n @param [Pathname] path\n        the location of the container\n\n Read the resources from disk\n\n @return [XCAssets::Bundle]", "Build the section\n\n @return [Section]", "Discover Info.plist files by build settings of the application target\n\n @return [Set<Pathname>]\n         the relative paths to the .plist-files", "Find the native development languages by trying to use the\n \"Localization native development region\" from Info.plist\n\n @return [Set<String>]", "Read a file and collect all its keys\n\n @param  [Pathname] path\n         the path to the .strings file to read\n\n @return [Hash{String => Hash}]", "compatibility\n returns true if ferret indexing is enabled for this record.\n\n The optional is_bulk_index parameter will be true if the method is called\n by rebuild_index or bulk_index, and false otherwise.\n\n If is_bulk_index is true, the class level ferret_enabled state will be\n ignored by this method (per-instance ferret_enabled checks however will\n take place, so if you override this method to forbid indexing of certain\n records you're still safe).", "NotificationListener listener, NotificationFilter filter, Object handback", "Get MBean attribute specified by name.  If it is just a plain attribute\n then unwrap the attribute and just return the value.", "Set MBean attribute specified by name to value", "Invoke an operation.  A NoMethodError will be thrown if this MBean\n cannot respond to the operation.\n\n FIXME: Add scoring to pick best match instead of first found", "Convert a collection of java objects to their Java class name equivalents", "Compare two apk files and return results.\n\n {\n   base: {\n     file_size: Integer,\n     download_size: Integer,\n     required_features: Array<String>,\n     non_required_features: Array<String>,\n     permissions: Array<String>,\n     min_sdk: String,\n     target_sdk: String,\n     method_reference_count: Integer,\n     dex_count: Integer,\n   },\n   other: {\n     file_size: Integer,\n     download_size: Integer,\n     required_features: Array<String>,\n     non_required_features: Array<String>,\n     permissions: Array<String>,\n     min_sdk: String,\n     target_sdk: String,\n     method_reference_count: Integer,\n     dex_count: Integer,\n   },\n   diff: {\n     file_size: Integer,\n     download_size: Integer,\n     required_features: {\n       new: Array<String>,\n       removed: Array<String>,\n     },\n     non_required_features:{\n       new: Array<String>,\n       removed: Array<String>,\n     },\n     permissions: {\n       new: Array<String>,\n       removed: Array<String>,\n     },\n     min_sdk: Array<String>,\n     target_sdk: Array<String>,\n     method_reference_count: Integer,\n     dex_count: Integer,\n   }\n }\n\n @return [Hash]", "Create a new +Section+.\n\n @param  [String] name\n         see Section#name\n\n @param  [Hash] items\n         see Section#items\n\n @param  [Hash] options\n         see Section#options\n\n @return [XCRes::Section]", "Apply the configured exclude file patterns to a list of files\n\n @param [Array<Pathname>] file_paths\n        the list of files to filter\n\n @param [Array<Pathname>]\n        the filtered list of files", "Discover all references to files with a specific extension in project,\n which belong to a resources build phase of an application target.\n\n @param  [String] extname\n         the extname, which contains a leading dot\n         e.g.: '.bundle', '.strings'\n\n @return [Array<PBXFileReference>]", "Find files in resources build phases of application targets\n\n @return [Array<PBXFileReference>]", "find the real link for the shortened link key and redirect", "declares a class as ferret-searchable.\n\n ====options:\n fields:: names all fields to include in the index. If not given,\n          all attributes of the class will be indexed. You may also give\n          symbols pointing to instance methods of your model here, i.e.\n          to retrieve and index data from a related model.\n\n additional_fields:: names fields to include in the index, in addition\n                     to those derived from the db scheme. use if you want\n                     to add custom fields derived from methods to the db\n                     fields (which will be picked by aaf). This option will\n                     be ignored when the fields option is given, in that\n                     case additional fields get specified there.\n\n if:: Can be set to a block that will be called with the record in question\n      to determine if it should be indexed or not.\n\n index_dir:: declares the directory where to put the index for this class.\n             The default is Rails.root/index/Rails.env/CLASSNAME.\n             The index directory will be created if it doesn't exist.\n\n reindex_batch_size:: reindexing is done in batches of this size, default is 1000\n mysql_fast_batches:: set this to false to disable the faster mysql batching\n                      algorithm if this model uses a non-integer primary key named\n                      'id' on MySQL.\n\n ferret:: Hash of Options that directly influence the way the Ferret engine works. You\n          can use most of the options the Ferret::I class accepts here, too. Among the\n          more useful are:\n\n     or_default:: whether query terms are required by\n                  default (the default, false), or not (true)\n\n     analyzer:: the analyzer to use for query parsing (default: nil,\n                which means the ferret StandardAnalyzer gets used)\n\n     default_field:: use to set one or more fields that are searched for query terms\n                     that don't have an explicit field list. This list should *not*\n                     contain any untokenized fields. If it does, you're asking\n                     for trouble (i.e. not getting results for queries having\n                     stop words in them). Aaf by default initializes the default field\n                     list to contain all tokenized fields. If you use :single_index => true,\n                     you really should set this option specifying your default field\n                     list (which should be equal in all your classes sharing the index).\n                     Otherwise you might get incorrect search results and you won't get\n                     any lazy loading of stored field data.\n\n For downwards compatibility reasons you can also specify the Ferret options in the\n last Hash argument.", "helper to defines a method which adds the given field to a ferret\n document instance", "Creates dependencies for minke", "Writes the preview for this slide to disk.", "Check that mandatory parameters are not nil and contain valid values\n\n @return [Boolean] if configuration is valid", "Selects the ads with the matching title.\n\n @param [String, Regexp] title\n   The title to search for.\n\n @yield [ad]\n   Each matching ad will be passed to the given block.\n\n @yieldparam [SponsoredAd] ad\n   A sponsored ad with the matching title.\n\n @return [Array, Enumerator]\n   The sponsored ads with the matching title. If no block is given,\n   an Enumerator object will be returned.\n\n @example\n   sponsored.ads_with_title('be attractive')\n   # => SponsoredLinks\n\n @example\n   sponsored.ads_with_title(/buy me/) do |ad|\n     puts ad.url\n   end", "Selects the ads with the matching URL.\n\n @param [String, Regexp] url\n   The URL to search for.\n\n @yield [ad]\n   Each matching ad will be passed to the given block.\n\n @yieldparam [SponsoredAd] ad\n   A sponsored ad with the matching URL.\n\n @return [Array, Enumerator]\n   The sponsored ads with the matching URL. If no block is given,\n   an Enumerator object will be returned.\n\n @example\n   sponsored.ads_with_url(/\\.com/)\n   # => SponsoredLinks", "Selects the ads with the matching direct URL.\n\n @param [String, Regexp] direct_url\n   The direct URL to search for.\n\n @yield [ad]\n   Each matching ad will be passed to the given block.\n\n @yieldparam [SponsoredAd] ad\n   A sponsored ad with the matching direct URL.\n\n @return [Array, Enumerator]\n   The sponsored ads with the matching URL. If no block is given,\n   an Enumerator object will be returned.\n\n @example\n   sponsored.ads_with_direct_url(/\\.com/)\n   # => SponsoredLinks", "The aspect ratio of the deck.\n\n Returns a Symbol, either :widescreen or :standard (4:3).", "The top colors present in the title slide.\n\n This returns a Hash of the color (in RGB) and its percentage in the frame.\n For example:\n\n   {\n     [1, 1, 1]   => 0.7296031746031746,\n     [8, 12, 15] => 0.13706349206349205,\n     [ \u2026 ]\n   }", "Initialize a new ResourceImage\n\n @param  [Hash]\n         the initial attribute values\n\n Read from hash\n\n @param  [Hash]\n         the hash to deserialize\n\n @return [ResourceImage]", "Serialize to hash\n\n @return [Hash{String => String}]", "Instantiate and add an analyzer by its class.\n All properties will be copied to the child analyzer.\n\n @param [Class] analyzer_class\n        the class of the analyzer to instantiate and add\n\n @param [Hash] options\n        options which will be passed on initialization\n\n @return [Analyzer]", "Make a HTTP POST request.\n\n @param path [String] The path, relative to api_endpoint\n @param options [Hash] body params for request\n @return [Hashie::Mash]", "generate a url from either a url string, or a shortened url object", "The 'real' Ferret Index instance", "rebuilds the index from all records of the model classes associated with this index", "Parses the given query string into a Ferret Query object.", "Total number of hits for the given query.", "highlight search terms for the record with the given id.", "retrieves the ferret document number of the record with the given key.", "A long-term app_access_token might be supplied on connection parameters\n If not, we fetch a short-term one here.", "The regions affected by this suppression.\n\n @return [ActiveResource::PaginatedCollection<ESP::Region>]", "The external accounts affected by this suppression.\n\n @return [ActiveResource::PaginatedCollection<ESP::ExternalAccount>]", "The signatures being suppressed.\n\n @return [ActiveResource::PaginatedCollection<ESP::Signature>]", "The custom signatures being suppressed.\n\n @return [ActiveResource::PaginatedCollection<ESP::CustomSignature>]", "Create a suppression for this region.\n\n @param arguments [Hash] Required hash of region suppression attributes.\n   ===== Valid Arguments\n\n   See {API documentation}[http://api-docs.evident.io?ruby#suppression-create] for valid arguments\n @return [ESP::Suppression::Region]\n @example\n   suppress(external_account_ids: [5], reason: 'My very good reason for creating this suppression')", "Raises RuntimeError if this HelpLink is incorrectly configured.", "Sets the bot presence, status message and priority.", "Add a command alias for the given original +command_name+", "Add a command meta", "Returns the default help message describing the bot's command repertoire.\n Commands are sorted alphabetically by name, and are displayed according\n to the bot's and the commands's _public_ attribute.", "Creates a new Thread dedicated to listening for incoming chat messages.\n When a chat message is received, the bot checks if the sender is its\n master. If so, it is tested for the presence commands, and processed\n accordingly. If the bot itself or the command issued is not made public,\n a message sent by anyone other than the bot's master is silently ignored.\n\n Only the chat message type is supported. Other message types such as\n error and groupchat are not supported.", "Send request to server\n\n @overload request(command, payload)\n   @param [String, #to_s] command EPP Command to call\n   @param [XML::Node, XML::Document, String] payload EPP XML Payload\n @overload request(command)\n   @param [String, #to_s] command EPP Command to call\n   @yield [xml] block to construct payload\n   @yieldparam [XML::Node] xml XML Node of the command\n     for the payload to be added into\n @return [Response] EPP Response object\n def request(command, payload = nil, extension = nil, &block)\n   @req = if payload.nil? && block_given?\n     Request.new(command, req_tid, &block)\n   else\n     Request.new(command, payload, extension, req_tid)\n   end\n\n   @resp = send_recv_frame(@req)\n end\n @note Primarily an internal method, exposed to enable testing\n @param [] command\n @param [] extension\n @return [EPP::Request]\n @see request", "EPP Server Connection\n\n @yield connected session\n @example typical usage\n   connection do\n     # .. do stuff with logged in session ..\n   end\n @example usage with with_login\n   connection do\n     with_login do\n       # .. do stuff with logged in session ..\n     end\n   end", "Send XML frame\n @param [String,Request] xml Payload to send\n @return [Integer] number of bytes written", "Receive XML frame\n @return [String] XML response", "Calls the configured Markdown renderer, if none exists\n then uses `simple_format` to return more than nothing.", "Head SHA of default branch, used for creating new branches", "Name of branch to submit pull request from\n Starts with patch-1 and keeps going until it finds one not taken", "Create a pull request with the form contents", "Run a command, wait until it is done and continue", "Run a command, wait until it is done, then exit", "Run a command in the background, optionally log to a log file and save\n the process ID in a pid file", "Stop a command started with 'run_bg'. Provide the name of he pid file you\n used in 'run_bg'", "Start a console\n\n @return [void]", "Creates and returns an instance of the EPP 1.0 namespace\n\n @param [XML::Node] node to create the namespace on\n @param [String, nil] Name to give the namespace\n @return [XML::Namespace] EPP 1.0 namespace", "Creates and returns a new node in the EPP 1.0 namespace\n\n @param [String] name of the node to create\n @param [String,XML::Node,nil] value of the node\n @return [XML::Node]", "Creates and returns a new XML namespace\n\n @param [XML::Node] node XML node to add the namespace to\n @param [String] name Name of the namespace to create\n @param [String] uri URI of the namespace to create\n @return [XML::Namespace]", "Creates and returns a new XML document\n\n @param [XML::Document,String] obj Object to create the document with\n @return [XML::Document]", "Hook called when method is missing\n\n @param [Symbol] method_name\n\n @return [self]\n\n @api private", "Execute a command\n\n @param [Array<String>] args Arguments that will be used to execute the command\n @param [Hash] options Options for command execution\n\n @return [Integer] Exit code of the command execution", "Executes a command without handling error conditions\n\n @return [Integer] Exit code", "Start building a command line interface\n\n @param [Cliqr::CLI::Config] config the configuration options for the\n interface (validated using CLI::Validator)\n\n @return [Cliqr::CLI::ConfigBuilder]\n Validate and build a cli interface based on the configuration options\n\n @return [Cliqr::CLI::Interface]\n\n @throws [Cliqr::Error::ConfigNotFound] if a config is <tt>nil</tt>\n @throws [Cliqr::Error::ValidationError] if the validation for config fails", "Initialize all variables to sensible defaults.\n Load and execute a Runfile call.", "Add an action to the @actions array, and use the last known\n usage and help messages sent by the DSL.", "Add an option flag and its help text.", "Add a patameter and its help text.", "Run the command. This is a wrapper around docopt. It will\n generate the docopt document on the fly, using all the\n information collected so far.", "Loads the set of remote errors into the object's Errors based on the\n content-type of the error-block received.", "Locates a record from a given path, that consists of a slug and its scope,\n as would appear in a URL path component.\n\n @param [String] path The scope and slug concatenated together.\n @return [ActiveRecord::Base] The object with that slug.\n @raise [ActiveRecord::RecordNotFound] If no object with that slug is\n   found.", "Sends all commands at once and reads responses\n @return [Array] of responses", "if existing in params path then use that\n if it doesnt assume it is a full path and check that\n else fall back to convention, which also eventually gets checked in check_for_errors\n\n Type - :params or :template", "Returns String with value of \"yml\" or \"json\".", "Returns the +page_number+ page of data.\n\n Returns +self+ when +page_number+ == +#current_page_number+\n\n @param page_number [Integer] The page number of the data wanted. Must be between 1 and +#last_page_number+.\n @return [PaginatedCollection, self]\n @raise [ArgumentError] if no page number or an out-of-bounds page number is supplied.\n @example\n   alerts.current_page_number # => 5\n   page = alerts.page(2)\n   alerts.current_page_number # => 5\n   page.current_page_number # => 2", "Create a new runfile in the current directory. We can either\n create a standard 'Runfile' or a 'named.runfile'.", "Show some helpful tips, and a list of available runfiles", "Output the list of available runfiles", "Output the list of available runfiles without filename", "Prints a friendly output of the shortcut list", "Returns the list of runfiles, organized as columns based on the\n current terminal width", "Pass a json api compliant hash to the api.", "Initialize connection pool\n\n @param [Hash] options Connection options\n\n @option options [Float] :timeout (1.0) Connection acquisition timeout.\n @option options [Integer] :size Pool size.\n @option options [Hash] :connection see {Connection#initialize}\n Run commands on a connection from pool.\n Connection is wrapped to the {Session}.\n @yield [session] provide {Session} to a block\n @yieldreturn response from the last executed operation\n\n @example\n   pool = Oxblood::Pool.new(size: 8)\n   pool.with do |session|\n     session.set('hello', 'world')\n     session.get('hello')\n   end # => 'world'", "Return all docopt lines for the 'Usage' section", "Return all docopt lines for the 'Commands' section", "Return all docopt lines for the 'Examples' section", "Returns a `p.hint` used to explain a nearby form field containing\n the given `hint_text`.", "Creates a `searchable_select` that also shows a dynamic image preview of the selected record.\n Useful for previewing images or avatars chosen by name.\n `preview_url_method` should be a method name to call on the associated model instance\n that returns a fully-qualified URL to the image preview.", "Renders a Markdown composer element for editing `method`,\n with fullscreen previewing and some text assistance tools.\n Requires that you set `Tolaria.config.markdown_renderer`.\n Options are forwarded to `text_area`.", "Returns a file upload field with a more pleasant interface than browser\n file inputs. Changes messaging if the `method` already exists.\n Options are forwarded to the hidden `file_field`.", "Returns an image upload field with a more pleasant interface than browser\n file inputs. Changes messaging if the `method` already exists.\n\n #### Special Options\n\n - `:preview_url` If the file already exists, provide a URL to a 42\u00d742px\n   version of the image, and it will be displayed to the user in a preview\n   box to better communicate which file they are replacing.\n\n Other options are forwarded to the hidden `file_field`.", "Returns a text field that allows the user to input a date and time.\n Automatically validates itself and recovers to a template if blanked out.\n This field uses moment.js to parse the date and set the values on a\n set of hidden Rails `datetime_select` fields.\n Options are forwarded to the hidden `datetime_select` group.", "Returns a text field that parameterizes its input as users type\n and renders it into the given preview template. Useful for\n demonstrating the value of a URL or other sluggified text.\n\n #### Special Options\n\n - `:pattern` - Should be a string that includes an asterisk (`*`)\n   character. As the user types, the asterisk will be replaced with\n   a parameterized version of the text in the text box and shown\n   in a preview area below the field.\n   The default is `\"/blog-example/*\"`.\n\n Other options are forwarded to `text_field`.", "Returns a text field that expects to be given a 3 or 6-digit\n hexadecimal color value. A preview block near the field\n demonstrates the provided color to the user.\n Options are forwarded to `text_field`.", "Read until separator\n @param [String] separator separator\n @return [String] read result", "Write data to socket\n @param [String] data given\n @return [Integer] the number of bytes written", "Instance methods.", "Return violations for resource\n\n @param [Resource] resource\n\n @api private", "Convenience method to run a mounted filesystem to completion.\n\n @param [Array<String|Integer>] signals list of signals to handle.\n   Default is all available signals. See {#trap_signals}\n\n @return [void]\n @since 1.1.0\n @see RFuse.main", "Main processing loop\n\n Use {#exit} to stop processing (or externally call fusermount -u)\n\n Other ruby threads can continue while loop is running, however\n no thread can operate on the filesystem itself (ie with File or Dir methods)\n\n @return [void]\n @raise [RFuse::Error] if already running or not mounted", "Set debugging on or off\n @param [Boolean] value enable or disable debugging\n @return [Boolean] the new debug value\n @since 1.1.0", "Returns true if DOM is changed within the element.\n\n @example Wait until DOM is changed inside element with default delay\n   browser.div(id: 'test').wait_until(&:dom_changed?).click\n\n @example Wait until DOM is changed inside element with default delay\n   browser.div(id: 'test').wait_until do |element|\n     element.dom_changed?(delay: 5)\n   end\n\n @param delay [Integer, Float] how long to wait for DOM modifications to start", "Run this signature.\n Returns a collection of alerts.\n Throws an error if not successful.\n\n @param (see #run)\n @return [ActiveResource::PaginatedCollection<ESP::Alert>]\n @raise [ActiveResource::ResourceInvalid] if not successful.\n @example\n   signature = ESP::Signature.find(3)\n   alerts = signature.run!(external_account_id: 3, region: 'us_east_1')", "Run this signature.\n Returns a collection of alerts.\n If not successful, returns a Signature object with the errors object populated.\n\n @param arguments [Hash] Required hash of run arguments.\n   ===== Valid Arguments\n\n   See {API documentation}[http://api-docs.evident.io?ruby#signature-run] for valid arguments\n @return [ActiveResource::PaginatedCollection<ESP::Alert>, self]\n @example\n   signature = ESP::Signature.find(3)\n   alerts = signature.run(external_account_id: 3, region: 'us_east_1')", "Create a suppression for this signature.\n\n @param arguments [Hash] Required hash of signature suppression attributes.\n   ===== Valid Arguments\n\n   See {API documentation}[http://api-docs.evident.io?ruby#suppression-create] for valid arguments\n @return [ESP::Suppression::Signature]\n @example\n   suppress(regions: ['us_east_1'], external_account_ids: [5], reason: 'My very good reason for creating this suppression')", "The csv_data for the table fu instance is loaded either from the remote source or from a local\n file, depending on the keys present in the yaml file.", "The real +updated_at+ of a Table instance is the newer modification time of the csv file or\n the yaml file. Updates to either resource should break the cache.", "paginate uses TableFu's only! method to batch the table. It also computes the page attributes\n which are nil and meaningless otherwise.", "A convienence method to return the sort array for table setter.", "Returns the last-modified time from the remote server. Assumes the remote server knows how to\n do this. Returns the epoch if the remote is dense.", "Dispatches to web_modification_time if we're dealing with a url, otherwise just stats the\n local file.", "Receiver in XML form\n @return [XML::Document] XML of the receiver", "Response extension block\n @return [XML::Node, Array<XML::Node>] extension", "Uses the default Jekyll markdown parser to\n parse the contents of this block", "Watches a socket and produces an event when there's data available to read.\n\n Sockets which have previously had `Socket#listen` called fire events\n when there is an incoming connection pending.\n In this case, {Event#data} contains the size of the listen backlog.\n\n Other sockets return when there is data to be read,\n subject to the SO_RCVLOWAT value of the socket buffer.\n This may be overridden via the `low_water` parameter,\n which sets a new low-water mark.\n In this case, {Event#data} contains the number of bytes\n of protocol data available to read.\n\n If the read direction of the socket has shut down,\n then {Event#eof?} is set.\n It's possible for {Event#eof?} to be set while there's still\n data pending in the socket buffer.\n\n Note that this isn't compatible with JRuby\n unless a native-code file descriptor is passed in.\n This means the file descriptor must be returned by an FFI-wrapped C function.\n\n @param fd [Socket, Fixnum] A Ruby Socket, or the file descriptor\n   for a native Socket.\n @param low_water [Fixnum] The low-water mark for new data.\n @yield [event] A block that will be run when the specified socket\n   has data to read.\n @yieldparam event [Event] The Event object containing information\n   about the event that occurred.\n @return [Watcher] The Watcher for this event.\n @raise [SystemCallError] If something goes wrong when registering the Watcher.", "Watches a file or directory for changes.\n The `flags` parameter specifies which changes\n will fire events.\n\n The {Event#flags} field contains the changes that caused the event to be fired.\n {Event#data} and {Event#eof?} are unused.\n\n Note that this only watches a single file.\n If the file is a direcotry,\n it will only report changes to the directory itself,\n not to any files within the directory.\n\n ## Flags\n\n `:delete`\n : The file was deleted.\n\n `:write`\n : The file was modified.\n\n `:extend`\n : The size of the file increased.\n\n `:attrib`\n : Attributes of the file, such as timestamp or permissions, changed.\n\n `:link`\n : The link count of the file changed.\n\n `:rename`\n : The file was renamed.\n\n `:revoke`\n : Access to the file was revoked,\n   either via the `revoke(2)` system call\n   or because the underlying filesystem was unmounted.\n\n @param path [String] The path to the file or directory.\n @param flags [Array<Symbol>] Which events to watch for.\n @yield [event] A block that will be run when the file changes.\n @yieldparam event [Event] The Event object containing information\n   about the event that occurred.\n @return [Watcher] The Watcher for this event.\n @raise [SystemCallError] If something goes wrong when registering the Watcher.", "Watches a process for changes.\n The `flags` parameter specifies which changes\n will fire events.\n\n The {Event#flags} field contains the changes that caused the event to be fired.\n {Event#data} and {Event#eof?} are unused.\n\n ## Flags\n\n `:exit`\n : The process has exited.\n\n `:fork`\n : The process has created a child process via `fork(2)` or similar.\n\n `:exec`\n : The process has executed a new process via `exec(2)` or similar.\n\n `:signal`\n : The process was sent a signal.\n   This is only supported under Darwin/OS X.\n\n `:reap`\n : The process was reaped by the parent via `wait(2)` or similar.\n   This is only supported under Darwin/OS X.\n\n `:track`\n : Follow the process across `fork(2)` calls.\n   {Event#flags} for the parent process will contain `:fork`,\n   while {Event#flags} for the child process will contain `:child`.\n   If the system was unable to attach an event to the child process,\n   {Event#flags} will contain `:trackerr`.\n   This is not supported under Darwin/OS X.\n\n @param pid [Fixnum] The id of the process.\n @param flags [Array<Symbol>] Which events to watch for.\n @yield [event] A block that will be run when the process changes.\n @yieldparam event [Event] The Event object containing information\n   about the event that occurred.\n @return [Watcher] The Watcher for this event.\n @raise [SystemCallError] If something goes wrong when registering the Watcher.", "Calls the commonteamroster API and returns a CommonTeamRoster resource.\n\n @param team_id [Integer]\n @param season [String]\n @param league_id [String]\n @return [NbaStats::Resources::CommonTeamRoster]", "Converts an array or hash of names to a name for an input form.\n\n @example\n   build_name(:foo => :bar)            # => \"foo[bar]\"\n   build_name(:foo, :bar)              # => \"foo[bar]\"\n   build_name(:foo => {:bar => :baz})  # => \"foo[bar][baz]\"\n   build_name(:foo, :bar => :baz)      # => \"foo[bar][baz]\"\n\n @param [Array, Hash]  args  A hierarchy of strings.\n\n @return [String] The expected name of the form input.", "Calls the boxscoreadvanced API and returns a BoxScoreAdvanced resource.\n\n @param game_id [String]\n @param range_type [Integer]\n @param start_period [Integer]\n @param end_period [Integer]\n @param start_range [Integer]\n @param end_range [xxxxxxxxxx]\n @return [NbaStats::Resources::BoxScoreAdvanced]", "Calls the commonallplayers API and returns a CommonAllPlayers resource.\n\n @param season [String]\n @param is_only_current_season [Integer]\n @param league_id [String]\n @return [NbaStats::Resources::CommonAllPlayers]", "Calls the teaminfocommon API and returns a TeamInfoCommon resource.\n\n @param team_id [Integer]\n @param season [String]\n @param season_type [String]\n @param league_id [String]\n @return [NbaStats::Resources::TeamInfoCommon]", "Calls the teamyearbyyearstats API and returns a TeamYearByYearStats resource.\n\n @param team_id [Integer]\n @param season [String]\n @param per_mode [String]\n @param season_type [String]\n @param league_id [String]\n @return [NbaStats::Resources::TeamYearByYearStats]", "Calls the boxscoreusage API and returns a BoxScoreUsage resource.\n\n @param game_id [String]\n @param range_type [Integer]\n @param start_period [Integer]\n @param end_period [Integer]\n @param start_range [Integer]\n @param end_range [Integer]\n @return [NbaStats::Resources::BoxScoreUsage]", "Calls the draftcombineplayeranthro API and returns a DraftCombinePlayerAnthro resource.\n\n @param season_year [String]\n @param league_id [String]\n @return [NbaStats::Resources::DraftCombinePlayerAnthro]", "Most recent gem specifications of all wagons available in GEM_HOME.", "Update the Wagonfile with the given gem specifications.", "Remove the given gem specifications from the Wagonfile.", "Check if all wagon dependencies of the given gem specifications\n are met by the installed wagons.\n Returns nil if everything is fine or a string with error messages.", "Check if the app requirement of the given gem specifications\n are met by the current app version.\n Returns nil if everything is fine or a array with error messages.", "Checks if the wagons for given gem specifications are protected.\n Returns nil if everything is fine or a string with error messages.", "List of available gem specifications with the given names.\n Raises an error if a name cannot be found.", "Removes all gem specifications with the same name in to_be_excluded from full.\n Versions are ignored.", "The wagon class of the given spec.", "Calls the commonplayerinfo API and returns a CommonPlayerInfo resource.\n\n @param player_id [Integer]\n @param season_type [String]\n @param league_id [String]\n @return [NbaStats::Resources::CommonPlayerInfo]", "Calls the franchisehistory API and returns a FranchiseHistory resource.\n\n @param league_id [String]\n @return [NbaStats::Resources::FranchiseHistory]", "Calls the leaguedashlineups API and returns a LeagueDashLineups resource.\n\n @param season [String]\n @param group_quantity [Integer]\n @param measure_type [String]\n @param per_mode [String]\n @param plus_minus [String]\n @param pace_adjust [String]\n @param rank [String]\n @param outcome [String]\n @param location [String]\n @param month [Integer]\n @param season_segment [String]\n @param date_from [Date]\n @param date_to [Date]\n @param opponent_team_id [Integer]\n @param vs_conference [String]\n @param vs_division [String]\n @param game_segment [String]\n @param period [Integer]\n @param last_n_games [Integer]\n @param game_id [String]\n @param season_type [String]\n @param league_id [String]\n @return [NbaStats::Resources::LeagueDashLineups]", "Append wagons at the end of all railties, even after the application.", "Calls the homepageleaders API and returns a HomePageLeaders resource.\n\n @param season [String]\n @param season_type [String]\n @param league_id [String]\n @param game_scope [String]\n @param stat_category [String]\n @param player_scope [String]\n @param player_or_team [String]\n @return [NbaStats::Resources::HomePageLeaders]", "Calls the teamgamelog API and returns a TeamGameLog resource.\n\n @param team_id [Integer]\n @param season [String]\n @param season_type [String]\n @param league_id [String]\n @return [NbaStats::Resources::TeamGameLog]", "Calls the boxscorescoring API and returns a BoxScoreScoring resource.\n\n @param game_id [String]\n @param range_type [Integer]\n @param start_period [Integer]\n @param end_period [Integer]\n @param start_range [Integer]\n @param end_range [Integer]\n @return [NbaStats::Resources::BoxScoreScoring]", "Calls the draftcombinespotshooting API and returns a DraftCombineSpotShooting resource.\n\n @param season_year [String]\n @param league_id [String]\n @return [NbaStats::Resources::DraftCombineSpotShooting]", "Calls the commonteamyears API and returns a CommonTeamYears resource.\n\n @param league_id [String]\n @return [NbaStats::Resources::CommonTeamYears]", "Hands off the request to Faraday for further processing\n\n @param method [Symbol] the http method to call\n @param path [String] the url path to the resource\n @param params [Hash] optional additional url params\n @yield [Faraday::Response] for further request customizations.\n @return [Faraday::Response]\n @raises [DeskApi::Error::ClientError]\n @raises [DeskApi::Error::ParserError]", "Calls the shotchartdetail API and returns a ShotChartDetail resource.\n\n @param season [String]\n @param team_id [Integer]\n @param player_id [Integer]\n @param game_id [String]\n @param outcome [String]\n @param location [String]\n @param month [Integer]\n @param season_segment [String]\n @param date_from [Date]\n @param date_to [Date]\n @param opponent_team_id [Integer]\n @param vs_conference [String]\n @param vs_division [String]\n @param position [String]\n @param rookie_year [String]\n @param game_segment [String]\n @param period [Integer]\n @param last_n_games [Integer]\n @param context_filter [String]\n @param context_measure [String]\n @param season_type [String]\n @param league_id [String]\n @return [NbaStats::Resources::ShotChartDetail]", "Returns the middleware proc to be used by Faraday\n\n @return [Proc]", "Resets the client to the default settings.\n\n @return [DeskApi::Client]", "Raises an error if credentials are not set or of\n the wrong type.\n\n @raise [DeskApi::Error::ConfigurationError]", "Experimental Implementation.\n DO NOT USE THIS METHOD", "Takes an identifier token, and tranforms its type to\n match Ruby keywords where the identifier is actually a keyword.\n Reserved words are defined in S.8.5.1 of the Ruby spec.", "Perform a HTTP GET request\n\n @param path [String]\n @param params [Hash]\n @return [Hash]", "Send the HTTP request\n\n @param method [String]\n @param path [String]\n @return [RestClient::Response]", "Calls the draftcombinestats API and returns a DraftCombineStats resource.\n\n @param season_year [String]\n @param league_id [String]\n @return [NbaStats::Resources::DraftCombineStats]", "Calls the playerdashboardbygeneralsplits API and returns a PlayerDashboardByGeneralSplits resource.\n\n @param season [String]\n @param player_id [Integer]\n @param date_from [Date]\n @param date_to [Date]\n @param game_segment [String]\n @param last_n_games [Integer]\n @param league_id [String]\n @param location [String]\n @param measure_type [String]\n @param month [Integer]\n @param opponent_team_id [Integer]\n @param outcome [String]\n @param pace_adjust [String]\n @param per_mode [String]\n @param period [Integer]\n @param plus_minus [String]\n @param rank [String]\n @param season_segment [String]\n @param season_type [String]\n @param vs_conference [String]\n @param vs_division [String]\n @return [NbaStats::Resources::PlayerDashboardByGeneralSplits]", "Joins multiple strings into a sentence with punctuation and conjunctions.\n\n @example Forming sentences\n   make_sentence(\"foo\")                # => \"foo\"\n   make_sentence(\"foo\", \"bar\")         # => \"foo and bar\"\n   make_sentence(\"foo\", \"bar\", \"baz\")  # => \"foo, bar, and baz\"\n\n @example Overriding the conjunction\n   make_sentence(\"foo\", \"bar\", \"baz\", :conjunction => \"or\")  # => \"foo, bar, or baz\"\n\n @param [Strings] *strings   A list of strings to be combined into a sentence. The last item\n                             can be an options hash.\n\n @option *strings.last [String] :conjunction (\"and\")   The conjunction to use to join sentence\n                                                       fragments.\n\n @return [String]", "Delegates missing instance methods to the source object.", "Calls the boxscorefourfactors API and returns a BoxScoreFourFactors resource.\n\n @param game_id [String]\n @param range_type [Integer]\n @param start_period [Integer]\n @param end_period [Integer]\n @param start_range [Integer]\n @param end_range [Integer]\n @return [NbaStats::Resources::BoxScoreFourFactors]", "Answers whether or not the matcher matches any elements within +rendered+.\n\n @param [String] rendered    A string of HTML or an Object whose +to_s+ method returns HTML.\n                             (That includes Nokogiri classes.)\n\n @return [Boolean]", "Describes a group of attribute criteria, combining them into a sentence fragment, with\n punctuation and conjunctions if necessary.\n\n @param [Array] attributes   A list of <tt>[key, value]</tt> pairs that describe the attribute\n                             criteria.\n\n @return [String]", "Calls the playerprofile API and returns a PlayerProfile resource.\n\n @param player_id [Integer]\n @param season [String]\n @param graph_start_season [String]\n @param graph_end_season [String]\n @param graph_stat [String]\n @param season_type [String]\n @param league_id [String]\n @return [NbaStats::Resources::PlayerProfile]", "Calls the playercareerstats API and returns a PlayerCareerStats resource.\n\n @param player_id [Integer]\n @param per_mode [String]\n @param league_id [String]\n @return [NbaStats::Resources::PlayerCareerStats]", "If a block is given, it gets run after the final delimiter is detected. The\n primary purpose for this is to allow the capture of regex modifiers", "Called from tokenize_lt_operators when it identifies that\n << is a heredoc delimiter. Expects that '<<' will already\n be included in the current thunk.", "Returns a hash based on the current definition of the resource\n\n @return [Hash] definition hash", "Checks if this resource responds to a specific method\n\n @param method [String/Symbol]\n @return [Boolean]", "Returns the embedded resource\n\n @param method [String/Symbol]\n @return [DeskApi::Resource]", "Returns the linked resource\n\n @param method [String/Symbol]\n @return [DeskApi::Resource]", "Returns the requested embedded resource, linked resource or field value,\n also allows to set a new field value\n\n @param method [String/Symbol]\n @param args [Mixed]\n @param block [Proc]\n @return [Mixed]", "Calls the leaguedashplayerstats API and returns a LeagueDashPlayerStats resource.\n\n @param season [String]\n @param measure_type [String]\n @param per_mode [String]\n @param plus_minus [String]\n @param pace_adjust [String]\n @param rank [String]\n @param outcome [String]\n @param location [String]\n @param month [Integer]\n @param season_segment [xxxxxxxxxx]\n @param date_from [Date]\n @param date_to [Date]\n @param opponent_team_id [Integer]\n @param vs_conference [String]\n @param vs_division [String]\n @param game_segment [String]\n @param period [Integer]\n @param last_n_games [Integer]\n @param game_scope [String]\n @param player_experience [String]\n @param player_position [String]\n @param starter_bench [String]\n @param conf [String]\n @param season_type [String]\n @param league_id [String]\n @return [NbaStats::Resources::LeagueDashPlayerStats]", "Calls the boxscore API and returns a BoxScore resource.\n\n @param game_id [String]\n @param range_type [Integer]\n @param start_period [Integer]\n @param end_period [Integer]\n @param start_range [Integer]\n @param end_range [Integer]\n @return [NbaStats::Resources::BoxScore]", "Determines if the user has all of the given roles linked to it.\n\n @param [String] args an argument list of one or more roles to check for.\n @return [true|false] true if the user is linked to all of the given roles.", "Determines if the user has permission to a given action. If the action\n does not exist at all, it is assumed the action is publicly available.\n\n @param [String] action name of the action to check permission for.\n @return [true|false] true if the user has at least one role linked to it\n   with permission to the given action.", "Calls the scoreboard API and returns a Scoreboard resource.\n\n @param game_date [Date]\n @param day_offset [Integer]\n @param league_id [String]\n @return [NbaStats::Resources::Scoreboard]", "grab the keyword form request url", "Get Redis that user might be using or instantiate\n a new one", "Calls the draftcombinedrillresults API and returns a DraftCombineDrillResults resource.\n\n @param season_year [String]\n @param league_id [String]\n @return [NbaStats::Resources::DraftCombineDrillResults]", "Calls the playbyplay API and returns a PlayByPlay resource.\n\n @param game_id [String]\n @param start_period [Integer]\n @param end_period [Integer]\n @return [NbaStats::Resources::PlayByPlay]", "Returns a C struct corresponding to this watcher.\n\n @param flags [Array<Symbol>] Flags for the C struct's `flags` field,\n   in addition to the `@flags` var.\n @return [Native::KEvent]", "Runs the `kevent` C call with this Watcher's kevent struct as input.\n This effectively means telling kqueue to perform some action\n with this Watcher as an argument.\n\n @param flags [Array<Symbol>] Flags specifying the action to perform\n   as well as any additional flags.\n @return [void]\n @raise [SystemCallError] If something goes wrong when performing the C call.", "Calls the draftcombinenonstationaryshooting API and returns a DraftCombineNonStationaryShooting resource.\n\n @param season_year [String]\n @param league_id [String]\n @return [NbaStats::Resources::DraftCombineNonStationaryShooting]", "Converts foo_bar_param to fooBarParam.", "Calls the boxscoremisc API and returns a BoxScoreMisc resource.\n\n @param game_id [String]\n @param range_type [Integer]\n @param start_period [Integer]\n @param end_period [Integer]\n @param start_range [Integer]\n @param end_range [Integer]\n @return [NbaStats::Resources::BoxScoreMisc]", "Calls the leaguedashteamstats API and returns a LeagueDashTeamStats resource.\n\n @param date_from [Date]\n @param date_to [Date]\n @param game_scope [String]\n @param game_segment [String]\n @param last_n_games [Integer]\n @param league_id [String]\n @param location [String]\n @param measure_type [String]\n @param month [Integer]\n @param opponent_team_id [String]\n @param outcome [String]\n @param pace_adjust [String]\n @param per_mode [String]\n @param period [Integer]\n @param player_experience [String]\n @param player_position [String]\n @param plus_minus [String]\n @param rank [String]\n @param season [String]\n @param season_segment [String]\n @param season_type [String]\n @param starter_bench [String]\n @param vs_conference [String]\n @param vs_division [String]\n @return [NbaStats::Resources::LeagueDashTeamStats]", "Calls the playergamelog API and returns a PlayerGameLog resource.\n\n @param league_id [String]\n @param player_id [Integer]\n @param season [String]\n @param season_type [String]\n @return [NbaStats::Resources::PlayerGameLog]", "Initializes a matcher that matches multiple input elements.\n\n @param [Hash] components  A hash of matchers. The keys should be the keys used in Rails'\n                           multi-parameter assignment, e.g., <tt>\"1i\"</tt>, <tt>\"2s\"</tt>, etc,\n                           and the values are the matchers that must be satisfied.\n Tests whether the matcher matches the +rendered+ string. It delegates matching to its\n matchers. It returns true if all of its matchers return true. It returns false if *any* of its\n matchers return false.\n\n @param [String] rendered  A string of HTML or an Object whose +to_s+ method returns HTML.\n                           (That includes Nokogiri classes.)\n\n @return [Boolean]", "Specifies the inputs' names with more accuracy than the default regular expressions. It\n delegates to each matcher's +for+ method. But it first appends the matcher's key to the last\n component of the input's name.\n\n @example Input naming delegation\n   hour_matcher   = HasSelect.new\n   minute_matcher = HasSelect.new\n   time_matcher   = MultipleInputMatcher.new('4i' => hour_matcher, '5i' => minute_matcher)\n\n   time_matcher.for(:event => :start_time) # calls hour_matcher.for(\"event\", \"start_time(4i)\")\n                                           # and minute_matcher.for(\"event\", \"start_time(5i)\")\n\n @param [Array, Hash]  args  A hierarchy of string that specify the attribute name.\n\n @return [MultipleInputMatcher] self", "Set's +matcher+'s input name according to +args+ and +key+.\n\n @param [String]       key     The matcher's key.\n @param [HasInput]     matcher The matcher.\n @param [Arrah, Hash]  args    A hierarchy of names that would normally be passed to\n                               {HasInput#for}.", "Check that we are in a git repo that we have write access to.\n\n @api private\n @return [void]", "Get the current branch but raise an error if it looks like we're on a detched head.\n\n @api private\n @return [String]", "Check if a commit or commit message is already signed off.\n\n @api private\n @param commit_or_message [String, Git::Commit] Commit object or message string.\n @return [String, nil]", "Methods for generating modified binary.", "Accessor for column and rows\n @example\n   df = DataFrame.new({a: [1, 2, 3], b: [2, 3, 4]})\n   df[0..1].to_json #-> {a: [1, 2], b: [2, 3]}\n   df[:a] #-> <Mikon::Series>", "Access column with its name", "IRuby notebook automatically call this method", "Sort by label\n @param [Symbol] label column name to sort by\n @param [Bool] ascending default true", "Access row using index", "Match a yield with a explicit or implicit target\n\n yield target\n\n @param parent [Node] Parent node to which we append the definition", "The actual action method for creating new resource.", "Check whether the given column is a reflection or not.", "Transforms a response into one object based on the response's body.\n\n If you pass a hash like this:\n\n   { 200 => ProductCreated, 202 => ProductAccepted }\n\n the transformation will decide which object to create based on the status.\n\n It's important to note that the class must provide attribute writers for this method to be\n able to fill an object with the responses's body data.\n\n @param entity_class_or_decider [Hash, Class] A class or a hash of Fixnum => Class\n   to decide with the status.\n @param root [String, nil] The root to use to get the object from the body.\n\n @return [Object] The result of the transformation.", "Transforms a response into many objects based on the response's body.\n\n @param entity_class_or_decider [Hash, Class] A class or a hash of Fixnum => Class\n   to decide with the status.\n @param root [String, nil] The root to use to get an array from the body.\n\n @return [Array<Object>] The result of the transformation.", "Enqueue an url, no matter what", "URLs enqueue policy", "It extracts URLs from the page", "whether a page is expired or not", "whether a page exists or not", "The url is enqueued for a later visit", "It invokes a plugin method if any", "returns true if the default url option should be set for this request", "It's totally obviuse. Join the guest group if no group provided", "Base class for all the DSL property classes to be\n used as the yielded object inside each section DSL\n scope.\n\n For example the below code will yield an instance of\n one of this class children.\n\n  in_index do\n    # This will yield an instance of this class child\n  end\n\n The most important note in this class is that all the public\n methods that their name starts with an underscore (_) not meant to\n be used as DSL.\n Allow user to specify an array of model attributes to be used\n in respected section. For example attributes to show as header\n columns in index section", "Replace foreign key names with their reflection names\n and create an array of model fields", "Return a boolean indicating whether the Rails constant is defined.\n It cannot identify Rails < 2.1\n\n Example:\n rails?(3) => true if Rails major version is 3\n rails?(3.0) => true if Rails major.minor version is 3.0\n rails?(:>=, 3) => true if Rails major version is >= 3\n rails?(:>=, 3.1) => true if Rails major.minor version is >= 3.1", "Include framework hooks for Rails\n\n This method is called by <tt>init.rb</tt>, which is run by Rails on startup.\n\n Customize rendering.  Include custom headers and don't render the layout for AJAX.\n Insert the Rack::Ajax middleware to rewrite and handle requests.\n Add custom attributes to outgoing links.\n\n Hooks for Rails 3 are installed using Railties.", "Evaluate the embedded ruby code using the current context\n\n @param node [Array] Node code generation data\n @param indent [Fixnum] Size of the indentation to be added", "Allow localized scope", "This method allow user to define his routes in api\n namespace", "A convenience accessor to get a hash representation of the\n current state of the configuration\n @return [Hash] the configuration in hash form", "A convenience accessor to instantiate a configuration from a hash\n @param [Hash] h the hash to read into the configuration\n @return [Configuration] the configuration with values assigned\n @raise [ConfigurationError] if the given hash ambiguous values\n     - string and symbol keys with the same string value pointing to\n     different values", "Generate the code for a if-elsif-else control structure\n\n @param node [Array] Node code generation data\n @param indent [Fixnum] Size of the indentation to be added", "Generate the code for a unless-else control structure\n\n @param node [Array] Node code generation data\n @param indent [Fixnum] Size of the indentation to be added", "Generate the code for a case-when-else control structure\n\n @param node [Array] Node code generation data\n @param indent [Fixnum] Size of the indentation to be added", "Generate a comment", "Check if we match an node node with its attributes and possibly\n inline text\n\n node [ attributes ] Inline text\n\n @param parent [Node] Parent node to which we append the node", "Accept node shorthand attributes. Each shorthand attribute is directly\n mapped to an attribute key\n\n @param atts [Hash] Node attributes", "Get element attributes\n\n @param atts [Hash] Accumulator for node attributes\n @param for_definition [Boolean] Set default value in wrapped to nil", "Check if we match node attributes\n\n [ assignments ]\n\n @param as_parameters [Boolean] Accept or reject identifier nodes", "Get all attribute assignments as key=value pairs or standalone keys\n\n [ assignments ]\n\n @param list [Hash] Parent to which we append nodes\n @param as_parameters [Boolean] Accept or reject identifier nodes", "Extend node attributes with hash from\n\n +value\n +{hash: \"value\"}\n +(paranthesis)", "Analyze the input code and check for matching tokens.\n In case no match was found, throw an exception.\n In special cases, modify the token hash.\n\n @param parent [Array] Parent node to which we append to", "Write out definition node using ruby def\n\n @param node [Node] Current node data with options", "Respond to missing according to the method_missing implementation", "Set each node as a defined node if a definition exists with the given\n node name, unless we're inside a definition with the same name as the node\n because we want to avoid recursion.\n\n @param node [Node] Input Node to checked for existence of definitions", "Check and accept or reject a given token as long as we have tokens\n remaining. Shift the code with the match length plus any extra character\n count around the capture group\n\n @param token [RegEx] Token to be accepted by the parser\n @param required [Boolean] Expect the given token syntax\n @param strip [Boolean] Left strip the current code to remove whitespace", "Indent all lines of the input text using give indentation\n\n @param text [String] Input text to be indented\n @param indent [String] Indentation string to be appended", "Executes block with the access token\n\n @param [String||Symbol] resource_name name of the resource to execute over\n @param [String||Symbol] action name of the action to execute over\n @param [Hash] options for the execution\n @return the execution return or nil", "Omniauth users does not need password", "Returns a blop with the file data\n\n @param [String] style The style to use\n @param [String] path The path to save the file to\n @return [String] the object metadata", "Update render settings\n\n @param input [Symbol/String] Input code or file\n @param settings [Hash] Opulent settings override\n\n Avoid code duplication when layouting is set. When we have a layout, look\n in layouts/application by default.\n\n @param scope [Object] Template evaluation context\n @param locals [Hash] Render call local variables\n @param block [Proc] Processing environment data", "Read input as file or string input\n\n @param input [Object]", "Add .op extension to input file if it isn't already set.\n\n @param input [Symbol] Input file", "Turn call node attributes into a hash string\n\n @param attributes [Array] Array of node attributes", "Go through the node attributes and apply extension where needed\n\n @param attributes [Array] Array of node attributes, from parser\n @param extension [String] Extension identifier", "Split a string by its interpolation, then check if it really needs to be\n escaped or not. Huge performance boost!\n\n @param string [String] Input string\n @param escape [Boolean] Escape string\n\n @ref slim-lang Thank you for the interpolation code", "Evaluates configurable properties and passes eventual hashes\n down to subconfigurations", "Assigns a value after running the assertions\n @param [Symbol] property the property to type test\n @param [Any] value the given value", "Generate an element.\n\n With two arguments, it generates an element with the specified text content.\n\n   r.element :size, 42\n   # => <size>42</size>\n\n More commonly, though, the second argument is omitted, in which case the\n element content is assumed to be the named property of the current #subject.\n\n   r.representing my_shoe do\n     r.element :size\n   end\n   # => <size>9</size>\n\n If a block is attached, nested elements can be generated.  The element \"value\"\n (whether explicitly provided, or derived from the current subject) becomes the\n subject during evaluation of the block.\n\n   r.element :book, book do\n     r.title\n     r.author\n   end\n   # => <book><title>Whatever</title><author>Whoever</author></book>\n\n Providing a final Hash argument specifies element attributes.\n\n   r.element :size, :type => \"integer\"\n   # => <size type=\"integer\">9</size>", "Generate a list of elements from Enumerable data.\n\n   r.list_of :books, my_books do\n     r.element :title\n   end\n   # => <books type=\"array\">\n   #      <book><title>Sailing for old dogs</title></book>\n   #      <book><title>On the horizon</title></book>\n   #      <book><title>The Little Blue Book of VHS Programming</title></book>\n   #    </books>\n\n Like #element, the value can be explicit, but is more commonly extracted\n by name from the current #subject.", "Check if the parser matches an expression node", "Recursively gather expressions separated by a comma and add them to the\n expression buffer\n\n experssion1, experssion2, experssion3\n\n @param buffer [String] Accumulator for the array elements", "Accept a ruby method call modifier", "Recursively gather expression attributes separated by a comma and add\n them to the expression buffer\n\n expression1, a: expression2, expression3\n\n @param buffer [String] Accumulator for the call elements", "Accept a ruby symbol defined through a colon and a trailing expression\n\n :'symbol'\n :symbol", "Accept ternary operator syntax\n\n condition ? expression1 : expression2", "Convert the Ajax-Info hash to JSON before the request is sent.\n Invoked as an after filter.\n\n Adds the current +layout+ and +controller+ to the hash.\n These values will be sent in future requests using the Ajax-Info header.\n\n +controller+ is the result of calling ActionController#controller_name, so\n if your controller is ApplicationController the value will be <tt>'application'</tt>.\n\n +layout+ is the name of the layout without any path or extension.  So for example if\n layouts/simple.html.erb or layouts/ajax/simple.html.erb are rendered the\n value of +layout+ would be <tt>'simple'</tt> in both cases.", "Return the layout to use for an AJAX request, or nil if the default should be used.\n\n If no ajax_layout is set, look for the default layout in <tt>layouts/ajax</tt>.\n If the layout cannot be found, use the default.", "Check if we match an compile time filter\n\n :filter\n\n @param parent [Node] Parent node to which we append the element", "Generate the code for a standard text node\n\n @param node [Array] Node code generation data\n @param indent [Fixnum] Size of the indentation to be added", "Check if we have an include node, which will include a new file inside\n of the current one to be parsed\n\n @param parent [Array] Parent node to which we append to", "Parses UNIX timestamps and creates Time objects.", "Generate the code for a standard node element, with closing tags or\n self enclosing elements\n\n @param node [Array] Node code generation data\n @param indent [Fixnum] Size of the indentation to be added", "Before we save this model, make sure each flex column has a chance to serialize itself up and assign itself\n properly to this model object. Note that we only need to call through to flex-column objects that have actually\n been instantiated, since, by definition, there's no way the contents of any other flex columns could possibly\n have been changed.", "Returns the correct flex-column object for the given column name. This simply creates an instance of the\n appropriate flex-column class, and saves it away so it will be returned again if someone requests the object for\n the same column later.\n\n This method almost never gets invoked directly; instead, everything calls it via\n FlexColumns::ActiveRecord::Base#_flex_column_object_for.", "Check if we match a new node definition to use within our page.\n\n Definitions will not be recursive because, by the time we parse\n the definition children, the definition itself is not in the\n knowledgebase yet.\n\n However, we may use previously defined nodes inside new definitions,\n due to the fact that they are known at parse time.\n\n @param nodes [Array] Parent node to which we append to", "Convert the environment hash to yaml so it can be unserialized later", "Return asset paths for a particular webpack entry point.\n\n Response may either be full URLs (eg http://localhost/...) if the dev server\n is in use or a host-relative URl (eg /webpack/...) if assets are precompiled.\n\n Will raise an error if our manifest can't be found or the entry point does\n not exist.", "Checks for existence of a cookbook file or template source in a cookbook.\n @param [String] source name of the desired template or cookbook file source\n @param [Symbol] segment `:files` or `:templates`\n @param [String, nil] cookbook to look in, defaults to current cookbook\n @return [String, nil] full path to the source or `nil` if it doesn't exist\n @example\n   has_source?(\"foo.erb\", :templates)\n   has_source?(\"bar.conf\", :files, \"a_cookbook\")", "All system commands are prefixed with an underscore.", "Create a context from the environment binding, extended with the locals\n given as arguments\n\n @param locals [Hash] Binding extension\n @param block [Binding] Call environment block\n @param content [Binding] Content yielding\n\n Evaluate ruby code in current context\n\n @param code [String] Code to be evaluated", "Extend the call context with a Hash, String or other Object\n\n @param context [Object] Extension object", "Extend instance, class and global variables for use in definitions\n\n @param bind [Binding] Binding to extend current context binding", "Allow user to specify an array of model attributes to be used\n in respected section. For example attributes to show as header\n columns in index section", "Fetch all or part of the corresponding resource\n from data base with respect to `scope` DSL.\n\n The important thing here is that by using `scope`\n DSL this method will chain the resulted scope\n with other scopes like `page` and `policy_scope`", "Actual match code", "Match an if-else control structure", "Sleep for the amount of time necessary to obey the Crawl-Delay specified by the server", "Translate route name to url dynamically", "The workhorse.  Will pass all requred_param_values to the configured authenticate_method\n @see WardenStrategies::Simple.config\n @see Warden::Strategy::Base#authenticate!\n @api private", "Creates current invoice at API.\n\n API method: <tt>POST /charge-accounts/:uuid/invoices/</tt>\n\n API documentation: https://charging.financeconnect.com.br/static/docs/charges.html#post-charge-accounts-uuid-invoices", "List all payments for an invoice\n\n API method: <tt>GET /invoices/:uuid/payments/</tt>\n\n API documentation: https://charging.financeconnect.com.br/static/docs/charges.html#get-invoices-uuid-payments", "Returns a String with the temporary URL for print current invoice.\n\n API method: <tt>GET /invoices/:uuid/billet/</tt>\n\n API documentation: https://charging.financeconnect.com.br/static/docs/charges.html#get-invoices-uuid-billet", "Get resource participants tags\n\n [API]\n   Method: <tt>GET /api/v1/reimbursements/:id/participants</tt>\n   Method: <tt>GET /api/v1/expenses/:id/participants</tt>\n   Method: <tt>GET /api/v1/advancements/:id/participants</tt>\n\n   Documentation: http://developers.rexpense.com/api/participants#index\n   Documentation: http://developers.rexpense.com/api/expense_participants#index\n   Documentation: http://developers.rexpense.com/api/reimbursement_participants#index", "Update an attribute on charge account at API.\n\n API method: <tt>PATCH /charge-accounts/:uuid/</tt>\n\n API documentation: https://charging.financeconnect.com.br/static/docs/charges.html#patch-charge-accounts-uuid", "Get organization memberships\n\n [API]\n   Method: <tt>GET /api/v1/organizations/:id/memberships</tt>\n\n   Documentation: http://developers.rexpense.com/api/memberships#index", "Create organization membership\n\n [API]\n   Method: <tt>POST /api/v1/organizations/:id/memberships</tt>\n\n   Documentation: http://developers.rexpense.com/api/memberships#create", "Update organization membership\n\n [API]\n   Method: <tt>PUT /api/v1/organizations/:id/memberships/:membership_id</tt>\n\n   Documentation: http://developers.rexpense.com/api/memberships#update", "Get resource attachments\n\n [API]\n   Method: <tt>GET /api/v1/expenses/:id/attachments</tt>\n\n   Documentation: http://developers.rexpense.com/api/attachments#index", "Get resource attachment\n\n [API]\n   Method: <tt>GET /api/v1/expenses/:id/attachments/:id</tt>\n\n   Documentation: http://developers.rexpense.com/api/attachments#show", "Get resource comments\n\n [API]\n   Method: <tt>GET /api/v1/reimbursements/:id/comments</tt>\n   Method: <tt>GET /api/v1/expenses/:id/comments</tt>\n   Method: <tt>GET /api/v1/advancements/:id/comments</tt>\n\n   Documentation: http://developers.rexpense.com/api/comments#index", "Get resource comment\n\n [API]\n   Method: <tt>GET /api/v1/reimbursements/:id/comments/:comment_id</tt>\n   Method: <tt>GET /api/v1/expenses/:id/comments/:comment_id</tt>\n   Method: <tt>GET /api/v1/advancements/:id/comments/:comment_id</tt>\n\n   Documentation: http://developers.rexpense.com/api/comments#show", "Create resource comment\n\n [API]\n   Method: <tt>POST /api/v1/reimbursements/:id/comments</tt>\n   Method: <tt>POST /api/v1/expenses/:id/comments</tt>\n   Method: <tt>POST /api/v1/advancements/:id/comments</tt>\n\n   Documentation: http://developers.rexpense.com/api/comments#create", "Update resource comment\n\n [API]\n   Method: <tt>PUT /api/v1/reimbursements/:id/comments/:comment_id</tt>\n   Method: <tt>PUT /api/v1/expenses/:id/comments/:comment_id</tt>\n   Method: <tt>PUT /api/v1/advancements/:id/comments/:comment_id</tt>\n\n   Documentation: http://developers.rexpense.com/api/comments#update", "synchronize EPP key with Registry, and optionally email it to owner", "Make another API call to get all domain info. Often necessary when domains are\n found using Domain.all instead of Domain.find.", "Restore the revision to the original record. If any errors are encountered restoring attributes, they\n will be added to the errors object of the restored record.", "Restore a record and all its associations.", "Standardizes the XML response by converting fields to integers\n and forcing the order summaries into an array.", "Adds the required security credentials and formats\n the message to match the ShipCompliant structure.\n\n   ShipCompliant.client.call(:some_operation, {\n     'SomeKey' => 'SomeValue'\n   })", "Displays a confirmation message showing the configuration of the\n Elastic MapReduce job flow and cluster.", "Calls the Elastic MapReduce API to create a Job Flow. Returns the Job Flow ID.", "Renders scatter graph.", "Render area graph.", "Register a new user or show errors", "Build the environment hash by extracting the environment\n variables from the provided travis environment and merging\n with any provided overrides", "Extract environment variables from a value\n The value is expected to be either a hash or a string with\n one or more key value pairs on the form\n   KEY=VALUE", "Extract variables from a string on the form\n   KEY1=VALUE1 KEY2=\"VALUE2\"\n Optional quoting around the value is allowed", "Inject this instance for Chef < 12.3. Don't call this on newer Chef.\n\n @api private\n @see Base.install\n @return [void]", "redefine this method for your controller if you want to provide custom error pages\n returns response array for rack\n if you need to change just body of error message, define render_http_error method\n @api plugin", "return the record IDs used", "Load a revision for a record with a particular id. Associations added since the revision\n was created will still be in the restored record.\n If you want to save a revision with associations properly, use restore_revision!", "Load a revision for a record with a particular id and save it to the database. You should\n always use this method to save a revision if it has associations.", "Load the last revision for a record with the specified id and save it to the database. You should\n always use this method to save a revision if it has associations.", "Returns a hash structure used to identify the revisioned associations.", "Call this method to implement revisioning. The object changes should happen inside the block.", "Create a revision record based on this record and save it to the database.", "Set an attribute based on a meta argument", "An array of +ErrorResult+ items or an empty array if the response was\n successful.\n\n   result.errors.each do |error|\n     puts \"#{error.message} [#error.key]\"\n   end", "Writer defined below\n Returns a new Graph.  You can optionally pass in a default graph type and an options hash.\n\n   Graph.new           # New graph\n   Graph.new(:line)    # New graph with default graph type of Line\n   Graph.new({...})    # New graph with options.\n\n Options:\n\n title::  Graph's title\n x_legend :: Title for X Axis\n y_legend :: Title for Y Axis\n theme::  A theme object to use when rendering graph\n layers::  An array of Layers for this graph to use\n default_type::  A symbol indicating the default type of Layer for this graph\n value_formatter::   Sets a formatter used to modify marker values prior to rendering\n point_markers::  Sets the x-axis marker values\n point_markers_rotation::  Sets the angle of rotation for x-axis marker values\n point_markers_ticks::  Sets a small tick mark above each marker value.  Helful when used with rotation.\n rasterizer::  Sets the rasterizer to use when rendering to an image format.  Defaults to RMagick.\n Renders the graph in it's current state to an SVG object.\n\n Options:\n size:: An array indicating the size you wish to render the graph.  ( [x, y] )\n width:: The width of the rendered graph.  A height is calculated at 3/4th of the width.\n theme:: Theme used to render graph for this render only.\n min_value:: Overrides the calculated minimum value used for the graph.\n max_value:: Overrides the calculated maximum value used for the graph.\n renderer:: Provide a Renderer object to use instead of the default.\n\n For other image formats:\n as:: File format to render to ('PNG', 'JPG', etc)\n to:: Name of file to save graph to, if desired.  If not provided, image is returned as blob/string.", "Returns new Stacked graph.\n\n You can provide a block for easily adding layers during (just after) initialization.\n Example:\n   Stacked.new do |stacked|\n     stacked << Scruffy::Layers::Line.new( ... )\n     stacked.add(:bar, 'My Bar', [...])\n   end\n\n The initialize method passes itself to the block, and since stacked is a LayerContainer,\n layers can be added just as if they were being added to Graph.\n Overrides Base#render to fiddle with layers' points to achieve a stacked effect.", "A stacked graph has many data sets.  Return legend information for all of them.", "Renders the graph and all components.", "Populates the job from the list of segments to be parsed.", "Runs the job by calling Elastic MapReduce API.  If successful the\n parse time is set for each segment.", "Return list of segment descriptions.", "Sets the job description which forms part of the Elastic MapReduce\n job flow name.", "Here for the moment for benchmark comparisons", "Renders line graph.\n\n Options:\n See initialize()", "Returns the status of the current crawl.", "Creates crawl segments from the warc.paths file for this crawl.", "Resets parse time of all parsed segments to null so they will be parsed\n again. Returns the updated crawl status.", "Gets the WARC file paths from S3 for this crawl if it exists.", "Takes in a S3 object and returns the contents as an uncompressed string.", "Parses the segment names and file counts from the WARC file paths.", "Render Multi Area graph.", "Returns the normalized equivalent of a given list\n\n   normalize_numbers([3, 4, 7])\n   # => [0, 1, 4]\n\n @return [Fixnum] the normalized equivalent of the given +_numbers+", "Parse values from Ambit database\n @param [OpenTox::Feature]\n @param [TrueClass,FalseClass,Float]\n @param [OpenTox::Dataset]", "Get all substances\n @return [Array<OpenTox::Substance>]", "Get all features\n @return [Array<OpenTox::Feature>]", "Get all values for a given substance and feature\n @param [OpenTox::Substance,BSON::ObjectId,String] substance or substance id\n @param [OpenTox::Feature,BSON::ObjectId,String] feature or feature id\n @return [TrueClass,FalseClass,Float]", "Writers\n Add a value for a given substance and feature\n @param [OpenTox::Substance,BSON::ObjectId,String] substance or substance id\n @param [OpenTox::Feature,BSON::ObjectId,String] feature or feature id\n @param [TrueClass,FalseClass,Float]", "Dataset operations\n Split a dataset into n folds\n @param [Integer] number of folds\n @return [Array] Array with folds [training_dataset,test_dataset]", "Serialisation\n Convert dataset to csv format including compound smiles as first column, other column headers are feature names\n @return [String]", "Project.logger.inspect(@posts, item)\n Project.logger.inspect(\"@post\" => @post)\n @since 0.0.1", "Initialize a new Queue.\n\n max_size:   - The maximum size the queue can grow to. This helps when\n               walking a large graph by forcing us to walk deeper.\n random_idx: - Add frames to the queue at random indicies. This helps when\n               walking a large graph by forcing us to walk deeper.\n\n Returns nothing.\n Add a frame to the queue if its GID hasn't been seen already and the queue\n hasn't exceeded its max size.\n\n frame - The Frame to add to the queue.\n\n Returns true if the frame was added, false otherwise.", "Add a GID to the queue.\n\n gid    - The String GID to add to the queue.\n parent - The frame where this GID was discovered (optional).\n\n Returns true if a frame was added, false otherwise.", "Finds a location by +FulfillmentLocation+.\n\n   result.location('WineShipping')[:supplier] #=> 'LOCATION-SUPPLIER'", "Must be called once before using cog.\n In the context of a command-line invocation, this method will be called automatically. Outside of that context, for example in a unit test, it will have to be called manually.\n @option opt [Boolean] :fullpaths (false) when listing files, full paths should be shown\n @option opt [Boolean] :minimal (false) only load the built-in Cogfile\n @option opt [String] :project_cogfile_path (nil) explicitly specify the location of the project {DSL::Cogfile}. If not provided, it will be searched for. If none can be found, {#project?} will be +false+", "Access the tax information for a shipment. Returns an instance of\n ShipmentSalesTaxRate.", "Finds all the compliance rules for a shipment.\n Returns an instance of ShipmentCompliance.\n\n  shipment_compliance = compliance_result.compliance_rules_for_shipment('SHIPMENT-KEY')\n  puts shipment_compliance.compliant? #=> false", "Find configuration data in environment variables. This is the only option\n on Chef 12.0, 12.1, and 12.2.\n\n @api private", "Find configuration data in node attributes.\n\n @api private", "Returns a Hash of inventory levels.\n\n - The key is the +InventoryType+.\n - The value is +Quantity+ as a float.\n\n     product.inventory_levels #=> {\n       available: 2,\n       on_hold: 2,\n       back_order: 4\n     }", "Returns a configured job flow to the calling job.", "Set job flow properties from settings in cluster.yml.", "Configures bootstrap actions that will be run when each instance is\n launched. EMR config is an XML file of Hadoop settings stored on S3.\n There are applied to each node by a bootstrap action.", "Collects Legend Info from the provided Layers.\n\n Automatically filters by legend's categories.", "Converts hash keys to Pascal case and rejects invalid keys.\n\n   :sales_order_keys #=> 'SalesOrderKeys'", "Returns a typical graph layout.\n\n These are squeezed into viewports.", "Returns a custom jar step that is configured with the jar location,\n class name and input and output paths.\n\n For parse jobs optionally specifies the maximum # of Common Crawl\n data files to process before the job exits.", "Sets the Elastic MapReduce job flow step name based on the type of job it\n belongs to.", "The GIDs from this frame's results.\n\n Returns an Array of GID Strings.", "Configures the job for secondary sort on the specified slice of the mapper\n output key.\n\n Hadoop comes with a partitioner that can partition the map output based\n on a slice of the map output key. Humboldt ships with a comparator that\n uses the same configuration. Together they can be used to implement\n secondary sort.\n\n Secondary sort is a mapreduce pattern where you emit a key, but partition\n and group only on a subset of that key. This has the result that each\n reduce invocation will see values grouped by the subset, but ordered by\n the whole key. It is used, among other things, to efficiently count\n distinct values.\n\n Say you want to count the number of distinct visitors to a site. Your\n input is pairs of site and visitor IDs. The na\u00efve implementation is to\n emit the site as key and the visitor ID as value and then, in the reducer,\n collect all IDs in a set, and emit the site and the size of the set of IDs.\n This is very memory inefficient, and impractical. For any interesting\n amount of data you will not be able to keep all the visitor IDs in memory.\n\n What you do, instead, is to concatenate the site and visitor ID and emit\n that as key, and the visitor ID as value. It might seem wasteful to emit\n the visitor ID twice, but it's necessary since Hadoop will only give you\n the key for the first value in each group.\n\n You then instruct Hadoop to partition and group on just the site part of\n the key. Hadoop will still sort the values by their full key, so within\n each group the values will be sorted by visitor ID. In the reducer it's\n now trivial to loop over the values and just increment a counter each time\n the visitor ID changes.\n\n You configure which part of the key to partition and group by specifying\n the start and end _indexes_. The reason why they are indexes and not a\n start index and a length, like Ruby's `String#slice`, is that you also can\n use negative indexes to count from the end. Negative indexes are useful\n for example when you don't know how wide the part of the key that you want\n use is. In the example above if you use the domain to identify sites these\n can be of different length. If your visitor IDs are 20 characters you can\n use 0 and -21 as your indexes.\n\n @param [Fixnum] start_index The first index of the slice, negative numbers\n   are counted from the end\n @param [Fixnum] end_index The last index of the slice, negative numbers\n   are counted from the end\n @see http://hadoop.apache.org/docs/r2.7.1/api/org/apache/hadoop/mapreduce/lib/partition/BinaryPartitioner.html Hadoop's BinaryPartitioner", "Returns a new Base object.\n\n Any options other that those specified below are stored in the @options variable for\n possible later use.  This would be a good place to store options needed for a custom\n graph.\n\n Options:\n title:: Name/title of data group\n points:: Array of data points\n preferred_color:: Color used to render this graph, overrides theme color.\n preferred_outline:: Color used to render this graph outline, overrides theme outline.\n relevant_data:: Rarely used - indicates the data on this graph should not\n                 included in any graph data aggregations, such as averaging data points.\n style:: SVG polyline style. (default: 'fill-opacity: 0; stroke-opacity: 0.35')\n stroke_width:: numeric value for width of line (0.1 - 10, default: 1)\n relativestroke:: stroke-width relative  to image size? true or false (default)\n shadow:: Display line shadow? true or false (default)\n dots:: Display co-ord dots? true or false (default)\n Builds SVG code for this graph using the provided Builder object.\n This method actually generates data needed by this graph, then passes the\n rendering responsibilities to Base#draw.\n\n svg:: a Builder object used to create SVG code.", "Sets up several variables that almost every graph layer will need to render\n itself.", "Converts hash keys to Pascal case and handles special cases.\n\n   :bottle_size_ml #=> 'BottleSizeML'", "Adds an entry into Gemfile for the supplied gem.\n\n   gem \"rspec\", group: :test\n   gem \"technoweenie-restful-authentication\", lib: \"restful-authentication\", source: \"http://gems.github.com/\"\n   gem \"rails\", \"3.0\", git: \"git://github.com/rails/rails\"", "Appends a line inside the TinyRailsApp class on boot.rb.\n\n   application do\n     \"config.assets.enabled = true\"\n   end", "Connection methods from mongoid to mysql", "Build a query for our relay schema that selects an inline fragment for\n every node type. For every inline fragment, we select the ID of every node\n field and connection.\n\n Returns a GraphQL::Language::Nodes::Document instance.", "Make an inline fragment AST.\n\n type           - The GraphQL::ObjectType instance to make the fragment\n                  for.\n with_children: - Boolean. Whether to select all children of this inline\n                  fragment, or just it's ID.\n\n Returns a GraphQL::Language::Nodes::InlineFragment instance or nil if the\n created AST was invalid for having no selections.", "Make a field AST.\n\n field     - The GraphQL::Field instance to make the fragment for.\n arguments - A Hash of arguments to include in the field.\n &blk      - A block to call with the AST and field type before returning\n             the AST.\n\n Returns a GraphQL::Language::Nodes::Field instance or nil if the created\n AST was invalid for having no selections or missing required arguments.", "Make a field AST for a node field.\n\n field - The GraphQL::Field instance to make the fragment for.\n\n Returns a GraphQL::Language::Nodes::Field instance.", "Make a field AST for an edges field.\n\n field - The GraphQL::Field instance to make the fragment for.\n\n Returns a GraphQL::Language::Nodes::Field instance.", "Make a field AST for a connection field.\n\n field - The GraphQL::Field instance to make the fragment for.\n\n Returns a GraphQL::Language::Nodes::Field instance or nil if the created\n AST was invalid for missing required arguments.", "Is this field for a relay node?\n\n field - A GraphQL::Field instance.\n\n Returns true if the field's type includes the `Node` interface or is a\n union or interface with a possible type that includes the `Node` interface\n Returns false otherwise.", "Is this field for a relay connection?\n\n field - A GraphQL::Field instance.\n\n Returns true if this field's type has a `edges` field whose type has a\n `node` field that is a relay node. Returns false otherwise.", "Get the possible types of a union or interface.\n\n type - A GraphQL::UnionType or GraphQL::InterfaceType instance.\n\n Returns an Array of GraphQL::ObjectType instances.", "Wraps the +RuleComplianceResponse+ nodes with ComplianceRule.\n\n   compliance_errors = shipment.rules.reject { |r| r.compliant? }", "constructer to one time initialze genric keys\n request CCAvenue encrypted data", "calling response method to check if everything went well", "verify checksum response", "hex-to-bin", "Walk this client's graph from the given GID.\n\n from_id: - The String GID to start walking from.\n variables: - A Hash of variables to be passed to GraphQL::Client.\n context: - A Hash containing context to be passed to GraphQL::Client.\n &blk     - A block to call with each Walker::Frame that is visited.\n\n Returns nothing.", "Returns an instance of the first music player that's launched", "Converts percentage values into actual pixel values based on the known\n render size.\n\n Returns a hash consisting of :x, :y, :width, and :height elements.", "Called by the value marker component.  Routes the format call\n to one of a couple possible methods.\n\n If the formatter defines a #format method, the returned value is used\n as the value.  If the formatter defines a #format! method, the value passed is\n expected to be modified, and is used as the value.  (This may not actually work,\n in hindsight.)", "Returns a new Number formatter.\n\n Options:\n precision:: precision to use for value.  Can be set to an integer, :none or :auto.\n             :auto will use whatever precision is necessary to portray all the numerical\n             information, up to :precision_limit.\n\n             Example:  [100.1, 100.44, 200.323] will result in [100.100, 100.440, 200.323]\n\n separator:: decimal separator.  Defaults to '.'\n delimiter:: delimiter character.  Defaults to ','\n precision_limit:: upper limit for auto precision. (Ignored if roundup is specified)\n roundup:: round up the number to the given interval\n Formats the value.", "Returns a new Currency class.\n\n Options:\n precision:: precision of value\n unit:: Defaults to '$'\n separator:: Defaults to '.'\n delimiter:: Defaults to ','\n negative_color:: Color of value marker for negative values.  Defaults to 'red'\n special_negatives:: If set to true, parenthesizes negative numbers.  ie:  -$150.50 becomes ($150.50).\n                     Defaults to false.\n Formats value marker.", "Returns new Percentage formatter.\n\n Options:\n precision:: Defaults to 3.\n separator:: Defaults to '.'\n Formats percentages.", "Calculate OpenBabel descriptors\n @param [String] descriptor type\n @param [OpenTox::Compound]\n @return [Hash]", "return neighbouring tiles to the north, northeast, and east", "Render the class in the currently active language\n @param path [String] file system path without the extension, relative to the project root. The extension will be determined based on the currently active language\n @option opt [String] :language key for the language to use. The language must define a seed extension", "Draw box plot.", "Copy keep bodies from the original file to the scratch file\n @param original [String] file in which to search for keep statements. If the original does not exist, then scratch will serve as the original (we do this so that the keeps will get expanded in any case)\n @param scratch [String] file to which keep bodies will be copied\n @return [nil]", "Returns new Multi graph.\n\n You can provide a block for easily adding layers during (just after) initialization.\n Example:\n   Multi.new do |multi|\n     multi << Scruffy::Layers::Line.new( ... )\n     multi.add(:multi_bar, 'My Bar', [...])\n   end\n\n The initialize method passes itself to the block, and since multi is a LayerContainer,\n layers can be added just as if they were being added to Graph.\n Overrides Base#render to fiddle with layers' points to achieve a multi effect.", "Draw bar graph.\n Now handles positive and negative values gracefully.", "Stamp a template into a file or return it as a string\n @param template_path [String] path to template file relative to {Config#template_path}\n @param destination [String] path to which the generated file should be written, relative to the {Config::ProjectConfig#project_path}\n @option opt [Boolean] :absolute_template_path (false) is the +template_path+ absolute?\n @option opt [Boolean] :absolute_destination (false) is the +destination+ absolute?\n @option opt [Boolean] :once (false) if +true+, the file will not be updated if it already exists\n @option opt [Binding] :binding (nil) an optional binding to use while evaluating the template\n @option opt [String, Array<String>] :filter (nil) name(s) of {Filters}\n @option opt [Boolean] :quiet (false) suppress writing to STDOUT?\n @return [nil or String] if +destination+ is not provided, the stamped template is returned as a string", "Provide a value for embeds with the given hook\n @param hook [String] hook name used in the embed statements\n @yieldparam context [EmbedContext] provides information about the environment in which the embed statement was found\n @yieldreturn The value which will be used to expand the embed (or replace the embedded content)\n @return [nil]", "Takes in an array of parse jobs that are to be combined. Creates a single\n job step whose input paths are the outputs of the parse jobs.", "Runs the job by calling the Elastic MapReduce API.", "Returns the S3 location for reading a parse job. A wildcard is\n used for the segment names. The input filter depends on the output\n file type of the parse job and what type of compression is used.", "Loads a YAML configuration file.", "Loads the sqlite database.  If no database exists it will be created\n and the database migrations will be run.", "Checks if a S3 bucket name is in use.", "Creates a bucket using the S3 API.", "Deletes a bucket and its contents using the S3 API.", "Creates config directory and copies config templates into it.\n Saves S3 bucket name to jobs.yml and AWS credentials to aws.yml.", "Saves AWS access credentials to aws.yml unless they are configured as\n environment variables.", "Saves config values by overwriting placeholder values in template.", "Deletes the config directory including its contents.", "Notifies user of results of init or destroy commands.", "will execute single migration by running up or down script", "will execute range of migrations", "Runs sparkr with the given +args+\n @return [void]", "Create chemical fingerprint\n @param [String] fingerprint type\n @return [Array<String>]", "Match a SMARTS substructure\n @param [String] smarts\n @param [TrueClass,FalseClass] count matches or return true/false\n @return [TrueClass,FalseClass,Fixnum]", "Get SVG image\n @return [image/svg] Image data", "Get png image\n @example\n   image = compound.png\n @return [image/png] Image data", "Override default generate_coordinates method to iterate through the layers and\n generate coordinates based on the average data points.", "Resolve snippet path by context and tag\n\n @param context [::SocialSnippet::Context] The context of snippet\n @param tag [::SocialSnippet::Tag] The tag of snippet", "Find repository by tag\n\n @param tag [::SocialSnippet::Tag] The tag of repository", "Find repository by repo name\n\n @param name [String] The name of repository", "remove an image\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Image/remove.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] raised when tag is not found.\n @raise [Hyperb::Error::Conflict] raised when the image will only be removed with force.\n @raise [Hyperb::Error::InternalServerError] server error.\n\n @return [Array] array of downcase symbolized json response.\n\n @param params [Hash] A customizable set of params.\n @option params [String] :name image name to be removed\n @option params [Boolean] :force force image to be removed", "inspect an image\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Image/inspect.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] raised when tag is not found.\n @raise [Hyperb::Error::InternalServerError] server error on hyper side.\n\n @return [Hash] downcased symbolized `inspect` json response.\n\n @param params [Hash] A customizable set of params.\n @option params [String] :name image name to be removed", "Creates a child, adds it to children, and returns the child", "Lookup a child node by its name", "Custom respond_with wich stores resources for later use", "returns a hash containing formated host config data\n\n @returns [Hash]", "Constructor for a report generator\n Export report to PDF with given datasource", "Generic method to export to some format like ODT and DOCX as file in the given place", "Generic method to export to some format like ODT and DOCX", "Create object file if not exist and load datasource", "Build the default parameters Hash for printing", "Load parseable XML datasource with java component", "Fill the report with valid method depending on datasource", "Returns a hash of the defined fields.\n\n   class SomeMessageType < Outbox::Messages::Base\n     fields :to, :from\n   end\n   message = SomeMessageType.new to: 'Bob'\n   message.from 'John'\n   message.fields #=> { to: 'Bob', from: 'John' }\n\n Also allows you to set fields if you pass in a hash.\n\n   message.fields to: 'Bob', from: 'Sally'\n   message.fields #=> { to: 'Bob', from: 'Sally' }", "Assigns the values of the given hash.\n\n   message.to = 'Bob'\n   message.fields = { from: 'Sally' }\n   message.fields #=> { to: 'Bob', from: 'Sally' }", "Checks the current values of the fields and raises errors for any\n validation issues.", "serialize a ruby object to a file in json\n\n path - file path\n data - data to be serialized\n\n Returns nothing", "unserialize a json file to a ruby object\n\n path - file path\n\n Returns a ruby object or nil", "Translate orthorgraphy to IPA", "accepts only datetime", "accepts datetime and time", "Adds a inheritance handler to Object so we can add loggers for registered classes", "Creates a table around the objects and yields a builder.\n\n Example:\n\n   index_for @users do |t|\n     t.attribute :name\n     t.attribute :email\n   end", "Create action links and yields a builder.\n\n Example:\n\n   index_for_actions @user do |a|\n     a.action_link :show\n     a.action_link :edit\n   end\n\n   index_for_actions @user, :show, :edit", "Creates a desc list around the object and yields a builder.\n\n Example:\n\n   show_for @user do |l|\n     l.attribute :name\n     l.attribute :email\n   end", "Make an HTTP POST call to the Brightcove API for a particular API method.\n\n @param api_method [String] Brightcove API method.\n @param parameters [Hash] Optional hash containing parameter names and values.", "Nested attributes are currently not handled in basecontroller", "Creates a new room.\n\n @param name [String] Name of the room.\n @param owner_user_id [int] User ID of the room's owner.\n @param privacy [String, 'public'] Privacy setting for room.\n @param topic [String, ''] Room topic.\n @param guest_access [int, 0] Whether or not to enable guest access for this room. 0 = false, 1 = true. (default: 0).\n\n @see https://www.hipchat.com/docs/api/method/rooms/create", "Send a message to a room.\n\n @param room_id [int] ID of the room.\n @param from [String] Name the message will appear be sent from. Must be less than 15 characters long. May contain letters, numbers, -, _, and spaces.\n @param message [String] The message body. Must be valid XHTML. HTML entities must be escaped (e.g.: &amp; instead of &). May contain basic tags: a, b, i, strong, em, br, img, pre, code. 5000 characters max.\n @param notify [int] Boolean flag of whether or not this message should trigger a notification for people in the room (based on their individual notification preferences). 0 = false, 1 = true. (default: 0)\n @param color [String] Background color for message. One of \"yellow\", \"red\", \"green\", \"purple\", or \"random\". (default: yellow)\n @param message_format [String] Determines how the message is treated by HipChat's server and rendered inside HipChat applications. One of \"html\" or \"text\". (default: html)\n @see https://www.hipchat.com/docs/api/method/rooms/message", "Create a new user in your group.\n\n @param email [String] User's email.\n @param name [String] User's full name.\n @param title [String] User's title.\n @param is_group_admin [int] Whether or not this user is an admin. 0 = false, 1 = true. (default: 0)\n @param password [String, nil] User's password. If not provided, a randomly generated password will be returned.\n @param timezone [String, 'UTC'] User's timezone. Must be a PHP supported timezone. (default: UTC)\n\n @see https://www.hipchat.com/docs/api/method/users/create", "embed video, calculates embed iframe by urls from various simple formats, but not accept iframe code", "The block is passed node itself as parent and the vector midpoints of\n its children to be.\n\n The block sets is own refob, and returns either true, in which case\n all the children are created, or it returns false, in which case none\n of the children will be created, in effect, marking itself as a leaf\n node.", "Asi.new reads in the source file for the ASIObjectDictionary and creates\n an internal Hash\n @param params [Hash]\n Convert the array of hashes to a hash with the address as primary key", "Convenience method for starting a thread to watch for changes in log\n levels and apply them.  You don't need to use this if you are manually\n calling activate levels at all your entry points.\n\n @param [Integer] How long to sleep between checks\n @return [Thread] The monitor thread", "Backs up original values of logger levels before we overwrite them\n This is better in local memory since we shouldn't reset loggers that we haven't set\n @param [Enumerable<String>] The logger names to backup", "Restores original values of logger levels after expiration", "Define and call methods to return the value of the dimensions and metrics\n in the report.\n @!macro method_missing", "Convert metric to the right type.", "Set up the keystroke mapper.\nAdd a map entry", "Handle the preamble characters in the command sequence.", "Builds an XML document around request data", "returns a new pattern matcher differing from the original only in the options specified", "converst list into a string representing a regex pattern suitable for inclusion in a larger regex", "for reference, when searching, listing all possible responses is\n logical, but it is impossible to track all survey response answers\n that match the desired answer. therefore, we only track one\n example, and later find all similar response answers based on the\n question strategy", "Override this method to use your favorite HTTP library. This method receives\n an array of bodies. It is intended that each element of the array be\n transmitted as a separate POST request, _not_ that the bodies be\n concatenated and sent as one request.\n\n A response of code found in the `:success` option is considered successful.\n\n @param [String] url The URL to POST to.\n @param [Hash<String, String>] headers The request headers.\n @param [Array<String>] bodies The bodies of each request to POST.\n @raise [StandardError] If a response other than 2xx or 422 is returned.", "Generates the set of migrations by parsing the passed in block\n\n Translates a hash based on defined migrations\n with a given context and returns the hash.\n This will modify whatever gets passed in.", "Utility methods\n Check if any required parameter is missing in params hash\n\n @param required_param_names array of names of required parameters that need to be checked\n @param params hash of params that will be used to check the presence of each required_param_name\n\n @return Hoiio::InputError if a required param is missing", "Check that only 1 required parameter is needed for specific API calls\n\n @param required_param_names array of names of required parameters that need to be checked\n @param params hash of params that will be used to check the presence of each required_param_name\n\n @return Hoiio::InputError if a required param is missing or if all required params are present", "This function is no different from the \"copyright_year\" function above. It just uses some\n conventions to render another template file when it's called.", "Retrieves a new authentication token to use for this client\n or reuse the same one from memory.", "Make an API with access_token", "Send a message to STC that a payment\n has started.\n\n @return String status", "see attributes_to_pull_from_json for the order if creating yourself", "Build new prompt object and set defaults\n\n Request user input", "Validate user input", "Parse user input", "checks if all args are keys into the hash\n\n @return [Boolean]\n\n @param params [Hash] hash to check.\n @option *args [String] array of strings to check against the hash", "prepares all json payloads before sending to hyper\n\n input: { foo_bar: 'test' }\n output: {'FooBar': 'test' }", "Builds the \"x, y\" pairs, and returns these pairs in block", "Builds the \"x, y, index\" pairs, and returns these pairs in block", "parse a single message of the PO format.\n\n @param message a single PO message in String format without leading or trailing whitespace\n @return [Hash] parsed PO message information in Hash format", "matches the msgctxt line and will continue to check for msgid afterwards\n\n msgctxt is optional", "matches the msgid line. Will check for optional msgid_plural.\n Will advance to msgstr or msgstr_plural based on msgid_plural\n\n msgid is required", "matches the msgid_plural line.\n\n msgid_plural is optional\n\n @return [boolean] true if msgid_plural is present, false otherwise", "parses the msgstr singular line\n\n msgstr is required in singular translations", "parses the msgstr plural lines\n\n msgstr plural lines are used when there is msgid_plural.\n They have the format msgstr[N] where N is incremental number starting from zero representing\n the plural number as specified in the headers \"Plural-Forms\" entry. Most languages, like the\n English language only have two plural forms (singular and plural),\n but there are languages with more plurals", "parses previous comments, which provide additional information on fuzzy matching\n\n previous comments are:\n * #| msgctxt\n * #| msgid\n * #| msgid_plural", "parses the multiline messages of the previous comment lines", "parses a multiline message\n\n multiline messages are indicated by an empty content as first line and the next line\n starting with the double quote character", "identifies a message line and returns it's text or raises an error\n\n @return [String] message_text", "adds text to the given key in results\n creates an array if the given key already has a result", "Resolve tag's ref", "register features are not queued and go straight out", "Exposes the linked list structure in an Enumerable-compatible format", "Called for each comment line", "Initialise a UrlInfo for a particular URL\n\n @param [String] url the URL you want to get info about\n @param [Integer] request_timeout Max time to wait for headers from the server\n\n Check the Content-Type of the resource\n\n @param [String, Symbol, Array] type the prefix (before \"/\") or full Content-Type content\n @return [Boolean] true if Content-Type matches something from the types list", "Formats an account number for ESR\n\n Account numbers for ESR should have the following format:\n XXYYYYYYZ, where the number of digits is fixed. We support\n providing the number in the format XX-YYYY-Z which is more\n common in written communication.", "Loads LDAP host and authentication configuration", "Clear out any count caches which have SQL that includes the scopes table", "Generate QiitaScouter markdown file.", "Filter simulator data", "Create a new request instrumentation package.\n\n A \"request\", for the purposes of this discussion, is a distinct\n interaction with an external system, typically either the receipt of some\n sort of communication from another system which needs a response by this\n system (the one being instrumented), or else the communication to another\n system from this one for which we are expecting an answer.  Each instance\n of this class should be used to instrument all requests of a particular\n type.\n\n For each instance of this class, the following metrics will be created:\n\n * `<prefix>_requests_total` -- a counter indicating the total number\n   of requests started (initiated or received by the system).  Labels on\n   this metric are taken from the label set passed to #measure.\n\n * `<prefix>_request_duration_seconds` -- a histogram for the response\n   times of successful responses (that is, where no exception was raised).\n   You can get the count of total successful responses from\n   `<prefix>_request_duration_seconds_count`.  Labels on this metric\n   are taken from the labels set generated during the measured run (as\n   generated by manipulating the hash yielded to your block).\n\n * `<prefix>_exceptions_total` -- a count of the number of exceptions\n   raised during processing.  A label, `class`, indicates the class of\n   the exception raised.  Labels on this metric are taken from the\n   label set passed to #measure, along with a special label `class`\n   to indicate the class of the exception raised.\n\n * `<prefix>_in_progress_count` -- a gauge indicating how many requests\n   are currently in progress as at the time of the scrape.  Labels on this\n   metric are taken from the label set passed to #measure.\n\n @param prefix [#to_s] the string that will be prepended to all of the\n   Prometheus metric names generated for this instrumentation.  The prefix\n   you choose should include both the application name (typically the\n   first word) as well as a unique identifier for the request type itself.\n   Multiple words should be underscore separated.\n\n @param outgoing [Boolean] whether this Request instance is collecting\n   data on incoming requests or outgoing requests (the default, as usually\n   there is one incoming request handler, but there can easily be several\n   outgoing request types).  It is only used to customise the metric\n   description text for the metrics, so it's not crucially important.\n\n @param description [#to_s] a short explanation of what this is measuring.\n   It should be a singular and indefinite noun phrase, to maximise the\n   chances that it will fit neatly into the generated description text.\n\n @param registry [Prometheus::Client::Registry] the client registry in\n   which all the metrics will be created.  The default will put all the\n   metrics in the Prometheus Client's default registry, which may or may\n   not be what you're up for.  If you're using Frankenstein::Server, you\n   want `stats_server.registry`.\n\n Instrument an instance of the request.\n\n Each time a particular external communication occurs, it should be\n wrapped by a call to this method.  Request-related statistics (that\n the request has been made or received) are updated before the passed\n block is executed, and then after the block completes,\n response-related statistics (duration or exception) are recorded.  The\n number of currently-in-progress instances of the request are also kept\n track of.\n\n @param labels [Hash] a set of labels that can help to differentiate\n   different sorts of requests.  These labels are applied to the\n   `<prefix>_requests_total` and `<prefix>_in_progress_count` metrics, as\n   well as the `<prefix>_exceptions_total` metric, if an exception is\n   raised.\n\n   Don't get too fancy with this label set -- it's unusual that this is\n   actually useful in practice.  However it is provided for those unusual\n   cases where it isn't a bad idea.  Your go-to solution should be to\n   label the `<prefix>_request_duration_seconds` metric (by modifying the\n   hash yielded to the block you pass to #measure), rather than using\n   this parameter with wild abandon.\n\n   Serious talk time: I've been there.  It seems like a great idea at\n   first, to differentiate requests with lots of labels, but it usually\n   just ends up turning into a giant mess.  Primarily, due to the way that\n   Prometheus deals with label sets, if you *ever* use a label on *any* of\n   your requests, you need to set the same label to some value on *all* of\n   your requests.  So, unless you can say with certainty that every\n   request you receive will logically have some meaningful value for a\n   given label, you shouldn't use it.\n\n   **NOTE**: the labelset you specify here will be the default labelset\n   applied to the `<prefix>_request_duration_seconds` metric.  If you need\n   to remove a label from the response, use `labels.replace` or\n   `labels.delete` to remove the key.\n\n @yield [Hash] the labels that will be applied to the\n   `<Prefix>_request_duration_seconds` metric.\n\n   In order for your label set to be applied, you must *mutate the\n   hash that is yielded*, rather than overwriting it.  That means,\n   for example, that the following code **will not work**:\n\n       req_stats.measure do |labels|\n         labels = {foo: 'bar', baz: 'wombat'}\n         ...\n\n   Instead, you need to either set each key one by one, or use the\n   handy-dandy Hash#replace method, like this:\n\n       req_stats.measure do |labels|\n         labels.replace(foo: 'bar', baz: 'wombat')\n         ...\n\n   If your labels are not being applied to your response histogram,\n   check for any assignment to the yielded variable.  It's *really* easy\n   to do by mistake.\n\n   **NOTE WELL**: The Prometheus specification (assuming it exists)\n   apparently requires that all of the instances of a given metric\n   have the same set of labels.  If you fail to do this, an exception\n   will be raised by Prometheus after the block is executed.\n\n @raise [Prometheus::Request::NoBlockError] if you didn't pass a block to\n   call.  There's nothing to instrument!\n\n @raise [Prometheus::Client::LabelSetValidator::LabelSetError] if you\n   violate any written or unwritten rules about how Prometheus label\n   sets should be constructed.\n\n @raise [Exception] any exception raised by the executed block will\n   be re-raised by this method after statistics collection is\n   complete.\n\n @return [Object] whatever was returned by the block passed.", "Retrieve a complete set of labels and values for the metric.", "Make sure that the type we were passed is one Prometheus is known to accept.", "find all chatter feeds based on object_type, query_string, and given binding", "Return an instance of Sounds whose sets include any of the given\n features.", "Return feature sets that include all of the given features", "Return an instance of Sounds whose sets exclude any of the given\n features.", "Return an instance of Sounds whose sets exclude all of the given\n features.", "Check resource params are present based on the current controller name.", "if current params contain order for this column then revert direction\n else add order_params for this column to current params", "Create a Curator.\n\n Typically this is done automatically when <tt>#characteristics</tt> is called on an instance of a characterized class for the first time.\n @param [Object] The subject of the curation -- an instance of a characterized class\n @see Charisma::Base#characteristics\n The special hash wrapped by the curator that actually stores the computed characteristics.", "Store a late-defined characteristic, with a Charisma wrapper.\n @param [Symbol] key The name of the characteristic, which must match one defined in the class's characterization\n @param value The value of the characteristic", "decompose compound units", "Insert snippets to given text\n\n @param text [String] The text of source code", "Insert snippet by tag and context", "Insert depended snippet", "Sort by dependency", "Returns the unit with the given label. Creates a new unit if necessary.\n\n Raises MeasurementError if the unit could not be created.", "Returns the Unit which matches the str prefix.\n\n Raises MeasurementError if the unit could not be determined.", "Returns the Factor which matches the label, or nil if no match.", "Returns whether text ends in suffix.", "Create new Config object, either ephemerally or from a file", "fetch all pages of results", "fetch a record by id", "Format a beautiful hint string", "The default for `display_link_type_id` is \"Fallback\" in Cake, which\n doesn't have an ID and, hence, cannot be set via the API. In order to not\n change it, it has to be absent from the request.", "The step_name variable below is a string that may or\n may not match the regex pattern of one of the hashes\n in the steps array.", "Detect if two URIs are equivalent versions of the same uri.\n\n When both uris are github repositories, uses a more lenient matching\n system is used that takes github's repository organization into account.\n\n For non-github URIs this method requires the two URIs to have the same\n host, equivalent paths, and either the same user or an absolute path.\n\n @return [Boolean] true if the URI probably indicates the same repository.", "fetches counters atomically", "A simple \"Twitter like\" pagination link that creates a link to the previous page.\n\n ==== Examples\n Basic usage:\n\n   <%= link_to_previous_page @items, 'Previous Page' %>\n\n Ajax:\n\n   <%= link_to_previous_page @items, 'Previous Page', :remote => true %>\n\n By default, it renders nothing if there are no more results on the previous page.\n You can customize this output by passing a block.\n\n   <%= link_to_previous_page @users, 'Previous Page' do %>\n     <span>At the Beginning</span>\n   <% end %>", "A simple \"Twitter like\" pagination link that creates a link to the next page.\n\n ==== Examples\n Basic usage:\n\n   <%= link_to_next_page @items, 'Next Page' %>\n\n Ajax:\n\n   <%= link_to_next_page @items, 'Next Page', :remote => true %>\n\n By default, it renders nothing if there are no more results on the next page.\n You can customize this output by passing a block.\n\n   <%= link_to_next_page @users, 'Next Page' do %>\n     <span>No More Pages</span>\n   <% end %>", "Renders rel=\"next\" and rel=\"prev\" links to be used in the head.\n\n ==== Examples\n Basic usage:\n\n   In head:\n   <head>\n     <title>My Website</title>\n     <%= yield :head %>\n   </head>\n\n   Somewhere in body:\n   <% content_for :head do %>\n     <%= rel_next_prev_link_tags @items %>\n   <% end %>\n\n   #-> <link rel=\"next\" href=\"/items/page/3\" /><link rel=\"prev\" href=\"/items/page/1\" />", "Calculate contast ratio beetween RGB1 and RGB2.", "Calculate the relative luminance for an rgb color", "Convert RGB color to sRGB.", "Calculate lightness for sRGB color.", "Create a new server instance.\n\n @param port [Integer] the TCP to listen on.\n\n @param logger [Logger] send log messages from WEBrick to this logger.\n   If not specified, all log messages will be silently eaten.\n\n @param metrics_prefix [#to_s] The prefix to apply to the metrics exposed\n   instrumenting the metrics server itself.\n\n @param registry [Prometheus::Client::Registry] if you want to use an existing\n   metrics registry for this server, pass it in here.  Otherwise, a new one\n   will be created for you, and be made available via #registry.\n\n Start the server instance running in a separate thread.\n\n This method returns once the server is just about ready to start serving\n requests.", "Assign the given hash where each key is a message type and\n the value is a hash of options for that message type.", "Run request on connection\n\n @param [Faraday::Connection]\n\n @return [Faraday::Response]\n\n @api private", "Validates all properties based on configured validators.\n\n @return [Hash<Symbol,Array>] map of errors where key is the property name\n                              and value is the list of errors\n @see ClassMethods#add_validator", "Load capabilities based on current device data", "Load appium text file if available and attempt to start the driver\n platform is either android or ios, otherwise read from ENV\n caps is mapping of appium capabilities", "Define a signal handler for SIGINT", "Decide whether to execute specs in parallel or not\n @param [String] platform\n @param [int] threads\n @param [String] spec_path\n @param [boolean] parallel", "Define Spec path, validate platform and execute specs", "Fire necessary appium server instances and Selenium grid server if needed.", "Create a Query object.\n @param access_token [String] A valid access token with which to make a request to\n   the specified View ID.\n @param end_date [Date, String] The end date for the report.\n @param query_string [String, Hash, JSON] The query in JSON format.\n @param start_date [Date, String] The start date for the report.\n @param view_id [String] The view ID of the property for which to submit the\n   query.\n Send the requested query to Google Analytics and return the response.\n @return [GAAPI::Response] The response from the request.", "The keys have to be strings to get converted to a GA query.\n Adapted from Rails.", "Raise remote status error\n\n @return [undefined]\n\n @api private", "Sets up a new event\n\n\n GET /api/v1/event/{eventKey}/performance/{performanceKey}/sections/{languageCode}\n Get available sections, pricetypes and prices of the selected performance\n\n @return Array of sections", "Figures out which translations are done for each version.", "Ideally, this would be polymorphic-enabled", "Allows you to set all the attributes by passing in a hash of attributes with\n keys matching the attribute names.\n\n   class Cat\n     include Assignment::Attributes\n     attr_accessor :name, :status\n   end\n\n   cat = Cat.new\n   cat.assign_attributes(name: \"Gorby\", status: \"yawning\")\n   cat.name # => 'Gorby'\n   cat.status => 'yawning'\n   cat.assign_attributes(status: \"sleeping\")\n   cat.name # => 'Gorby'\n   cat.status => 'sleeping'", "Create a Hash from a JSON response\n @param response response of Hoiio API\n @return response parsed as a Hash", "return agency name as single string", "return agency name, allowing arrays in output", "Creates a MainProcess which keeps running\n and continuously checks if new jobs are queued.\n\n @return [Scheduler::MainProcess] the created MainProcess.\n\n Main loop.\n\n @return [nil]", "Reschedules currently running jobs.\n\n @return [nil]", "Get the device data from the DEVICES environment variable", "Save device specifications to output directory", "Get the device information for the respective platform", "Start the appium server with the specified options", "Generate node config for sellenium grid", "Start an appium server or the platform on the specified port", "Launch the Selenium grid hub and required appium instances", "Builds the inner XML of the Mindbody SOAP call", "Build a Mindbody SOAP request for the given service", "Expects response XML to already be parsed", "Finds +index+ in +hash+ by searching recursively\n\n @param [Hash] hash\n   The hash to search\n\n @param index\n   The hash key to look for", "Overloads the << operator to put the new item into the correct\nlist or assign it to the correct attribute.\nAssignment is done based on item's class or a parent class of item.", "True if all attributes, actions and conditions are the same.\nOverloads the << operator to put the new item into the correct\nlist or assign it to the correct attribute.\nAssignment is done based on item's class or a parent class of item.", "Add this Vector to vector2, returning a new Vector.\nThis operation is useful when calculating the effect of wind or thrust on an object's current heading.", "Handle conversion methods", "Get all the albums by this artist", "Returns an array of tracks", "create a func\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Func/create.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::Conflict] raised when func already exist\n @raise [Hyperb::Error::BadRequest] raised when a bad parameter is sent\n @raise [Hyperb::Error::InternalServerError] server error on hyper side.\n @raise [ArgumentError] when required arguments are not provided.\n\n @param params [Hash] A customizable set of params.\n\n @param params :name [String] the function name.\n\n @param params :container_size [String] the size of containers\n to run the function (e.g. s1,s2, s3, s4, m1, m2, m3, l1, l2, l3)\n\n @param params :timeout [String] default is 300 seconds, maximum is 86400 seconds.\n @param params :uuid [String] The uuid of function.\n\n @param params :config [Hash] func configurations\n @param params config :tty [Boolean] attach streams to a tty\n @param params config :exposed_ports [Hash] an object mapping ports to an empty\n object in the form of: \"ExposedPorts\": { \"<port>/<tcp|udp>: {}\" }\n @param params config :env [Array] list of env vars, \"VAR=VALUE\"\n @param params config :cmd [Array|String] list of env vars, \"VAR=VALUE\"\n @param params config :image [String] image to run\n @param params config :entrypoint [String] entrypoint\n @param params config :working_dir [String] working directory\n @param params config :labels [Hash] labels\n\n @param params :host_config [Hash] func host configurations\n @param params host_config :links [Array] list of links\n @param params host_config :port_bindings [Hash]\n @param params host_config :publish_all_ports [Boolean]\n @param params host_config :volumes_from [Array]\n @param params host_config :network_mode [String]", "remove a func\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Func/remove.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::Conflict] raised when func with that name is running\n @raise [Hyperb::Error::BadRequest] raised when a bad parameter is sent\n @raise [Hyperb::Error::InternalServerError] server error on hyper side.\n @raise [ArgumentError] when required arguments are not provided.\n\n @param params [Hash] A customizable set of params.\n\n @param params :name [String] the function name.", "call a func\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Func/call.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] no such func\n @raise [ArgumentError] when required arguments are not provided.\n\n @param params [Hash] A customizable set of params.\n\n @param params :name [String] the function name.\n @param params :uuid [String] function uuid.\n @param params :sync [Boolean] block until function reply", "wrap `http_method`, `url`, `params` together", "Determine the default ip address, taken from packetfu's utils.rb", "Determine the default routeable interface, taken from packetfu's utils.rb", "Run all operations, or a specific operation\n\n @param  [Hash]    config          config hash to pass to operations (currently  :host, :user, :password)\n @param  [String]  operation_name  the single operation to run, otherwise all", "def within_expected_folder?\n      rel_design_path_list = @relative_path_from_project.to_s.split('/')\n      return nil if rel_design_path_list.length < 3\n      str = [rel_design_path_list.first(2)].join('/')\n      STANDARD_LIBRARY_FOLDERS_LIST.include? str\n    end\nFunction that looks for a sources.rb file within the project", "Returns an array of targets that are at the given distance or closer.", "Returns an array of targets that have collided with the actor.", "Returns an array of targets that are weaker than the actor.\nFor now, strength is based merely on size.", "Logs out of the Salesforce session", "Returns a new Measurement which expresses this measurement as the given unit.", "Returns a new Measurement whose unit is this Measurement's unit and quantity is the\n result of applying the given method to this Measurement's quantity and the other quantity.\n\n If other is a Measurement, then the operation argument is the other Measurement quantity, e.g.:\n   Measurement.new(:g, 3).apply(Measurement.new(:mg, 2000), :div) #=> 1 gram", "Returns the application of method to this measurement and the other measurement or Numeric.\n If other is a Measurement, then the returned Measurement Unit is the composition of this\n Measurement's unit and the other Measurement's unit.", "for now assumes", "Initializes the logger's formatter proc based on the value of format\n instance variable. This method should only be called inside the register\n method\n @private", "Initializes the logger object from the standard library. This method\n should only be called inside the register method\n @private", "Log a message to the configured logger using the severity and program name\n as specified\n @param [String] message message to be logged\n @param [Number] severity message's severity\n @see http://ruby-doc.org/stdlib-2.2.4/libdoc/logger/rdoc/Logger.html\n @private", "Set up the sub resources using shared @client object", "list floating ips\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_ls.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] raised when ips are not found.\n\n @returns [Array] array of downcased symbolized has\n\n @param params [Hash] A customizable set of params.\n @option params [String] :filters", "release a floating ip\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_release.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] raised when ips are not found.\n\n @param params [Hash] A customizable set of params.\n @option params [String] :ip the number of free fips to allocate", "allocate a new floating ip\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_allocate.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n\n @return [Array] Array of ips (string).\n\n @param params [Hash] A customizable set of params.\n @option params [String] :count the number of free fips to allocate", "If object is over the speed, reduce its speed.", "Add the given vector to each object, but limited by elapsed time.", "Reduce each object's speed at the given rate.", "Remove objects if there are too many objects in environment.", "Define a characteristic.\n\n This is used within <tt>Charisma::Base::ClassMethods#characterize</tt> blocks to curate attributes on a class. Internally, a <tt>Charisma::Characteristic</tt> is created to store the definition.\n @param [Symbol]\n @param [Symbol] name The name of the characteristic. The method with this name will be called on the characterized object to retrieve its raw value.\n @param [Hash] options The options hash.\n @option [Symbol] display_with A symbol that gets sent as a method on the characteristic to retrieve its display value.\n @option [Class, Symbol] measures Specifies a measurement for the characteristic. Either provide a class constant that conforms to the Charisma::Measurement API, or use a symbol to specify a built-in Charisma measurement.\n @option [Proc] blk A proc that defines how the characteristic should be displayed.\n @see Charisma::Base::ClassMethods#characterize\n @see Charisma::Characteristic\n @see Charisma::Measurement", "Define a method find_by_KEY if the specified cache key\n is not an active record column", "Parse the lookup key", "Search the cache for records with the specified attributes\n\n * +finder+ - Same as with +find+ specify <tt>:all</tt>, <tt>:last</tt> or <tt>:first</tt>\n   <tt>:all</all> returns an array of active records, <tt>:last</tt> or <tt>:first</tt> returns a single instance\n * +attributes+ - a hash map of fields (or methods) => values\n\n   User.find_in_static_cache(:first, {:password => 'fun', :user_name => 'giraffe'})", "Perform find by searching through the static record cache\n if only an id is specified", "Override calculate to compute data in memory if possible\n Only processes results if there is no scope and the no keys other than distinct", "Return the array of results to calculate if they are available", "Find all the record and initialize the cache", "Retrieve the method name to call based on the attributes\n Single attributes on primary key or the specified key call directly to the cache\n All other methods iterate through the cache", "Define the finder method on the class, and return the name of the method\n Ex. find_by_id will define find_by_id_with_static_rc\n\n The cache is searched if no additional arguments (:conditions, :joins, etc) are specified\n If additional arguments do exist find_by_id_without_static_rc is invoked", "Method missing is overridden to use cache calls for finder methods", "Initializes the generator.\n\n @param options [Hash]\n Generates the given slip.\n\n @param slip [Bollettino::Slip]\n @param path [String]", "stop and remove a compose project\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Compose/compose_down.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] raised ips are not found.\n\n @returns [HTTP::Response::Body] a streamable response object\n\n @param params [Hash] A customizable set of params.\n @option params [String] :project project name\n @option params [Boolean] :rmorphans rm containers for services not defined in the compose file\n @option params [String] :rmi remove images, all/local\n @option params [Boolean] :vol remove data volumes", "create a compose project\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/\n Compose/compose_create.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] raised ips are not found.\n\n @returns [HTTP::Response::Body] a streamable response object\n\n @param params [Hash] A customizable set of params.\n @option params [String] :project project name\n @option params [Hash] :serviceconfigs a hash representing a docker compose file services block\n @option params [Hash] :networkconfigs\n @option params [Hash] :volumeconfigs", "Serialize the message to the given StringIO.\n\n @return [nil]", "Serialize the message to a String.\n\n @return [String] the serialized message, in a String", "Set the actor's heading to point directly at first target.", "Accelerate toward the first target, but limited by rate.", "Remove the target from the environment.", "Apply the given tag to the targets.", "Blend the actor's color with the assigned color.", "Push the targets away from the actor, with force limited by elapsed time.", "Pull the targets toward the actor, with force limited by elapsed time.", "Add children to environment.", "Copy prototype to actor's location.", "Calls super method.\nAlso adds actor's vector to child's.\nFinally, reduces child's size to actor's size divided by number of shrapnel pieces.", "Copies next prototype into environment.", "Calls super method.\nAlso adds angle to target to child's vector angle.", "Finds an entity or entities.\n\n @param context [String] the lookup context.\n @param facet_name [Symbol] the facet name.\n @param args [Array] the argument splat passed to the facet.\n\n @return [Object] the retrieved entity or entities.", "Finds a facet.\n\n @param context [String] the lookup context.\n @param facet_name [Symbol] the facet name.\n\n @return [Object] the facet.", "dirty hack to avoid rails' sorted query in url", "create a service\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Service/create.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n\n @return [Hash] Hash containing service information.\n\n @param params [Hash] A customizable set of params.\n @param params [String] :image  service name\n @param params [String] :name image name\n @param params [Fixnum] :replicas numer of replicas\n @param params [Fixnum] :serviceport service port\n @param params [Fixnum] :containerport container port\n @param params [Hash] :labels hash containing labels\n @param params [String] :entrypoint entrypoint\n @param params [String] :cmd command\n @param params [Boolean] :stdin keep STDIN open even if not attached.\n @param params [Array] :env array of envs [\"env=value\", [\"env2=value\"]]\n @param params [String] :algorithm algorithm of the service, 'roundrobin', 'leastconn'\n @param params [String] :protocol prot\n @param params [String] :workingdir working directory\n @param params [Boolean] :sessionaffinity whether the service uses sticky sessions.\n @param params [String] :securitygroups security group for the container.", "This method is called to convert all the keys of a hash into symbols to allow consistent usage of hashes within your Ruby application.", "This method is called to convert all the keys of a hash into strings to allow consistent usage of hashes within your Ruby application.", "Convert an object to a hash representation of its instance variables.\n @return [Hash] if the object is not nil, otherwise nil is returned.", "Establish a follow relationship between two IDs. After adding the follow\n relationship, it checks to see if the relationship is reciprocated and establishes that\n relationship if so.\n\n @param from_id [String] The ID of the individual establishing the follow relationship.\n @param to_id [String] The ID of the individual to be followed.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(1, 11)", "Remove a follow relationship between two IDs. After removing the follow\n relationship, if a reciprocated relationship was established, it is\n also removed.\n\n @param from_id [String] The ID of the individual removing the follow relationship.\n @param to_id [String] The ID of the individual to be unfollowed.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(1, 11)\n   Amico.unfollow(1, 11)", "Block a relationship between two IDs. This method also has the side effect\n of removing any follower or following relationship between the two IDs.\n\n @param from_id [String] The ID of the individual blocking the relationship.\n @param to_id [String] The ID of the individual being blocked.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.block(1, 11)", "Accept a relationship that is pending between two IDs.\n\n @param from_id [String] The ID of the individual accepting the relationship.\n @param to_id [String] The ID of the individual to be accepted.\n @param scope [String] Scope for the call.\n\n Example\n\n   Amico.follow(1, 11)\n   Amico.pending?(1, 11) # true\n   Amico.accept(1, 11)\n   Amico.pending?(1, 11) # false\n   Amico.following?(1, 11) #true", "Deny a relationship that is pending between two IDs.\n\n @param from_id [String] The ID of the individual denying the relationship.\n @param to_id [String] The ID of the individual to be denied.\n @param scope [String] Scope for the call.\n\n Example\n\n   Amico.follow(1, 11)\n   Amico.pending?(1, 11) # true\n   Amico.deny(1, 11)\n   Amico.pending?(1, 11) # false\n   Amico.following?(1, 11) #false", "Check to see if one individual is following another individual.\n\n @param id [String] ID of the individual checking the following status.\n @param following_id [String] ID of the individual to see if they are being followed by id.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(1, 11)\n   Amico.following?(1, 11)\n\n @return true if id is following following_id, false otherwise", "Check to see if one individual is a follower of another individual.\n\n @param id [String] ID of the individual checking the follower status.\n @param following_id [String] ID of the individual to see if they are following id.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(11, 1)\n   Amico.follower?(1, 11)\n\n @return true if follower_id is following id, false otherwise", "Check to see if one individual has blocked another individual.\n\n @param id [String] ID of the individual checking the blocked status.\n @param blocked_id [String] ID of the individual to see if they are blocked by id.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.block(1, 11)\n   Amico.blocked?(1, 11)\n\n @return true if id has blocked blocked_id, false otherwise", "Check to see if one individual is blocked by another individual.\n\n @param id [String] ID of the individual checking the blocked by status.\n @param blocked_id [String] ID of the individual to see if they have blocked id.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.block(1, 11)\n   Amico.blocked_by?(11, 1)\n\n @return true if id is blocked by blocked_by_id, false otherwise", "Check to see if one individual has reciprocated in following another individual.\n\n @param from_id [String] ID of the individual checking the reciprocated relationship.\n @param to_id [String] ID of the individual to see if they are following from_id.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(1, 11)\n   Amico.follow(11, 1)\n   Amico.reciprocated?(1, 11)\n\n @return true if both individuals are following each other, false otherwise", "Check to see if one individual has a pending relationship with another.\n\n @param from_id [String] ID of the individual checking the pending relationships.\n @param to_id [String] ID of the individual to see if they are pending an approval from from_id.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(1, 11)\n   Amico.pending_with?(11, 1) # true\n\n @return true if the relationship is pending, false otherwise", "Count the number of pages of following relationships for an individual.\n\n @param id [String] ID of the individual.\n @param page_size [int] Page size.\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(1, 11)\n   Amico.follow(1, 12)\n   Amico.following_page_count(1)\n\n @return the number of pages of following relationships for an individual.", "Count the number of pages of follower relationships for an individual.\n\n @param id [String] ID of the individual.\n @param page_size [int] Page size (default: Amico.page_size).\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(11, 1)\n   Amico.follow(12, 1)\n   Amico.followers_page_count(1)\n\n @return the number of pages of follower relationships for an individual.", "Count the number of pages of blocked relationships for an individual.\n\n @param id [String] ID of the individual.\n @param page_size [int] Page size (default: Amico.page_size).\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.block(1, 11)\n   Amico.block(1, 12)\n   Amico.blocked_page_count(1)\n\n @return the number of pages of blocked relationships for an individual.", "Count the number of pages of blocked_by relationships for an individual.\n\n @param id [String] ID of the individual.\n @param page_size [int] Page size (default: Amico.page_size).\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.block(11, 1)\n   Amico.block(12, 1)\n   Amico.blocked_by_page_count(1)\n\n @return the number of pages of blocked_by relationships for an individual.", "Count the number of pages of reciprocated relationships for an individual.\n\n @param id [String] ID of the individual.\n @param page_size [int] Page size (default: Amico.page_size).\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(1, 11)\n   Amico.follow(1, 12)\n   Amico.follow(11, 1)\n   Amico.follow(12, 1)\n   Amico.reciprocated_page_count(1)\n\n @return the number of pages of reciprocated relationships for an individual.", "Count the number of pages of pending relationships for an individual.\n\n @param id [String] ID of the individual.\n @param page_size [int] Page size (default: Amico.page_size).\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(11, 1)\n   Amico.follow(12, 1)\n   Amico.pending_page_count(1) # 1\n\n @return the number of pages of pending relationships for an individual.", "Count the number of pages of individuals waiting to approve another individual.\n\n @param id [String] ID of the individual.\n @param page_size [int] Page size (default: Amico.page_size).\n @param scope [String] Scope for the call.\n\n Examples\n\n   Amico.follow(1, 11)\n   Amico.follow(1, 12)\n   Amico.pending_with_page_count(1) # 1\n\n @return the number of pages of individuals waiting to approve another individual.", "Retrieve a count of all of a given type of relationship for the specified id.\n\n @param id [String] ID of the individual.\n @param type [Symbol] One of :following, :followers, :reciprocated, :blocked, :blocked_by, :pending, :pending_with.\n @param scope [String] Scope for the call.\n\n @return Count of all of a given type of relationship for the specified id.", "Retrieve a page count of a given type of relationship for the specified id.\n\n @param id [String] ID of the individual.\n @param type [Symbol] One of :following, :followers, :reciprocated, :blocked, :blocked_by, :pending, :pending_with.\n @param page_size [int] Page size (default: Amico.page_size).\n @param scope [String] Scope for the call.\n\n @return Page count of a given type of relationship for the specified id.", "Add the following, followers and check for a reciprocated relationship. To be used from the\n +follow+ and +accept+ methods.\n\n @param from_id [String] The ID of the individual establishing the follow relationship.\n @param to_id [String] The ID of the individual to be followed.", "Count the total number of pages for a given key in a Redis sorted set.\n\n @param key [String] Redis key.\n @param page_size [int] Page size from which to calculate total pages.\n\n @return total number of pages for a given key in a Redis sorted set.", "Retrieve a page of items from a Redis sorted set without scores.\n\n @param key [String] Redis key.\n @param options [Hash] Default options for paging.\n\n @return a page of items from a Redis sorted set without scores.", "Convert a response from Google Analytics into a comma-separated values\n format file.\n @return [String] The result of the query formatted as a comma-separated\n   values string.", "list existing containers\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/list.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::InternalServerError] raised when 5xx is returned from hyper.\n\n @return [Hyperb::Container] Array of Hyperb::Container.\n\n @param params [Hash] A customizable set of params.\n\n @option params [Boolean] :all show all containers, false by default\n @option params [Boolean] :size show containers size\n @option params [String] :limit show `limit` last created containers.\n @option params [String] :since show only containers created since Id.\n @option params [String] :before only containers created before Id.\n TODO: @option params [Hash] :filters JSON encoded value of the filters.", "remove the container id\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/remove.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] raised when container can't be found.\n @raise [Hyperb::Error::Conflict] raised when container is running and can't be removed.\n @raise [Hyperb::Error::InternalServerError] raised when a 5xx is returned.\n\n @return [Hash] downcased symbolized json response.\n\n @param params [Hash] A customizable set of params.\n\n @option params [Boolean] :v remove volumes attached. default false\n @option params [Boolean] :force force remove. default false", "create a container\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/create.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::Conflict] raised container with the same name is already created.\n @raise [Hyperb::Error::InternalServerError] raised when a 5xx is returned\n\n @return [Hash] hash containing downcased symbolized json response.\n\n @param params [Hash] A customizable set of params.\n\n @option params [String] :name container name\n @option params [String] :image image to be used\n @option params [String] :hostname container hostname\n @option params [String] :entrypoint container entrypoint\n @option params [String] :cmd container command\n @option params [String] :user add user to container\n @option params [String] :workingdir working directory for commands to run in.\n @option params [Array] :mounts array of strings with mount directories.\n @option params [String] :networkmode network mode, ie 'bridge'.\n @option params [Hash] :exposedports ports to expose.\n\n @option params [Hash] :exposedports ports to expose.\n\n @option params [Hash] :labels hash containing key: value\n @option params labels [String] :sh_hyper_instancetype container size: s1, s2, s3 ...", "rename a container\n\n @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/rename.html\n\n @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.\n @raise [Hyperb::Error::NotFound] raised when the container can't be found.\n @raise [Hyperb::Error::InternalServerError] raised when 5xx is returned.\n\n @param params [Hash] A customizable set of params.\n @option params [String] :id new name\n @option params [String] :name new name", "Load the configuration file\n @private", "Recursively parses the loaded settings and creating log file destinations\n @param [Hash] the loaded settings\n @param [LogFile] the logfile object\n @see Logmsg:LogFile\n @private", "Add a friend to the current user.", "Add tracks or playlists to the current user's collection.", "Add a track to a playlist.", "Create a new playlist in the current user's collection.  The new\n playlist will be returned if the creation is successful, otherwise\n null will be returned.", "Get information about the currently logged in user.", "Delete a playlist.", "Get the activity events for a user, a user's friends, or\n everyone on Rdio.", "Get the albums in the user's collection by a particular artist.", "Find the most popular artists or albums for a user, their friends\n or the whole site.", "Return new albums released across a timeframe.", "Return the object that the supplied Rdio short-code is a\n representation of, or null if the short-code is invalid.", "Return the object that the supplied Rdio url is a representation\n of, or null if the url doesn't represent an object.", "Get an playback token. If you are using this for web playback you\n must supply a domain.", "Get the current user's playlists.", "Return the site-wide most popular items for a given type.", "Which tracks on the given album are in the user's collection.", "Which tracks from the given artist are in the user's collection.", "Remove a friend from the current user.", "Remove tracks or playlists from the current user's collection.", "Remove an item from a playlist by its position in the playlist.", "Sets the name and description for a playlist.", "Match the supplied prefix against artists, albums, tracks and\n people in the Rdio system.  Return the first ten matches.", "Retrieve an access token given the specified End User username, password and Linkshare AccountID.\n\n @param [String] username the End User username\n @param [String] password the End User password\n @param [String] sid the Account ID\n @param [Hash] params additional params", "execute a shell command and raise an error if non-zero exit code is returned", "Configure a model to be used with devise and google authentication\n @param [Array] modules a list of symbols used with a devise call", "Set up sub resources to be used to call Hoiio API\n This method passes the @client object to the initialize block of all API request.", "Update an item using an OmekaItem instance\n @param omeka_item [OmekaItem] An instance of OmekaItem\n @since 0.0.4", "Helper method to build an API request\n\n @param method [String] The type of REST request to make: \"get\", \"post\",\n   \"put\", or \"delete\".\n @param resource [String] The type of resource to request from the Omeka\n   site, e.g., \"items\" or \"site\".\n @param id [Integer] The id of the resource to request from the Omeka\n   site.\n @param body [] The body of a request in a PUT or POST request.\n @param query [Hash] Additional query parameters for the request.\n\n @return [NetHttpPersistentResponseWrapper] A wrapper around the API's\n response, containing the HTTP code and the response body.\n\n @since 1.0.0", "the same as markdown", "Add a feature, replacing either the place or manner of articulation,\n or the height or backness. Returns self.", "Remove a feature, and return self.", "Iterator for lines passing |line, original_line_number, modified_line_number| as block arguments", "Provides access to instance methods", "Create a content box.\n\n options - A hash of options to apply to the box.\n &block - The content of the box, passed an instance of Helpers::BoxBuilder.\n\n Valid options:\n\n * :headline -- The headline to show in the box.\n * :class -- A class to apply to the box.\n * :id -- The ID to apply to the box.\n\n Example:\n   <% content_box :headline => \"My Box\", :class => \"alert\", :id => \"my_box\" do |box| %>\n     <% box.navigation do |nav| %>\n       <% nav.item \"List People\", people_path, :active => true %>\n       <% nav.item \"New Person\", new_person_path %>\n       <% nav.item \"Search\", search_path(:type => \"people\") %>\n     <% end %>\n\n     <% box.breadcrumbs do |crumbs| %>\n       <% crumbs.item \"Home\", root_path %>\n       <% crumbs.item \"People\", people_path %>\n       <% crumbs.item \"Bob Jones\", person_path(@person), :active => true %>\n     <% end %>\n\n     <p>This is a really neat box, which will be displayed with a headline and navigation.</p>\n   <% end %>\n\n Returns the completed box, yields an instance of Helpers::BoxBuilder.", "Display an icon\n\n name - The icon to display\n size - One of :small or :large (optional)\n options - A hash to be passed to the image_tag helper (optional)\n\n Example:\n   manageable_icon(\"add\")\n   # => image_tag(\"/assets/manageable/icons/16x16/add.png\", :alt => \"Add\")\n   manageable_icon(\"new_item\", :large)\n   # => image_tag(\"/assets/manageable/icons/32x32/new_item.png, :alt => \"New Item\")\n\n Returns an image tag, ready to be displayed in a template.", "Creates a set of buttons\n\n options - A hash of attributes to apply to the wrapping div tag\n\n Example:\n   <div class=\"block\">\n     <div class=\"content\">\n       <%= controls do |c|\n         c.item \"Copy\", copy_person_path(person), :icon => \"copy_person\"\n         c.item \"Delete\", person_path(person), :method => :delete\n       end %>\n     </div>\n   </div>\n\n Returns a set of controls to be displayed.", "Displays a breadcrumb trail\n\n options - A hash of attributes to apply to the wrapping div tag\n\n Example:\n   <div class=\"block\">\n     <div class=\"content\">\n       <h2><%= @news_item.title %></h2>\n       <p><%= @news_item.content %></p>\n     </div>\n     <%= breadcrumbs do |b|\n       b.item \"Home\", root_path\n       b.item \"News\", news_path\n       b.item \"Awesome New Things\", news_path(@news_item), :active => true\n     %>\n   </div>\n\n Returns the breadcrumb trail.", "Creates a link_to button", "Helper for custom attrtastic like builder", "Call a method for the current Request\n\n Example:\n   wsdl = SOAP::LC.new( ).wsdl( \"http://...\" )\n   request = wsdl.request( )\n   response = request.call( \"myMethod\", :param1 => \"hello\" )\n     # => #<SOAP::Response:0xNNNNNN>", "Returns the DN for the given CN attribute", "Returns the mail for a given CN attribute", "Searches a group and its nested member groups for a member DN\n @param [Array] groups CNs to search\n @param [String] dn the DN to search for\n @param [Array] seen groups that have already been traversed\n @return [Boolean] true if dn was seen in groups", "Gets the entire list of members for a CN.\n Handles range results.\n @param [String] cn of the entry to fetch.\n @param [Integer] start index of range result\n @return [Array] list of member CNs", "deploys a request in singularity", "Make a new message. Every message can be created using a hash,\n block, or direct assignment.\n\n   message = Message.new do\n     email do\n       subject 'Subject'\n     end\n   end\n   message = Message.new email: { subject: 'Subject' }\n   message = Message.new\n   message.email = Email.new subject: 'Subject'\n Loops through each registered message type and sets the content body.", "Delivers all of the messages to the given 'audience'. An 'audience'\n object can be a hash or an object that responds to the current message\n types. Only the message types specified in the 'audience' object will\n be sent to.\n\n   message.deliver email: 'hello@example.com', sms: '+15555555555'\n   audience = OpenStruct.new\n   audience.email = 'hello@example.com'\n   audience.sms = '+15555555555'\n   message.deliver(audience)", "Generate a notification message.", "Fire up the Android emulators", "Sets up a new section\n\n\n Makes a reservation for this section\n POST /api/v1/event/{eventKey}/performance/{performanceKey}/section/{performanceSectionKey}/reservation/{languageCode}\n @param email: '' [type] [description]\n\n @return Reservation", "Convert this Modelish object into a vanilla Hash with stringified keys.\n\n @return [Hash] the hash of properties", "Main interface for checking feats", "Returns the CSS needed to round the correct corner\n\n `border-top-left-radius`", "Takes care of bootstrapping the Json file, both in terms of creating the\n file and in terms of creating a skeleton Json schema.\n\n Return true if successfully saved.", "I know, right?", "Determines the Google Compute project which contains bases instances of\n type name\n\n @param [String] name The platform type to search for\n\n @return The Google Compute project name\n\n @raise [Exception] If the provided platform type name is unsupported", "Discover the currently active Google Compute API\n\n @param [String] version The version of the Google Compute API to discover\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail to discover the Google Compute API,\n either through errors or running out of attempts", "Creates an authenticated connection to the Google Compute Engine API\n\n @param [String] keyfile The location of the Google Compute Service\n Account keyfile to use for authentication\n\n @param [String] password The password for the provided Google Compute\n Service Account key\n\n @param [String] email The email address of the Google Compute Service\n Account we are using to connect\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail to create an authenticated\n connection to the Google Compute API, either through errors or running\n out of attempts", "Executes a provided Google Compute request using a previously configured\n and authenticated Google Compute client connection\n\n @param [Hash] req A correctly formatted Google Compute request object\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail to execute the request, either\n through errors or running out of attempts", "Determines a list of existing Google Compute firewalls\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @return [Array[Hash]] The firewalls array of hashes\n\n @raise [Exception] Raised if we fail determine the list of existing\n firewalls, either through errors or running out of attempts", "Create a Google Compute firewall on the current connection\n\n @param [String] name The name of the firewall to create\n\n @param [Hash] network The Google Compute network hash in which to create\n the firewall\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail create the firewall, either through\n errors or running out of attempts", "Create a Google Compute disk on the current connection\n\n @param [String] name The name of the disk to create\n\n @param [Hash] img The Google Compute image to use for instance creation\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail create the disk, either through\n errors or running out of attempts", "Create a Google Compute instance on the current connection\n\n @param [String] name The name of the instance to create\n\n @param [Hash] img The Google Compute image to use for instance creation\n\n @param [Hash] machineType The Google Compute machineType\n\n @param [Hash] disk The Google Compute disk to attach to the newly created\n instance\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail create the instance, either through\n errors or running out of attempts", "Delete a Google Compute instance on the current connection\n\n @param [String] name The name of the instance to delete\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail delete the instance, either through\n errors or running out of attempts", "Delete a Google Compute disk on the current connection\n\n @param [String] name The name of the disk to delete\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail delete the disk, either through\n errors or running out of attempts", "Delete a Google Compute firewall on the current connection\n\n @param [String] name The name of the firewall to delete\n\n @param [Integer] start The time when we started code execution, it is\n compared to Time.now to determine how many further code execution\n attempts remain\n\n @param [Integer] attempts The total amount of attempts to execute that we\n are willing to allow\n\n @raise [Exception] Raised if we fail delete the firewall, either through\n errors or running out of attempts", "Set tags on a Google Compute instance\n\n @param [Array<String>] data An array of tags to be added to an instance\n\n @return [Hash] A correctly formatted Google Compute request hash", "Create a Google Compute instance create request\n\n @param [String] name The name of the instance to create\n\n @param [String] image The link to the image to use for instance create\n\n @param [String] machineType The link to the type of Google Compute\n instance to create (indicates cpus and memory size)\n\n @param [String] disk The link to the disk to be used by the newly created\n instance\n\n @return [Hash] A correctly formatted Google Compute request hash", "Loop through each line in the caller and see if the method we're watching is being called\n This is needed due to the way TracePoint deals with inheritance", "Parses original method call location\n Determines if a string literal was used or not", "Perform a lint of relevant code\n\n All defined lints require a \"result\" method\n @example the result method in the child class\n   def result\n     @task = __method__.to_s\n     @path ||= 'path/or/**/glob/to/files''\n     lint_data = JSON.parse(`some-command-line-linter`)\n     @output[:files_inspected] ||= files_inspected(extension, delimiter, base_path_replacement)\n     refine data_from_output\n   end\n\n Inherits settings from {Config#initialize}\n @see Config#initialize\n\n @param opts [Hash] ({}) options passed directly to the lint\n @option opts [Hash] :git_files filename: file location\n   @see GitControl#lints_and_stats\n @option opts [Array, String] :file_paths lint only specific files or directories\n   Accepts globs too\n   which is used to define paths from the URL\n @option opts [Config object] :config custom Maximus::Config object\n @return [void] this method is used to set up instance variables\n Convert raw data into warnings, errors, conventions or refactors. Use this wisely.\n @param data [Hash] unfiltered lint data\n @return [Hash] refined lint data and all the other bells and whistles", "List all files inspected\n @param ext [String] extension to search for\n @param delimiter [String] comma or space separated\n @param remove [String] remove from all file names\n @return all_files [Array<string>] list of file names", "Compare lint output with lines changed in commit\n @param lint [Hash] output lint data\n @param files [Hash<String: String>] filename: filepath\n @return [Array] lints that match the lines in commit", "Add severities to @output\n @since 0.1.5\n @param data [Hash]", "Send abbreviated results to console or to the log\n @return [String] console message to display", "If there's just too much to handle, through a warning.\n @param lint_length [Integer] count of how many lints\n @return [String] console message to display", "Dev display, executed only when called from command line\n @param errors [Hash] data from lint\n @return [String] console message to display", "Handle data and generate relevant_output if appropriate\n @since 0.1.6\n @see #refine\n @param data [String, Hash]\n @return [String, Hash] String if error, Hash if success", "generate the POST body required for bulk job creation\n\n @param name [String]  Desired name for bulk job\n @param api_url [String] Desired API url to use for urls\n @param urls [Array] An array of input urls to pass to bulk job\n @param options [Hash] An hash of options\n @return [Hash]", "retrieve data per given jobName\n\n @param jobName [String] Name of bulk job\n @param _options [Hash] An hash of options\n @return [Hash]", "Global options for all of maximus\n\n @param opts [Hash] options passed directly to config\n @option opts [Boolean] :is_dev (false) whether or not the class was initialized from the command line\n @option opts [String, Boolean, nil] :log ('log/maximus_git.log') path to log file\n   If not set, logger outputs to STDOUT\n @option opts [String, Boolean] :git_log (false) path to log file or don't log\n   The git gem is very noisey\n @option opts [String] :root_dir base directory\n @option opts [String] :domain ('http://localhost') the host - used for Statistics\n @option opts [String, Integer] :port ('') port number - used for Statistics\n   and appended to domain. If blank (false, empty string, etc.), will not\n   append to domain\n @option opts [String, Array] :file_paths ('') path to files. Accepts glob notation\n @option opts [Hash] :paths ({home: '/'}) labeled relative path to URLs. Statistics only\n @option opts [String] :commit accepts sha, \"working\", \"last\", or \"master\".\n @option opts [String] :config_file ('maximus.yml') path to config file\n @option opts [Boolean] :compile_assets (true) compile and destroy assets automagically\n @option opts [String] :framework (nil) accepts 'rails' and 'middleman' (should only be used\n   when calling Maximus from a Ruby script)\n @return [#load_config_file #group_families #evaluate_settings] this method is used to set up instance variables\n Set global options or generate appropriate config files for lints or statistics\n @param settings_data [Hash] (@settings) loaded data from the discovered maximus config file\n @return [Hash] paths to temp config files and static options\n   These should be deleted with destroy_temp after read and loaded", "Remove all or one created temporary config file\n @see temp_it\n @param filename [String] (nil) file to destroy\n   If nil, destroy all temp files", "Look for a maximus config file\n\n Checks ./maximus.yml, ./.maximus.yml, ./config/maximus.yml in order.\n   If there hasn't been a file discovered yet, checks ./config/maximus.yml\n   and if there still isn't a file, load the default one included with the\n   maximus gem.\n\n @since 0.1.4\n @param file_path [String]\n @param root [String] file path to root directory\n @return @settings [Hash]", "Allow shorthand to be declared for groups Maximus executions\n\n @example disable statistics\n   @settings[:statistics] = false\n   set_families('statistics', ['phantomas', 'stylestats', 'wraith'])\n\n Sets as Boolean based on whether or not the queried label is `true`\n @param head_of_house [String] @settings key and group label\n @param family [Array] group of other @settings keys to be disabled\n @return [void] modified @settings", "Load config files if filename supplied\n\n @param value [Mixed] value from base config file\n @param [Hash] return blank hash if file not found so\n   the reset of the process doesn't break", "Create a temp file with config data\n\n Stores all temp files in @temp_files or self.temp_files\n   In Hash with filename minus extension as the key.\n\n @param filename [String] the preferred name/identifier of the file\n @param data [Mixed] config data important to each lint or statistic\n @return [String] absolute path to new config file", "Accounting for space-separated command line arrays\n @since 0.1.4\n @param paths [Array]\n @return [Hash]", "Wraith is a complicated gem with significant configuration\n @see yaml_evaluate, temp_it\n @param value [Hash] modified data from a wraith config or injected data\n @param name [String] ('wraith') config file name to write and eventually load\n @return [String] temp file path", "See if a config file exists\n\n @see load_config_file\n\n This is used exclusively for the load_config_file method\n @param file [String] file name\n @param root [String] file path to root directory\n @return [String, FalseClass] if file is found return the absolute path\n   otherwise return false so we can keep checking", "Save jshintignore if available\n @since 0.1.7\n @param settings_data_key [Hash]\n @return updates settings", "returns a pipe-delimeted list of prefix attributes", "returns a space-delimeted list of attribute=value pairs for all optionals", "Validates the contents of params against the database records.", "Creates a new user", "confirm user account", "Returns the user with matching email\n\n `GET /api/users/search?email=xxx`", "Set up instance variables\n\n Inherits settings from {Config#initialize}\n @param opts [Hash] options passed directly to config\n @option opts [Config object] :config custom Maximus::Config object\n @option opts [String] :commit accepts sha, \"working\", \"last\", or \"master\".\n 30,000 foot view of a commit\n @param commit_sha [String] (head_sha) the sha of the commit\n @return [Hash] commit data", "Compare two commits and get line number ranges of changed patches\n\n @example output from the method\n   {\n     'sha': {\n       rb: {\n         filename: 'file.rb',\n         changes: {\n           ['0..4'],\n           ['10..20']\n         }\n       }\n     }\n   }\n @param sha1 [String]\n @param sha2 [String]\n @return [Hash] diff_return files changed grouped by file extension and line number", "Run appropriate lint for every sha in commit history.\n For each sha a new branch is created then deleted\n\n @example sample output\n   {\n     'sha': {\n       lints: {\n         scsslint: {\n           files_inspec...\n         },\n       },\n       statisti...\n     },\n     'sha'...\n   }\n\n @see compare\n @param lint_by_path [Boolean] only lint by files in git commit and\n   not the commit as a whole\n @param git_shas [Hash] (#compare) a hash of gitcommit shas\n   and relevant file types in the commit\n @param nuclear [Boolean] do everything regardless of what's in the commit\n @return [Hash] data all data grouped by task", "Define associations to linters based on file extension\n @return [Hash] linters and extension arrays", "Get general stats of commit on HEAD versus last commit on master branch\n @modified 0.1.4\n @param old_commit [Git::Object]\n @param new_commit [Git::Object]\n @return [Git::Diff] hash of abbreviated, useful stats with added lines", "Get diff stats on just the initial commit\n Ruby-git doesn't support this well\n @see diff\n @since 0.1.5\n @param commit_sha [String]\n @return [Hash] stat data similar to Ruby-git's Diff.stats return", "Associate files by extension and match their changes\n @since 0.1.5\n @param commit_sha [String]\n @param files [String] list of files from git\n @return [Hash] files with matched extensions and changes", "All data retrieved from reports\n @since 0.1.6\n @param lint_opts [Hash]\n @return [Hash]", "Specific data retrieved by file extension\n @since 0.1.6\n @param ext [String]\n @param lint_opts [Hash]\n @return [Hash]", "Destroy created branch\n @since 0.1.5\n @param base_branch [String] branch we started on\n @param sha [String] used to check against created branch name", "Get list of file paths\n @param files [Hash] hash of files denoted by key 'filename'\n @param ext [String] file extension - different extensions are joined different ways\n @return [String] file paths delimited by comma or space", "Joins directory names together with the path, but does not resolve\n the resulting path.\n\n @param [Array] names\n   The names to join together.\n\n @return [Path]\n   The joined path.\n\n @example\n   Path.up(7).join('etc/passwd')\n   # => #<Ronin::Path:../../../../../../../etc/passwd>", "Validates the set of claims.\n\n @param options [Hash] The claim validation options (see\n   {Sandal::DEFAULT_OPTIONS} for details).\n @return [Hash] A reference to self.\n @raise [Sandal::ClaimError] One or more claims is invalid.", "Validates the expires claim.\n\n @param max_clock_skew [Numeric] The maximum clock skew, in seconds.\n @return [void].\n @raise [Sandal::ClaimError] The \"exp\" claim is invalid, or the token has\n   expired.", "Validates the not-before claim.\n\n @param max_clock_skew [Numeric] The maximum clock skew, in seconds.\n @return [void].\n @raise [Sandal::ClaimError] The \"nbf\" claim is invalid, or the token is\n   not valid yet.", "Validates the issuer claim.\n\n @param valid_iss [Array] The valid issuers.\n @return [void].\n @raise [Sandal::ClaimError] The \"iss\" claim value is not a valid issuer.", "Validates the audience claim.\n\n @param valid_aud [Array] The valid audiences.\n @return [void].\n @raise [Sandal::ClaimError] The \"aud\" claim value does not contain a valid\n   audience.", "Gets the value of a claim as a Time.", "Returns a new instance of Sorter\n\n @param project [Hash] the project to sort\n Traverses the objects in the project clone and sorts in place\n objects that are held under the `SORTABLE_ITEMS` keys\n\n @return [Hash] a sorted project", "The comparator used during the sort\n\n The comparator resolves the attributes for the node and appends a\n known prefix to objects where `isa = PBXGroup` to ensure that groups\n are sorted above files\n\n @param uuid [String] the uuid of the object to examine\n @!visibility public", "check the ruby sexp nodes for the ruby file.\n\n @param [String] filename is the filename of ruby code.\n @param [String] content is the content of ruby file.", "trigger all after_check callbacks defined in all checkers.", "parse ruby code.\n\n @param [String] filename is the filename of ruby code.\n @param [String] content is the content of ruby file.", "recursively check ruby sexp node.\n\n 1. it triggers the interesting checkers' start callbacks.\n 2. recursively check the sexp children.\n 3. it triggers the interesting checkers' end callbacks.", "fire the message off", "Binds an application to the specified call legs.\n @example\n   bind_meta_app :key          => 2,\n                 :listen_to    => \"a\",\n                 :respond_on   => \"s\",\n                 :application  => \"execute_extension\",\n                 :parameters   => \"dx XML features\"\n @see http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_bind_meta_app", "Bridges an incoming call to an endpoint, optionally taking an array of\n channel variables to set. If given an array of arrays, each contained\n array of endpoints will be called simultaneously, with the next array\n of endpoints as failover. See the examples below for different constructs\n and the callstring it sends to FreeSWITCH.\n @example\n   bridge \"user/coltrane\", \"user/backup-office\"\n   #=> user/coltrane,user/backup-office\n @example With channel variables\n   bridge \"user/coltrane\", \"user/backup-office\", :some_var => \"value\"\n   #=> {some_var=value}user/coltrane,user/backup-office\n @example With failover\n   bridge ['user/coltrane', 'user/davis'], ['user/sun-ra', 'user/taylor']\n   #=> user/coltrane,user/davis|user/sun-ra,user/taylor\n @see http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_bridge", "Plays a sound file and reads DTMF presses.\n @example\n   play_and_get_digits \"please-enter.wav\", \"wrong-choice.wav\",\n     :min          => 1,\n     :max          => 2,\n     :tries        => 3,\n     :terminators  => \"#\",\n     :timeout      => 5000,\n     :regexp       => '\\d+'\n @see http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_play_and_get_digits", "Records a message, with an optional limit on the maximum duration of the\n recording.\n @example Without limit\n   record \"/path/to/new/file.wac\"\n @example With 20 second limit\n   record \"/path/to/new/file.wac\", :limit => 20\n @see http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_record", "Get a quantile value for a given rank.\n\n @param rank [Float] The target quantile to retrieve.  It *must* be one of\n                     the invariants provided in the constructor.\n\n @return [Numeric, nil]  The quantile value for the rank or nil if no\n   observations are present.", "Find all files that were linted by extension\n\n @param path [String] path to folders\n @param ext [String] file extension to search for\n @return [Array<String>] list of file paths", "Convert string to boolean\n @param str [String] the string to evaluate\n @return [Boolean] whether or not the string is true", "Edit and save a YAML file\n @param yaml_location [String] YAML absolute file path\n @return [void]", "Ensure path exists\n @param path [String, Array] path to files can be directory or glob\n @return [Boolean]", "Default paths to check for lints and some stats\n @since 0.1.6.1\n Note: is_rails? must be defined second-to-last if more frameworks are added\n @param root [String] base directory\n @param folder [String] nested folder to search for for Rails or Middleman\n @param extension [String] file glob type to search for if neither\n @return [String] path to desired files", "Ensures user is owner of the comment and sets the `@comment` variable in the controllers", "Validate if user has access to comment in the post\n\n @param post_id [Integer] post id\n @param comment_id [Integer] comment id", "An open scope denies reference to local variables in enclosing scopes.", "Checks if the given variable is in scope.", "Creates new comment belonging to the post\n\n `POST /api/boards/:board_id/posts/:post_id/`", "Updates a comment\n\n `PUT /api/boards/:board_id/posts/:post_id/comments/:id`", "Ensure user has access to the board and sets the `@board` variable in the controller", "Validate if user has access to board\n\n @param board_id [Integer] board id", "Create a stream object, bind it to the input variable\n Instance variables are necessary because @end is state\n This needs to be synchronized because it uses @end as state", "Lame workaround for the fact that mash doesn't hash correctly", "Iterates over each word in the list.\n\n @yield [word]\n   The given block will be passed each word.\n\n @yieldparam [String] word\n   A word from the list.\n\n @return [Enumerator]\n   If no block is given, an Enumerator will be returned.\n\n @raise [RuntimeError]\n   {#path} or {#words} must be set.\n\n @api public", "Iterates over each word, and each mutation, from the list.\n\n @yield [word]\n   The given block will be passed each word.\n\n @yieldparam [String] word\n   A word from the list.\n\n @return [Enumerator]\n   If no block is given, an Enumerator will be returned.\n\n @api public", "Saves the words to a new file.\n\n @param [String] path\n   The path to the new wordlist file.\n\n @return [Wordlist]\n   The wordlist object.\n\n @see #each\n\n @since 0.5.0\n\n @api public", "subscription.subscription_owner", "Access the hash table that comes with FreeSWITCH.\n @example\n   socket.hash :insert, :realm, :key, \"value\"\n   socket.hash :select, :realm, :key\n   socket.hash :delete, :realm, :key\n Originate a new call.\n @example Minimum options\n   socket.originate 'sofia/user/coltrane', :extension => \"1234\"\n @example With :dialplan and :context\n @see http://wiki.freeswitch.org/wiki/Mod_commands#originate", "add an warning.\n\n @param [String] message, is the warning message\n @param [String] filename, is the filename of source code\n @param [Integer] line_number, is the line number of the source code which is reviewing", "TypeNotFoundError\n Perform type lookup\n\n @param [Object] object\n\n @return [Object]\n   if found\n\n @raise [TypeNotFoundError]\n   otherwise\n\n @api private", "Converts all of the keys to strings, optionally formatting key name", "the annotation should have one argument, and we just want whatever it is", "Iterates over timing annotations of a block and sums them up.", "Given a set of blocks, returns 'GotoStatement's of branches", "Two parameter methods.\n\n Returns all other word forms of the same lemma for a given word form.\n   api.wordforms(\"Auto\") => [\"Auto\", \"Autos\"]\n @return [Array] a list", "Three parameter methods.\n\n Attempts to find linguistic collocations that occur to the right\n of the given input word.\n The parameter 'Wortart' accepts four values 'A, V, N, S'\n which stand for adjective, verb, noun and stopword respectively.\n The parameter restricts the type of words found.\n It returns an array:\n   api.right_collocation_finder(\"Auto\", \"V\", 10) =>\n   [\"Auto\", \"abfackeln\", \"V\", ...]", "Returns statistically significant co-occurrences of the input word.", "This method extracts valuable data from the XML structure\n of the soap response. It returns an array with extracted xml text nodes\n or nil, if the service provided no answer.", "Create a new aliyun ONS Producer instance.\n\n @param access_key [String] the access key to aliyun ONS\n @param secret_key [String] the secret key to aliyun ONS\n @param producer_id [String] the producer ID\n @param options [Hash{String, Symbol => String}]\n @option options [String] :namesrv_addr the nameserver used to fetching ons_addr\n @option options [String] :ons_addr the ONS server address\n @option options [String, Fixnum, Bignum] :send_timeout (3000) send message timeout\n Send a message.\n\n @example send 'Hello, World!' message with tag :tagA which is under topic :TopicTestMQ\n   producer.send_message('TopicTestMQ', 'tagA', 'Hello, World!')\n\n @see #send_timer_message\n\n @param topic [String] the message topic\n @param tag [String] the message tag\n @param body [String] the message body\n @param key [String] the message key\n @return [String] the message id", "Send a timer message.\n\n @example send 'Hello, World!' message at 30 seconds later\n   producer.send_timer_message('TopicTestMQ', 'tagA', 'Hello, World!', Time.now + 30)\n\n @see #send_message\n\n @param topic [String] the message topic\n @param tag [String] the message tag\n @param body [String] the message body\n @param timer [#to_i] when deliver the message\n @param key [String] the message key\n @return [String] the message id", "Distributes results to the event and result queues.\n @api private", "Takes events from the event queue and dispatches them to callbacks.\n @api private", "Do some reasonable sleuthing on the SSH public key for GCE", "Create a new instance of the Google Compute Engine hypervisor object\n\n @param [<Host>] google_hosts The Array of google hosts to provision, may\n ONLY be of platforms /centos-*/, /debian-*/, /rhel-*/, /suse-*/. Only\n supports the Google Compute provided templates.\n\n @param [Hash{Symbol=>String}] options The options hash containing\n configuration values @option options [String] :gce_project The Google\n Compute Project name to connect to\n\n @option options [String] :gce_keyfile The location of the Google Compute\n service account keyfile\n\n @option options [String] :gce_password The password for the Google Compute\n service account key\n\n @option options [String] :gce_email The email address for the Google\n Compute service account\n\n @option options [String] :gce_machine_type A Google Compute machine type\n used to create instances, defaults to n1-highmem-2\n\n @option options [Integer] :timeout The amount of time to attempt execution\n before quiting and exiting with failure\n Create and configure virtual machines in the Google Compute Engine,\n including their associated disks and firewall rules", "Shutdown and destroy virtual machines in the Google Compute Engine,\n including their associated disks and firewall rules", "Adapted from Rails country_select. Just uses country codes instead of full names.", "Returns boards belonging to current user\n\n `GET /api/boards`", "Creates board belonging to current user.\n\n `POST /api/boards`", "Updates a single board.\n\n `PUT /api/boards/:id`", "generate an url consisting of your api key and the endpoint you'd like to use\n\n @param url [String] The url to pass to diffbot\n @param token [String] Diffbot API token\n @param type [String] API to use\n @return [String] a formatted url with your api key, endpoint and input url", "add the options hash to your input url\n\n @param options [Hash] An hash of options\n @param request [String] The url to append options to\n @return [String] a formatted url with options merged into the input url", "Returns information of the color object", "Returns a next color object in X11 colors.\n The color sequence is determined by its color mode.", "check the ruby plain code.\n\n @param [String] filename is the filename of ruby code.\n @param [String] content is the content of ruby file.", "Ensures user is owner of the post and sets the `@post` variable in the controllers", "Validate if user has access to the post in the board\n\n @param board_id [Integer] board id\n @param post_id [Integer] post id", "Find all CSS files or compile.\n\n Uses sprockets if Rails; Sass engine otherwise.\n Compass is supported\n @return [#compile_scss_rails, #compile_scss, Array] CSS files", "Load Compass paths if the gem exists\n @see find_css_files\n @since 0.1.5", "Add directories to load paths\n @todo This function is here in case older versions of SCSS will need it\n   because there shouldn't be a need to load paths, but there might be a need\n   in older versions of SCSS, which should be tested (although the SCSSLint)\n   dependency may dictate our scss version\n @since 0.1.5", "Turn scss files into css files\n Skips if the file starts with an underscore\n @see find_css_files\n @since 0.1.5", "Find all css files\n @param path [String] globbed file path\n @return [Array] paths to compiled CSS files", "Creates a single post belonging to the board\n\n `POST /api/boards/:board_id/posts/`", "Encrypts model attribute value", "Decrypts model attribute value", "Transforms the given AST into a RipperPlus AST.", "Adds variables to the given scope stack from the given node. Allows\n nodes from parameter lists, left-hand-sides, block argument lists, and\n so on.", "If this node's subtrees are ordered as they are lexically, as most are,\n transform each subtree in order.", "Transforms a parameter list, and adds the new variables to current scope.\n Used by both block args and method args.", "patch tags go from alpha, alpha2, alpha3, etc.", "Visit a child by name\n\n @param [Symbol] name\n   the attribute name of the child to visit\n\n @return [undefined]\n\n @api private", "Visit many children\n\n @param [Symbol] name\n   the name of the collection attribute with children to visit\n\n @return [undefined]\n\n @api private", "Call block inside indented context\n\n @return [undefined]\n\n @api private", "Various bad-strings.\n\n @yield [string]\n   The given block will be passed each bad-string.\n\n @yieldparam [String] string\n   A bad-string containing known control characters, deliminators\n   or null-bytes (see {NULL_BYTES}), of varying length\n   (see {SHORT_LENGTHS} and {LONG_LENGTHS}).", "The range of bit-fields.\n\n @yield [bitfield]\n   The given block will be passed each bit-field.\n\n @yieldparam [String] bitfield\n   A bit-field (8bit - 64bit).", "The range of signed bit-fields.\n\n @yield [bitfield]\n   The given block will be passed each bit-field.\n\n @yieldparam [String] bitfield\n   A signed bit-field (8bit - 64bit).", "Run phantomas through the command line\n @see Statistic#initialize", "Initializes the Rule\n @param [Hash] kwargs The options to initialize the Rule with\n @option kwargs [String] :enabled true or false\n @option kwargs [String] :action The action\n @option kwargs [String] :proto The protocol\n @option kwargs [String] :src The source IP\n @option kwargs [String] :sport The source Port\n @option kwargs [String] :dir The direction of traffic flow\n @option kwargs [String] :dst The destination IP\n @option kwargs [String] :dport The destination Port\n @option kwargs[Array<Snort::RuleOption>] :options The better way of passing in options, using\n   option objects that know how to represent themselves as a string properly\n Output the current object into a snort rule", "Get a diff percentage of all changes by label and screensize\n\n @example { :statistics => { \"/\" => { :browser=>\"phantomjs\", :name=>\"home\", :percent_changed=>{ 1024=>2.1, 1280=>1.8, 767=>3.4 } } } }\n @param browser [String] headless browser used to generate the gallery\n @return [Hash] { path: { browser, path_label, percent_changed: { size: percent_diff ] } }", "Grab the percentage change from previous snapshots\n @since 0.1.5\n @param file [String]\n @param browser_output [Hash]\n @return [Hash]", "Create a new aliyun ONS Consumer instance.\n\n @param access_key [String] the access key to aliyun ONS\n @param secret_key [String] the secret key to aliyun ONS\n @param consumer_id [String] the consumer ID\n @param options [Hash{String, Symbol => String}]\n @option options [String] :namesrv_addr the nameserver used to fetching ons_addr\n @option options [String] :ons_addr the ONS server address\n @option options [String, Fixnum, Bignum] :thread_num the consumer thread numbers\n Subsribe a topic.\n\n @example subscribe tag :tagA under topic :TopicTestMQ\n   consumer.subscribe('TopicTestMQ', 'tagA') {}\n\n @example subscribe tag :tagA and :tagB under topic :TopicTestMQ\n   consumer.subscribe('TopicTestMQ', 'tagA || tagB') {}\n\n @example subscribe all tags under topic :TopicTestMQ\n   consumer.subscribe('TopicTestMQ', '*') {}\n\n @param topic [String] the message topic\n @param expression [String] the subsribe expression used to filter messages\n @param handler [#call] the handler which will handle the message\n @return [self] returns itself", "Connects to the remote debugging server in a Webkit tab.\n\n @param [Hash] opts info on the tab to connect to\n @option opts [WebkitRemote::Tab] tab reference to the tab whose debugger\n     server this RPC client connects to\n Remote debugging RPC call.\n\n See the following URL for implemented calls.\n     https://developers.google.com/chrome-developer-tools/docs/protocol/1.1/index\n\n @param [String] method name of the RPC method to be invoked\n @param [Hash<String, Object>, nil] params parameters for the RPC method to\n     be invoked\n @return [Hash<String, Object>] the return value of the RPC method", "Blocks until a WebKit message is received, then parses it.\n\n RPC notifications are added to the @events array.\n\n @param [Integer, nil] expected_id if a RPC response is expected, this\n     argument has the response id; otherwise, the argument should be nil\n @return [Hash<String, Object>, nil] a Hash containing the RPC result if an\n     expected RPC response was received; nil if an RPC notice was received", "Gets yaml file from current vagrantfile\n\n@return [String]", "Gets current provisioner with impressbox type\n\n@return [::VagrantPlugins::Kernel_V2::VagrantConfigProvisioner,nil]", "Updates name param in options hash\n\n@param options [Hash]  Input/output hash", "Writes message for action result\n\n@param result [Boolean]", "Renders and safes file\n\n@param local_file [String] Local filename\n@param tpl_file  [String] Template filename", "Makes data files array\n\n@param current_file [String] Current file name\n\n@return [Array]", "display list of accounts for authenticated user", "Get list subnet", "Get list netmask", "Get list option", "Get value authoritative", "Set data in object", "Setups basic actions and helpers in resources controller.\n\n #### Options\n\n - `sti` - include STI helpers\n - `kaminari` - include Kaminari helpers\n - `after_save_action` - action to use for `after_save_url`\n - `source_relation` - override `source_relation`", "returns all segments, don't need an offset", "Rack's call", "Raise an exception if the cache isn't compatible with the current library version", "prevents Run collection to grow beyond max_run_per_job", "Retrieves the tabs that are currently open in the browser.\n\n These tabs can be used to start debugging.\n\n @return [Array<WebkitRemote::Browser::Tab>] the open tabs", "returns all clubs, don't need an offset", "returns all members, don't need an offset", "Parses value with specified block. Reraises occured error with Error.", "Parses each value in array with specified block.\n Returns `nil` if `val` is not an array.", "An object to use as log in Rails mode.\n @return [ActiveSupport::Logger] Default is <tt>conf.rails.logger</tt>.", "Requires nested modules with `require_dependency`.\n Pass custom directory to require its content.\n By default uses caller's filename with stripped `.rb` extension from.", "returns all efforts, don't need an offset", "Yields up each XML element for the given Param object.", "Validates and formats a proposed value for this parameter. Returns\n the formatted value. Raises an ArgumentError if the value\n is invalid.\n\n The 'name' and 'style' arguments are used in conjunction with the\n default Param object.", "delete token from Plaid if there are no more accounts for this token", "delete Plaid user", "Add `self` to `types_list`. Defines scope for ActiveRecord models.", "Reads value from redis.", "Remove record from redis.", "Add new group to database.\n\n @param opts [Hash] Options that will be passed to Keepassx::Group#new.\n @return [Keepassx::Group]\n rubocop:disable Metrics/MethodLength", "Get next group ID number.\n\n @return [Fixnum]", "Retrieves last sibling index\n\n  @param parent [Keepassx::Group] Last sibling group.\n  @return [Integer] index Group index.", "Returns an Address object refering to this resource", "Creates a representation by plugging a set of parameters\n into a representation format.", "RETS Transaction Methods \n\n Most of these transaction methods mirror the RETS specification methods, so if you are\n unsure what they mean, you should check the RETS specification. The latest version can be\n found at http://www.rets.org\n Attempts to log into the server using the provided username and password.\n\n If called with a block, the results of the login action are yielded,\n and logout is called when the block returns.  In that case, #login\n returns the block's value. If called without a block, returns the\n result.\n\n As specified in the RETS specification, the Action URL is called and\n the results made available in the #secondary_results accessor of the\n results object.", "Requests Metadata from the server. An optional type and id can be specified to request\n subsets of the Metadata. Please see the RETS specification for more details on this.\n The format variable tells the server which format to return the Metadata in. Unless you\n need the raw metadata in a specified format, you really shouldn't specify the format.\n\n If called with a block, yields the results and returns the value of the block, or\n returns the metadata directly.", "Performs a GetObject transaction on the server. For details on the arguments, please see\n the RETS specification on GetObject requests.\n\n This method either returns an Array of DataObject instances, or yields each DataObject\n as it is created. If a block is given, the number of objects yielded is returned.\n\n TODO: how much of this could we move over to WEBrick::HTTPRequest#parse?", "Peforms a RETS search transaction. Again, please see the RETS specification for details\n on what these parameters mean. The options parameter takes a hash of options that will\n added to the search statement.", "The following code was copied out of fileutils.rb from ruby 1.9.3-p392", "Return all Ohm models.\n You can also pass a module class to get all models including that module", "Return all superclasses for a given class.", "Convenience method to define a no-argument singleton method on\n this object.", "Tracker for a yet-unlaunched process.\n\n @param [Hash] opts tweak the options below\n @option opts [Integer] port the port used by the remote debugging server;\n     the default port is 9292\n @option opts [Number] timeout number of seconds to wait for the browser\n     to start; the default timeout is 10 seconds\n @option opts [Hash<Symbol, Number>] window set the :left, :top, :width and\n     :height of the browser window; by default, the browser window is\n     256x256 starting at 0,0.\n @option opts [Boolean] allow_popups when true, the popup blocker is\n     disabled; this is sometimes necessary when driving a Web UI via\n     JavaScript\n @option opts [Boolean] headless if true, Chrome runs without any dependency\n     on a display server\n @option opts [String] chrome_binary path to the Chrome binary to be used;\n     by default, the path is automatically detected\n Starts the browser process.\n\n @return [WebkitRemote::Browser] master session to the started Browser\n     process; the session's auto_close is set to false so that it can be\n     safely discarded; nil if the launch fails", "Stops the browser process.\n\n Only call this after you're done with the process.\n\n @return [WebkitRemote::Process] self", "Builds a service response object out of an HTTPResponse object.", "Reads the reply from the socket\n and parses the returned json into a ruby object.\n\n Throws WrongMagicCode when magic word is wrong.\n Throws WrongType if returned type does not match expected.\n\n This is a bit duplicated code\n  but I don't know a way to read the full send reply\n  without knowing its length", "method_missing is to catch generated methods that don't get delegated.", "method_missing won't catch these guys because they were defined in\n the delegation operation.", "Generates crontab for each scheduled Job using Whenever DSL.", "For generating time tags calculated using jquery.timeago", "Check if object still exists in the database and display a link to it,\n otherwise display a proper message about it.\n This is used in activities that can refer to\n objects which no longer exist, like removed posts.", "Perform a deep copy.", "Binds some or all of the unbound variables in this address to values.", "Starts interacting with the launchpad. Resets the device when\n the interaction was properly stopped via stop or close.\n\n Optional options hash:\n\n [<tt>:detached</tt>]  <tt>true/false</tt>,\n                       whether to detach the interaction, method is blocking when +false+,\n                       optional, defaults to +false+\n\n Errors raised:\n\n [Launchpad::NoInputAllowedError] when input is not enabled on the interaction's device\n [Launchpad::NoOutputAllowedError] when output is not enabled on the interaction's device\n [Launchpad::CommunicationError] when anything unexpected happens while communicating with the launchpad", "Stops interacting with the launchpad.\n\n Errors raised:\n\n [Launchpad::NoInputAllowedError] when input is not enabled on the interaction's device\n [Launchpad::CommunicationError] when anything unexpected happens while communicating with the", "Registers a response to one or more actions.\n\n Parameters (see Launchpad for values):\n\n [+types+] one or an array of button types to respond to,\n           additional value <tt>:all</tt> for all buttons\n [+state+] button state to respond to,\n           additional value <tt>:both</tt>\n\n Optional options hash:\n\n [<tt>:exclusive</tt>] <tt>true/false</tt>,\n                       whether to deregister all other responses to the specified actions,\n                       optional, defaults to +false+\n [<tt>:x</tt>]         x coordinate(s), can contain arrays and ranges, when specified\n                       without y coordinate, it's interpreted as a whole column\n [<tt>:y</tt>]         y coordinate(s), can contain arrays and ranges, when specified\n                       without x coordinate, it's interpreted as a whole row\n\n Takes a block which will be called when an action matching the parameters occurs.\n\n Block parameters:\n\n [+interaction+] the interaction object that received the action\n [+action+]      the action received from Launchpad::Device.read_pending_actions", "Deregisters all responses to one or more actions.\n\n Parameters (see Launchpad for values):\n\n [+types+] one or an array of button types to respond to,\n           additional value <tt>:all</tt> for actions on all buttons\n           (but not meaning \"all responses\"),\n           optional, defaults to +nil+, meaning \"all responses\"\n [+state+] button state to respond to,\n           additional value <tt>:both</tt>\n\n Optional options hash:\n\n [<tt>:x</tt>] x coordinate(s), can contain arrays and ranges, when specified\n               without y coordinate, it's interpreted as a whole column\n [<tt>:y</tt>] y coordinate(s), can contain arrays and ranges, when specified\n               without x coordinate, it's interpreted as a whole row", "Returns an array of grid positions for a range.\n\n Parameters:\n\n [+range+] the range definitions, can be\n           * a Fixnum\n           * a Range\n           * an Array of Fixnum, Range or Array objects", "Checks if the event meets a set of conditions.\n\n This is used in WebkitRemote::Client#wait_for.\n\n @param [Hash<Symbol, Object>] conditions the conditions that must be met\n     by an event to get out of the waiting loop\n @option conditions [Class] class the class of events to wait for; this\n     condition is met if the event's class is a sub-class of the given class\n @option conditions [Class] type synonym for class that can be used with the\n     Ruby 1.9 hash syntax\n @option conditions [String] name the event's name, e.g.\n     \"Page.loadEventFired\"\n @return [Boolean] true if this event matches all the given conditions", "Module to hold generated methods. Single for all status fields in model.", "Initialize new model, sets parent record and call build_defaults method", "Convert request params to model scopes", "Prints a manpage, all pretty and paged.\n Returns the terminal-formatted manpage, ready to be printed to\n the screen.", "Returns the raw manpage. If we're not running in standalone\n mode, it's a file sitting at the root under the `man`\n directory.\n\n If we are running in standalone mode the manpage will be\n included after the __END__ of the file so we can grab it using\n DATA.", "Clear logs `tail -f`-safely.", "Returns a URI and a set of HTTP headers for this request.", "Changes a single LED.\n\n Parameters (see Launchpad for values):\n\n [+type+] type of the button to change\n\n Optional options hash (see Launchpad for values):\n\n [<tt>:x</tt>]     x coordinate\n [<tt>:y</tt>]     y coordinate\n [<tt>:red</tt>]   brightness of red LED\n [<tt>:green</tt>] brightness of green LED\n [<tt>:mode</tt>]  button mode, defaults to <tt>:normal</tt>, one of:\n                   [<tt>:normal/tt>]     updates the LED for all circumstances (the new value will be written to both buffers)\n                   [<tt>:flashing/tt>]   updates the LED for flashing (the new value will be written to buffer 0 while the LED will be off in buffer 1, see buffering_mode)\n                   [<tt>:buffering/tt>]  updates the LED for the current update_buffer only\n\n Errors raised:\n\n [Launchpad::NoValidGridCoordinatesError] when coordinates aren't within the valid range\n [Launchpad::NoValidBrightnessError] when brightness values aren't within the valid range\n [Launchpad::NoOutputAllowedError] when output is not enabled", "Changes all LEDs in batch mode.\n\n Parameters (see Launchpad for values):\n\n [+colors] an array of colors, each either being an integer or a Hash\n           * integer: calculated using the formula\n             <tt>color = 16 * green + red</tt>\n           * Hash:\n             [<tt>:red</tt>]   brightness of red LED\n             [<tt>:green</tt>] brightness of green LED\n             [<tt>:mode</tt>]  button mode, defaults to <tt>:normal</tt>, one of:\n                               [<tt>:normal/tt>]     updates the LEDs for all circumstances (the new value will be written to both buffers)\n                               [<tt>:flashing/tt>]   updates the LEDs for flashing (the new values will be written to buffer 0 while the LEDs will be off in buffer 1, see buffering_mode)\n                               [<tt>:buffering/tt>]  updates the LEDs for the current update_buffer only\n           the array consists of 64 colors for the grid buttons,\n           8 colors for the scene buttons (top to bottom)\n           and 8 colors for the top control buttons (left to right),\n           maximum 80 values - excessive values will be ignored,\n           missing values will be filled with 0\n\n Errors raised:\n\n [Launchpad::NoValidBrightnessError] when brightness values aren't within the valid range\n [Launchpad::NoOutputAllowedError] when output is not enabled", "Controls the two buffers.\n\n Optional options hash:\n\n [<tt>:display_buffer</tt>]  which buffer to use for display, defaults to +0+\n [<tt>:update_buffer</tt>]   which buffer to use for updates when <tt>:mode</tt> is set to <tt>:buffering</tt>, defaults to +0+ (see change)\n [<tt>:copy</tt>]            whether to copy the LEDs states from the new display_buffer over to the new update_buffer, <tt>true/false</tt>, defaults to <tt>false</tt>\n [<tt>:flashing</tt>]        whether to start flashing by automatically switching between the two buffers for display, <tt>true/false</tt>, defaults to <tt>false</tt>\n\n Errors raised:\n\n [Launchpad::NoOutputAllowedError] when output is not enabled", "Writes several messages to the MIDI device.\n\n Parameters:\n\n [+messages+]  an array of hashes (usually created with message) with:\n               [<tt>:message</tt>]   an array of\n                                     MIDI status code,\n                                     MIDI data 1 (note),\n                                     MIDI data 2 (velocity)\n               [<tt>:timestamp</tt>] integer indicating the time when the MIDI message was created", "Do provision tasks", "Runs primary configuration\n\n@param root_config [Object] Root Vagrant config", "Gets preconfigured MassFileLoader instance\n\n@param type [String] Files type\n\n@return [::Impressbox::Objects::MassFileLoader]", "Loads xaml config\n\n@return [::Impressbox::Objects::ConfigFile]", "Waits for the remote debugging server to send a specific event.\n\n @param (see WebkitRemote::Event#matches?)\n @return [Array<WebkitRemote::Event>] all the events received, including the\n     event that matches the class requirement", "Make sure that each language specification matches at least one\n language.", "Helper method specifying how a simulation is identified by arguments.", "Warn in PR comment about the conflict between PRs\n @return   [Array<Hash>]", "Create required keyspace and column families", "Fetch hash of word counts as a single row from cassandra.\n Here column_name is the class and column value is the count", "Increment total word count for a given class by 'count'", "Increment total document count for a given class by 'count'", "Fetch 100 rows from summary table, yes, increase if necessary", "Checks if all of the required run parameters are set.\n\n @return [Boolean]", "Performs k-fold cross-validation and returns a confusion matrix.\n\n The algorithm is as follows (Mitchell, 1997, p147):\n\n   partitions = partition data into k-equal sized subsets (folds)\n   for i = 1 -> k:\n     T = data \\ partitions[i]\n     train(T)\n     classify(partitions[i])\n   output confusion matrix\n\n @raise [ArgumentError] if the runner is missing required attributes\n @return [ConfusionMatrix]", "Creates a post in a publication on behalf of the authenticated user.\n\n @param publication [Publication] A publication object.\n @param opts [Hash] A hash of options to use when creating a post. The opts\n   hash requires the keys: `:title`, `:content_format`, and `:content`. The\n   following keys are optional: `:tags`, `:canonical_url`,\n   `:publish_status`, and `:license`\n @return [Hash] The response is a Post object within a data envelope.\n   Example response:\n   ```\n   HTTP/1.1 201 OK\n   Content-Type: application/json; charset=utf-8\n   {\n     \"data\": {\n       \"id\": \"e6f36a\",\n       \"title\": \"Liverpool FC\",\n       \"authorId\": \"5303d74c64f66366f00cb9b2a94f3251bf5\",\n       \"tags\": [\"football\", \"sport\", \"Liverpool\"],\n       \"url\": \"https://medium.com/@majelbstoat/liverpool-fc-e6f36a\",\n       \"canonicalUrl\": \"http://jamietalbot.com/posts/liverpool-fc\",\n       \"publishStatus\": \"public\",\n       \"publishedAt\": 1442286338435,\n       \"license\": \"all-rights-reserved\",\n       \"licenseUrl\": \"https://medium.com/policy/9db0094a1e0f\",\n       \"publicationId\": \"e3ef7f020bd\"\n     }\n   }\n   ```", "sign in user to get tokens", "sign in client to get access_token", "validate the token", "extract public key from metadata's jwks_uri using kid", "Save the result of classification\n\n @param [Object] actual  The classified value\n @param [Object] truth   The known, expected value\n @return [self]", "Returns the F-measure of the classifier's precision and recall.\n\n @param [Float] beta Favor precision (<1), recall (>1), or both (1)\n @return [Float]", "Creates a packet of preprocessed ruby code to run it later\n , useful to execute the same code repeatedly and avoid heavy\n preprocessing of ruby code all the times.\n\n See EvalHook::Packet for more information\n\n Example:\n\n   hook_handler = HookHandler.new\n\n   pack = hook_handler.packet('print \"hello world\\n\"')\n   10.times do\n     pack.run\n   end\n\n   pack.dispose", "This is used to initialize the application.\n It runs in a thread because startup depends on EventMachine running", "Loads all application classes. Called on startup.", "Watch for any file changes in the load paths.", "Data can be a ruby data structure or a string representing clojure data", "Query can be a ruby data structure or a string representing clojure data\n If the args_or_dbname is a String, it will be converted into one arg\n pointing to that database.", "This function render a cell set with params.", "This function return the url of sidebar logo.", "This function return the url of login logo.", "This function return the url of application logo.", "Convenience wrapper for do_dispatch\n This is the heart of the server, called indirectly by a Rack aware server.\n\n @param env [Hash]\n @return [Array]", "Route, instantiate controller, return response from controller's action.", "Sets up a controller for a request.", "Populate the parameters based on the HTTP method.", "Runs before_dispatch in all plugins.\n\n @param env [Hash]\n @return [Hash]", "Runs after_dispatch in all plugins.\n\n @param env [Hash]\n @return [Hash]", "Passes arguments from ARGV and sets metadata flag\n @param args [Array<String>] The command-line arguments\n Configures the arguments for the command\n @param opts [OptionParser]", "Parses options sent from command-line", "Create a new instance.\n\n @return [Ownlan::Configuration]", "Returns an array of strings where each string comprises five numeric\n characters, each one representing one roll of a die. The number of\n elements in the array equals the number of words specified for the\n passphrase.\n @param number_of_words [Integer] the desired number of words in the\n   passphrase\n @return [Array<String>] an array of strings each one of which represents\n   five rolls of a die", "Returns processed options and url as parameters\n @param params [Hash<Symbol>] :url and :metadata\n @return [Hash<Symbol>] processed parameters for http request", "Searches the routes for a match given a Rack env.\n\n {#match} looks in the {#routes} to find a match.\n\n This method looks at PATH_INFO in +env+ to get the current request's path.\n\n == Return\n\n No Match:\n\n   {:error => :not_found}\n\n Match:\n\n   {:ok => {:controller => 'controller', :action => 'action', :var => 'value'}}\n\n @param env [Hash]\n @return [Hash]", "Adds a route for a path and arguments.\n\n @param path [String]\n @param args [Array]", "Returns a hash suitable for sending to Redis.new.\n The hash is generated from the host, port, db and\n password from the URI as well as any query vars.\n\n e.g.\n\n      uri = URI.parse \"redis://127.0.0.1/6/?timeout=5\"\n      uri.conf\n        # => {:db=>6, :timeout=>\"5\", :host=>\"127.0.0.1\", :port=>6379}", "This function return the name of the current theme used for the\n application.", "You seem to be able to load 20 songs at a time for an artist. I haven't\n found a way to vary the number you get back from the query, but you can\n paginate through in blocks of 20 songs.", "This function return an array of url of assets from the main application.", "Returns custom Typhoeus connection configuration\n @param url [String] API url to be used as base\n @param debug [Boolean] flag to log responses into STDOUT\n @return [Typhoeus::Connection] configured http client for requests to API", "Returns processed metadata, and image attributes params\n @param params [Hash<Symbol>] metadata and image attributes\n @return [Hash<Symbol>] processed parameters", "Returns parsed response from API\n @return [Filepreviews::Response] json response as callable methods", "Web Client API", "MusicManager Uploader identification", "Originally from redis-rb", "String with the text of all matching elements, separated by separator.", "A helper method for easy finding", "Goes through all the things and returns results that match the options attributes hash", "Returns the private dirty RSS for the given process, in KB.", "text can be either an array of strings or a string\n klass is a symbol", "need to use thetvdb id here since the slug can't be used for unseen", "Create a duplicate of this color.\n Add the individual RGB values of two colors together. You\n may also use an equivalent numeric or string color representation.\n\n Examples:\n\n   gray = Colorist::Color.new(0x333333)\n   gray + \"#300\"   # => <Color #663333>\n   gray + 0x000000 # => <Color #333333>\n   white = \"white\".to_color\n   gray + white    # => <Color #ffffff>", "Returns an array of the hue, saturation and value of the color.\n Hue will range from 0-359, hue and saturation will be between 0 and 1.", "Uses a naive formula to generate a gradient between this color and the given color.\n Returns the array of colors that make the gradient, including this color and the\n target color.  By default will return 10 colors, but this can be changed by supplying\n an optional steps parameter.", "Adds a table to the table store. A valid table must be a Hash with single character string keys and numerical values.\n A table that is not a Hash will raise a TypeError. The table name will be converted to a Symbol.\n @example\n   Gematria::Tables.add_table :mini_english, 'a' => 1, 'b' => 2, 'c' => 3\n @raise [TypeError] if table is not a valid Hash\n @param name [#to_sym] table name\n @param table [Hash{String => Number}] table of characters pointing to corresponding values\n @return [void]", "Mark should be 'true' or 'false', as a String", "Main method that initiates scoring emotions", "MethodMissing to implement metods that\n are the names of each emotion that will returen\n the score of that specific emotion for the text", "Last part of the scoring process\n If all scores are empty ambiguous is scored as 1", "Increments the score of an emotion if the word exist\n in that emotion bank", "Iterates all emotions for word in text", "Logic to score all unique words in the text", "Parse the specified file with the provided matcher.\n\n The first returned match will be used as the version.", "Update a file naively matching the specified matcher and replace any\n matching lines with the new version.", "Convenience function for update_file to apply to multiple files.", "Echo what is being requested\n\n === Parameters\n options(Hash):: Options specified\n\n === Return\n true:: Always return true", "Map arguments options into forwarder actor compatible options\n\n === Parameters\n options(Hash):: Arguments options\n\n === Return\n result(Hash):: Forwarder actor compatible options hash", "Create RUYML data from a YAML hash.\n Underlying hashes will be accessed\n as instances of this class. Other\n types are kept untouched and returned\n as is.\n Renders RUYML data using the given template.\n Rendered data is either written to an optional\n output file path or to stdout.", "New instance of a Outpost-based class.\n @see Application#using", "Runs all notifications associated with an Outpost-based class.", "Append output to current audit section\n\n === Parameters\n text(String):: Output to append to audit entry\n\n === Return\n true:: Always return true\n\n === Raise\n ApplicationError:: If audit id is missing from passed-in options", "Actually send audits to core agent and log failures\n\n === Parameters\n options[:kind](Symbol):: One of :status, :new_section, :info, :error, :output\n options[:text](String):: Text to be audited\n options[:category](String):: Optional, must be one of RightScale::EventCategories::CATEGORIES\n\n === Return\n true:: Always return true", "Send any buffered output to auditor\n\n === Return\n Always return true", "Generate an html string for the current document, but replace the provided\n nodes with their xhtml strings.", "Trigger re-enrollment\n\n === Return\n true:: Always return true", "Checks whether process with given pid is running\n\n === Parameters\n pid(Fixnum):: Process id to be checked\n\n === Return\n true:: If process is running\n false:: Otherwise", "Run daemon or run one agent communication check\n If running as a daemon, store pid in same location as agent except suffix the\n agent identity with '-rchk'.\n\n === Parameters\n options(Hash):: Run options\n   :time_limit(Integer):: Time limit for last communication and interval for daemon checks,\n     defaults to PING_INTERVAL_MULTIPLIER times agent's ping interval or to DEFAULT_TIME_LIMIT\n   :max_attempts(Integer):: Maximum number of communication check attempts,\n     defaults to DEFAULT_MAX_ATTEMPTS\n   :retry_interval(Integer):: Number of seconds to wait before retrying communication check,\n     defaults to DEFAULT_RETRY_INTERVAL, reset to :time_limit if exceeds it\n   :daemon(Boolean):: Whether to run as a daemon rather than do a one-time communication check\n   :log_path(String):: Log file directory, defaults to one used by agent\n   :stop(Boolean):: Whether to stop the currently running daemon and then exit\n   :ping(Boolean):: Try communicating now regardless of whether have communicated within\n     the configured time limit, ignored if :daemon true\n   :verbose(Boolean):: Whether to display debug information\n\n === Return\n true:: Always return true", "Perform required checks\n\n === Return\n true:: Always return true", "Check communication, repeatedly if necessary\n\n === Parameters\n attempt(Integer):: Number of attempts thus far\n must_try(Boolean):: Try communicating regardless of whether required based on time limit\n\n === Return\n true:: Always return true", "Get elapsed time since last communication\n\n === Return\n (Integer):: Elapsed time", "Ask instance agent to try to communicate\n\n === Parameters\n attempt(Integer):: Number of attempts thus far\n\n === Return\n true:: Always return true", "Trigger re-enroll\n This will normally cause the checker to exit\n\n === Return\n true:: Always return true", "Handle error by logging message and optionally aborting execution\n\n === Parameters\n description(String):: Description of context where error occurred\n error(Exception|String):: Exception or error message\n abort(Boolean):: Whether to abort execution\n\n === Return\n true:: If do not abort", "Convert elapsed time in seconds to displayable format\n\n === Parameters\n time(Integer|Float):: Elapsed time\n\n === Return\n (String):: Display string", "Run recipe command implementation\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:options](Hash):: Pass-through options sent to forwarder or instance_scheduler\n   with a :tags value indicating tag-based routing instead of local execution\n\n === Return\n true:: Always return true", "Run RightScript command implementation\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:options](Hash):: Pass-through options sent to forwarder or instance_scheduler\n   with a :tags value indicating tag-based routing instead of local execution\n\n === Return\n true:: Always return true", "Send a retryable request to a single target with a response expected, retrying multiple times\n at the application layer in case failures or errors occur.\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:type](String):: Request type\n opts[:payload](String):: Request data, optional\n opts[:timeout](Integer):: Timeout for retryable request, -1 or nil for no timeout\n opts[:options](Hash):: Request options\n\n === Return\n true:: Always return true", "Get Instance State value for Agent type\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n\n === Return\n true:: Always return true", "Get Instance State value for Run type\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n\n === Return\n true:: Always return true", "Get tags command\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:timeout](Integer):: Timeout for retryable request, -1 or nil for no timeout\n\n === Return\n true:: Always return true", "Add given tag\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:tag](String):: Tag to be added\n opts[:timeout](Integer):: Timeout for retryable request, -1 or nil for no timeout\n\n === Return\n true:: Always return true", "Remove given tag\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:tag](String):: Tag to be removed\n opts[:timeout](Integer):: Timeout for retryable request, -1 or nil for no timeout\n\n === Return\n true:: Always return true", "Query for instances with given tags\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:tags](String):: Tags to be used in query\n opts[:timeout](Integer):: Timeout for retryable request, -1 or nil for no timeout\n\n === Return\n true:: Always return true", "Create an audit entry.\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:summary](String):: Initial audit summary; must be present in order to avoid a blank summary!\n opts[:category](String):: One of the categories enumerated by RightScale::EventCategories\n opts[:user_email](String):: Optional; email of user who caused the audit event\n\n === Return\n result(RightScale::OperationResult):: result; if successful, payload == an integer audit ID", "Update audit summary\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:title](Hash):: Chef attributes hash\n\n === Return\n true:: Always return true", "Update inputs patch to be sent back to core after cook process finishes\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:patch](Hash):: Patch to be forwarded to core\n\n === Return\n true:: Always return true", "Helper method to send a request to one or more targets with no response expected\n See Sender for details", "Helper method to send a request to a single target agent with a response expected\n The request is retried if the response is not received in a reasonable amount of time\n The request is timed out if not received in time, typically configured to 2 minutes\n The request is allowed to expire per the agent's configured time-to-live, typically 1 minute\n See Sender for details", "Helper method to send a retryable request to a single target with a response expected,\n retrying at the application layer until the request succeeds or the timeout elapses;\n default timeout is 'forever'.\n\n See RetryableRequest for details", "Send scheduling request for recipe or RightScript\n If it returns with a bundle, schedule the bundle for execution\n\n === Parameters\n type(String):: Type of request\n conn(EM::Connection):: Connection used to send reply\n payload(Hash):: Request parameters\n\n === Return\n true:: Always return true", "Get shutdown request command\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n\n === Return\n true:: Always return true", "Set reboot timeout command\n\n === Parameters\n opts[:conn](EM::Connection):: Connection used to send reply\n opts[:level](String):: shutdown request level\n opts[:immediately](Boolean):: shutdown immediacy or nil\n\n === Return\n true:: Always return true", "Adds a transcoding to the video instance and reloads itself to\n reflect the changed transcodings array.\n\n @param [Hash] parameters The parameters to pass in when creating the transcoding.\n\n @option parameters [String] :encoding_profile_id Id of the Encoding Profile to be used for the transcoding.\n\n @return [Boolean] Indicating wether the transcoding was successfully created.", "Performs an HTTP get request with built-in retries and redirection based\n on HTTP responses.\n\n === Parameters\n attempts(int):: number of attempts\n\n === Return\n result(String):: body of response or nil", "Handles some cases which raise exceptions in the URI class.\n\n === Parameters\n path(String):: URI to parse\n\n === Return\n uri(URI):: parsed URI\n\n === Raise\n URI::InvalidURIError:: on invalid URI", "Process a file and add a result to the report.\n\n @param path [String]\n\n @return [void]", "Processes shutdown requests by communicating the need to shutdown an\n instance with the core agent, if necessary.\n\n === Parameters\n errback(Proc):: error handler or nil\n audit(Audit):: audit for shutdown action, if needed, or nil.\n\n === Block\n block(Proc):: continuation block for successful handling of shutdown or nil\n\n === Return\n always true", "Handles any shutdown failure.\n\n === Parameters\n audit(Audit):: Audit or nil\n errback(Proc):: error handler or nil\n msg(String):: Error message that will be audited and logged\n res(RightScale::OperationResult):: Operation result with additional information\n\n === Return\n always true", "The following is a hack to get around Netzke's broken handling\n of filtering on PostgreSQL enums columns.", "Helper method used to send command client request to RightLink agent\n\n === Parameters\n cmd(String):: Command name\n content(String):: Audit content\n options(Hash):: Audit options or nil\n\n === Return\n true:: Always return true", "Return include tags for entry points by given asset kind.\n Also common file could be included", "Return include tags for entry point by given asset kind.\n No extra common file included even if it exists", "Path to 'cook_runner' ruby script\n\n === Return\n path(String):: Path to ruby script used to run Chef", "Report cook process execution failure\n\n === Parameters\n title(String):: Title used to update audit status\n msg(String):: Optional, extended failure message\n\n === Return\n true:: Always return true", "Parses azure user metadata into a hash.\n\n === Parameters\n data(String):: raw data\n\n === Return\n result(Hash):: Hash-like leaf value", "Initialize parameter gatherer\n\n === Parameters\n bundle<RightScale::ExecutableBundle>:: the bundle for which to gather inputs\n options[:listen_port]:: Command server listen port\n options[:cookie]:: Command protocol cookie\n\n === Return\n true:: Always return true\n Retrieve from RightNet and process credential values in bundle's executables.\n\n == Returns:\n @return [TrueClass] true on success and false on error", "Handle a RightNet response to our retryable request. Could be success, failure or unexpected.", "Return the number of credentials remaining to be gathered", "Do the actual substitution of credential values into the bundle", "Report a failure by setting some attributes that our caller will query, then updating our Deferrable\n disposition so our caller gets notified via errback.", "Use the command protocol to send a retryable request. This class cannot reuse Cook's\n implementation of the command-proto request wrappers because we must gather credentials\n concurrently for performance reasons. The easiest way to do this is simply to open a\n new command proto socket for every distinct request we make.", "Should there be a link created for this cookbook?\n\n === Parameters\n repo_sha (String) :: unique identifier of the cookbook repository\n position (String) :: repo relative ppath of the cookbook\n\n === Returns\n true if there is a cookbook in the given repo that should be checekd out", "Checkout the given repo and link each dev cookbook to it's matching repose path\n\n === Parameters\n callback (Proc) :: to be called for each repo checked out see RightScraper::Scraper.scrape for details\n\n === Return\n  true", "Creates a symlink from the checked out cookbook to the expected repose download location\n\n === Parameters\n repo_sha (String) :: unique identifier of the cookbook repository\n position (String) :: repo relative ppath of the cookbook\n\n === Returns\n true if link was created, false otherwise", "Set command client cookie and initialize responses parser\n Send command to running agent\n\n === Parameters\n options(Hash):: Hash of options and command name\n   options[:name]:: Command name\n   options[:...]:: Other command specific options, passed through to agent\n\n === Return\n true:: Always return true", "Stop command client, wait for all pending commands to finish prior\n to calling given callback\n\n === Return\n true:: Always return true\n\n === Block\n called once all pending commands have completed", "Map a universally-unique integer RightScale user ID to a locally-unique Unix UID.", "Pick a username that does not yet exist on the system. If the given\n username does not exist, it is returned; else we add a \"_1\" suffix\n and continue incrementing the number until we arrive at a username\n that does not yet exist.\n\n === Parameters\n ideal(String):: the user's ideal (chosen) username\n\n === Return\n username(String):: username with possible postfix", "Ensure that a given user exists and that his group membership is correct.\n\n === Parameters\n username(String):: preferred username of RightScale user\n uuid(String):: RightScale user's UUID\n superuser(Boolean):: whether the user should have sudo privileges\n\n === Block\n If a block is given AND the user needs to be created, yields to the block\n with the to-be-created account's username, before creating it. This gives\n the caller a chance to provide interactive feedback to the user.\n\n === Return\n username(String):: user's actual username (may vary from preferred username)\n\n === Raise\n (LoginManager::SystemConflict):: if an existing non-RightScale-managed UID prevents us from creating a user", "If the given user exists and is RightScale-managed, then ensure his login information and\n group membership are correct. If force == true, then management tasks are performed\n irrespective of the user's group membership status.\n\n === Parameters\n uuid(String):: RightScale user's UUID\n superuser(Boolean):: whether the user should have sudo privileges\n force(Boolean):: if true, performs group management even if the user does NOT belong to 'rightscale'\n\n === Options\n :force:: if true, then the user will be updated even if they do not belong to the RightScale group\n :disable:: if true, then the user will be prevented from logging in\n\n === Return\n username(String):: if the user exists, returns his actual username\n false:: if the user does not exist", "Create a Unix user with the \"useradd\" command.\n\n === Parameters\n username(String):: username\n uid(String):: account's UID\n expired_at(Time):: account's expiration date; default nil\n shell(String):: account's login shell; default nil (use systemwide default)\n\n\n === Raise\n (RightScale::LoginManager::SystemConflict):: if the user could not be created for some reason\n\n === Return\n true:: always returns true", "Modify a user with the \"usermod\" command.\n\n === Parameters\n username(String):: username\n uid(String):: account's UID\n locked(true,false):: if true, prevent the user from logging in\n shell(String):: account's login shell; default nil (use systemwide default)\n\n === Return\n true:: always returns true", "Adds or removes a user from an OS group; does nothing if the user\n is already in the correct membership state.\n\n === Parameters\n group(String):: group name\n operation(Symbol):: :add or :remove\n username(String):: username to add/remove\n\n === Raise\n Raises ArgumentError\n\n === Return\n result(Boolean):: true if user was added/removed; false if", "Check if user with specified Unix UID exists in the system, and optionally\n whether he belongs to all of the specified groups.\n\n === Parameters\n uid(String):: account's UID\n\n === Return\n exist_status(Boolean):: true if exists; otherwise false", "Check if group with specified name exists in the system.\n\n === Parameters\n name(String):: group's name\n\n === Block\n If a block is given, it will be yielded to with various status messages\n suitable for display to the user.\n\n === Return\n exist_status(Boolean):: true if exists; otherwise false", "Search through some directories to find the location of a binary. Necessary because different\n Linux distributions put their user-management utilities in slightly different places.\n\n === Parameters\n cmd(String):: name of command to search for, e.g. 'usermod'\n\n === Return\n path(String):: the absolute path to the command\n\n === Raise\n (LoginManager::SystemConflict):: if the command can't be found", "Recursively flattens metadata.\n\n === Parameters\n tree_metadata(Hash):: metadata to flatten\n flat_metadata(Hash):: flattened metadata or {}\n metadata_path(Array):: array of metadata path elements or []\n path_index(int):: path array index to update or 0\n\n === Returns\n flat_metadata(Hash):: flattened metadata", "Flattens a sequence of metadata keys into a simple key string\n distinguishing the path to a value stored at some depth in a tree of\n metadata.\n\n === Parameters\n metadata_path(Array):: array of metadata path elements\n\n === Returns\n flat_path(String):: flattened path", "Produce file name for given script nickname\n\n === Parameters\n nickname(String):: Script nick name\n\n === Return\n path(String):: Path to corresponding recipe", "Path to cache directory for given script\n\n === Parameters\n script(Object):: script object of some kind (e.g. RightScale::RightScriptInstantiation)\n\n === Return\n path(String):: Path to directory used for attachments and source", "Search through the youtube API, executing multiple queries where necessary\n @param criteria [Hash]\n @example\n   client = Yourub::Client.new\n   client.search(country: \"DE\", category: \"sports\", order: 'date')", "return the number of times a video was watched\n @param video_id[Integer]\n @example\n   client = Yourub::Client.new\n   client.get_views(\"G2b0OIkTraI\")", "return an hash containing the metadata for the given video\n @param video_id[Integer]\n @example\n   client = Yourub::Client.new\n   client.get(\"G2b0OIkTraI\")", "This is fundamentally broken\n Can keep this for multi-lie html comment perhaps\n But don't lookahead on text otherwise", "Implement `render` so that it uses our own header pattern.", "Cleanup files generated by instance state", "Test and delete if exists", "Setup location of files generated by script execution", "Verify the configured API key is valid", "Support for dumping comments", "Dumps the comments on a particular table to the stream.", "Creates a command client and sends the given payload.\n\n === Parameters\n @param [Hash] cmd as a payload hash\n @param [TrueClass, FalseClass] verbose flag\n @param [TrueClass, FalseClass] timeout or nil\n\n === Block\n @yield [response] callback for response\n @yieldparam response [Object] response of any type", "Default logger for printing to console", "Activates RightScale environment before running ohai\n\n === Return\n true:: Always return true", "Manages planned volumes by caching planned volume state and then ensuring\n volumes have been reattached in a predictable order for proper assignment\n of local drives.\n\n === Parameters\n block(Proc):: continuation callback for when volume management is complete.\n\n === Return\n result(Boolean):: true if successful", "Detaches the planned volume given by its mapping.\n\n === Parameters\n mapping(Hash):: details of planned volume", "Attaches the planned volume given by its mapping.\n\n === Parameters\n mapping(Hash):: details of planned volume", "Manages device assignment for volumes with considerations for formatting\n blank attached volumes.\n\n === Parameters\n mapping(Hash):: details of planned volume", "Merges mappings from query with any last known mappings which may have a\n locally persisted state which needs to be evaluated.\n\n === Parameters\n last_mappings(Array):: previously merged mappings or empty\n current_mappings(Array):: current unmerged mappings or empty\n\n === Returns\n results(Array):: array of hashes representing merged mappings", "Can the login manager function on this platform?\n\n == Returns:\n @return [TrueClass] if LoginManager works on this platform\n @return [FalseClass] if LoginManager does not work on this platform", "Enact the login policy specified in new_policy for this system. The policy becomes\n effective immediately and controls which public keys are trusted for SSH access to\n the superuser account.\n\n == Parameters:\n @param [RightScale::LoginPolicy] New login policy\n @param [String] Serialized instance agent identity\n\n == Yields:\n @yield [String] audit content yielded to the block provided\n\n == Returns:\n @return [TrueClass] if supported by given platform\n @return [FalseClass] if not supported by given platform", "Returns prefix command for public key record\n\n == Parameters:\n @param [String] account's username\n @param [String] account's email address\n @param [String] account's uuid\n @param [Boolean] designates whether the account has superuser privileges\n @param [String] optional profile_data to be included\n\n == Returns:\n @return [String] command string", "Returns current SSH host keys\n\n == Returns:\n @return [Array<String>] Base64 encoded SSH public keys", "For any user with a public key fingerprint but no public key, obtain the public key\n from the old policy or by querying RightScale using the fingerprints\n Remove a user if no public keys are available for it\n\n == Parameters:\n @param [Array<LoginUsers>] Login users whose public keys are to be populated\n @param [String] Serialized instance agent identity\n @param [RightScale::LoginPolicy] New login policy\n\n == Yields:\n @yield [String] audit content yielded to the block provided\n\n == Returns:\n @return [TrueClass] always returns true", "Manipulates the authorized_keys file to match the given login policy\n Schedules expiration of users from policy and audits the policy in\n a human-readable format\n\n == Parameters:\n @param [RightScale::LoginPolicy] New login policy\n @param [String] Serialized instance agent identity\n @param [Array<LoginUsers>] Array of updated users\n @param [Array<LoginUsers>] Array of users with public keys missing\n\n == Yields:\n @yield [String] audit content yielded to the block provided\n\n == Returns:\n @return [TrueClass] always returns true", "Populate missing public keys from old public keys using associated fingerprints\n Also populate any missing fingerprints where possible\n\n == Parameters:\n @param [Array<LoginUser>] Login users whose public keys are to be updated if nil\n @param [Hash<String, String>] Public keys with fingerprint as key and public key as value\n @param [Boolean] Whether to remove a user's public key if it cannot be obtained\n           and the user itself if none of its public keys can be obtained\n\n == Returns:\n @return [Array<LoginUser,String] User and fingerprint for each missing public key", "Create fingerprint for public key\n\n == Parameters:\n @param [String] RSA public key\n @param [String] Name of user owning this key\n\n == Return:\n @return [String] Fingerprint for key if it could create it\n @return [NilClass] if it could not create it", "Returns array of public keys of specified authorized_keys file\n\n == Parameters:\n @param [String] path to authorized_keys file\n\n == Returns:\n\n @return [Array<Array(String, String, String)>] array of authorized_key parameters: algorith, public key, comment", "Return a verbose, human-readable description of the login policy, suitable\n for appending to an audit entry. Contains formatting such as newlines and tabs.\n\n == Parameters:\n @param [Array<LoginUser>] All LoginUsers\n @param [Array<LoginUser>] Subset of LoginUsers who are authorized to act as superusers\n @param [LoginPolicy] Effective login policy\n @param [Array<LoginUser>] Users for which a public key could not be obtained\n\n == Returns:\n @return [String] description", "Given a list of LoginUsers, compute an authorized_keys file that encompasses all\n of the users and has a suitable options field that invokes rs_thunk with the right\n command-line params for that user. Omit any users who are expired.\n\n == Parameters:\n @param [Array<LoginUser>] array of updated users list\n\n == Returns:\n @return [Array<String>] public key lines of user accounts", "Schedules expiration of new users from policy and existing ones\n\n @param [Array<LoginUsers>] Array of updated users\n\n == Returns:\n @return [TrueClass] always returns true", "Replace the contents of specified keys file\n\n == Parameters:\n @param [Array<String>] list of lines that authorized_keys file should contain\n @param [String] path to authorized_keys file\n @param [Hash] additional parameters for user/group\n\n == Returns:\n @return [TrueClass] always returns true", "Returns a Hash of frequencies of each uniq word in the text", "Converts all the words to its stem form", "Captures and returns emojies in the text", "Removing non ASCII characters from text", "Generate log line from given input", "Filters any message which should not appear in audits.\n\n === Parameters\n severity(Constant):: One of Logger::DEBUG, Logger::INFO, Logger::WARN, Logger::ERROR or Logger::FATAL\n message(String):: Message to be audited", "Configure root access for vSphere cloud", "Add public key to ssh authorized_keys file\n\n If the file does not exist, it will be created.\n If the key already exists, it will not be added again.\n\n === Parameters\n public_key(String):: public ssh key\n\n === Return", "Trigger execution of given command in instance agent and wait for it to be done\n\n === Parameters\n message(String):: Console display message\n command(String):: Command name\n\n === Return\n (Boolean):: true if command executed successfully, otherwise false", "Attempt to connect to the given address on the given port as a quick verification\n that the metadata service is available.\n\n === Parameters\n addr(String):: address of the metadata service\n port(Number):: port of the metadata service\n timeout(Number)::Optional - time to wait for a response\n\n === Return\n connected(Boolean):: true if a connection could be made, false otherwise", "Splits data on the given splitter character and returns hash.\n\n === Parameters\n data(String):: raw data\n splitter(String):: splitter character\n name_value_delimiter(String):: name/value delimiter (defaults to '=')\n\n === Return\n hash(Hash):: hash result", "Build a valid request results with given content", "Starts execution of the thread pool.\n\n @note Can be restarted after finalization.", "Read file and try parsing\n if success parse, find proc AST\n\n @param filename [String] reading file path\n @param linenum [Integer] start line number\n @return [Parser::AST::Node] Proc AST", "Remove tail comma and wrap dummy method, and retry parsing\n For proc inner Array or Hash", "Called to validate user input. Just return a hash of errors if there are any", "Checks whether there is a gitlab installation\n at the given +gitlab_url+", "Checks whether a user with the given +token+ exists\n in the gitlab installation located at +gitlab_url+", "Connects to the gitlab installation at +gitlab_url+\n using the given +private_token+ and executes the given block", "Creates the parent directory for the full path of generated file.\n\n === Parameters\n file_name(String):: output file name without extension\n\n === Return\n result(String):: full path of generated file", "Writes given metadata to file.\n\n === Parameters\n metadata(Hash):: Hash-like metadata to write\n subpath(Array|String):: subpath if deeper than root or nil\n\n === Return\n always true", "Queries and writes current metadata to file.\n\n === Parameters\n kind(Symbol):: kind of metadata must be one of [:cloud_metadata, :user_metadata, WILDCARD]\n\n === Return\n result(ActionResult):: action result", "Attempts to clear any files generated by writers.\n\n === Return\n always true\n\n === Raise\n CloudError:: on failure to clean state", "Gets the option given by path, if it exists.\n\n === Parameters\n kind(Symbol):: :user_metadata or :cloud_metadata\n === Return\n result(Array(MetadataWriter)):: responds to write", "Assembles the command line needed to regenerate cloud metadata on demand.", "make the given path relative to this cloud's DSL script path only if the\n path is not already absolute.\n\n === Parameters\n path(String):: absolute or relative path\n\n === Return\n result(String):: absolute path", "Determines the developer log level, if any, which forces and supercedes\n all other log level configurations.\n\n === Return\n level(Token):: developer log level or nil", "Whether dev cookbooks path should be used instead of standard\n cookbooks repositories location\n True if in dev mode and all dev cookbooks repos directories are not empty\n\n === Return\n true:: If dev cookbooks repositories path should be used\n false:: Otherwise", "Re-initialize then merge given state\n\n === Parameters\n state_to_merge(RightScale::InstanceState):: InstanceState to be passed on to Cook\n overrides(Hash):: Hash keyed by state name that will override state_to_merge\n\n === Return\n true:: Always", "Save dev state to file\n\n === Return\n true:: Always return true", "load dev state from disk\n\n === Return\n true:: Always return true", "Registry method for a dynamic metadata type.\n\n === Parameters\n cloud_name(String):: name of one or more clouds (which may include DEFAULT_CLOUD) that use the given type\n cloud_script_path(String):: path to script used to describe cloud on creation\n\n === Return\n always true", "Gets the path to the script describing a cloud.\n\n === Parameters\n cloud_name(String):: a registered_type cloud name\n\n === Return\n cloud_script_path(String):: path to script used to describe cloud on creation\n\n === Raise\n UnknownCloud:: on error", "Factory method for dynamic metadata types.\n\n === Parameters\n cloud(String):: a registered_type cloud name\n options(Hash):: options for creation\n\n === Return\n result(Object):: new instance of registered_type metadata type\n\n === Raise\n UnknownCloud:: on error", "Getter for the default cloud name. This currently relies on a\n 'cloud file' which must be present in an expected RightScale location.\n\n === Return\n result(String):: content of the 'cloud file' or UNKNOWN_CLOUD_NAME", "Determines if queue is busy\n\n === Return\n active(Boolean):: true if queue is busy", "Pushes a context to a thread based on a name determined from the context.\n\n === Parameters\n context(Object):: any kind of context object\n\n === Return\n true:: always true", "Deletes any inactive queues from the hash of known queues.\n\n === Return\n still_active(Boolean):: true if any queues are still active", "Closes all thread queues.\n\n === Return\n result(Boolean):: true if any queues are still active (and stopping)", "Create health-checked HTTP client for performing authorization\n\n @return [RightSupport::Net::BalancedHttpClient] client", "Get authorized with RightApi using OAuth2\n As an extension to OAuth2 receive URLs needed for other servers\n Retry authorization if RightApi not responding or if get redirected\n\n @return [TrueClass] always true\n\n @raise [Exceptions::Unauthorized] authorization failed\n @raise [BalancedHttpClient::NotResponding] cannot access RightApi\n @raise [CommunicationModeSwitch] changing communication mode", "Get authorized and then continuously renew authorization before it expires\n\n @param [Integer, NilClass] wait time before attempt to renew; defaults to\n   have the expiry time if authorized, otherwise 0\n\n @return [TrueClass] always true", "Update URLs and other data returned from authorization\n Recreate client if API URL has changed\n\n @param [Hash] response containing URLs with keys as symbols\n\n @return [TrueClass] always true\n\n @raise [CommunicationModeSwitch] changing communication mode", "Handle redirect by adjusting URLs to requested location and recreating HTTP client\n\n @param [RightScale::BalancedHttpClient::Redirect] exception containing redirect location,\n   which is required to be a full URL\n\n @return [Boolean] whether successfully redirected", "Reconnect with authorization server by periodically checking health\n Delay random interval before starting to check to reduce server spiking\n When again healthy, renew authorization\n\n @return [TrueClass] always true", "Pushes value into a queue by executing it.\n If execution results in an exception\n then exception is stored itself.\n\n @note allowed only when queue is running.", "Gets IP address for specified device\n\n === Parameters\n device(String):: target device name\n\n === Return\n result(String):: current IP for specified device or nil", "best-effort auditing, but try not to block user\n Manage individual user SSH logins\n\n === Parameters\n options(Hash):: Hash of options as defined in +parse_args+\n\n === Return\n true:: Always return true", "Create an audit entry to record this user's access. The entry is created\n asynchronously and this method never raises exceptions even if the\n request fails or times out. Thus, this is \"best-effort\" auditing and\n should not be relied upon!\n\n === Parameters\n email(String):: the user's email address\n username(String):: the user's email address\n access(Symbol):: mode of access; one of :scp, :sftp, :command or :shell\n command(String):: exact command that is being executed via SSH\n client_ip(String):: origin IP address\n\n === Return\n Returns true on success, false otherwise", "Display the Message of the Day if it exists.", "Returns +value+ surrounded by double quotes. This method is idempotent\n so +value+ will only be quoted once regardless of how may times the\n method is called on it.\n\n @example Quoting a BEL parameter.\n    quote(\"apoptotic process\")\n    # => \"\\\"apoptotic process\\\"\"\n @example Escaping quotes within a value.\n    quote(\"vesicle fusion with \\\"Golgi apparatus\\\"\")\n    # => \"\\\"vesicle fusion with \\\\\\\"Golgi apparatus\\\\\\\"\\\"\"\n\n @parameter [#to_s] value a value to be quoted\n @return    [String] value surrounded by double quotes", "Parse arguments and run", "generate FDF content", "generate XFDF content", "NAT Routing Support\n\n Add routes to external networks via local NAT server\n\n no-op if no RS_ROUTE<N> variables are defined\n\n === Return\n result(True):: Always true", "Add route to network through NAT server\n\n Will not add if route already exists\n\n === Parameters\n network(String):: target network in CIDR notation\n nat_server_ip(String):: the IP address of the NAT \"router\"\n\n === Raise\n StandardError:: Route command fails\n\n === Return\n result(True):: Always returns true", "Is a route defined to network via NAT \"router\"?\n\n === Parameters\n network(String):: target network in CIDR notation\n nat_server_ip(String):: the IP address of the NAT \"router\"\n\n === Return\n result(Boolean):: true if route exists, else false", "Sets single network adapter static IP addresse and nameservers\n\n Parameters\n n_ip(Fixnum):: network adapter index", "Configures a single network adapter with a static IP address\n\n Parameters\n device(String):: device to be configured\n ip(String):: static IP to be set\n netmask(String):: netmask to be set\n gateway(String):: default gateway IP to be set\n nameservers(Array):: array of nameservers to be set", "Returns a validated list of nameservers\n\n == Parameters\n none", "Manage instance tags\n\n === Parameters\n options(Hash):: Hash of options as defined in +parse_args+\n\n === Return\n true:: Always return true", "Format output for display to user\n\n === Parameter\n result(Object):: JSON-compatible data structure (array, hash, etc)\n format(String):: how to print output - json, yaml, text\n\n === Return\n a String containing the specified output format", "Forward audit command received from cook using audit proxy\n\n === Parameters\n kind(Symbol):: Kind of audit, one of :append_info, :append_error, :create_new_section, :update_status and :append_output\n text(String):: Audit content\n thread_name(String):: thread name for audit or default\n options[:category]:: Optional, associated event category, one of RightScale::EventCategories\n\n === Raise\n RuntimeError:: If audit_proxy is not set prior to calling this", "Reset proxy object and notify close event listener\n\n === Parameters\n thread_name(String):: execution thread name or default\n\n === Return\n true:: Always return true", "Initializes a Downloader with a list of hostnames\n\n The purpose of this method is to instantiate a Downloader.\n It will perform DNS resolution on the hostnames provided\n and will configure a proxy if necessary\n\n === Parameters\n @param <[String]> Hostnames to resolve\n\n === Return\n @return [Downloader]\n\n Downloads an attachment from Repose\n\n The purpose of this method is to download the specified attachment from Repose\n If a failure is encountered it will provide proper feedback regarding the nature\n of the failure\n\n === Parameters\n @param [String] Resource URI to parse and fetch\n\n === Block\n @yield [] A block is mandatory\n @yieldreturn [String] The stream that is being fetched", "Resolve a list of hostnames to a hash of Hostname => IP Addresses\n\n The purpose of this method is to lookup all IP addresses per hostname and\n build a lookup hash that maps IP addresses back to their original hostname\n so we can perform TLS hostname verification.\n\n === Parameters\n @param <[String]> Hostnames to resolve\n\n === Return\n @return [Hash]\n   * :key [<String>] a key (IP Address) that accepts a hostname string as it's value", "Parse Exception message and return it\n\n The purpose of this method is to parse the message portion of RequestBalancer\n Exceptions to determine the actual Exceptions that resulted in all endpoints\n failing to return a non-Exception.\n\n === Parameters\n @param [Exception] Exception to parse\n\n === Return\n @return [Array] List of exception class names", "Orders ips by hostnames\n\n The purpose of this method is to sort ips of hostnames so it tries all IPs of hostname 1,\n then all IPs of hostname 2, etc\n\n == Return\n @return [Array] array of ips ordered by hostnames", "Create and return a RequestBalancer instance\n\n The purpose of this method is to create a RequestBalancer that will be used\n to service all 'download' requests.  Once a valid endpoint is found, the\n balancer will 'stick' with it. It will consider a response of '408: RequestTimeout' and\n '500: InternalServerError' as retryable exceptions and all other HTTP error codes to\n indicate a fatal exception that should abort the load-balanced request\n\n === Return\n @return [RightSupport::Net::RequestBalancer]", "Apply padding to text\n\n @param [String] text\n\n @return [String]\n\n @api private", "Factory method for a new sequence.\n\n context(RightScale::OperationContext)", "Audit executable sequence status after it ran\n\n === Parameters\n sequence(RightScale::ExecutableSequence):: finished sequence being audited\n\n === Return\n true:: Always return true", "Setup log for test.", "Runs the metadata provider after starting a server to respond to fetch\n requests.\n\n === Parameters\n metadata_provider(MetadataProvider):: metadata_provider to test\n\n metadata_formatter(MetadataFormatter):: metadata_formatter to test\n\n block(callback):: handler for server requests\n\n === Returns\n metadata(Hash):: flat metadata hash", "Process literal node. If a literal is a number and add it to the\n collection of magic numbers.\n\n @param exp [Sexp]\n\n @return [Sexp]", "Writes objects to JSON using a streaming mechanism in Oj.\n\n If an IO is provided as +output_io+ then the encoded JSON will be written\n directly to it and returned from the method.\n\n If an IO is not provided (i.e. `nil`) then the encoded JSON {String} will\n be returned.\n\n @param  [Hash, Array, Object] data      the objects to encode as JSON\n @param  [IO]                  output_io the IO to write the encoded JSON\n         to\n @param  [Hash]                options supplemental options to Oj; default\n         is to set the +:mode+ option to +:compat+\n @return [IO, String]          an {IO} of encoded JSON is returned if it\n was provided as an argument, otherwise a JSON-encoded {String} is\n returned", "Determine inputs that need special security treatment.\n @return [Hash] map of sensitive input names to various values; good for filtering.", "Initialize and configure the logger", "Configure chef so it can find cookbooks and so its logs go to the audits\n\n === Return\n true:: Always return true", "Update the Chef cookbook_path based on the cookbooks in the bundle.\n\n === Return\n true:: Always return true", "Checkout repositories for selected cookbooks.  Audit progress and errors, do not fail on checkout error.\n\n === Return\n true:: Always return true", "Checks whether Ohai is ready and calls given block with it\n if that's the case otherwise schedules itself to try again\n indefinitely\n\n === Block\n Given block should take one argument which corresponds to\n ohai instance\n\n === Return\n true:: Always return true", "Creates a new ohai and configures it.\n\n === Return\n ohai(Ohai::System):: configured ohai", "Initialize inputs patch and report success\n\n === Parameters\n node(ChefNode):: Chef node used to converge, can be nil (patch is empty in this case)\n\n === Return\n true:: Always return true", "Set status with failure message and audit it\n\n === Parameters\n title(String):: Title used to update audit status\n msg(String):: Failure message\n\n === Return\n true:: Always return true", "Wrap chef exception with explanatory information and show\n context of failure\n\n === Parameters\n e(Exception):: Exception raised while executing Chef recipe\n\n === Return\n msg(String):: Human friendly error message", "Format a single line for the error context, return empty string\n if given index is negative or greater than the lines array size\n\n === Parameters\n lines(Array):: Lines of text\n index(Integer):: Index of line that should be formatted for context\n padding(Integer):: Number of character to pad line with (includes prefix)\n prefix(String):: Single character string used to prefix line\n                  use line number if not specified", "Retry executing given block given number of times\n Block should return true when it succeeds\n\n === Parameters\n retry_message(String):: Message to audit before retrying\n times(Integer):: Number of times block should be retried before giving up\n\n === Block\n Block to be executed\n\n === Return\n success(Boolean):: true if execution was successful, false otherwise.", "Determines if the the line is a start_part comment.\n Return the file name otherwise nil", "Determines if the the line is an all_parts comment.\n Return the file name otherwise nil", "Determines if the the line is an end_parts comment.\n Return true otherwise nil", "processes the lines\n ruleset is to be a string read in using File.read", "Main method that initiates calculating polarity", "Checks if words has happy or sad emoji and adds polarity for it", "Appends polarities of words to array polarities", "This is now quite tricky. We do two routing passes, a pass before the\n system networking is setup (@boot is true) in which we setup static system\n config files and a pass after system networking (@boot is false) in which\n we fix up the remaining routes cases involving DHCP. We have to set any routes\n involving DHCP post networking as we can't know the DHCP gateway beforehand", "Persist network route to file\n\n If the file does not exist, it will be created.\n If the route already exists, it will not be added again.\n\n === Parameters\n network(String):: target network in CIDR notation\n nat_server_ip(String):: the IP address of the NAT \"router\"\n\n === Return\n result(True):: Always returns true", "Persist device config to a file\n\n If the file does not exist, it will be created.\n\n === Parameters\n device(String):: target device name\n data(String):: target device config", "Add line to config file\n\n If the file does not exist, it will be created.\n If the line already exists, it will not be added again.\n\n === Parameters\n filename(String):: absolute path to config file\n line(String):: line to add\n\n === Return\n result(Hash):: Hash-like leaf value", "Read contents of config file\n\n If file doesn't exist, return empty string\n\n === Return\n result(String):: All lines in file", "Appends line to config file", "Run bundle given in stdin", "Helper method to send a request to one or more targets with no response expected\n See InstanceCommands for details", "Retrieve current instance tags\n\n === Parameters\n timeout(Fixnum):: Number of seconds to wait for agent response", "Initialize instance variables\n Report inputs patch to core", "Report failure to core", "Print failure message and exit abnormally", "Stop command client then stop auditor stub then EM", "Provides a blocking request for the given command\n Can only be called when on EM defer thread\n\n === Parameters\n cmd(Hash):: request to send\n\n === Return\n response(String):: raw response\n\n === Raise\n BlockingError:: If request called when on EM main thread", "Load serialized content\n fail if serialized data is invalid\n\n === Parameters\n data(String):: Serialized content\n error_message(String):: Error to be logged/audited in case of failure\n format(Symbol):: Serialization format\n\n === Return\n content(String):: Unserialized content", "Wrap a text into lines no longer than wrap_at length.\n Preserves existing lines and existing word boundaries.\n\n @example\n   wrapping = Verse::Wrapping.new \"Some longish text\"\n\n   wrapping.wrap(8)\n   # => >Some\n        >longish\n        >text\n\n @api public", "Get the url for a particular call, doing the signing and all that other stuff.\n\n [method] the RTM method to call\n [params] hash of parameters.  The +method+, +api_key+, and +api_sig+ parameters should _not_ be included.\n [endpoint] the endpoint relate to BASE_URL at which this request should be made.", "Turns params into a URL", "Signs the request given the params and secret key\n\n [params] hash of parameters", "Top sites for the specified two letter country code.", "All countries that have Alexa top sites.", "reload the object after doing a query to the api", "get the property from the hash\n if the value is not set and the object has not been loaded, try to load it", "Setup the bootstrap args and run the bootstrap command", "AUTHORIZATION API Methods   \n\n logs in a user\n the account_id is different from user id response\n TVAuth.login(\n   username: \"bar\",\n   password: \"foo\",\n   account_id: \"00000000-0000-0000-0000-000000000000\"\n )", "Returns the set flags on the frame.\n @return [Array<Symbol>] The flags.", "Sets the frame flags.\n @param values [Array<Symbol>] The flags.", "Receives the specified data and process.\n @param new_data [String] The data received from the peer.", "Returns a Stream object with the specified ID.\n @param stream_id [Integer] the stream id\n @return [Stream] the stream", "Sends local settings to the peer.\n @param new_settings [Hash<Symbol, Integer>]", "Sends GOAWAY frame to the peer and closes the connection.\n @param error_type [Symbol] The error type to be contained in the GOAWAY frame.", "This assumes states is a hash", "Inuit Helper Methods", "Create DSL block\n\n @param [Symbol, String] block name\n @param [String] parameter that is passed in to block\n @return [String] DSL block string", "Create DSL property of block\n\n @param [String] name of the property\n @param [Syntaxer::Runner, Array] properties\n @return [String] DSL property string", "This method should be called when scheduling a recurring job as it checks to ensure no\n other instances of the job are already running.", "Page loads typically takes longer.", "instantiates ABPerson record from attributes", "Sets the tags for the task.", "Set callback that will be called when received a chunk of response body.\n @yield [chunk] A chunk of the response body.", "Create a bug\n\n @param product - the name of the product the bug is being filed against\n @param component - the name of a component in the product above.\n @param summary - a brief description of the bug being filed.\n @param version - version of the product above; the version the bug was found in.\n @param **kwargs - keyword-args containing optional/defaulted params\n\n Return the new bug ID", "Search for a bug\n\n +query+ has to be either a +Query+ object or\n a +String+ that will be searched in the summary\n of the bugs.", "Given a named query's name, runs it\n on the server\n @returns [Array<String>] list of bugs", "Fetches a named query by its full url\n @private\n @returns [Array<String>] list of bugs", "Retrieves one or more bugs by id\n @return [Array<Bug>] a list of bugs", "Add an attachment to bugs with given ids\n\n Params:\n @param summary - a short string describing the attachment\n @param file - [File] object to attach\n @param *ids - a list of bug ids to which the attachment will be added\n @param **kwargs - optional keyword-args that may contain:\n  - content_type - content type of the attachment (if ommited,\n  'application/octet-stream' will be used)\n  - file_name - name of the file (if ommited, the base name of the\n  provided file will be used)\n  - patch? - flag saying that the attachment is a patch\n  - private? - flag saying that the attachment is private\n  - comment\n\n @return [Array<ID>] a list of the attachment id(s) created.", "connects to host using alias", "append an alias for the given user@host with the options passed", "Returns all the alias names of in the file", "Parse the command line options using OptionParser.", "where and how is this used???", "return the executor used to execute the permit", "Updates your ead from a given file by first deleting the existing ead document and\n any component documents, then creating a new index from the supplied file.\n This method will also commit the results to your solr server when complete.", "Returns an OM document from a given file.\n\n Determines if you have specified a custom definition for your ead document.\n If you've defined a class CustomDocument, and have passed it as an option\n to your indexer, then SolrEad will use that class instead of SolrEad::Document.", "Returns an OM document from a given Nokogiri node\n\n Determines if you have specified a custom definition for your ead component.\n If you've defined a class CustomComponent, and have passed it as an option\n to your indexer, then SolrEad will use that class instead of SolrEad::Component.", "Determines the url to our solr service by consulting yaml files", "Once a batch is ready the Client fires off purge requests on the list of\n urls.", "Trap certain signals so the Client can report back the progress of the\n job and close the log.", "The logger redirects all STDOUT writes to a logger instance.", "resque-cleaner helpers", "Processes received frames for this stream. Internal use.\n @private", "Reserves a stream to server push. Sends PUSH_PROMISE and create new stream.\n @param headers [Enumerable<String, String>] The *request* headers. It must contain all of them: ':authority', ':method', ':scheme' and ':path'.\n @return [Stream] The stream to send push response.", "Sends DATA frame. If the data is larger than MAX_FRAME_SIZE, DATA frame will be splitted.\n @param data [String, IO] The data to send.\n @param end_stream [Boolean] Set END_STREAM flag or not.", "Remove the topo name attribute from all nodes, so topo search\n knows they are not in the topology", "Caches jobs for the duration of the block, flushes them at the end.", "Publish all the cached jobs", "You do not have permission to perform this action", "Check syntax in repository directory\n\n @see Checker#process", "Check syntax in indicated directory\n\n @see Checker#process", "Configures the Jira REST Client with your credentials\n\n @param jira_url [String]  The full url to your Jira instance, e.g.,\n   \"https://myjirainstance.atlassian.net\"\n @param jira_username [String] The username to use for accessing the Jira\n   instance. Commonly, this is an email address.\n @param jira_api_token [String] The API key to use to access the Jira\n   instance. Generate one here: https://id.atlassian.com/manage/api-tokens\n\n @return [JIRA::Client] The underlying jira-ruby JIRA::Client instance", "Labels the Pull Request with Jira Project Keys and Component Names\n\n @param issue_prefixes [Array<String>] An array of issue key prefixes;\n   this is often the project key. These must be present in the title or\n   body of the Pull Request\n @param project [Boolean] Label using the Jira Ticket's Project Key?\n @param components [Boolean] Label using the Jira Ticket's Component Names?\n @param labels [Boolean] Label using the Jira Ticket's Labels?\n\n @return [Array<String>, nil] The list of project & component labels\n   that were applied or nil if no issue or labels were found", "Runs all the methods needed when a worker begins its lifecycle.\nOVERRIDE for multithreaded workers", "override so we can synchronize the client on the reconnect for multithreaded workers.", "Returns the options specifice to the add command only", "Returns the standard options", "get actual node properties for export", "put node details in node array, overwriting existing details", "check for supportconfigs and download", "Load the settings from a compliant Qualys.yml file. This can be used for\n easy setup with frameworks other than Rails.\n\n @example Configure Qualys.\n   Qualys.load!(\"/path/to/qualys.yml\")\n\n @param [ String ] path The path to the file.", "Embed svg symbols", "Alexa data for an individual site", "Update persistence auto-timestamp attributes", "Returns the whole config or a specific value\n\n namespace - the namespace where the key is searched\n key - the key neede\n defaultValue - default value to return if the value is nil", "Loads the attachable methods, scope, and config into the model.", "Convert `data` between formats.\n @return [String] the converted data", "Write URL path method for use in HTTP methods.\n\n The map method most be used by following syntax:\n\n   map <name>, <path>\n\n If name is equal :root, then returns path ended by slash \"/\".\n\n   map :root,    \"tasks\"       #=> /tasks/\n   map :changes, \"last-changes #=> /tasks/last-changes", "Check arguments. If argument is a symbol and exist map path before\n setted, then return path mapped by symbol name.", "Returns all paths mapped by root path in prefix.", "Replace simbols in url for", "Get paths from location maps.", "Reserves a new stream to server push.\n @param args [Hash] The argument to pass to Stram.new.", "Main method of the application\n takes un processed ARGS and pass it to our parser to start our processing", "generic container for all things form", "Main rendering method", "initialize args for another knife command", "run another knife command", "check if resource exists", "make sure the chef environment exists", "a single result value", "A lazy collection which fetches records on demand.", "A hash of the provided params hashes merged into the default_params.", "Returns the path to the custom template if it exists", "Returns the path to the templates directory\n\n Returns string", "Replace the placeholders by the variables\n\n name: template name\n datas: hash containing the values\n\n Returns string", "Creates a new instance of CliCommand\n @param [String] path_to_binary see {#binary}. If nil, it will be initialized from {Configuration}\n @param [String] path_to_barman_home see {#barman_home}. If nil, it will be initialized from {Configuration}", "Instructs barman to get information about a specific backup\n @param [String] server server name\n @param [String] backup_id id of the backup\n @param [Hash] opts options for creating a {Backup}\n @option opts [Boolean] :with_wal_files whether to include {WalFiles} in each {Backup}\n @return [Backup] a new {Backup} object\n @raise [ArgumentError] if backup_id is nil", "Instructs barman to get information about a server\n @param [String] name name of the server\n @param [Hash] opts options for creating {Server}\n @option opts [Boolean] :with_backups whether to include {Backups} in {Server}\n @option opts [Boolean] :with_wal_files whether to include {WalFiles} in each {Backup}\n @return [Server] a new {Server}", "Instructs barman to get information about all servers\n @param [Hash] opts options for creating {Servers}\n @option opts [Boolean] :with_backups whether to include {Backups}\n @option opts [Boolean] :with_wal_files whether to include {WalFiles}\n @return [Servers] an array of {Server}", "Instructs barman to list all wal files for a specific backup id\n @param [String] server server name\n @param [String] backup_id id of the backup\n @return [WalFiles] an array of {WalFile}\n @raise [RuntimeError] if wal file duplicates are found in xlog.db\n @raise [RuntimeError] if barman lists a wal file but no information could be found in xlog.db", "Parses lines reported by barman's `list-server`\n @param [Array<String>] lines an array of lines from output of barman's `list-server` cmd\n @return [Array<String>] an array of server names", "Creates an argument string for barman recovery command based on opts Hash\n @param [Hash] opts options for creating the arguments\n @option opts [String] :remote_ssh_cmd the ssh command to be used for remote recovery\n @option opts [String, Time] :target_time the timestamp as recovery target\n @option opts [String] :target_xid the transaction ID as recovery target\n @option opts [Boolean] :exclusive whether to stop immediately before or immediately after the recovery target\n @return [String] the arguments\n @since 0.0.3", "Update an existing node", "Update original node, return list of updated properties.", "Update methods all return true if an actual update is made", "USER API Methods       \n\n creates a user\n TVUser.create_user(\n   username: \"bar\",\n   password: \"foo\",\n   attributes: {\n     \"id\": \"000\",\n     \"name\": \"John\",\n     \"type\": \"patient\"\n     }\n   }\n )", "list all users\n TVUser.list_users", "Loads a directory into the MemeLib, for template consumption\n Clobbers any existing templates\n\n @param [String] dir Directory glob pattern to meme templates\n @return [Hash] Hash of all templates and their filepaths", "Create a meme from a template\n\n @param [String] template: nil The template to use. Omit for random template\n @param [String] top: nil\n @param [String] bottom: nil\n @param [String] watermark: nil\n @return [LeMeme::Meme]", "return list of symbols for role groups the user belongs to", "Sends frame respecting inner-stream flow control.\n @param frame [Frame] The frame to be sent.", "Increases receiving window size. Sends WINDOW_UPDATE frame to the peer.\n @param wsi [Integer] The amount to increase receiving window size. The legal range is 1 to 2^32-1.", "Add an attachment to the bug\n For the params description, see the Client.add_attachment method.\n\n @return [ID] of the new attachment", "Update the display with the data from the LED buffer. This is a noop method\n for the fake LEDs.", "Set the LED at position `num` to the provided 24-bit RGB color value.\n\n Returns the 24-bit RGB color value.", "Replace the LED colors with the 24-bit RGB color values found in the `ary`.\n If the `ary` is longer than the LED string then the extra color values will\n be ignored. If the `ary` is shorter than the LED string then only the LEDS\n up to `ary.length` will be changed.\n\n You must call `show` for the new colors to be displayed.\n\n Returns this PixelPi::Leds instance.", "Set the selected LEDs to the given `color`. The `color` msut be given as a\n 24-bit RGB value. You can also supply a block that receives an LED index and\n returns a 24-bit RGB color.\n\n Examples:\n    leds.fill( 0x00FF00 )\n    leds.fill( 0xFF0000, 2, 2 )\n    leds.fill( 0x0000FF, (4...8) )\n    leds.fill { |i| 256 << i }\n\n Returns this PixelPi::Leds instance.", "Iterates through the result of the current query.\n\n @note Requires Bicho.client to be set\n\n @yield [Bicho::Bug]", "Create a query.\n\n @example query from a hash containing the attributes:\n   q = Query.new({:summary => \"substring\", :assigned_to => \"foo@bar.com\"})\n\n @example using chainable methods:\n   q = Query.new.assigned_to(\"foo@bar.com@).summary(\"some text\")\n\n Query responds to all the bug search attributes.\n\n @see {Bug.where Allowed attributes}", "Appends a parameter to the query map\n\n Only used internally.\n\n If the parameter already exists that parameter is converted to an\n array of values\n\n @private", "Create an RTMMethodSpace\n\n [name] the name of this method space, e.g. 'tasks'\n [endpoint] an endpoing to RTM\n Calls the method on RTM in most cases.  The only exception is if this RTMMethodSpace is 'tasks' and you\n call the 'notes' method on it: a new RTMMethodSpace is returned for the 'rtm.tasks.notes' method-space.\n\n This returns a response object as from HTTParty, dereferenced into <rsp>.  So, for example, if you called\n the 'tasks.getList' method, you would get a hash that could be accessed via response['tasks'].\n This object is a Hash and Array structure that mimcs the XML returned by RTM.  One quirk is that for methods that could return 1 or more\n of the same item (tasks.getList is a good example; it will return multilple <list> elements unless you restrict by list, in which case\n it returns only one <list> element).   Because HTTParty doesn't understand this, you may find it convienient to convert such\n results to arrays.  the to_array extension on Hash and Array accomplish this:\n\n     response = rtm.tasks.getList(:filter => 'list:Work')\n     response['tasks']['list'].as_array.each do |list|\n       list['taskseries'].as_array.each do |task|\n         puts task['name']\n       end\n     end\n\n So, call to_array on anything you expect to be a list.\n\n This method raises either a BadResponseException if you got a bad or garbled response from RTM or a VerificationException\n if you got a non-OK response.", "Set the attributes based on the given hash", "Creates a new HTTP client.\n @param host [String | IO] the host to connect, or IO object.\n @param port [Integer] the port number to connect\n @param config [Hash<Symbol, Object>] the client configuration\n Starts communication.\n If block passed, waits for asynchronous requests and closes the connection after calling the block.", "Creates a new HTTP request.\n @param headers [Hash<String, String>] the request headers\n @param body [String] the request body\n @param options [Hash<Symbol, Object>] request options\n @param block [Proc] if passed, it will be called when received response headers.", "Create a new FlatFile object for a database in the given path.\n @param dir [String] Directory path for the data base file\n Open the flat file for reading and writing.", "Close the flat file. This method must be called to ensure that all data\n is really written into the filesystem.", "Force outstanding data to be written to the filesystem.", "Delete the blob for the specified ID.\n @param id [Integer] ID of the object to be deleted\n @return [Boolean] True if object was deleted, false otherwise", "Delete the blob that is stored at the specified address.\n @param addr [Integer] Address of the blob to delete\n @param id [Integer] ID of the blob to delete", "Delete all unmarked objects.", "Write the given object into the file. This method never uses in-place\n updates for existing objects. A new copy is inserted first and only when\n the insert was successful, the old copy is deleted and the index\n updated.\n @param id [Integer] ID of the object\n @param raw_obj [String] Raw object as String\n @return [Integer] position of the written blob in the blob file", "Read the object at the specified address.\n @param addr [Integer] Offset in the flat file\n @param id [Integer] ID of the data blob\n @return [String] Raw object data", "Eliminate all the holes in the file. This is an in-place\n implementation. No additional space will be needed on the file system.", "This method iterates over all entries in the FlatFile and removes the\n entry and inserts it again. This is useful to update all entries in\n case the storage format has changed.", "This method clears the index tree and the free space list and\n regenerates them from the FlatFile.", "Defines the rake tasks.\n\n @api private", "Create a new lock for the given file.\n @param file_name [String] file name of the lock file\n @param options [Hash] See case statement\n Attempt to take the lock.\n @return [Boolean] true if lock was taken, false otherwise", "Release the lock again.", "Erase the lock file. It's essentially a forced unlock method.", "Starts wmctile, runs the required methods.\n\n @param [Hash] command line options\n @param [Array] window_strings ARGV array\n\n\n Creates a new window based on @arguments and @window_strings.\n If no window is found, checks for the -x/--exec argument. If present, executes it.\n If there's no -x command and a window is not found, raises an error.\n\n @param [Integer] index index of the window from matching windows array\n\n @return [Window] window instance", "Switch to target_workspace.\n\n @param [String] target_workspace Target workspace index or \"next\"/\"previous\".\n\n @return [Integer] Target workspace number", "Transitions to the state at the specified path. The path can be relative\n to any state along the current state's path.", "All events the current state will respond to", "def selectable_products\n=begin rdoc\n\n==== Bugzilla::Product#enterable_products\n\nReturns Hash table for the products information that the user\ncan enter bugs against. the Hash key is the product name and\ncontaining a Hash table which contains id, name, description,\nis_active, default_milestone, has_uncomfirmed, classification,\ncomponents, versions and milestones. please see\nhttp://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html#get\nfor more details.\n\n=end", "def enterable_products\n=begin rdoc\n\n==== Bugzilla::Product#accessible_products\n\nReturns Hash table for the products information that the user\ncan search or enter bugs against. the Hash key is the product\nname and containing a Hash table which contains id, name, description,\nis_active, default_milestone, has_uncomfirmed, classification,\ncomponents, versions and milestones. please see\nhttp://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html#get\nfor more details.\n\n=end", "Store a simple Hash as a JSON encoded file into the DB directory.\n @param name [String] Name of the hash. Will be used as file name.\n @param hash [Hash] A Hash that maps String objects to strings or\n numbers.", "Get the parent relation.  Polymorphic relations are prioritized first.\n @return [Object, nil] ActiveRecord object instasnce", "Climb up each parent object in the hierarchy until the top is reached.\n   This has a no-repeat safety built in.  Polymorphic parents have priority.\n @return [Object, nil] top parent ActiveRecord object instace", "All belongs_to parents as class objects. One if polymorphic.\n @return [Array<Object>] ActiveRecord classes of parent objects.", "Is the given `string` deemed a good password?\n An additional `word_list` can be provided; its entries add only\n minimally when considering the strength of `string`.\n\n   NdrSupport::Password.valid?('google password')    #=> false\n   NdrSupport::Password.valid?(SecureRandom.hex(12)) #=> true", "Parses add_file dsl, it adds a new file.\n\n @param filename [String] file name of newly created file.\n @param content [String] file body of newly created file.", "Parses remove_file dsl, it removes a file.\n\n @param filename [String] file name.", "Establishes the connection to the server, if successful, will return the\n greeting frame.", "Gracefully close the connection", "gets a frame from the socket and returns the parsed response.", "The equivalent of the `KM.identify` method of the JavaScript API.", "Send a text message to remote_number", "Place a call to remote_number, and ring back forwarding_number which\n should be set up on the currently logged in Google Voice account", "Google provides XML data for various call histories all with the same\n URL pattern in a getful manner. So here we're just dynamically creating\n methods to fetch that data in a DRY-manner. Yes, define_method is slow,\n but we're already making web calls which drags performance down anyway\n so it shouldn't matter in the long run.", "Initializes the connection to QuickBase.", "Initializes the connection to QuickBase and sets the QuickBase URL and port to use for requests.", "Sends requests to QuickBase and processes the reponses.", "Returns whether to prepend 'API_' to request string", "Turns program stack tracing on or off.\n If followed by a block, the tracing will be toggled on or off at the end of the block.", "Extracts error info from XML responses returned by QuickBase.", "Called by processResponse to put the XML from QuickBase\n into a DOM tree using the REXML module that comes with Ruby.", "Gets the value for a specific field at the top level\n of the XML returned from QuickBase.", "Gets an array of values at an Xpath in the XML from QuickBase.", "Gets a dbid at an Xpath in the XML from specified dbName of Quickbase", "Returns a string representation of the attributes of an XML element.", "Returns the name of field given an \"fid\" XML element.", "Returns a QuickBase field type, given an XML \"fid\" element.", "Returns the value of a field property, or nil.", "Returns whether a field ID is the ID for the key field in a QuickBase table.", "Returns a human-readable string representation of a QuickBase field value.\n Also required for subsequent requests to QuickBase.", "Returns the first XML sub-element with the specified attribute value.", "Returns an array of XML sub-elements with the specified attribute name.", "Returns the XML element for a field returned by a getRecordInfo call.", "Returns the value for a field returned by a getRecordInfo call.", "Returns the printable value for a field returned by a getRecordInfo call.", "Get an array of field IDs for a table.", "Get an array of field names for a table.", "Get a Hash of application variables.", "Makes the table with the specified name the 'active' table, and returns the id from the table.", "Get the name of a table given its id.", "Get a list of the names of the child tables of an application.", "Get a list of the dbids of the child tables of an application.", "Get the number of child tables of an application", "Given a DBID, get the QuickBase realm it is in.", "Returns whether a given string represents a valid QuickBase field type.", "Returns whether a given string represents a valid QuickBase field property.", "Given an array of field names or field IDs and a table ID, builds an array of valid field IDs and field names.\n Throws an exception when an invalid name or ID is encountered.", "Builds the request XML for retrieving the results of a query.", "Returns the clist associated with a query.", "Returns the slist associated with a query.", "Returns the criteria associated with a query.", "Returns a valid query operator.", "Get a field's base type using its name.", "Get a field's type using its name.", "Returns the human-readable string represntation of a date, given the\n milliseconds version of the date.  Also needed for requests to QuickBase.", "Converts milliseconds to hours and returns the value as a string.", "Returns a string format for a time of day value.", "Returns a string formatted for a currency value.", "Returns a string formatted for a percent value, given the data from QuickBase", "Returns the milliseconds representation of a date specified in mm-dd-yyyy format.", "Returns the URL-encoded version of a non-printing character.", "Returns the list of string substitutions to make to encode or decode field values used in XML.", "Modify the given string for use as a XML field value.", "Modify the given XML field value for use as a string.", "Called by client methods to notify event subscribers", "API_AddRecord, using the active table id.", "version of doQuery that takes a Hash of parameters", "Download a file's contents from a file attachment field in QuickBase.\n You must write the contents to disk before a local file exists.", "Download and save a file from a file attachment field in QuickBase.\n Use the filename parameter to override the file name from QuickBase.", "API_FieldAddChoices\n The choice parameter can be one choice string or an array of choice strings.", "Loop through the list of Pages for an application", "Get all the values for one or more fields from a specified table.\n\n e.g. getAllValuesForFields( \"dhnju5y7\", [ \"Name\", \"Phone\" ] )\n\n The results are returned in Hash, e.g. { \"Name\" => values[ \"Name\" ], \"Phone\" => values[ \"Phone\" ] }\n The parameters after 'fieldNames' are passed directly to the doQuery() API_ call.\n\n  Invalid 'fieldNames' will be treated as field IDs by default,  e.g. getAllValuesForFields( \"dhnju5y7\", [ \"3\" ] )\n  returns a list of Record ID#s even if the 'Record ID#' field name has been changed.", "Get all the values for one or more fields from a specified table.\n This also formats the field values instead of returning the raw value.", "Get all the values for one or more fields from a specified table, in JSON format.\n This formats the field values instead of returning raw values.", "Get all the values for one or more fields from a specified table, in human-readable JSON format.\n This formats the field values instead of returning raw values.", "Collect summary records into an array.", "Loop through a list of records returned from a query.\n Each record will contain all the fields with values formatted for readability by QuickBase via API_GetRecordInfo.", "Query records, sum the values in a numeric field, calculate each record's percentage\n of the sum and put the percent in a percent field each record.", "Query records, get the average of the values in a numeric field, calculate each record's deviation\n from the average and put the deviation in a percent field each record.", "Given an array of two numbers, return the second number as a percentage of the first number.", "Given an array of two numbers, return the difference between the numbers as a positive number.", "Get an array of the existing choices for a multiple-choice text field.", "Finds records with the same values in a specified\n list of fields and deletes all but the first or last duplicate record.\n The field list may be a list of field IDs or a list of field names.\n The 'options' parameter can be used to keep the oldest record instead of the\n newest record, and to control whether to ignore the case of field values when\n deciding which records are duplicates.  Returns the number of records deleted.", "Make one or more copies of a record.", "Import data directly from an Excel file into the active table.", "Add records from lines in a CSV file.\n If dbid is not specified, the active table will be used.\n values in subsequent lines.  The file must not contain commas inside field names or values.", "Import records from a text file in Tab-Separated-Values format.", "Make a CSV file using the results of a query.\n Specify a different separator in the second paramater.\n Fields containing the separator will be double-quoted.\n\n e.g. makeSVFile( \"contacts.txt\", \"\\t\", nil )\n e.g. makeSVFile( \"contacts.txt\", \",\", \"dhnju5y7\", nil, nil, \"List Changes\" )", "Create a CSV file using the records for a Report.", "Get the CSV data for a Report.", "Translate a simple SQL UPDATE statement to a QuickBase editRecord call.\n\n Note: This method is here primarily for Rails integration.\n Note: This assumes, like SQL, that your column (i.e. field) names do not contain spaces.\n Note: This assumes that Record ID# is the key field in your table.", "Translate a simple SQL INSERT statement to a QuickBase addRecord call.\n\n Note: This method is here primarily for Rails integration.\n Note: This assumes, like SQL, that your column (i.e. field) names do not contain spaces.", "Iterate record XML and yield only 'f' elements.", "Add method aliases that follow the ruby method naming convention.\n E.g. sendRequest will be aliased as send_request.", "Create a new cookbook from the given hash.\n\n @param [Hash] hash\n   the hash from which to create the cookbook\n Dump this cookbook to a hash.\n\n @return [Hash]\n   the hash representation of this cookbook", "Return a list of all object IDs of all persistend objects that this Array\n is referencing.\n @return [Array of Integer] IDs of referenced objects", "Generate the expected value.\n\n @return [Integer, Range] Generate the expected value.", "Obfuscate a name or address, either with the given seed, or default seed", "Start a Community Zero server in a forked process. This method returns\n the PID to the forked process.\n\n @param [Fixnum] wait\n   the number of seconds to wait for the server to start\n\n @return [Thread]\n   the thread the background process is running in", "Boolean method to determine if the server is currently ready to accept\n requests. This method will attempt to make an HTTP request against the\n server. If this method returns true, you are safe to make a request.\n\n @return [Boolean]\n   true if the server is accepting requests, false otherwise", "Gracefully stop the Community Zero server.\n\n @param [Fixnum] wait\n   the number of seconds to wait before raising force-terminating the\n   server", "The actual application the server will respond to.\n\n @return [RackApp]", "Create the cookbook from the metadata.\n\n @param [CommunityZero::Metadata] metadata\n   the metadata to create the cookbook from", "Parse the metadata from the tarball.\n\n @param [Tempfile] tarball\n   the temporarily uploaded file\n\n @return [Metadata]", "Internal method used to complete initialization of the Account after\n all transactions have been associated with it.\n\n @return [void]", "Lookup schema in cache or try to fetch", "Return true or throw exception", "For now it's just logged in or not?\n This will work with effective_roles one day...", "Create a new Store.\n @param data_base [String] the name of the database\n @param options [Hash] various options to affect the operation of the\n        database. Currently the following options are supported:\n        :engine     : The class that provides the back-end storage\n                      engine. By default FlatFileDB is used. A user\n                      can provide it's own storage engine that must\n                      conform to the same API exposed by FlatFileDB.\n        :cache_bits : the number of bits used for cache indexing. The\n                      cache will hold 2 to the power of bits number of\n                      objects. We have separate caches for reading and\n                      writing. The default value is 16. It probably makes\n                      little sense to use much larger numbers than that.\n        :serializer : select the format used to serialize the data. There\n                      are 3 different options:\n                      :marshal : Native Ruby serializer. Fastest option\n                      that can handle most Ruby data types. Big\n                      disadvantate is the stability of the format. Data\n                      written with one Ruby version may not be readable\n                      with another version.\n                      :json : About half as fast as marshal, but the\n                      format is rock solid and portable between\n                      languages. It only supports basic Ruby data types\n                      like String, Integer, Float, Array, Hash. This is\n                      the default option.\n                      :yaml : Can also handle most Ruby data types and is\n                      portable between Ruby versions (1.9 and later).\n                      Unfortunately, it is 10x slower than marshal.\n     :progressmeter : reference to a ProgressMeter object that receives\n                      progress information during longer running tasks.\n                      It defaults to ProgressMeter which only logs into\n                      the log. Use ConsoleProgressMeter or a derived\n                      class for more fancy progress reporting.\n Copy the store content into a new Store. The arguments are identical to\n Store.new().\n @param options [Hash] various options to affect the operation of the", "Close the store and ensure that all in-memory objects are written out to\n the storage backend. The Store object is no longer usable after this\n method was called.", "You need to call this method to create new PEROBS objects that belong to\n this Store.\n @param klass [Class] The class of the object you want to create. This\n        must be a derivative of ObjectBase.\n @param args Optional list of other arguments that are passed to the\n        constructor of the specified class.\n @return [POXReference] A reference to the newly created object.", "For library internal use only!\n This method will create a new PEROBS object.\n @param klass [BasicObject] Class of the object to create\n @param id [Integer] Requested object ID\n @param args [Array] Arguments to pass to the object constructor.\n @return [BasicObject] Newly constructed PEROBS object", "Flush out all modified objects to disk and shrink the in-memory list if\n needed.", "Return the object with the provided ID. This method is not part of the\n public API and should never be called by outside users. It's purely\n intended for internal use.", "This method can be used to check the database and optionally repair it.\n The repair is a pure structural repair. It cannot ensure that the stored\n data is still correct. E. g. if a reference to a non-existing or\n unreadable object is found, the reference will simply be deleted.\n @param repair [TrueClass/FalseClass] true if a repair attempt should be\n        made.\n @return [Integer] The number of references to bad objects found.", "Calls the given block once for each object, passing that object as a\n parameter.", "Mark phase of a mark-and-sweep garbage collector. It will mark all\n objects that are reachable from the root objects.", "Check the object with the given start_id and all other objects that are\n somehow reachable from the start object.\n @param start_id [Integer] ID of the top-level object to start\n        with\n @param repair [Boolean] Delete refernces to broken objects if true\n @return [Integer] The number of references to bad objects.", "Return a list of all object IDs that the attributes of this instance are\n referencing.\n @return [Array of Integer] IDs of referenced objects", "This method should only be used during store repair operations. It will\n delete all references to the given object ID.\n @param id [Integer] targeted object ID", "Textual dump for debugging purposes\n @return [String]", "Return a single data structure that holds all persistent data for this\n class.", "Add record to set.  Flag if covered already.\n @param record [Object] ActiveRecord object instance\n @return [Object, nil] Object if added safely, nil otherwise", "method_missing will transform any record argument into a formatted string and pass the\n method and arguments on to the internal Set.  Also will flag any existing records covered.", "Takes a xml response and checks that the result is in the right range of\n results, that is, between 1000 and 1999, which are results meaning all\n went well.\n\n In case all went well, it either calls the callback if given, or returns\n true.\n\n In case there was a problem, an EPPErrorResponse exception is raised.", "Creates the xml for the command.\n\n You can either pass a block to it, in that case, it's the command body,\n or a series of procs, the first one being the commands, the other ones\n being the extensions.\n\n   command do |xml|\n       xml.logout\n   end\n\n or\n\n   command(lambda do |xml|\n       xml.logout\n     end, lambda do |xml|\n       xml.extension\n     end)", "Creates HTTPS handler.\n @return [Net::HTTP] HTTPS handler.\n @see #http", "Gets form data for POST request\n @param [Hash] defopts\n @param [Hash] opts\n @return [Hash] Form data to be sent.\n @raise [ContractError]", "Will join channels specified in configuration.", "What did they say?", "A convenience method to get one or many zip codes by code, code and add-on, code and city or just\n city.\n There are various allowed styles to pass those values.\n All numeric values can be passed either as Integer or String.\n You can pass the code and add-on as six-digit number, or you can pass the code\n as four digit number plus either the add-on or name as second parameter. Or you can\n pass the code alone, or the name alone.\n\n @example All usage styles\n   zip_codes[805200]           # zip code 8052, add-on 0\n   zip_codes[\"805200\"]         # zip code 8052, add-on 0\n   zip_codes[8052, 0]          # zip code 8052, add-on 0\n   zip_codes[\"8052\", 0]        # zip code 8052, add-on 0\n   zip_codes[8052, \"0\"]        # zip code 8052, add-on 0\n   zip_codes[\"8052\", 0]        # zip code 8052, add-on 0\n   zip_codes[8052, \"Z\u00fcrich\"]   # zip code 8052, add-on 0\n   zip_codes[\"8052\", \"Z\u00fcrich\"] # zip code 8052, add-on 0\n   zip_codes[8052]             # all zip codes with code 8052\n   zip_codes[\"8052\"]           # all zip codes with code 8052\n   zip_codes[\"Z\u00fcrich\"]         # all zip codes with name \"Z\u00fcrich\"\n\n @see #by_code_and_add_on  Get a zip code by code and add-on directly\n @see #by_code_and_name    Get a zip code by code and name directly\n @see #by_name             Get a collection of zip codes by name directly\n @see #by_ordering_number  Get a zip code by its ONRP directly (#[] can't do that)\n\n @param [String, Integer] key\n   Either the zip code, zip code and add-on\n @return [SwissMatch::ZipCode, SwissMatch::ZipCodes]\n   Either a SwissMatch::ZipCodes collection of zip codes or a single SwissMatch::ZipCode, depending on\n   the argument you pass.", "complete file path", "Regex for matching dumped CSVs", "returns an array of strings for CSV header based on booty", "File increment for next CSV to dump", "Write the header to a given File.", "This method makes a call to `execute_async_script` which means that the\n DOM observer script must explicitly signal that it is finished by\n invoking a callback. In this case, the callback is nothing more than\n a delay. The delay is being used to allow the DOM to be updated before\n script actions continue.\n\n The method returns true if the DOM has been changed within the element\n context, while false means that the DOM has not yet finished changing.\n Note the wording: \"has not finished changing.\" It's known that the DOM\n is changing because the observer has recognized that. So the question\n this method is helping to answer is \"has it finished?\"\n\n Consider the following element definition:\n\n    p :page_list, id: 'navlist'\n\n You could then do this:\n\n    page_list.dom_updated?\n\n That would return true if the DOM content for page_list has finished\n updating. If the DOM was in the process of being updated, this would\n return false. You could also do this:\n\n    page_list.wait_until(&:dom_updated?).click\n\n This will use Watir's wait until functionality to wait for the DOM to\n be updated within the context of the element. Note that the \"&:\" is\n that the object that `dom_updated?` is being called on (in this case\n `page_list`) substitutes the ampersand. You can also structure it like\n this:\n\n    page_list.wait_until do |element|\n        element.dom_updated?\n    end\n\n The default delay of waiting for the DOM to start updating is 1.1\n second. However, you can pass a delay value when you call the method\n to set your own value, which can be useful for particular sensitivities\n in the application you are testing.", "Serialize the given object using the object serializer.\n @param obj [ObjectBase] Object to serialize\n @return [String] Serialized version", "De-serialize the given String into a Ruby object.\n @param raw [String]\n @return [Hash] Deserialized version", "Check a config option and adjust it if needed.\n @param name [String] Name of the config option.", "Ensure that we have a directory to store the DB items.", "Initialize a gem_spec.\n\n @param name [String] gem name\n @param comparator [Hash] comparator to gem version, e.g. {eq: '2.0.0'},\n   comparator key can be eq, lt, gt, lte, gte or ne.\n Check if the specified gem version in Gemfile.lock matches gem_spec comparator.\n\n @return [Boolean] true if matches, otherwise false.\n @raise [Synvert::Core::GemfileLockNotFound] raise if Gemfile.lock does not exist.", "The response hash for this cookbook.\n\n @param [CommunityZero::Cookbook] cookbook\n   the cookbook to generate a hash for", "Order the results by the specified columns.\n\n @param ordering an array of hashes, of the form {:column =>\n   \"name\", :ascending => true}\n @api public", "Close the stack file. This method must be called before the program is\n terminated to avoid data loss.", "Push the given bytes onto the stack file.\n @param bytes [String] Bytes to write.", "Pop the last entry from the stack file.\n @return [String or nil] Popped entry or nil if stack is already empty.", "def get_bugs\n=begin rdoc\n\n==== Bugzilla::Bug#get_comments(bugs)\n\n=end", "The `when_ready` method is called on an instance of an interface. This\n executes the provided validation block after the page has been loaded.\n The Ready object instance is yielded into the block.\n\n Calls to the `ready?` method use a poor-man's cache approach. The idea\n here being that when a page has confirmed that it is ready, meaning that\n no ready validations have failed, that information is stored so that any\n subsequent calls to `ready?` do not query the ready validations again.", "This method checks if the ready validations that have been specified\n have passed. If any ready validation fails, no matter if others have\n succeeded, this method immediately returns false.", "check if none of child node matches the rules.", "Add the rid related validations to the model.\n @param options [Hash] same as in RandomUniqueID.config", "Defines the setter and getter for the RID of a relationship.\n\n @param related_class [Class] class in which the RID methods are going to be defined.\n @param relationship_name [String] name of the relationship for which the RID methods are going to be defined.\n @see RandomUniqueId::ClassMethods.belongs_to", "This is the entry point to the DSL method for creating menu items", "Search the keys of the node that fits the given key. The result is\n either the index of an exact match or the index of the position where\n the given key would have to be inserted.\n @param key [Integer] key to search for\n @return [Integer] Index of the matching key or the insert position.", "Calculate the value for the response field", "Normalizes `required` and `optional` fields to the form of Hash with options.\n @param [NilClass,Hash,Array, etc.] arr Something to normalize.", "Gets fields to validate\n @return [Hash] Fields to validate.", "Validates specified `value` with `ipaddr` field.\n @param [Object] key Value to validate.\n @param [Object] value Value to validate.\n @param [Hash] opts opts with optional ipaddr field.\n @return [String] Updated `value`", "Validates specified `form` for presence of all required fields.\n @param [Hash] form Form to validate.\n @param [Hash] fields Fields to test.\n return void\n @raise ContractError", "Validates specified `form` with `required` and `optional` fields.\n @param [Hash] form Form to validate.\n @return [Hash] Updated form.\n @raise ContractError", "Return if given key is stored in the node.\n @param key [Integer] key to search for\n @return [Boolean] True if key was found, false otherwise", "Remove the element from a leaf node at the given index.\n @param index [Integer] The index of the entry to be removed\n @return [Object] The removed value", "Remove the specified node from this branch node.\n @param node [BigTreeNode] The child to remove", "Gather some statistics about the node and all sub nodes.\n @param stats [Stats] Data structure that stores the gathered data", "Return true if the object with given ID exists\n @param id [Integer]", "Load the given object from the filesystem.\n @param id [Integer] object ID\n @return [Hash] Object as defined by PEROBS::ObjectBase or nil if ID does\n         not exist", "Check if the object is marked.\n @param id [Integer] ID of the object to check\n @param ignore_errors [Boolean] If set to true no errors will be raised\n        for non-existing objects.", "fixme - make these shell safe", "Query the installed cookbooks, returning those who's name matches the\n given query.\n\n @param [String] query\n   the query parameter\n\n @return [Array<CommunityZero::Cookbook>]\n   the list of cookbooks that match the given query", "Add the given cookbook to the cookbook store. This method's\n implementation prohibits duplicate cookbooks from entering the store.\n\n @param [CommunityZero::Cookbook] cookbook\n   the cookbook to add", "Remove the cookbook from the store.\n\n @param [CommunityZero::Cookbook] cookbook\n   the cookbook to remove", "Determine if the cookbook store contains a cookbook. If the version\n attribute is nil, this method will return the latest cookbook version by\n that name that exists. If the version is specified, this method will only\n return that specific version, or nil if that cookbook at that version\n exists.\n\n @param [String] name\n   the name of the cookbook to find\n @param [String, nil] version\n   the version of the cookbook to search\n\n @return [CommunityZero::Cookbook, nil]\n   the cookbook in the store, or nil if one does not exist", "Return a list of all versions for the given cookbook.\n\n @param [String, CommunityZero::Cookbook] name\n   the cookbook or name of the cookbook to get versions for", "Return a list of all object IDs of all persistend objects that this Hash\n is referencing.\n @return [Array of Integer] IDs of referenced objects", "This method should only be used during store repair operations. It will\n delete all referenced to the given object ID.\n @param id [Integer] targeted object ID", "Split the current page. This split is done by splitting the ID range in\n half. This page will keep the first half, the newly created page will\n get the second half. This may not actually yield an empty page as all\n values could remain with one of the pages. In this case further splits\n need to be issued by the caller.\n @return [IDListPageRecord] A new IDListPageRecord object.", "Defines which columns of the base dimension are present in the\n shrunken dimension.\n\n Takes an array of the column names as symbols.\n\n The columns must be a subset of the base dimension's columns;\n additional names will raise a Chicago::MissingDefinitionError.", "Insert position.\n\n @return [Integer] insert position.", "This method provides the means to get the aspects of an accessor\n signature. The \"aspects\" refer to the locator information and any\n qualifier information that was provided along with the locator.\n This is important because the qualifier is not used to locate an\n element but rather to put conditions on how the state of the\n element is checked as it is being looked for.\n\n Note that \"qualifiers\" here refers to Watir boolean methods.", "Create a new DynamoDB object.\n @param db_name [String] name of the DB directory\n @param options [Hash] options to customize the behavior. Currently only\n        the following options are supported:\n        :serializer    : Can be :json and :yaml\n        :aws_id        : AWS credentials ID\n        :aws_key       : AWS credentials key\n        :aws_region    : AWS region to host the data\n Delete the entire database. The database is no longer usable after this\n method was called.", "Permanently delete all objects that have not been marked. Those are\n orphaned and are no longer referenced by any actively used object.\n @return [Integer] Count of the deleted objects.", "Basic consistency check.\n @param repair [TrueClass/FalseClass] True if found errors should be\n        repaired.", "Proxy all calls to unknown methods to the referenced object.", "Library internal method to transfer the Object to a new store.\n @param store [Store] New store", "Restore the object state from the storage back-end.\n @param level [Integer] the transaction nesting level", "Check the availability of domains\n\n takes a list of domains as arguments\n\n returns an array of hashes containing three fields :\n [<tt>:name</tt>] The domain name\n [<tt>:avail</tt>] Wether the domain is available or not.\n [<tt>:reason</tt>] The reason for non availability, if given.", "Returns the informations about a domain\n\n Takes either a unique argument, a string, representing the domain, or a\n hash with : <tt>:name</tt> the domain name, and optionnaly\n <tt>:authInfo</tt> the authentication information and possibly\n <tt>:roid</tt> the contact the authInfo is about.\n\n Returned is a hash mapping as closely as possible the result expected\n from the command as per Section\n {3.1.2}[https://tools.ietf.org/html/rfc5731#section-3.1.2] of {RFC\n 5731}[https://tools.ietf.org/html/rfc5731] :\n [<tt>:name</tt>] The fully qualified name of the domain object.\n [<tt>:roid</tt>]\n    The Repository Object IDentifier assigned to the domain object when\n    the object was created.\n [<tt>:status</tt>]\n    an optionnal array of elements that contain the current status\n    descriptors associated with the domain.\n [<tt>:registrant</tt>] one optionnal registrant nic handle.\n [<tt>:contacts</tt>]\n   an optionnal hash which keys are choosen between +admin+, +billing+ and\n   +tech+ and which values are arrays of nic handles for the corresponding\n   contact types.\n [<tt>:ns</tt>]\n   an optional array containing nameservers informations, which can either\n   be an array of strings containing the the fully qualified name of a\n   host, or an array of hashes containing the following keys :\n   [<tt>:hostName</tt>] the fully qualified name of a host.\n   [<tt>:hostAddrv4</tt>]\n      an optionnal array of ipv4 addresses to be associated with the host.\n   [<tt>:hostAddrv6</tt>]\n      an optionnal array of ipv6 addresses to be associated with the host.\n [<tt>:host</tt>]\n    an optionnal array of fully qualified names of the subordinate host\n    objects that exist under this superordinate domain object.\n [<tt>:clID</tt>] the identifier of the sponsoring client.\n [<tt>:crID</tt>]\n   an optional identifier of the client that created the domain object.\n [<tt>:crDate</tt>] an optional date and time of domain object creation.\n [<tt>:exDate</tt>]\n   the date and time identifying the end of the domain object's\n   registration period.\n [<tt>:upID</tt>]\n   the identifier of the client that last updated the domain object.\n [<tt>:upDate</tt>]\n   the date and time of the most recent domain-object modification.\n [<tt>:trDate</tt>]\n   the date and time of the most recent successful domain-object transfer.\n [<tt>:authInfo</tt>]\n   authorization information associated with the domain object.", "Set the registered custom data field to the given value.\n @param name [String] Label of the offset\n @param value [Integer] Value", "Return the address of a free blob storage space. Addresses start at 0\n and increase linearly.\n @return [Integer] address of a free blob space", "Store the given byte blob at the specified address. If the blob space is\n already in use the content will be overwritten.\n @param address [Integer] Address to store the blob\n @param bytes [String] bytes to store", "Retrieve a blob from the given address.\n @param address [Integer] Address to store the blob\n @return [String] blob bytes", "Delete the blob at the given address.\n @param address [Integer] Address of blob to delete", "Check the file for logical errors.\n @return [Boolean] true of file has no errors, false otherwise.", "Redirect all log messages to the given IO.\n @param io [IO] Output file descriptor", "Rename a set of classes to new names.\n @param rename_map [Hash] Hash that maps old names to new names", "Delete all classes unless they are contained in _classes_.\n @param classes [Array of String] List of the class names", "Memory init function. Creates a default yaml file if it's non-existent.\n\n\n Reads the yaml file, creating it if non-existent.\n\n @return [void]", "Call the request.\n\n @param [CommunityZero::Request] request\n   the request object", "Returns a duplicated post object, or throws an exception", "Consumes a directive and generates a DirectiveStatement", "Replies to given message\n @option options [Xrc::Messages::Base] :to A message object given from server\n @option options [String] :body A text to be sent to server\n @return [REXML::Element] Returns an element sent to server\n @example\n   client.reply(body: \"Thanks\", to: message)", "Send a message\n @option options [String] :body Message body\n @option options [String] :from Sender's JID\n @option options [String] :to Address JID\n @option options [String] :type Message type (e.g. chat, groupchat)\n @return [REXML::Element] Returns an element sent to server\n @example\n   client.say(body: \"Thanks\", from: \"alice@example.com\", to: \"bob@example.com\", type: \"chat\")", "Store the value at the given index. If the index already exists the old\n value will be overwritten.\n @param index [Integer] Position in the array\n @param value [Integer] value", "Insert the value at the given index. If the index already exists the old\n value will be overwritten.\n @param index [Integer] Position in the array\n @param value [Integer] value", "Delete all entries for which the passed block yields true. The\n implementation is optimized for large bulk deletes. It rebuilds a new\n BTree for the elements to keep. If only few elements are deleted the\n overhead of rebuilding the BTree is rather high.\n @yield [key, value]", "Iterate over all entries in the tree. Entries are always sorted by the\n key.\n @yield [key, value]", "Iterate over all entries in the tree in reverse order. Entries are\n always sorted by the key.\n @yield [key, value]", "Convert the BigArray into a Ruby Array. This is primarily intended for\n debugging as real-world BigArray objects are likely too big to fit into\n memory.", "Save the node into the blob file.", "Add a new node for the given address and size to the tree.\n @param address [Integer] address of the free space\n @param size [Integer] size of the free space", "Check if this node or any sub-node has an entry for the given address\n and size.\n @param address [Integer] address of the free space\n @param size [Integer] size of the free space\n @return [Boolean] True if found, otherwise false", "Replace the link in the parent node of the current node that points to\n the current node with the given node.\n @param node [SpaceTreeNode]", "Compare this node to another node.\n @return [Boolean] true if node address is identical, false otherwise\n Collects address and size touples of all nodes in the tree with a\n depth-first strategy and stores them in an Array.\n @return [Array] Array with [ address, size ] touples.", "Check this node and all sub nodes for possible structural or logical\n errors.\n @param flat_file [FlatFile] If given, check that the space is also\n        present in the given flat file.\n @param count [Integer] The total number of entries in the tree\n @return [false,true] True if OK, false otherwise", "Check the integrity of the given sub-node link and the parent link\n pointing back to this node.\n @param link [String] 'smaller', 'equal' or 'larger'\n @param stack [Array] List of parent nodes [ address, mode ] touples\n @return [Boolean] true of OK, false otherwise", "Convert the node and all child nodes into a tree like text form.\n @return [String]", "The indentation and arch routing for the text tree.\n @return [String]", "Save all modified entries and delete all but the most recently added.", "Check the availability of contacts\n\n takes list of contacts as arguments\n\n returns an array of hashes containing three fields :\n [<tt>:id</tt>] the contact id\n [<tt>:avail</tt>] wether the contact id can be provisionned.\n [<tt>:reason</tt>]\n   the server-specific text to help explain why the object cannot be\n   provisioned.", "Returns the informations about a contact\n\n Takes either a unique argument, either\n a string, representing the contact id\n or a hash with the following keys :\n [<tt>:id</tt>] the contact id, and optionnaly\n [<tt>:authInfo</tt>] an optional authentication information.\n\n Returned is a hash mapping as closely as possible the result expected\n from the command as per Section 3.1.2 of RFC 5733 :\n [<tt>:id</tt>]\n   the server-unique identifier of the contact object. Most of the time,\n   the nic handle.\n [<tt>:roid</tt>]\n   the Repository Object IDentifier assigned to the contact object when\n   the object was created.\n [<tt>:status</tt>] the status of the contact object.\n [<tt>:postalInfo</tt>]\n   a hash containing one or two keys, +loc+ and +int+ representing the\n   localized and internationalized version of the postal address\n   information. The value is a hash with the following keys :\n   [<tt>:name</tt>]\n     the name of the individual or role represented by the contact.\n   [<tt>:org</tt>]\n     the name of the organization with which the contact is affiliated.\n   [<tt>:addr</tt>]\n     a hash with the following keys :\n     [<tt>:street</tt>]\n       an array that contains the contact's street address.\n     [<tt>:city</tt>] the contact's city.\n     [<tt>:sp</tt>] the contact's state or province.\n     [<tt>:pc</tt>] the contact's postal code.\n     [<tt>:cc</tt>] the contact's country code.\n [<tt>:voice</tt>] the contact's optional voice telephone number.\n [<tt>:fax</tt>] the contact's optional facsimile telephone number.\n [<tt>:email</tt>] the contact's email address.\n [<tt>:clID</tt>] the identifier of the sponsoring client.\n [<tt>:crID</tt>]\n   the identifier of the client that created the contact object.\n [<tt>:crDate</tt>] the date and time of contact-object creation.\n [<tt>:upID</tt>]\n   the optional identifier of the client that last updated the contact\n   object.\n [<tt>:upDate</tt>]\n   the optional date and time of the most recent contact-object\n   modification.\n [<tt>:trDate</tt>]\n   the optional date and time of the most recent successful contact-object\n   transfer.\n [<tt>:authInfo</tt>]\n   authorization information associated with the contact object.\n [<tt>:disclose</tt>]\n   an optional array that identifies elements that require exceptional\n   server-operator handling to allow or restrict disclosure to third\n   parties. See {section 2.9 of RFC\n   5733}[http://tools.ietf.org/html/rfc5733#section-2.9] for details.", "Window init function. Tries to find an id.\n\n @param [Hash] arguments command line options\n @param [String] window_string command line string given\n\n\n Filters down the window_list to @matching_windows.\n\n @param [Boolean] current_workspace_only Should only the current workspace be used?\n\n @return [void]", "Begin position of code to replace.\n\n @return [Integer] begin position.", "End position of code to replace.\n\n @return [Integer] end position.", "The rewritten erb expr code.\n\n @return [String] rewritten code.", "This method is used to provide a means for checking if a page has been\n navigated to correctly as part of a context. This is useful because\n the context signature should remain highly readable, and checks for\n whether a given page has been reached would make the context definition\n look sloppy.", "Create a new Cache object.\n @param bits [Integer] Number of bits for the cache index. This parameter\n        heavilty affects the performance and memory consumption of the\n        cache.\n Add an PEROBS::Object to the read cache.\n @param obj [PEROBS::ObjectBase]", "Tell the cache to start a new transaction. If no other transaction is\n active, the write cache is flushed before the transaction is started.", "Tell the cache to end the currently active transaction. All write\n operations of the current transaction will be synced to the storage\n back-end.", "Tell the cache to abort the currently active transaction. All modified\n objects will be restored from the storage back-end to their state before\n the transaction started.", "Update seed object with this player's values", "Adds a node to the graph.\n\n @param [Abuelo::Node] node to add\n\n @return [Abuelo::Graph] the graph\n\n @raise [Abuelo::Exceptions::NodeAlreadyExistsError] if the node is\n   already contained in the graph", "Adds an edge to the graph.\n Auto-adds the symmetric counterpart if graph is undirected.\n\n @param [Abuelo::Edge] edge to add\n\n @return [Abuelo::Graph] the graph\n\n @raise [Abuelo::Exceptions::EdgeAlreadyExistsError] if the edge is\n   already contained in the graph", "Initialize an instance.\n\n @param rewriter [Synvert::Core::Rewriter]\n @param file_pattern [String] pattern to find files, e.g. spec/**/*_spec.rb\n @param options [Hash] instance options, it includes :sort_by.\n @param block [Block] block code to find nodes, match conditions and rewrite code.\n @return [Synvert::Core::Rewriter::Instance]\n Process the instance.\n It finds all files, for each file, it executes the block code, gets all rewrite actions,\n and rewrite source code back to original file.", "It changes source code from bottom to top, and it can change source code twice at the same time,\n So if there is an overlap between two actions, it removes the conflict actions and operate them in the next loop.", "It checks if code is removed and that line is empty.\n\n @param source [String] source code of file\n @param line [String] the line number", "Creates a new CCM object.\n\n @param cipher [String] one of the supported algorithms like 'AES'\n @param key [String] the key used for encryption and decryption\n @param mac_len [Number] the length of the mac.\n        needs to be in 4, 6, 8, 10, 12, 14, 16\n\n @return [Object] the new CCM object\n Encrypts the input data and appends mac for authentication.\n If there is additional data, its included into mac calculation.\n\n @param data [String] the data to encrypt\n @param nonce [String] the nonce used for encryption\n @param additional_data [String] additional data to\n        authenticate with mac (not part of the output)\n\n @return [String] the encrypted data with appended mac", "Returns a BINARY-encoded version of `string`, if is cannot be represented as 7bit ASCII.", "Ensures all values of the given `hash` are BINARY-encoded, if necessary.", "Test if hash node contains specified key.\n\n @param [Object] key value.\n @return [Boolean] true if specified key exists.\n @raise [Synvert::Core::MethodNotSupported] if calls on other node.", "Get hash value node according to specified key.\n\n @param [Object] key value.\n @return [Parser::AST::Node] value node.\n @raise [Synvert::Core::MethodNotSupported] if calls on other node.", "Return the exact value.\n\n @return [Object] exact value.\n @raise [Synvert::Core::MethodNotSupported] if calls on other node.", "Recursively iterate all child nodes of current node.\n\n @yield [child] Gives a child node.\n @yieldparam child [Parser::AST::Node] child node", "Match current node with rules.\n\n @param rules [Hash] rules to match.\n @return true if matches.", "Compare actual value with expected value.\n\n @param actual [Object] actual value.\n @param expected [Object] expected value.\n @return [Integer] -1, 0 or 1.\n @raise [Synvert::Core::MethodNotSupported] if expected class is not supported.", "Convert a hash to flat one.\n\n @example\n   flat_hash(type: 'block', caller: {type: 'send', receiver: 'RSpec'})\n     #=> {[:type] => 'block', [:caller, :type] => 'send', [:caller, :receiver] => 'RSpec'}\n @param h [Hash] original hash.\n @return flatten hash.", "Get actual value from the node.\n\n @param node [Parser::AST::Node]\n @param multi_keys [Array<Symbol>]\n @return [Object] actual value.", "Get expected value from rules.\n\n @param rules [Hash]\n @param multi_keys [Array<Symbol>]\n @return [Object] expected value.", "Set the given value at the given index.\n @param index [Integer] Position to insert at\n @param value [Integer] value to insert", "Insert the given value at the given index. All following values will be\n pushed to a higher index.\n @param index [Integer] Position to insert at\n @param value [Integer] value to insert", "Compute the array index of the value with the given index in the current\n node.\n @param idx [Integer] Index of the value in the current node\n @return [Integer] Array index of the value", "Move first element of successor to end of child node\n @param child_index [Integer] index of the child", "Move last element of predecessor node to child\n @param child_index [Integer] index of the child", "Insert a value that is associated with the given key. If a value for\n this key already exists, the value will be overwritten with the newly\n provided value.\n @param key [Integer or String]\n @param value [Any PEROBS storable object]", "Retrieve the value for the given key. If no value for the key is found\n nil is returned.\n @param key [Integer or String]\n @return [Any PEROBS storable object]", "Check if the is a value stored for the given key.\n @param key [Integer or String]\n @return [TrueClass or FalseClass]", "Delete and return the entry for the given key. Return nil if no matching\n entry exists.\n @param key [Integer or String]\n @return [Object] Deleted entry", "Check if the data structure contains any errors.\n @return [Boolean] true if no erros were found, false otherwise", "Sets or gets field in the hash.", "Manage the free spaces tree in the specified directory\n @param dir [String] directory path of an existing directory\n Open the SpaceTree file.", "Add a new space with a given address and size.\n @param address [Integer] Starting address of the space\n @param size [Integer] size of the space in bytes", "Get a space that has at least the requested size.\n @param size [Integer] Required size in bytes\n @return [Array] Touple with address and actual size of the space.", "Iterate over all entries and yield address and size.", "parse legalEntityInfos content.", "Create a new IDList object. The data that can't be kept in memory will\n be stored in the specified directory under the given name.\n @param dir [String] Path of the directory\n @param name [String] Name of the file\n @param max_in_memory [Integer] Specifies the maximum number of values\n        that will be kept in memory. If the list is larger, values will\n        be cached in the specified file.\n @param page_size [Integer] The number of values per page. The default\n        value is 32 which was found the best performing config in  tests.\n Insert a new value into the list.\n @param id [Integer] The value to add", "Perform some consistency checks on the internal data structures. Raises\n a RuntimeError in case a problem is found.", "Locate all PDF files within the ZIP", "Specifies a one-to-one association with another class. This method should only be used\n if the other class contains the foreign key. If the current class contains the foreign key,\n then you should use +t_belongs_to+ instead.\n\n The following methods for retrieval and query of a single associated object will be added:\n\n [association(force_reload = false)]\n   Returns the associated object. +nil+ is returned if none is found.\n [association=(associate)]\n   Assigns the associate object, extracts the primary key, sets it as the foreign key,\n   and saves the associate object.\n\n (+association+ is replaced with the symbol passed as the first argument, so\n <tt>t_has_one :manager</tt> would add among others <tt>manager.nil?</tt>.)\n\n === Example\n\n An Account class declares <tt>t_has_one :beneficiary</tt>, which will add:\n * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => \"account_id = #{id}\")</tt>)\n * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)\n\n === Supported options\n [:class_name]\n   Specify the class name of the association. Use it only if that name can't be inferred\n   from the association name. So <tt>t_has_one :manager</tt> will by default be linked to the Manager class, but\n   if the real class name is Person, you'll have to specify it with this option.\n [:foreign_key]\n   Specify the foreign key used for the association. By default this is guessed to be the name\n   of this class in lower-case and \"_id\" suffixed. So a Person class that makes a +t_has_one+ association\n   will use \"person_id\" as the default <tt>:foreign_key</tt>.\n [:dependent]\n   If set to <tt>:destroy</tt>, the associated object is deleted when this object is, and all delete\n   callbacks are called.  If set to <tt>:delete</tt>, the associated object is deleted *without*\n   calling any of its delete callbacks.  If set to <tt>:nullify</tt>, the associated object's\n   foreign key is set to +NULL+.\n [:readonly]\n   If true, the associated object is readonly through the association.\n [:autosave]\n   If true, always save the associated object or destroy it if marked for destruction, when saving the parent object. Off by default.\n [:as]\n   Specifies a polymorphic interface (See <tt>t_belongs_to</tt>).\n [:disable_foreign_key_constraints]\n   If true, bypass foreign key constraints, like verifying no other objects are storing the key of the source object\n   before deleting it.  Defaults to false.\n\n Option examples:\n   t_has_one :credit_card, :dependent => :destroy  # destroys the associated credit card\n   t_has_one :credit_card, :dependent => :nullify  # updates the associated records foreign key value to NULL rather than destroying it\n   t_has_one :project_manager, :class_name => \"Person\"\n   t_has_one :project_manager, :foreign_key => \"project_id\"  # within class named SecretProject\n   t_has_one :boss, :readonly => :true\n   t_has_one :attachment, :as => :attachable", "Specifies a one-to-one association with another class. This method should only be used\n if this class contains the foreign key. If the other class contains the foreign key,\n then you should use +t_has_one+ instead.\n\n Methods will be added for retrieval and query for a single associated object, for which\n this object holds an id:\n\n [association(force_reload = false)]\n   Returns the associated object. +nil+ is returned if none is found.\n [association=(associate)]\n   Assigns the associate object, extracts the primary key, and sets it as the foreign key.\n\n (+association+ is replaced with the symbol passed as the first argument, so\n <tt>t_belongs_to :author</tt> would add among others <tt>author.nil?</tt>.)\n\n === Example\n\n A Post class declares <tt>t_belongs_to :author</tt>, which will add:\n * <tt>Post#author</tt> (similar to <tt>Author.find(author_id)</tt>)\n * <tt>Post#author=(author)</tt> (similar to <tt>post.author_id = author.id</tt>)\n\n === Supported options\n [:class_name]\n   Specify the class name of the association. Use it only if that name can't be inferred\n   from the association name. So <tt>t_belongs_to :manager</tt> will by default be linked to the Manager class, but\n   if the real class name is Person, you'll have to specify it with this option.\n [:foreign_key]\n   Specify the foreign key used for the association. By default this is guessed to be the name\n   of the association with an \"_id\" suffix. So a class that defines a <tt>t_belongs_to :person</tt>\n   association will use \"person_id\" as the default <tt>:foreign_key</tt>. Similarly,\n   <tt>t_belongs_to :favorite_person, :class_name => \"Person\"</tt> will use a foreign key\n   of \"favorite_person_id\".\n [:dependent]\n   If set to <tt>:destroy</tt>, the associated object is deleted when this object is, calling all delete\n   callbacks.  If set to <tt>:delete</tt>, the associated object is deleted *without* calling any of\n   its delete callbacks.  This option should not be specified when <tt>t_belongs_to</tt> is used in\n   conjuction with a <tt>t_has_many</tt> relationship on another class because of the potential\n   to leave orphaned records behind.\n [:readonly]\n   If true, the associated object is readonly through the association.\n [:autosave]\n   If true, always save the associated object or destroy it if marked for destruction, when saving the parent object. Off by default.\n [:polymorphic]\n   Specify this association is a polymorphic association by passing +true+. (*Note*: IDs for polymorphic associations are always\n   stored as strings in the database.)\n [:disable_foreign_key_constraints]\n   If true, bypass foreign key constraints, like verifying the target object exists when the relationship is created.\n   Defaults to false.\n\n Option examples:\n   t_belongs_to :project_manager, :class_name => \"Person\"\n   t_belongs_to :valid_coupon, :class_name => \"Coupon\", :foreign_key => \"coupon_id\"\n   t_belongs_to :project, :readonly => true\n   t_belongs_to :attachable, :polymorphic => true", "Specifies a one-to-many association.\n\n The following methods for retrieval and query of collections of associated objects will be added:\n\n [collection(force_reload = false)]\n   Returns an array of all the associated objects.\n   An empty array is returned if none are found.\n [collection<<(object, ...)]\n   Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.\n [collection.push(object, ...)]\n   Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.\n [collection.concat(other_array)]\n   Adds the objects in the other array to the collection by setting their foreign keys to the collection's primary key.\n [collection.delete(object, ...)]\n   Removes one or more objects from the collection by setting their foreign keys to +NULL+.\n   Objects will be in addition deleted and callbacks called if they're associated with <tt>:dependent => :destroy</tt>,\n   and deleted and callbacks skipped if they're associated with <tt>:dependent => :delete_all</tt>.\n [collection.destroy_all]\n   Removes all objects from the collection, and deletes them from their respective\n   database. If the deleted objects have any delete callbacks defined, they will be called.\n [collection.delete_all]\n   Removes all objects from the collection, and deletes them from their respective\n   database. No delete callbacks will be called, regardless of whether or not they are defined.\n [collection=objects]\n   Replaces the collections content by setting it to the list of specified objects.\n [collection_singular_ids]\n   Returns an array of the associated objects' ids\n [collection_singular_ids=ids]\n   Replace the collection with the objects identified by the primary keys in +ids+.\n [collection.clear]\n   Removes every object from the collection. This deletes the associated objects and issues callbacks\n   if they are associated with <tt>:dependent => :destroy</tt>, deletes them directly from the\n   database without calling any callbacks if <tt>:dependent => :delete_all</tt>, otherwise sets their\n   foreign keys to +NULL+.\n [collection.empty?]\n   Returns +true+ if there are no associated objects.\n [collection.size]\n   Returns the number of associated objects.\n\n (*Note*: +collection+ is replaced with the symbol passed as the first argument, so\n <tt>t_has_many :clients</tt> would add among others <tt>clients.empty?</tt>.)\n\n === Example\n\n Example: A Firm class declares <tt>t_has_many :clients</tt>, which will add:\n * <tt>Firm#clients</tt> (similar to <tt>Clients.find :all, :conditions => [\"firm_id = ?\", id]</tt>)\n * <tt>Firm#clients<<</tt>\n * <tt>Firm#clients.delete</tt>\n * <tt>Firm#clients=</tt>\n * <tt>Firm#client_ids</tt>\n * <tt>Firm#client_ids=</tt>\n * <tt>Firm#clients.clear</tt>\n * <tt>Firm#clients.empty?</tt> (similar to <tt>firm.clients.size == 0</tt>)\n * <tt>Firm#clients.size</tt> (similar to <tt>Client.count \"firm_id = #{id}\"</tt>)\n\n === Supported options\n [:class_name]\n   Specify the class name of the association. Use it only if that name can't be inferred\n   from the association name. So <tt>t_has_many :products</tt> will by default be linked\n   to the Product class, but if the real class name is SpecialProduct, you'll have to\n   specify it with this option.\n [:foreign_key]\n   Specify the foreign key used for the association. By default this is guessed to be the name\n   of this class in lower-case and \"_id\" suffixed. So a Person class that makes a +t_has_many+\n   association will use \"person_id\" as the default <tt>:foreign_key</tt>.\n [:dependent]\n   If set to <tt>:destroy</tt> all the associated objects are deleted alongside this object\n   in addition to calling their delete callbacks.  If set to <tt>:delete_all</tt> all\n   associated objects are deleted *without* calling their delete callbacks.  If set to\n   <tt>:nullify</tt> all associated objects' foreign keys are set to +NULL+ *without* calling\n   their save backs.\n [:readonly]\n   If true, all the associated objects are readonly through the association.\n [:limit]\n   An integer determining the limit on the number of rows that should be returned. Results\n   are ordered by a string representation of the id.\n [:offset]\n   An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.\n   Results are ordered by a string representation of the id.\n [:autosave]\n   If true, always save any loaded members and destroy members marked for destruction, when saving the parent object. Off by default.\n [:as]\n   Specifies a polymorphic interface (See <tt>t_belongs_to</tt>).\n [:disable_foreign_key_constraints]\n   If true, bypass foreign key constraints, like verifying no other objects are storing the key of the source object\n   before deleting it.  Defaults to false.\n\n Option examples:\n   t_has_many :products, :class_name => \"SpecialProduct\"\n   t_has_many :engineers, :foreign_key => \"project_id\"  # within class named SecretProject\n   t_has_many :tasks, :dependent => :destroy\n   t_has_many :reports, :readonly => true\n   t_has_many :tags, :as => :taggable", "Returns all alias names of the object\n @return [Array<Symbol>] the alias names", "Register a game with this rating period\n\n @param [Array<#rating,#rating_deviation,#volatility>] game_seeds ratings participating in a game\n @param [Array<Integer>] ranks corresponding ranks", "Construct a Value object.\n\n @param val [String, Integer]\n   Either a String in the form \"1234/100\" or an integer containing the\n   raw value.\n @param div [Integer]\n   The divisor value to use (when +val+ is given as a Integer).\n Add to a Value object.\n\n @param other [Value, Numeric]\n\n @return [Value] Result of addition.", "Multiply a Value object.\n\n @param other [Numeric, Value] Multiplier.\n\n @return [Numeric] Result of multiplication.", "Adds a prebuilt schema table to the schema\n\n Schema tables may not be dupliates of already present tables in\n the schema.\n\n TODO: figure out how to deal with linked dimensions when adding\n facts.", "Defines a fact table named +name+ in this schema.\n\n @see Chicago::Schema::Builders::FactBuilder\n @return [Chicago::Schema::Fact] the defined fact.\n @raise Chicago::MissingDefinitionError", "Defines a dimension table named +name+ in this schema.\n\n For example:\n\n    @schema.define_dimension(:date) do\n      columns do\n        date   :date\n        year   :year\n        string :month\n        ...\n      end\n\n      natural_key :date\n      null_record :id => 1, :month => \"Unknown Month\"\n    end\n\n @see Chicago::Schema::Builders::DimensionBuilder\n @return [Chicago::Schema::Dimension] the defined dimension.", "Defines a shrunken dimension table named +name+ in this schema.\n\n +base_name+ is the name of the base dimension that the shrunken\n dimension is derived from; this base dimention must already be\n defined.\n\n @see Chicago::Schema::Builders::ShrunkenDimensionBuilder\n @raise [Chicago::MissingDefinitionError] if the base dimension is not defined.\n @return [Chicago::Schema::Dimension] the defined dimension.", "This is the method that is delegated to in order to make sure that\n elements are interacted with appropriately. This will in turn delegate\n to `set_and_select` and `check_and_uncheck`, which determines what\n actions are viable based on the type of element that is being dealt\n with. These aspects are what tie this particular implementation to\n Watir.", "def check_version\n=begin rdoc\n\n==== Bugzilla::Bugzilla#requires_version(cmd, version_)\n\nRaise an exception if the Bugzilla doesn't satisfy\nthe requirement of the _version_.\n\n=end", "Create a new IDListPageFile object that uses the given file in the given\n directory as cache file.\n @param list [IDList] The IDList object that caches pages here\n @param dir [String] An existing directory\n @param name [String] A file name (without path)\n @param max_in_memory [Integer] Maximum number of pages to keep in memory\n @param page_size [Integer] The number of values in each page\n Load the IDListPage from the cache file.\n @param page_idx [Integer] The page index in the page file\n @param record [IDListPageRecord] the corresponding IDListPageRecord\n @return [IDListPage] The loaded values", "Create a new IDListPage and register it.\n @param record [IDListPageRecord] The corresponding record.\n @param values [Array of Integer] The values stored in the page\n @return [IDListPage]", "Return the IDListPage object with the given index.\n @param record [IDListPageRecord] the corresponding IDListPageRecord\n @return [IDListPage] The page corresponding to the index.", "Save the given IDListPage into the cache file.\n @param p [IDListPage] page to store", "Send a request to CALLR webservice", "Create a new BTreeBlob object.\n @param dir [String] Fully qualified directory name\n @param btreedb [BTreeDB] Reference to the DB that owns this blob\n Write the given bytes with the given ID into the DB.\n @param id [Integer] ID\n @param raw [String] sequence of bytes", "Set a mark on the entry with the given ID.\n @param id [Integer] ID of the entry", "Check if the entry for a given ID is marked.\n @param id [Integer] ID of the entry\n @param ignore_errors [Boolean] If set to true no errors will be raised\n        for non-existing objects.\n @return [TrueClass or FalseClass] true if marked, false otherwise", "Remove all entries from the index that have not been marked.\n @return [Array] List of deleted object IDs.", "Run a basic consistency check.\n @param repair [TrueClass/FalseClass] Not used right now\n @return [TrueClass/FalseClass] Always true right now", "Write a string of bytes into the file at the given address.\n @param raw [String] bytes to write\n @param address [Integer] offset in the file\n @return [Integer] number of bytes written", "Read _bytes_ bytes from the file starting at offset _address_.\n @param entry [Array] Index entry for the object\n @return [String] Raw bytes of the blob.", "Reserve the bytes needed for the specified number of bytes with the\n given ID.\n @param id [Integer] ID of the entry\n @param bytes [Integer] number of bytes for this entry\n @return [Integer] the start address of the reserved blob", "Retrieve a object reference from the cache.\n @param uid [Integer] uid of the object to retrieve.\n @param ref [Object] optional reference to be used by the load method", "Remove a object from the cache.\n @param uid [Integer] unique ID of object to remove.", "Write all excess modified objects into the backing store. If now is true\n all modified objects will be written.\n @param now [Boolean]", "Recursively escape any control characters in `object`.", "Escapes in-place any control characters in `string`, before returning it.", "Find all the states along the path", "If an initial state is not explicitly specified, we choose the first leaf\n state", "Create a new BTree object.\n @param dir [String] Directory to store the tree file\n @param name [String] Base name of the BTree related files in 'dir'\n @param order [Integer] The maximum number of keys per node. This number\n        must be odd and larger than 2 and smaller than 2**16 - 1.\n @param progressmeter [ProgressMeter] reference to a ProgressMeter object\n Open the tree file.", "Check if the tree file contains any errors.\n @return [Boolean] true if no erros were found, false otherwise", "Find and remove the value associated with the given key. If no entry was\n found, return nil, otherwise the found value.", "Add an outcome against the rating", "Rate calculates Rating as at the start of the following period based on game outcomes", "configure each model in turn", "retrieves a given Class ie. a type of model\n @param [Class, String, Symbol, BaseModel] which class to get\n @return [Class] the Class (model) of interest", "This is responsible to return a hash with the contents of a YAML file", "page sidebar navigation", "same as `before` except it will run after matched tests.\n @note `after` hooks will run even on failed tests.\n       however it wont run if some exception arise inside test.", "Render and return your shell's prompt.\n\n You can define the prompt with <tt>MyShell.prompt_with</tt> and access it without rendering with <tt>MyShell.bombshell_prompt</tt>.\n @see ClassMethods#prompt_with\n @see ClassMethods#bombshell_prompt\n @return String", "Scans for vulnerabilities and reports them.", "Handler for when a client sends an IRC command", "Checks that the campfire authentication is successful.\n\n callback - a block to call if successful.\n\n Yields to the callback on success (async)\n\n If it fails, it replies with an error to the client and\n disconnects.", "Check to see that the nick as provided during the registration\n process matches the authenticated campfire user. If the nicks don't\n match, send a nick change to the connected client.", "to mark below private in controllers", "Converts the properties contained in this object into a\n string that can be saved directly as a Java properties\n file.", "for pages_list sidebar", "Tries to render the partial, if it doesn't exist, we will\n try to find the partial in the default views folder for this\n controller.\n\n Example:\n\n in app/views/users/index.html.erb\n <%= render_partial_or_default 'item', :collection => @items %>\n\n First it will try to reder 'app/views/users/_item.html.erb'. If\n this file doesn't exist, it will lookup _item.html.erb in the\n default views folder.", "Recusively converts found MmJsonClient objects to hashes.", "Store the given options into the file. Existing options with the same keys\n\u00a0will be overwritten.", "We want to modify the url to request multi-page articles all in one request", "Returns the given String or IO object wrapped in an object that has\n one method, read_one_char - that gets used by all the subsequent\n parsing steps", "Package the expressions, stack and buffer.\n We use a special flag to tell us whether we need multuple expressions.\n If we do, the expressions will be returned. If not, just the stack.\n Also, anything that remains on the stack will be put on the expressions\n list if multiple_expressions is true.", "If the passed buf contains any bytes, put them on the stack and\n empty the buffer", "Parse from a passed IO object either until an unescaped stop_char is reached\n or until the IO is exhausted. The last argument is the class used to\n compose the subexpression being parsed. The subparser is reentrant and not\n destructive for the object containing it.", "Parse a string literal, in single or double quotes.", "Get attributes for a given class\n\n @param klass [ClassKit] a class that has been extended with ClassKit\n\n @return [Hash]", "Get attribute for a given class and name\n\n @param klass [ClassKit] a class that has been extended with ClassKit\n @param name [Symbol] an attribute name\n\n @raise [ClassKit::Exceptions::AttributeNotFoundError] if the given attribute could not be found\n\n @return [Hash] that describes the attribute", "Recursively removes all constant entries of modules and classes under\n the MyGemName namespace", "This method is called to convert a ClassKit object into a Hash.", "This method is called to convert a ClassKit object into JSON.", "This method is called to convert JSON into a ClassKit object.", "This method tries to identify the route contained at self.path to extract\n the destination's controller, action and other arguments and save them\n into the corresponding controller, action and defaults fields of the\n including objects.", "Returns a collection of Corpora\n Returns a collection of Corpora\n @param project_id ID of the Project\n @param [Hash] opts the optional parameters\n @return [CorporaCollection]", "Returns the Corpus\n Returns the Corpus\n @param project_id ID of the Project\n @param name Corpus name\n @param [Hash] opts the optional parameters\n @return [Corpus]", "Creates a new Corpus\n Creates a new Corpus\n @param project_id ID of the Project\n @param name Corpus name\n @param body\n @param [Hash] opts the optional parameters\n @return [nil]", "Creates a new Project\n Creates a new Project\n @param project\n @param [Hash] opts the optional parameters\n @return [Project]", "Returns the Job\n Returns the Job\n @param project_id ID of the Project\n @param job_id\n @param [Hash] opts the optional parameters\n @return [Job]", "Returns the Job Result\n Returns the Job Result\n @param project_id ID of the Project\n @param job_id\n @param [Hash] opts the optional parameters\n @return [JobResult]", "Returns a collection of Jobs\n Returns a collection of Jobs\n @param project_id ID of the Project\n @param [Hash] opts the optional parameters\n @option opts [Integer] :page page number\n @option opts [Integer] :per_page number of records per page\n @return [JobsCollection]", "Returns the Project\n Returns the Project\n @param project_id ID of the Project\n @param [Hash] opts the optional parameters\n @return [Project]", "Updates an existing Project\n Updates an existing Project\n @param project\n @param [Hash] opts the optional parameters\n @return [Project]", "Creates an upload session\n\n @param project_id ID of the Project\n @param video_upload_body\n @param [Hash] opts the optional parameters\n @return [UploadSession]", "Allow user defined fields to sort on in addition to introspected fields", "Create a NRead object to parse a nifti file or binary string and set header and image info instance variables.\n\n The nifti header will be checked for validity (header size and magic number) and will raise an IOError if invalid.\n\n NIFTI header extensions are not yet supported and are not included in the header.\n\n The header and image are accessible via the hdr and image instance variables.  An optional narray matrix may also be available in image_narray if desired by passing in :narray => true as an option.\n\n === Parameters\n\n * <tt>source</tt> -- A string which specifies either the path of a NIFTI file to be loaded, or a binary NIFTI string to be parsed.\n * <tt>options</tt> -- A hash of parameters.\n\n === Options\n\n * <tt>:bin</tt> -- Boolean. If set to true, string parameter will be interpreted as a binary NIFTI string, and not a path string, which is the default behaviour.\n * <tt>:image</tt> -- Boolean. If set to true, automatically load the image into @image, otherwise only a header is collected and you can get an image\n * <tt>:narray</tt> -- Boolean.  If set to true, a properly shaped narray matrix will be set in the instance variable @image_narray.  Automatically sets :image => true\n\n Unpack an image array from vox_offset to the end of a nifti file.\n\n === Parameters\n\n There are no parameters - this reads from the binary string in the @string instance variable.\n\n This sets @image_rubyarray to the image data vector and also returns it.", "Create an narray if the NArray is available\n Tests if a file is readable, and if so, opens it.\n\n === Parameters\n\n * <tt>image_array</tt> -- Array. A vector of image data.\n * <tt>dim</tt> -- Array. The dim array from the nifti header, specifing number of dimensions (dim[0]) and dimension length of other dimensions to reshape narray into.", "Parse the NIFTI Header.", "Read the nifti header according to its byte signature.\n The file stream will be left open and should be positioned at the end of the 348 byte header.", "Read any extended header information.\n The file stream will be left at imaging data itself, taking vox_offset into account for NIFTI Header Extended Attributes.\n Pass in the voxel offset so the extended header knows when to stop reading.", "Tests if a file is readable, and if so, opens it.\n\n === Parameters\n\n * <tt>file</tt> -- A path/file string.", "css class names for javascript-based validation", "Creates an NWrite instance.\n\n === Parameters\n\n * <tt>obj</tt> -- A NObject instance which will be used to encode a NIfTI string.\n * <tt>file_name</tt> -- A string, either specifying the path of a DICOM file to be loaded, or a binary DICOM string to be parsed.\n * <tt>options</tt> -- A hash of parameters.\n\n === Options\n\n Handles the encoding of NIfTI information to string as well as writing it to file.", "Write Basic Header", "Write Extended Header", "Power on VApp or VM", "Power off VApp or VM", "Cancels an Encoding.\n\n @param id Id of an Encoding.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [CanceledResponse]", "Copies a given Profile\n\n @param id Id of a Profile.\n @param factory_id Id of a Factory.\n @param copy_profile_body\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :expand If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.\n @return [Profile]", "Creates an Encoding\n\n @param factory_id Id of a Factory.\n @param create_encoding_body\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :screenshots Determines whether the response will include screenshots. By default this is not set.\n @option opts [BOOLEAN] :precise_status Determines whether the response will include a precise status. By default this is not set.\n @return [Encoding]", "Creates a new factory\n\n @param create_factory_body\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :with_storage_provider if set to &#x60;true&#x60;, results will include a storage provider&#39;s id\n @return [Factory]", "Creates a Profile\n\n @param factory_id Id of a Factory.\n @param create_profile_body\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :exclude_advanced_services\n @option opts [BOOLEAN] :expand If expand option is set Profile objects will contain all command parameters, even if their value is default. By default it is not set.\n @return [Profile]", "Creates a Video from a provided source_url.\n\n @param factory_id Id of a Factory.\n @param create_video_body\n @param [Hash] opts the optional parameters\n @return [Video]", "Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.\n\n @param id Id of an Encoding.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [DeletedResponse]", "Deletes a given Profile\n\n @param id Id of a Profile\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [DeletedResponse]", "Deletes a Video object.\n\n @param id Id of a Video.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [DeletedResponse]", "Delete a video's source file.\n\n @param id Id of a Video.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [DeletedResponse]", "Returns an Encoding object.\n\n @param id Id of an Encoding.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :screenshots Determines whether the response will include screenshots. By default this is not set.\n @option opts [BOOLEAN] :precise_status Determines whether the response will include a precise status. By default this is not set.\n @return [Encoding]", "Returns a list of Encoding objects\n\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @option opts [String] :video_id Id of a Video. When specified, the resulting list will contain videos that belong to the Video.\n @option opts [String] :status One of &#x60;success&#x60;, &#x60;fail&#x60;, &#x60;processing&#x60;. When specified, the resulting list will contain ecodings filtered by status.\n @option opts [String] :profile_id Filter by profile_id.\n @option opts [String] :profile_name Filter by profile_name.\n @option opts [Integer] :page A page to be fetched. Default is &#x60;1&#x60;.\n @option opts [Integer] :per_page A number of results per page. Default is &#x60;100&#x60;.\n @option opts [BOOLEAN] :screenshots Determines whether the response will include screenshots. By default this is not set.\n @option opts [BOOLEAN] :precise_status Determines whether the response will include a precise status. By default this is not set.\n @return [PaginatedEncodingsCollection]", "Returns a number of Encoding objects created using a given factory.\n\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [CountResponse]", "Returns a Factory object.\n Returns a Factory object.\n @param id id of a factory\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :with_storage_provider if set to &#x60;true&#x60;, results will include a storage provider&#39;s id\n @return [Factory]", "Returns a Factory's notification settings.\n\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [CloudNotificationSettings]", "Returns a Profile object.\n\n @param id_or_name A name or an id of a Profile.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :expand If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.\n @return [Profile]", "Returns a list of Encodings that belong to a Profile.\n\n @param id_or_name Id or name of a Profile.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [PaginatedEncodingsCollection]", "Returns a collection of Profile objects.\n\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :exclude_advanced_services Determine whether exclude Advanced Services profiles from the results. By default this is not set.\n @option opts [BOOLEAN] :expand If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.\n @option opts [Integer] :page A page to be fetched. Default is &#x60;1&#x60;.\n @option opts [Integer] :per_page A number of results per page. Default is &#x60;100&#x60;.\n @return [PaginatedProfilesCollection]", "Returns a collection of Video objects queued for encoding.\n\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :page A page to be fetched. Default is &#x60;1&#x60;.\n @option opts [Integer] :per_page A number of results per page. Default is &#x60;100&#x60;.\n @return [PaginatedVideoCollection]", "Retries a failed encoding.\n\n @param id Id of an Encoding.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [RetriedResponse]", "Returns a signed url pointing to an Encoding.\n\n @param id Id of an Encoding.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [EncodingSignedUrl]", "Returns a list of signed urls pointing to an Encoding's outputs.\n\n @param id Id of an Encoding.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [EncodingSignedUrls]", "Returns a signed url pointing to a Video.\n\n @param id Id of a Video.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [SignedVideoUrl]", "Toggles synchronisation settings.\n\n @param id id of the factory\n @param factory_sync_body\n @param [Hash] opts the optional parameters\n @return [FactorySync]", "Updates an Encoding\n\n @param id Id of an Encoding.\n @param factory_id Id of a Factory.\n @param update_encoding_body\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :screenshots Determines whether the response will include screenshots. By default this is not set.\n @option opts [BOOLEAN] :precise_status Determines whether the response will include a precise status. By default this is not set.\n @return [Encoding]", "Updates a Factory's settings. Returns a Factory object.\n\n @param id id of the factory\n @param update_factory_body\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :with_storage_provider if set to &#x60;true&#x60;, results will include a storage provider&#39;s id\n @return [Factory]", "Updates a Factory's notification settings.\n\n @param factory_id Id of a Factory.\n @param cloud_notification_settings_body\n @param [Hash] opts the optional parameters\n @return [CloudNotificationSettings]", "Updates a given Profile\n\n @param id\n @param factory_id Id of a Factory.\n @param update_profile_body\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :exclude_advanced_services\n @option opts [BOOLEAN] :expand If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.\n @return [Profile]", "Creates an upload session.\n\n @param factory_id Id of a Factory.\n @param video_upload_body\n @param [Hash] opts the optional parameters\n @return [UploadSession]", "Returns a list of Encodings that belong to a Video.\n\n @param id Id of a Video.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :page A page to be fetched. Default is &#x60;1&#x60;.\n @option opts [Integer] :per_page A number of results per page. Default is &#x60;100&#x60;.\n @option opts [BOOLEAN] :screenshots Determines whether the response will include screenshots. By default this is not set.\n @option opts [BOOLEAN] :precise_status Determines whether the response will include a precise status. By default this is not set.\n @return [PaginatedEncodingsCollection]", "Returns a Video's metadata\n\n @param id Id of a Video.\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @return [VideoMetadata]", "Returns a collection of Video objects.\n\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :page A page to be fetched. Default is &#x60;1&#x60;.\n @option opts [Integer] :per_page A number of results per page. Default is &#x60;100&#x60;.\n @return [PaginatedVideoCollection]", "Returns a collection of Workflows that belong to a Factory.\n\n @param factory_id Id of a Factory.\n @param [Hash] opts the optional parameters\n @option opts [Integer] :page A page to be fetched. Default is &#x60;1&#x60;.\n @option opts [Integer] :per_page A number of results per page. Default is &#x60;100&#x60;.\n @return [PaginatedWorkflowsCollection]", "To use the functionality of liquid-rails", "Write changes to the file", "Append in the thresholds.conf file to current collection", "Check if all objects in the Threshold Instance report .valid?", "Uniques by default to printable output\n Returns a new Threshold Object", "Returns a new Threshold Object with just suppressions", "Returns a new Threshold Object with just event_filters", "Returns a new Threshold Object with just rate_filters", "Hash -> Integer", "Passes the NObject to the DWrite class, which writes out the header and image to the specified file.\n\n === Parameters\n\n * <tt>file_name</tt> -- A string which identifies the path & name of the NIfTI file which is to be written to disk.\n * <tt>options</tt> -- A hash of parameters.\n\n === Options\n\n === Examples\n\n   obj.write(path + \"test.dcm\")", "Returns a NIFTI object by reading and parsing the specified file.\n This is accomplished by initializing the NRead class, which loads NIFTI information.\n\n === Notes\n\n This method is called automatically when initializing the NObject class with a file parameter,\n and in practice should not be called by users.", "Pages get duplicated\n Question elements get associated\n non-question elements get cloned", "Unifies the receiver with another value.\n\n First dereferences both the receiver and the other. If both dereferenced\n values are variables, unifies them with the other being bound to the\n receiver. If one of them is a variable, it gets bound to the other value.\n If none of them is a variable, they are checked for equality with eql?.\n Succeeds if other is the same object as the receiver.", "send email invite", "Generates an integer representation for this UUID.", "=begin rdoc\nOAuth2 +authorize_url+\n\nredirect or open this URL for login in Baidu website\n\n=== Params:\n\n* +opts+ Hash\n  * +redirect_uri+ String - default Baidu::DEFAULT_REDIRECT_URI,URL with logined redirect back\n\n=== Rails example:\n\n  class SessionController\n    def oauth\n      redirect_to $baidu.authorize_url(redirect_uri: callback_session_url)\n    end\n\n    def callback\n      auth_code = params[:code]\n      $baidu.token!(auth_code)\n    end\n  end\n=end", "=begin rdoc\nOAuth get_token method\n\nThis method will get #access_token (OAuth2::AccessToken) ... and save in Baidu instance\n\n== Params:\n\n* authorization_code - Authorization Code in callback URL\n* opts\n  * +redirect_uri+ String - default Baidu::DEFAULT_REDIRECT_URI,URL with logined redirect back\n=end", "=begin rdoc\nOAuth refresh_token method\n\nRefresh tokens when token was expired\n\n== Params:\n\n* refresh_token - refresh_token in last got #access_token\n=end", "stubbing given method and keeps original visibility\n\n if a block given, it will receive original method as first argument\n and any passed parameters as rest arguments.\n\n @example make Some::Remote::API.call to return success\n   stub(Some::Remote::API, :call) { :success }\n\n @example call original\n   stub(obj, :a) {|orig| orig.call}\n\n @param object object to define stub on\n @param stub  method to be stubbed.\n     if a Hash given, keys will be stubbed methods and values return values\n @param [Proc] &proc  block to be yielded when stub called\n @return MiniSpec::Mocks::Stub instance", "same as `stub` except it defines multiple stubs at once\n\n @param object\n @param *stubs\n @param &proc\n @return MiniSpec::Mocks::MultipleStubsProxy instance", "Nova instancia da classe Card\n @param [Hash] campos\n Montar o Hash de dados do pagamento no padr\u00e3o utilizado pela Getnet", "Public callback once a server connection is established.\n\n Initializes an IRCD instance for this connection.", "Generate an IPv6 Unique Local Address using the supplied system MAC address.\n Note that the MAC address is just used as a source of randomness, so where you\n get it from is not important and doesn't restrict this ULA to just that system.\n See RFC4193", "load panel all AJAX-like\n GET", "Returns a pointer to the object_id of +obj+", "determines method's visibility\n\n @param object\n @param method\n @return [Symbol] or nil", "checks whether given label matches any matcher.\n even if label matched, it will return `false` if label matches some rejector.\n\n @param label\n @param matchers  an `Array` of matchers and rejectors.\n   matchers contained as hashes, rejectors as arrays.\n @return `true` or `false`", "checks whether given label matches any rejector.\n\n @param label\n @param reject  an `Array` of rejectors, each being a `Hash` containing `:except` key\n @return `true` or `false`", "compare given label to given expression.\n if expression is a `Regexp` comparing using `=~`.\n otherwise `==` are used\n\n @param label\n @param x\n @return `true` or `false`", "Returns the URI with the signature appended to the query string\n\n return [String]", "Simple pluralization proxy\n\n Usage:\n   Polish.pluralize(1, \"dom\", \"domy\", \"dom\u00f3w\")", "set answers from posted response", "save this question's @answers to database", "has any sort of non-empty response?", "Adds a character to the set.\n\n @param [String, Integer] other\n   The character(s) or byte to add.\n\n @return [CharSet]\n   The modified character set.\n\n @raise [TypeError]\n   The argument was not a {String} or {Integer}.\n\n @since 0.2.1", "Determines if a character is contained within the character set.\n\n @param [String] char\n   The character to search for.\n\n @return [Boolean]\n   Specifies whether the character is contained within the\n   character set.", "Pass random characters to a given block.\n\n @param [Integer] n\n   Specifies how many times to pass a random character to the block.\n\n @yield [char]\n   The block will receive the random characters.\n\n @yieldparam [String] char\n   The random character from the character set.\n\n @return [Enumerator]\n   If no block is given, an enumerator object will be returned.", "Creates an Array of random bytes from the character set.\n\n @param [Integer, Array, Range] length\n   The length of the Array of random bytes.\n\n @return [Array<Integer>]\n   The randomly selected bytes.", "Creates an Array of random non-repeating bytes from the character set.\n\n @param [Integer, Array, Range] length\n   The length of the Array of random non-repeating bytes.\n\n @return [Array<Integer>]\n   The randomly selected non-repeating bytes.", "Finds sub-strings within given data that are made of characters within\n the character set.\n\n @param [String] data\n   The data to find sub-strings within.\n\n @param [Hash] options\n   Additional options.\n\n @option options [Integer] :length (4)\n   The minimum length of sub-strings found within the given data.\n\n @option options [Boolean] :offsets (false)\n   Specifies whether to return a Hash of offsets and matched\n   sub-strings within the data, or to just return the matched\n   sub-strings themselves.\n\n @yield [match,(index)]\n   The given block will be passed every matched sub-string, and the\n   optional index.\n\n @yield [String] match\n   A sub-string containing the characters from the character set.\n\n @yield [Integer] index\n   The index the sub-string was found at.\n\n @return [Array, Hash]\n   If no block is given, an Array or Hash of sub-strings is returned.", "requires that your model has the column has_offer_id\n requires that you implement the method has_offers_params within your model", "For a grouped AVP, returns all AVPs it contains with this name.\n\n @param [String] name The AVP name\n @return [Array<AVP>]", "Sets this AVP's byte data to an Address.\n\n @param [IPAddr] value\n @return [void]", "creates a double object.\n if one or more arguments given, first argument will be used as name, unless it is a Hash.\n arguments that goes after first one are treated as stubs.\n\n @example create a double that will respond to `color` and reported as :apple\n   apple = double(:apple, :color) { 'Red' }\n   apple.color # => Red\n\n @example injecting a double into a real battle and expecting it to receive some messages\n   user = double(:user, :name, :address)\n   expect(user).to_receive(:name, :address)\n   Shipping.new.get_address_for(user)\n\n @example spy on a double\n   user = double(:user, :name, :address)\n   Shipping.new.get_address_for(user)\n   assert(user).received(:name, :address)", "valid_ofx = false removes the namespaces", "helper methods below", "Defines a new task, using the name +name+.", "split_ints and merge_ints converts between string and integer array,\n where the integer is right-padded until it fits a 256 bit integer.", "Inherit from other Order", "copy an item and all it's children", "decode html entity", "call Notifier.deliver_notification", "Find catalog item from catalog by name and type.\n If item_type is set to nil, returns catalog item as long as its name match.\n Raises an exception if catalog is not found.\n Raises ObjectNotFoundError if an item matching the name and type is not found.\n Otherwise, returns the catalog item.", "Retornar a url conforme o ambiente", "Create a new RequestSignature instance\n\n @param http_method [String] The HTTP method from the request (GET, POST, PUT, or DELETE)\n @param base_uri [String] The base URI of the request. This is everything except the query string params\n @param query_params [Hash] A hash of the provided query string params\n\n It's required that you provide at least the http_method and base_uri. Params are optional\n\n @return [void]\n Returns the full signature string\n\n @return [String]", "Creates a new QueryHashParser instance\n\n @param query_hash [Hash] A hash of key/values to turn into a query stringo\n\n @return [void]\n Returns the hash (key/values) as an ordered query string. This joins the keys and values, and then\n joins it all with the ampersand. This is not escaped\n\n @return [String]", "Traverse into sexp by type and child position", "define custom assertion helpers.\n\n @note  helpers can be overridden by name,\n that's it, if some spec inherits `:a_duck?` helper\n you can use `helper(:a_duck?) { ... }` to override it.\n\n @note  tested object are passed to helper via first argument.\n   any arguments passed to helper are sent after tested object.\n\n @note  if a block used on left side,\n   it will be passed as last argument and the helper is responsible to call it.\n   please note that block will be passed as usual argument rather than a block.\n\n @note  if you need the current context to be passed into helper\n   use `:with_context` option. when doing so,\n   the context will come as last argument.\n\n @example\n\n   describe SomeTest do\n\n     helper :a_pizza? do |food|\n       does(food) =~  /cheese/\n       does(food) =~ /olives/\n     end\n\n     testing :foods do\n       food = Cook.some_food(with: 'cheese', and: 'olives')\n       is(food).a_pizza? #=> passed\n\n       food = Cook.some_food(with: 'potatoes')\n       is(food).a_pizza? #=> failed\n     end\n   end\n\n @example any other arguments are sent after tested object\n\n   describe SomeTest do\n\n     helper :a_pizza? do |food, ingredients|\n       does(food) =~ /dough/\n       does(ingredients).include? 'cheese'\n       does(ingredients).include? 'olives'\n     end\n\n     testing :foods do\n       ingredients = ['cheese', 'olives']\n       food = Cook.some_food(ingredients)\n       is(food).a_pizza? ingredients\n     end\n   end\n\n @example  given block passed as last argument\n\n    # block comes as a usual argument rather than a block\n    helper :is_invalid do |attr, block|\n      e = assert(&block).raise(FormulaValidationError)\n      assert(e.attr) == attr\n    end\n\n    test 'validates name' do\n      assert(:name).is_invalid do\n        formula \"name with spaces\" do\n          url \"foo\"\n          version \"1.0\"\n        end\n      end\n    end\n\n @example  using `with_context` option to get context as last argument\n\n   describe SomeTest do\n\n     helper :a_pizza?, with_context: true do |subject, ingredients, context|\n       # context is a Hash containing :left_method, left_object, :left_proc and :negation keys\n     end\n\n     testing :foods do\n       is(:smth).a_pizza? ['some', 'ingredients']\n       # helper's context will look like:\n       # {left_method: :is, left_object: :smth, left_proc: nil, negation: nil}\n\n       is { smth }.a_pizza? ['some', 'ingredients']\n       # helper's context will look like:\n       # {left_method: :is, left_object: nil, left_proc: 'the -> { smth } proc', negation: nil}\n     end\n   end", "checks whether given block throws a symbol\n and if yes compare it with expected one.\n if a optional value given it will be compared to thrown one.\n\n @param expected_symbol\n @param expected_value\n @param [Proc] &proc\n @return a failure [ThrowError] if expectation not met.\n         true if expectations met.", "calling given block and catching thrown symbol, if any.\n\n @param expected_symbol\n @param [Proc] &block", "extract thrown symbol from given exception\n\n @param exception", "Find a record by rowname and return the fields. Empty fields are nils.", "Initialize fiber's pool\n Borrow fiber from the pool and call the block inside", "There is entrypoint running fibers", "Return the fiber into the pool", "Creates a JavaScript anonymous function from a Ruby block", "Adds all of a module's public instance methods as Less functions", "append node to document", "Nova instancia da classe Cliente\n @param [Hash] campos\n Montar o Hash de dados do usuario no padr\u00e3o utilizado pela Getnet", "diffs +path+ with another revision. if no revision is specified, the\n previous revision is used.", "def update_captcha\n   return if @ignore_captcha\n   pp iden_json = json(:post, \"/api/new_captcha\")\n   iden = iden_json[\"json\"][\"data\"][\"iden\"]\n   # return @iden_and_captcha = [iden, \"\\n\"] if @ignore_captcha\n   # pp resp_with_token(:get, \"/captcha/#{iden_json[\"json\"][\"data\"][\"iden\"]}\", {})\n   puts \"CAPTCHA: https://reddit.com/captcha/#{iden}\"\n   @iden_and_captcha = [iden, gets.strip]\n end", "Get a list of supported languages and cache it.", "Nova instancia da classe Boleto\n @param [Hash] campos\n Montar o Hash de dados do pagamento no padr\u00e3o utilizado pela Getnet", "Returns all AVPs with the given name. Only covers \"top-level\"\n AVPs - it won't look inside Grouped AVPs.\n\n @param name [String] The AVP name, either one predefined in\n   {Constants::AVAILABLE_AVPS} or user-defined with {AVP.define}\n\n @return [Array<AVP>]", "Handle any string encoding", "request the page from the server and return the raw contents", "The title method returns the title of the web page.\n\n It does the basic extraction using the TITLE_RE regular\n expression and handles text encoding.  More advanced parsing can\n be done by overriding the title_processor method.", "The content method returns the important body text of the web page.\n\n It does basic extraction and pre-processing of the page content\n and then calls the content_processor method for any other more\n custom processing work that needs doing.  Lastly, it does some\n basic post processing and returns the content as a string.\n\n When writing a new parser, the CONTENT_RE constant should be\n defined in the subclass.  The KILL_CHARS_RE constant can be\n overridden if necessary.", "Creates an NImage instance.\n\n The NImages instance provides a user friendly interface to the NIFTI Image\n A NImage is typically built by NObject instance\n\n === Parameters\n\n * <tt>array_image</tt> -- The NIFTI image contained on and one dimensional array\n * <tt>dim</tt> -- The dimensions array from the NIFTI header.\n\n === Examples\n\n   # Creates an NImage to deal with an 9 position array that represents a 3x3 matrix\n   img = Nimage.new(Array.new(9,0.0), [2,3,3])\n\n Retrieves an element or partition of the dataset\n\n === Parameters\n\n * <tt>index</tt> -- The desired index on the dataset\n\n === Options\n\n === Examples\n\n   img[0][0]\n   img[0][0..1]", "Set the value for an element of the dataset\n\n === Parameters\n\n * <tt>index</tt> -- The desired index on the dataset\n * <tt>value</tt> -- The value that the will be set\n\n === Options\n\n === Examples\n\n   img[0][0] = 1.0", "associate answers from database with a set of elements\n update with responses from form", "convert posted response to a question into Array of values", "the mock is basically a stub with difference it will also add a expectation.\n that's it, a mock will stub a method on a object and\n will expect that stub to be called before test finished.\n\n the `mock` method will return the actual stub\n so you can build chained constraints on it.\n\n @note  if mocked method exists it's visibility will be kept\n\n @example  make `some_object` to respond to `:some_method`\n           and expect `:some_method` to be called before current test finished.\n           also make `:some_method` to behave differently depending on given arguments.\n           so if called with [:a, :b] arguments it will return 'called with a, b'.\n           called with [:x, :y] arguments it will return 'called with x, y'.\n           called with any other arguments or without arguments at all it returns 'whatever'.\n\n   mock(some_object, :some_method).\n     with(:a, :b) { 'called with a, b' }.\n     with(:x, :y) { 'called with x, y' }.\n     with_any { 'whatever' }", "overriding given method of given object with a proxy\n so MiniSpec can later check whether given method was called.\n\n if given method does not exists a NoMethodError raised\n\n @note  doubles and stubs will be skipped as they are already proxified\n\n @example\n   proxy(obj, :a)\n   assert(obj).received(:a)  # checking whether obj received :a message\n\n @param object\n @param method_name", "list existing answer sheets", "Create a new job\n\n @param project_id A unique identifier of a Project.\n @param data\n @param [Hash] opts the optional parameters\n @return [Job]", "Get QC job\n\n @param project_id A unique identifier of a Project.\n @param job_id A unique identifier of a Job.\n @param [Hash] opts the optional parameters\n @return [Job]", "Get project by Id\n\n @param project_id A unique identifier of a Project.\n @param [Hash] opts the optional parameters\n @return [Project]", "Get jobs form projects\n\n @param project_id A unique identifier of a Project.\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :expand Expand details of job\n @option opts [String] :status Filter jobs by status\n @option opts [Integer] :per_page Limit number of listed jobs (default to 30)\n @option opts [Integer] :page Index of jobs page to be listed\n @return [JobsCollection]", "Some people liked this; personally I've decided against using it but I'll keep it nonetheless", "reads the stream contents into a String object", "reads the stream contents into a StringIO object", "Creates a Stream instance.\n\n === Parameters\n\n * <tt>binary</tt> -- A binary string.\n * <tt>string_endian</tt> -- Boolean. The endianness of the instance string (true for big endian, false for small endian).\n * <tt>options</tt> -- A hash of parameters.\n\n === Options\n\n * <tt>:index</tt> -- Fixnum. A position (offset) in the instance string where reading will start.\n\n Decodes a section of the instance string and returns the formatted data.\n The instance index is offset in accordance with the length read.\n\n === Notes\n\n * If multiple numbers are decoded, these are returned in an array.\n\n === Parameters\n\n * <tt>length</tt> -- Fixnum. The string length which will be decoded.\n * <tt>type</tt> -- String. The type (vr) of data to decode.", "Encodes a value and returns the resulting binary string.\n\n === Parameters\n\n * <tt>value</tt> -- A custom value (String, Fixnum, etc..) or an array of numbers.\n * <tt>type</tt> -- String. The type (vr) of data to encode.", "Take a line as a string and return it as a tuple of rowname and datafields", "Read the next n characters from the string with escape sequence\n processing.", "Given a Unicode code point, return a string giving its UTF-8\n representation based on RFC 2279.", "Reads the next group of characters that match a regular\n expresion.", "Reads the next value from the string.  This can return either a\n string, a FixNum, a floating point value, a JSON array, or a\n JSON object.", "Provide completion for a given fragment.\n @param [String] fragment the fragment to complete for", "Create a new instance of the OpenStack hypervisor object\n@param [<Host>] openstack_hosts The array of OpenStack hosts to provision\n@param [Hash{Symbol=>String}] options The options hash containing configuration values\n@option options [String] :openstack_api_key The key to access the OpenStack instance with (required)\n@option options [String] :openstack_username The username to access the OpenStack instance with (required)\n@option options [String] :openstack_auth_url The URL to access the OpenStack instance with (required)\n@option options [String] :openstack_tenant The tenant to access the OpenStack instance with (required)\n@option options [String] :openstack_region The region that each OpenStack instance should be provisioned on (optional)\n@option options [String] :openstack_network The network that each OpenStack instance should be contacted through (required)\n@option options [String] :openstack_keyname The name of an existing key pair that should be auto-loaded onto each\n@option options [Hash] :security_group An array of security groups to associate with the instance\n                                            OpenStack instance (optional)\n@option options [String] :jenkins_build_url Added as metadata to each OpenStack instance\n@option options [String] :department Added as metadata to each OpenStack instance\n@option options [String] :project Added as metadata to each OpenStack instance\n@option options [Integer] :timeout The amount of time to attempt execution before quiting and exiting with failure\nProvided a flavor name return the OpenStack id for that flavor\n@param [String] f The flavor name\n@return [String] Openstack id for provided flavor name", "Provided an image name return the OpenStack id for that image\n@param [String] i The image name\n@return [String] Openstack id for provided image name", "Provided a network name return the OpenStack id for that network\n@param [String] n The network name\n@return [String] Openstack id for provided network name", "Provided an array of security groups return that array if all\nsecurity groups are present\n@param [Array] sgs The array of security group names\n@return [Array] The array of security group names", "Create and attach dynamic volumes\n\n Creates an array of volumes and attaches them to the current host.\n The host bus type is determined by the image type, so by default\n devices appear as /dev/vdb, /dev/vdc etc.  Setting the glance\n properties hw_disk_bus=scsi, hw_scsi_model=virtio-scsi will present\n them as /dev/sdb, /dev/sdc (or 2:0:0:1, 2:0:0:2 in SCSI addresses)\n\n @param host [Hash] thet current host defined in the nodeset\n @param vm [Fog::Compute::OpenStack::Server] the server to attach to", "Detach and delete guest volumes\n @param vm [Fog::Compute::OpenStack::Server] the server to detach from", "Get a floating IP address to associate with the instance, try\n to allocate a new one from the specified pool if none are available", "Create new instances in OpenStack", "Destroy any OpenStack instances", "Get key_name from options or generate a new rsa key and add it to\nOpenStack keypairs\n\n@param [Host] host The OpenStack host to provision\n@api private", "Returns one or more posts on a single day matching the arguments.\n If no date or url is given, date of most recent bookmark will be used.\n\n @option params [String] :tag filter by up to three tags\n @option params [Time] :dt return results bookmarked on this day\n @option params [String] :url return bookmark for this URL\n @option params [Boolean] :meta include a change detection signature in a meta attribute\n @return [Array<Post>] the list of bookmarks", "Returns a list of popular tags and recommended tags for a given URL.\n Popular tags are tags used site-wide for the url; recommended tags\n are drawn from the user's own tags.\n\n @param [String] url\n @return [Hash<String, Array>]", "Returns a list of the user's most recent posts, filtered by tag.\n\n @param <Hash> params the options to filter current posts\n @option params [String] :tag filter by up to three tags\n @option params [String] :count Number of results to return.\n                                Default is 15, max is 100\n\n @return [Array<Post>] the list of recent posts", "Returns a list of dates with the number of posts at each date\n\n @param [String] tag Filter by up to three tags\n\n @return [Hash<String,Fixnum>] List of dates with number of posts\n                               at each date", "Returns a full list of the user's tags along with the number of\n times they were used.\n\n @return [Array<Tag>] List of all tags", "Rename an tag or fold it into an existing tag\n\n @param [String] old_tag Tag to rename (not case sensitive)\n @param [String] new_tag New tag (if empty nothing will happen)\n\n @return [String] \"done\" when everything went as expected\n @raise [Error] if result code is not \"done\"", "Delete an existing tag\n\n @param [String] tag Tag to delete\n @return [nil]", "Returns a list of the user's notes\n\n @return [Array<Note>] list of notes", "Returns an individual user note. The hash property is a\n   20 character long sha1 hash of the note text.\n\n @return [Note] the note", "Construct params hash for HTTP request\n\n @param [Hash] params Query arguments to include in request\n @return [Hash] Options hash for request", "returns size of memory in megabytes", "sets size of memory in megabytes", "returns number of virtual cpus of VM", "sets number of virtual cpus of VM", "return nil if not sorted by this column\n return order dir if sorted by this column", "Runs request-response cycle.\n @param [Hash] params Request parameters. :cmd option is required.\n @option params [String] :cmd Command to be performed.\n @see VALID_COMMANDS", "Adds a handler for a specific Diameter application.\n\n @note If you expect to only send requests for this application,\n  not receive them, the block can be a no-op (e.g. `{ nil }`)\n\n @param app_id [Fixnum] The Diameter application ID.\n @option opts [true, false] auth\n   Whether we should advertise support for this application in\n   the Auth-Application-ID AVP. Note that at least one of auth or\n   acct must be specified.\n @option opts [true, false] acct\n   Whether we should advertise support for this application in\n   the Acct-Application-ID AVP. Note that at least one of auth or\n   acct must be specified.\n @option opts [Fixnum] vendor\n  If we should advertise support for this application in a\n  Vendor-Specific-Application-Id AVP, this specifies the\n  associated Vendor-Id.\n\n @yield [req, cxn] Passes a Diameter message (and its originating\n  connection) for application-specific handling.\n @yieldparam [Message] req The parsed Diameter message from the peer.\n @yieldparam [Socket] cxn The TCP connection to the peer, to be\n  passed to {Stack#send_answer}.", "Creates a Peer connection to a Diameter agent at the specific\n network location indicated by peer_uri.\n\n @param peer_uri [URI] The aaa:// URI identifying the peer. Should\n   contain a hostname/IP; may contain a port (default 3868).\n @param peer_host [String] The DiameterIdentity of this peer, which\n   will uniquely identify it in the peer table.\n @param realm [String] The Diameter realm of this peer.\n @return [Peer] The Diameter peer chosen.", "Nova instancia da classe Credit\n @param [Hash] campos\n Montar o Hash de dados do pagamento no padr\u00e3o utilizado pela Getnet", "retrieve and populate a list of available stores", "retrieve and populate list of categories for a given store_id\n\n @param [Integer] store_id of the store", "retrieves store content", "retrieves a single page of products given a query specified by an options hash. See options below.\n node_id, page_number, and an optional sorting method\n\n @param [Integer] store_id, from @api.navigation, returned as StoreID\n @param [Integer] category_id from @api.navigation, returned as CategoryType\n @param [Integer] sub_category_id from @api.navigation, returned as CategoryID\n @param [Integer] node_id from @api.navigation, returned as NodeId\n @param [Integer] page_number of the paginated search results, returned as PaginationInfo from search\n @param [String] sort style of the returned search results, default is FEATURED (can also be RATING, PRICE, PRICED, REVIEWS)\n @param [String] keywords", "retrieve product combo deals given an item number\n\n @param [String] item_number of the product\n @param [Integer] sub_category\n @param [Integer] sort_field\n @param [Integer] page_number", "retrieve product reviews given an item number\n\n @param [String] item_number of the product\n @param [Integer] page_number\n @param [String] time\n @param [String] rating default All (can also be 5, 4, 3, 2, 1)\n @param [String] sort default 'date posted' (can also be 'most helpful', 'highest rated', 'lowest rated', 'ownership')", "Returns the current mode string", "Retrieve the user from a message, either by finding it in the current\n list of known users, or by asking campfire for the user.\n\n message - the message for which to look up the user\n\n Yields the message and the user associated with the message", "a block to wrap each test evaluation\n\n @example\n   describe SomeClass do\n\n     around do |test|\n       DB.connect\n       test.run\n       DB.disconnect\n     end\n   end", "Extract the email list statistics from qp_statistics attribute.\n\n @return [QuestionproRails::EmailListStatistic] Email List Statistics.", "Produces the command used to run CutyCapt.\n\n @return [String]", "Parse 'config' request", "Detect error from output", "Parse configuration arguments", "register one time token for given user in redis\n the generated token will have a field \"email\" in order to identify the associated user later", "accesses token for given email if it is allowed", "DEPRECATED\n Use Point geometry which supports srid", "Checks if the server has a message and prints it if not empty.\n We will only check this once a day and won't print anything if the quiet\n option is set or if we output to a file.", "render html for pagination", "Sets and returns +namespace+.\n If called without parameters, returns +namespace+.\n\n Possible options:\n * <tt>:base</tt> - base namespace used for deep merging of values of other namespaces", "Sets +source+ for the configuration\n If called without parameters, returns +source+.\n\n Possible options:\n * <tt>:type</tt> - type of +source+ (optional, based on file extension)\n * <tt>:parser</tt> - parse of input +source+ (optional, based on +:type+)", "Loaded configuration stored in Settings class.\n Accepts +block+ as parameter.\n\n == Examples\n   settings do |settings|\n     settings.a = 1\n   end\n\n   settings do\n     a 1\n   end\n\n   settings.a = 1", "Sets up the configuration based on +namespace+ and +source+.\n If +base_namespace+ provided, merges it's values with other namespaces for handling\n nested overriding of values.\n\n Favours values from +namespace+ over values from +base_namespace+.", "Count changesets in the range from hash_a to hash_b in the repository.\n\n === Example:\n  repository.commits.count_range(hash_a, hash_b)", "Create instance to use API adfly\n\n If you want to get API key from https://adf.ly/publisher/tools#tools-api\n\n @param uid [String] Uid\n @param key [String] Key\n Create single link\n\n Maybe you want to see https://adf.ly/publisher/tools#tools-api\n\n @param data [Hash] data to send api\n\n @option data [String] :url Link to be converted\n @option data [Symbol] :advert_type Type of advertisement(:int or :banner)\n @option data [String] :domain Alias domain to be used for ther generated link\n\n @example Simple use\n   adfly.create_link(url: 'http://www.google.es')\n\n @return [String] Short link\n\n @raise [ArgumentError] Invalid parameters, link cannot be created", "Initializes new istance of FieldsBuilder.\n Param Class\n Creates new field in translation document.\n Param String or Symbol\n Other params are the same as for Mongoid's +field+", "Parse a JSON code coverage file and report that information as a\n message in Danger.\n @return  [void]", "Builds the markdown table displaying coverage on individual files\n @param [Array] covered_files\n @return [String] Markdown table", "Ensure argumanets are valid, assign values of arguments\n\n @param [Array] the global `name_args` object", "Inspect the cookbook directory's git status is good to push.\n Any existing tracked files should be staged, otherwise error & exit.\n Untracked files are warned about, but will allow continue.\n This needs more testing.", "Ensure that there isn't already a git tag for this version.", "Ensure that the remote and branch are indeed valid. We provide defaults in options.", "Get a list of all available nodes", "Get a list of all available metrics", "Get a configuration information for service\n\n services - Name of the service, or list of service names", "Get all service metrics values\n\n services - Name of the service, or list of service names", "Returns a value for +key+ from settings table.\n Yields +value+ of +key+ if +block+ provided.\n\n == Examples:\n\n   .key do |key|\n     ...\n   end\n\n   # or\n\n   .key do\n     ...\n   end", "Dumps settings as hash.", "Extract the choices from the hashes stored\n inside qp_answers attribute.\n\n @return [Array<QuestionproRails::Choice>] Choices.", "Converts ids, tags, and dom queries to a single string ready to pass\n directly to task.\n\n @param ids[Range, Array<String, Range, Fixnum>, String, Fixnum]\n @param tags[String, Array<String>]\n @param dom[String, Array<String>]\n @return [String] a string with ids tags and dom joined by a space\n @api public", "Converts arbitrary id input to a task safe string\n\n @param ids[Range, Array<String, Range, Fixnum>, String, Fixnum]\n @api public", "Convert a tag string or an array of strings to a space separated string\n\n @param tags [String, Array<String>]\n @api private", "Can the input be coerced to a JSON object without losing information?\n\n @return [Boolean] true if coercible, false if not\n @api private", "Cast an individual value, not an array", "Always provide the basic type as a class. If the type\n is an array, the class will be extracted.", "Splits the input lines in fasta format into slices, based on the\n batch_size of the current command. Executes the given block for each of\n the batches.", "Returns the device properties. It contains the whole output of 'getprop'\n @return [Hash<String, String>] the device properties", "Executes a shell command on the device, and receives the result.\n @!method shell(command)\n @return [String, self]\n @overload shell(command)\n   @param [String] command the command to execute\n   @return [String] all results of the command.\n @overload shell(command)\n   @param [String] command the command to execute\n   @return [self] self\n   @yield [line]\n   @yieldparam [String] line each line of results of the command.", "Pushes a file to the device.\n\n If *remotefile* path ends with '/', complements by the basename of\n *localfile*.\n @example\n   device = AdbSdkLib::Adb.new.devices.first\n   device.push('path/to/local.txt', '/data/local/tmp/remote.txt')\n   device.push('path/to/file.txt', '/data/local/tmp/') # uses file.txt\n @param [String] localfile the name of the local file to send\n @param [String] remotefile the name of the remote file or directory\n   on the device\n @return [self] self\n @raise [ArgumentError] If *localfile* is not found", "Pulls a file from the device.\n\n If *localfile* path ends with '/', complements by the basename of\n *remotefile*.\n @example\n   device = AdbSdkLib::Adb.new.devices.first\n   device.pull('/data/local/tmp/remote.txt', 'path/to/local.txt')\n   device.pull('/data/local/tmp/file.txt', 'path/to/dir/') # uses file.txt\n @param [String] remotefile the name of the remote file on the device to get\n @param [String] localfile the name of the local file or directory\n @return [self] self", "Retrieve the Raster Work of which this Object is a member\n @return [GeoWorks::Raster]", "Returns pixel content\n @param [Integer, Integer] pixel position x,y\n @return [AdbSdkLib::Pixel] pixel content", "Calls block once for each pixel in data, passing that device as a parameter.\n If no block is given, an enumerator is returned instead.\n @return [Enumerator] if not block given\n @return [self] if block given\n @yield [pixel] called with each pixel\n @yieldparam [Pixel] pixel a pixel instance", "Transform the object to the acceptable json format by questionpro.\n\n @return [Json] options in the call request.", "Get all the surveys that belongs to the api key's owner.\n\n @return [Array<QuestionproRails::Survey>] Surveys.", "Get a specific survey.\n Survey ID must be set inside the api request object.\n\n @return [QuestionproRails::Survey] Survey.", "Get list of survey Responses.\n Survey ID must be set inside the api request object.\n\n @return [Array<QuestionproRails::SurveyResponse>] Survey Responses.", "Get a specific survey Response.\n Survey ID must be set inside the api request object.\n Response ID must be set inside the api request object.\n\n @return [QuestionproRails::SurveyResponse] Survey Response.", "Get a specific survey Response Statistics.\n Survey ID must be set inside the api request object.\n\n @return [QuestionproRails::SurveyResponseCount] Survey Response Statistics.", "Delete a specific survey response.\n Survey ID must be set inside the api request object.\n Response ID must be set inside the api request object.\n\n @return sets ApiRequest success attribute to 1.", "Get Email Lists related to a specific survey.\n Survey ID must be set inside the api request object.\n\n @return [Array<QuestionproRails::EmailList>] Email Lists.", "Get Specific Email List.\n Email Group ID must be set inside the api request object.\n\n @return [QuestionproRails::EmailList] Email List.", "Get Templates related to a specific survey.\n Survey ID must be set inside the api request object.\n\n @return [Array<QuestionproRails::Template>] Templates.", "Get Specific Template.\n Template ID must be set inside the api request object.\n\n @return [QuestionproRails::Template] Template.", "Get all the accounts that belongs to the api key's owner.\n\n @return [Array<QuestionproRails::Account>] Accounts.", "Get Specific Account.\n User ID must be set inside the api request object.\n\n @return [QuestionproRails::Account] Account.", "Get Unsubscribed Emails related to the api key.\n\n @return [Array<QuestionproRails::UnsubscribedEmail>] Unsubscribed Emails.", "Survey ID must be set inside the api request object.\n\n @return [QuestionproRails::SurveyMeta] Survey meta.", "Send Specific Survey.\n Survey ID must be set inside the api request object.\n\n @param [Integer] mode (1).\n @param [Array<String>] emails to send to (nil).\n @param [Integer] template_id of email (nil).\n @return sets ApiRequest message attribute to \"Message successful.\".", "Get Send History related to a specific survey.\n Survey ID must be set inside the api request object.\n\n @return [Array<QuestionproRails::EmailBatch>] Email Batches.", "Send Reminders.\n Survey ID must be set inside the api request object.\n Email Group ID must be set inside the api request object.\n Template ID must be set inside the api request object.\n\n @return sets ApiRequest message attribute to \"Message successful.\".", "Create Email List.\n Survey ID must be set inside the api request object.\n\n @param [Array<String>] emails ([]).\n @param [String] email_group_name (nil).\n @return sets ApiRequest email_group_id to the created email list id.", "Extract the Questions from the hashes stored\n inside qp_questions attribute.\n\n @return [Array<QuestionproRails::Question>] Questions.", "Return the difference for the license.", "Fixes the document.", "Starts a new game.\n\n The engine is transitioned into the {Playing} state and the event\n\n   { name: :game_started }\n\n is triggered.\n\n @param turn [Grid::X, Grid::O] specifies which token has first play\n @raise [ArgumentError] unless turn is either {Grid::X} or {Grid::O}", "Extract the Sections from the hashes stored\n inside qp_sections attribute.\n\n @return [Array<QuestionproRails::Section>] Sections.", "Returns a Hash of diffstat-style summary of changes for the commit.", "Returns a new instance of RowBuilder.\n @return [RowBuilder] a new instance of RowBuilder.\n @param [Array<Symbol>] columns an array of symbols.\n @param builder [#call, #to_csv] optional row builder.\n @param type_map [Hash] map of column_name => type conversion to perform.\n @raise [RowError] super class of errors raised when there is a row error.\n @raise [EmptyRowColumnsError] raised when there are no columns.\n @raise [InvalidRowLengthError] raised when row has more columns than header columns.\n @example Create new row\n     RowBuilder.new!([:id])\n Returns an object representing the row.\n @return [Row, Object] a new instance of built row.\n @param row [Array] the row array.\n @raise [InvalidRowLengthError]\n   raised when there are more row elements longer than columns\n @example Build new row\n     r = RowBuilder.new([:id])\n     r.build(['1']).id #=> '1'", "Returns content of the specified section of hgrc.", "Returns content of the specified setting from a section.", "Adds a new hook to the repository.\n\n === Example:\n  repository.hooks.add('changegroup', 'do_something')", "unlike save, create returns the newly created document", "Lets make sure these keys are not clogging up the database forever", "Represent row as CSV\n @param columns [Array<Symbol>, Set<Symbol>, NilClass]\n   the columns to output, nil means all columns (default: nil)\n @return [String] CSV-string representation.", "Describe the contents of this row in a string.\n @return [String] content of this row", "Returns the column in CSV format\n @param [Symbol] column name\n @return [String] column value as CSV string", "updates file index", "builds a list of all commits reachable from a single commit", "Sets the attributes from a hash", "Warning! This assumes terms are unique, they are NOT required to be so in an OBO file.\n Ignores hash colisions!!\n @return [Hash]\n  (String => String) (name => id)", "Extract the Answers from the hashes stored\n inside qp_values attribute.\n\n @return [Array<QuestionproRails::ResponseAnswer>] Response Answers.", "Declare this in your model to require approval on new records or changes to fields.\n\n @param [Hash] options the options for this models approval workflow.\n @option options [Symbol,Array] :on    The events to require approval on (`:create`, `:update` or `:destroy`).\n @option options [String] :state_field The local field to store `:create` approval state.\n @option options [Array]  :ignore      A list of fields to ignore. By default we ignore `:created_at`, `:updated_at` and\n                                       the field specified in `:state_field`.\n @option options [Array]  :only        A list of fields to explicitly require approval on. This list supercedes `:ignore`.", "We ignore the iostream even though we get one, we're gonna\n read from a Horizon DB!\n Requires marc4j and jtds, and java_import's some classes.", "Converts from Marc8 to UTF8 if neccesary.\n\n Also replaces escaped unicode codepoints using custom Horizon \"<U+nnnn>\" format\n Or standard MARC 'lossless encoding' \"&#xHHHH;\" format.", "Mutate string passed in to fix leader bytes for marc21", "using softmax as output layer is recommended for classification where outputs are mutually exclusive", "Normalizes the various different input objects to Strings", "Buffering new CBOR data\n\n @param [String] cbor", "Consume CBOR data.\n This method will be called only in fiber.\n\n @param [Integer] size Size to consume\n @return [String]", "Extract the Email Groups from the hashes stored\n inside email_groups_list attribute.\n\n @return [Array<QuestionproRails::EmailGroup>] Email Groups.", "Extract the Templates from the hashes stored\n inside templates_list attribute.\n\n @return [Array<QuestionproRails::Template>] Templates.", "Returns a scope that limits results any occurrences of the specified record.\n Record can be specified by passing a staging record, or an id and table_name.", "Allow subscribing either by passing a reference to self\n or by passing a block which defines the state keys that\n this listener cares about", "Initialize state with the key-value pair associated with each reducer", "Creates a new repository instance on the given path\n\n @param [Hash] options A hash of options\n @option options [Boolean] :create (true) Creates the backing Git\n         repository if it does not already exist\n @option options [Boolean] :prepare (true) Prepares the backing Git\n         repository for use with Silo if not already done\n\n @raise [Grit::InvalidGitRepositoryError] if the path exists, but is not a\n        valid Git repository\n @raise [Grit::NoSuchPathError] if the path does not exist and option\n        :create is +false+\n @raise [InvalidRepositoryError] if the path contains another Git\n        repository that does not contain data managed by Silo.\n Stores a file or full directory structure into the repository inside an\n optional prefix path\n\n This adds one commit to the history of the repository including the file\n or directory structure. If the file or directory already existed inside\n the prefix, Git will only save the changes.\n\n @param [String] path The path of the file or directory to store into the\n        repository\n @param [String] prefix An optional prefix where the file is stored inside\n        the repository", "Adds a new remote to this Repository\n\n @param [String] name The name of the remote to add\n @param [String] url The URL of the remote repository\n @see Remote", "Gets a list of files and directories in the specified path inside the\n repository\n\n @param [String] path The path to search for inside the repository\n @return [Array<String>] All files and directories found in the specidied\n         path", "Loads remotes from the backing Git repository's configuration\n\n @see Remote::Git", "Generate a history of Git commits for either the complete repository or\n a specified file or directory\n\n @param [String] path The path of the file or directory to generate the\n        history for. If +nil+, the history of the entire repository will\n        be returned.\n @return [Array<Grit::Commit>] The commit history for the repository or\n         given path", "Get information about a file or directory in the repository\n\n @param [String] path The path of the file or directory to get information\n        about\n @return [Hash<Symbol, Object>] Information about the requested file or\n         directory.", "Prepares the Git repository backing this Silo repository for use with\n Silo\n\n @raise [AlreadyPreparedError] if the repository has been already prepared", "Purges a single file or the complete structure of a directory with the\n given path from the repository\n\n *WARNING*: This will cause a complete rewrite of the repository history\n and therefore deletes the data completely.\n\n @param [String] path The path of the file or directory to purge from the\n        repository\n @param [Boolean] prune Remove empty commits in the Git history", "Removes a single file or the complete structure of a directory with the\n given path from the HEAD revision of the repository\n\n *NOTE*: The data won't be lost as it will be preserved in the history of\n the Git repository.\n\n @param [String] path The path of the file or directory to remove from the\n        repository", "Removes the remote with the given name from this repository\n\n @param [String] name The name of the remote to remove\n @see Remote", "Restores a single file or the complete structure of a directory with the\n given path from the repository\n\n @param [String] path The path of the file or directory to restore from\n        the repository\n @param [String] prefix An optional prefix where the file is restored", "Add behaviors to the SolrDocument model", "Extract the Response Set from the hash stored\n inside qp_response_set attribute.\n\n @return [Array<QuestionproRails::ResponseSet>] Response Sets.", "setup rails_paginate collection\n build url", "link to page with i18n support", "Stops the server after handling the connection.\n Attempts to stop the server gracefully, otherwise\n shuts current connection right away.", "Provides dirt-simple logic for spitting out page numbers\n based on the current page.\n\n If we have 100 pages for example and we're at page 50,\n this would simply return\n\n     [45, 46, 47, 48, 49, 50, 51, 52, 53, 54]\n\n When we're at page 1, it displays 1 to 10.\n\n You can pass in a number to limit the total displayed pages.", "Below actual methods from api", "Executes block if it's its turn, queues the block in the other case.", "Yields a block and retries on retriable errors n times.\n The raised error could be the defined retriable or it child.\n\n Example:\n   class PizzaService\n     include Take2\n\n     number_of_retries 3\n     retriable_errors Net::HTTPRetriableError\n     retriable_condition proc { |error| response_status(error.response) < 500 }\n     on_retry proc { |error, tries|\n       puts \"#{self.name} - Retrying.. #{tries} of #{self.retriable_configuration[:retries]} (#{error})\"\n     }\n     backoff_strategy type: :exponential, start: 3\n\n     def give_me_food\n       call_api_with_retry do\n         # Some logic that might raise..\n         # If it will raise retriable, magic happens.\n         # If not the original error re raised\n       end\n     end\n\n   end", "Sets number of retries.\n\n Example:\n   class PizzaService\n     include Take2\n     number_of_retries 3\n   end\n Arguments:\n   num: integer", "Sets list of errors on which the block will retry.\n\n Example:\n   class PizzaService\n     include Take2\n     retriable_errors Net::HTTPRetriableError, Errno::ECONNRESET\n   end\n Arguments:\n   errors: List of retiable errors", "Sets the backoff strategy\n\n Example:\n   class PizzaService\n     include Take2\n     backoff_strategy type: :exponential, start: 3\n   end\n Arguments:\n   hash: object", "Exposes current class configuration", "Fetch and install the files determining their name and version if not provided.\n If the fetch_path contains a directory of files, it iterates over the directory\n installing each file that isn't in IGNORE_DIRS and a name and version can be\n determined for. It also installs a package.json file along side the JS file\n that contains meta data including the name and version, also merging with the\n original package.json if found.\n\n If options[:shallow] == true it will just copy the single file without any leading\n directories or a package.json. 'shallow' installation is used for Bundle#vendor", "checking on casted objects", "Do recursive validity checking", "Call value type\n @param [Symbol, String, #call] type the name of the type\n @param [Object] value to be converted", "Register a caller\n @param [Symbol, String] type the name of the type\n @param [#call] caller that responds to #call\n @return [Object] returns the caller\n @raise [TypeExistsError] if type is already registered", "Initializes a Client with given parameters.\n\n ==== Parameters\n\n [<tt>params</tt>] Optional <tt>Hash</tt> holding the initial parameters. Defaults to <tt>{}</tt>.\n Sends a message and returns a <tt>String</tt> with the message received. Updates #params to maintain state.\n\n ==== Parameters\n\n [<tt>message</tt>] Optional <tt>String</tt> holding the message to be sent. Defaults to <tt>''</tt>.", "Initialize the messenger.\n\n @param command [String] the name of the command file to run.\n @param arguments [String] the arguments to pass to the command.\n   may contain interpolated values, like +{key}+ or +{{key}}+.\n @param options [Hash] the options for the messenger.\n Runs the command and arguments with the given interpolations;\n defaults to no interpolations.\n\n @note This method may not raise a {NoCommandError} and instead\n   return a {Message} with the error code +127+, even if the\n   command doesn't exist.\n @yield [Message] when the command finishes.\n @raise [NoCommandError] on no command.\n @param interops [Hash<Symbol, Object>] the interpolations to\n   make.\n @param options [Hash<Symbol, Object>] the options for the\n   backend.\n @return [Message, Object] message if no block was given, the\n   return value of the block otherwise.", "Iterates over all the positions of this grid from left to right and top to bottom.\n\n @example\n  g = Grid.new\n  g.each do |r, c, k|\n    puts \"(#{r}, #{c}) -> #{k}\"\n  end", "Iterates over all the open positions of this grid from left to right and top to bottom.\n\n @example\n  g = Grid.new\n\n  g[1, 1] = g[2, 1] = Grid::X\n  g[2, 2] = g[3, 1] = Grid::O\n\n  g.each_open do |r, c|\n    puts \"(#{r}, #{c}) is open\"\n  end", "Returns true if a connection that's accessible to this class has\n already been opened.", "All direct children", "All direct and indirect children", "Execute an operation on the node itself and all children,\n direct and indirect.", "Default error handling called in every popen3 call. Only executes if\n thread had a failing exit code\n\n @raise [RuntimeError] if failing exit code", "Set the deduplication header strategy\n @param [Symbol, #call]\n   symbol with known strategy identifier or method that responds\n   to #call(colums, key_count)\n @return [#call] the header deduplication strategy\n @raise [UnknownDeduplicationStrategyError]", "Default header deduplicate strategies\n @return [Hash] the default header deduplicatation strategies", "Default converter registry\n @return [Hash] hash with default converters", "Returns the host. If a value is defined by both an option and the config\n file, the value of the option is used.", "Returns an input iterator to use for the request.\n - if arguments are given, uses arguments\n - if the input file option is given, uses file input\n - if none of the previous are given, uses stdin", "Returns an array of regular expressions containing all the selected fields", "Runs the command", "Saves an error to a new file in the .unipept directory in the users home\n directory.", "Handles the response of an API request.\n Returns a block to execute.", "Parses the json_response, wraps it in an array if needed and filters the\n fields based on the selected_fields", "Writes all changed aspects out to the file system\nwill also stage all changes", "This method will destroy all local tracked changes, resetting the local gitolite\n git repo to HEAD and reloading the entire repository\n Note that this will also delete all untracked files", "Updates the repo with changes from remote master", "Loads all .pub files in the gitolite-admin\nkeydir directory", "Initializes a dailycred object\n\n - @param [String] client\\_id the client's daiycred client id\n - @param [String] secret\\_key the clients secret key\n - @param [Hash] opts a hash of options\n Generates a Dailycred event\n\n - @param [String] user_id the user's dailycred user id\n - @param [String] key the name of the event type\n - @param [String] val the value of the event (optional)", "Prepares data from stash for persisting in embeded Translation documents.\n Also clears stash for further operations.", "Returns persisted value of attribute for given locale or nil.", "Handle url -> fields conversion", "Set the `bundle_dir` where bundles will be written. If `bundle_dir` is set\n to nil, all bundles will be written to STDOUT", "Output the parse Jimfile requirements and options as a Jimfile-ready\n JSON-encoded string", "Resolve the requirements specified in the Jimfile for each bundle to `paths`\n Raises MissingFile error", "Retrieve the Vector Work of which this Object is a member\n @return [GeoWorks::VectorWork]", "Call all plugins and collate any data returned.\n\n nil can be returned explicitly to say this plugin has nothing to return.\n\n @param [Symbol] method The name of the method to call. This should be namespaced somehow. For example, a plugin\n                        called `usmu-s3` could use the method namespace `s3` and have a hook called `:s3_upload`\n @param [Array] args The arguments to pass through to plugins. Can be empty.\n @return [Array] An array of non-nil values returned from plugins", "Call all plugins and allow for altering a value.\n\n The return value of each hook is passed into the next alter function, hence all implementations must always\n return a value. If the hook doesn't wish to modify data this call then it should return the original value.\n\n @param [Symbol] method The name of the method to call. This should be namespaced somehow. For example, a plugin\n                        called `usmu-s3` could use the method namespace `s3` and have a hook called `:s3_upload`\n @param [Object] value The value to modify.\n @param [Array]  context Optional extra parameters to provide.\n @return [Object] The modified value.", "Helper function to load a plugin from a gem specification\n\n @param [Gem::Specification] spec", "Instantiate the CLI\n @param writer [CLIResultWriter] the result writer to use\n Returns the expected runtime in seconds\n @param report_count [Integer] number of reports in benchmark\n @return [Integer] expected runtime in seconds", "Download or fetch the default benchmark file from cache\n @return [String] CSV file as a string", "Incomplete End Operation that are not the last entry in their session", "Incomplete Start on the same session as a subsequent start operation", "Sets properties from the constitutent external metadata file", "Helper function to generate a page\n\n @param [Usmu::Template::Page] page", "Change content of string, keeping quoting style.", "Remove node with preceding comma.", "view_helper for paginate\n\n == Options\n :id\n :class", "Returns an XML string that can be sent back to Google to\n communicate successful receipt of the notification.", "Take requests for an XML element and returns its value.\n\n   notification.google_order_number\n   => Returns value of '<google-order-number>'\n\n Because of how Nokogiri#at works, it will even dig into subtags\n and return the value of the first matching tag. For example,\n there is an +email+ field in +buyer-shipping-address+ and also\n in +buyer-billing-address+, but only the first will be returned.\n\n If you want to get at a value explicitly, use +notification.doc+\n and search the Nokogiri document manually.", "Convert matrix to CSV-string.\n @param columns [Array<Symbol>, Set<Symbol>, NilClass]\n   the columns to output, nil means all columns (default: nil)\n @yield [row]\n   The given block will be passed for every row - return truthy if you want the\n   row to be included in the output\n @yieldparam [Row] row\n @return [String] CSV-string representation.\n @example with selected columns\n   matrix.to_csv(columns: [:id, :country])\n @example with selected rows\n   matrix.to_csv { |row| row.country == 'Sweden' }\n @example with both selected columns and rows\n   matrix.to_csv(columns: [:id, :country]) { |row| row.country == 'Sweden' }", "Retrieves the current task list filtered by id, tag, or a dom query\n\n @example filter by an array of ids\n   tw.some(ids: [1..2, 5])\n @example filter by tags\n   tw.some(tags: [\"+school\", \"or\", \"-work\"]\n   # You can also pass in a TW style string if you prefer\n   tw.some(tags: \"+school or -work\"]\n @example filter by a dom query\n   require \"date\"\n   today = DateTime.now\n   # note that queries with dots need to be Strings, as they would be\n   # invalid Symbols\n   tw.some(dom: {project: \"Work\", \"due.before\" => today})\n   # You can also pass in a TW style string if you prefer\n   tw.some(dom: \"project:Work due.before:#{today}\")\n\n @param ids [Array<Range, Fixnum, String>, String, Range, Fixnum]\n @param tags [Array<String>, String]\n @param dom [Array<String>, String]\n @param active [Boolean] return only pending & waiting tasks\n @return [Array<Models::TaskModel>]\n @api public", "Calls `task _show` with initial overrides returns a Taskrc object of the\n result\n\n @return [Rtasklib::Taskrc]\n @api public", "Calls `task _version` and returns the result\n\n @return [String]\n @api public", "Retrieves a hash of hashes with info about the UDAs currently available\n\n @return [Hash{Symbol=>Hash}]\n @api public", "Update a configuration variable in the .taskrc\n\n @param attr [String]\n @param val [String]\n @return [Process::Status] the exit status of the thread\n @api public", "Add new found udas to our internal TaskModel\n\n @param uda_hash [Hash{Symbol=>Hash}]\n @param type [Class, nil]\n @param model [Models::TaskModel, Class]\n @api protected", "Retrieve an array of the uda names\n\n @return [Array<String>]\n @api public", "Sync the local TaskWarrior database changes to the remote databases.\n Remotes need to be configured in the .taskrc.\n\n @example\n   # make some local changes with add!, modify!, or the like\n   tw.sync!\n\n @return [Process::Status] the exit status of the thread\n @api public", "Returns contents of the manifest as a String at a specified revision.\n Latest version of the manifest is used if +revision+ is ommitted.\n\n === Example:\n  repository.manifest.contents", "If the style hasn't been registered yet, create a new array\n with the style property and value.\n\n If the style has been registered, and the property name is a duplicate,\n supplant the old property value with the new one.\n\n If the style has been registered, and the property is a new one,\n push the property and value onto the array.", "This method got nasty.", "Combines multiple promises into a single promise that is resolved when all of the input\n promises are resolved.\n\n @param [*Promise] Promises a number of promises that will be combined into a single promise\n @return [Promise] Returns a single promise that will be resolved with an array of values,\n   each value corresponding to the promise at the same index in the `promises` array. If any of\n   the promises is resolved with a rejection, this resulting promise will be resolved with the\n   same rejection.", "Generates the XML for the shipping cost, conditional on\n @flat_rate_shipping being set.", "Returns the shipping cost for the contents of the cart.", "Returns the currency for the cart.  Mixing currency not allowed; this\n library can't convert between currencies.", "Returns the signature for the cart XML.", "Returns HTML for a checkout form for buying all the items in the\n cart.", "header and rows", "load result from input array_or_relation to internal array", "Establish connection to the server", "Send a string of data followed by a newline symbol", "Reads a single line from socket", "Reads a packet of data until '.' reached", "Execute operation with timeout\n @param [Block] block Block to execute", "Checks if the current request passes authorization", "determines if a RestClient is disabled or not", "determines if given timestamp is within a specific window of minutes", "generates the string that is hashed to produce the signature", "Converts the given input data and corresponding fasta headers to another\n format.\n\n @param [Array] data The data we wish to convert\n\n @param [Array<Array<String>>] fasta_mapper Optional mapping between input\n data and corresponding fasta header. The data is represented as a list\n containing tuples where the first element is the fasta header and second\n element is the input data\n\n @param [Boolean] Is this the first output batch?\n\n @return [String] The converted input data", "Integrates the fasta headers into the data object", "Converts the given input data to the JSON format.\n\n @param [Array] data The data we wish to convert\n\n @param [Boolean] Is this the first output batch?\n\n @return [String] The converted input data in the JSON format", "Returns the header row for the given data and fasta_mapper. This row\n contains all the keys of the first element of the data, preceded by\n 'fasta_header' if a fasta_mapper is given.\n\n @param [Array] data The data that we will use to extract the keys from.\n\n @param [Array<Array<String>>] fasta_mapper Optional mapping between input\n data and corresponding fasta header. The data is represented as a list\n containing tuples where the first element is the fasta header and second\n element is the input data If a fasta_mapper is given, the output will be\n preceded with 'fasta_header'.\n\n @return [String] The header row", "Converts the given input data to the CSV format.\n\n @param [Array] data The data we wish to convert\n\n @param [Boolean] Is this the first output batch?\n\n @return [String] The converted input data in the CSV format", "Converts the given input data to the Blast format.\n\n @param [Array] data The data we wish to convert\n\n @param [Boolean] Is this the first output batch?\n\n @return [String] The converted input data in the Blast format", "Returns all records which have been assigned any of the given roles, as well as any record with no role assigned", "Authorization hash to use with all SOAP requests", "Retrieve the Image Work of which this Object is a member\n @return [GeoWorks::ImageWork]", "build array with all visible pages", "looks should this page visible", "Return Array of attribute names with presence validations", "Returns translations for current locale. Is used for initial mixing into\n @attributes hash. Actual translations are in @translated_attributes hash.\n Return Hash", "Returns instance of Translation for given locale.\n Param String or Symbol", "Return Array with locales, used for translation of this document", "Before save callback. Cleans @attributes hash from translated attributes\n and prepares them for persisting.", "Get single-occurrence events built and get a lits of recurrence\n events, these must be build last", "Defines methods into client\n @example\n   client.list_app\n   client.info_app(id: 1)", "Builds HTML string for bounding box selector tool.\n Calls boundingBoxSelector javascript function and\n passes the id of the location input element that it binds to.\n @param [Symbol] name of property that holds bounding box string\n @return[String]", "Database configuration file", "Explicit verbose mode, overrides configuration value", "Reads a file with JSON ShellCheck summary and reports it.\n\n @param    [String] file_path Path for ShellCheck summary in JSON format.\n @return   [void]", "A method that takes the ShellCheck summary and parses any violations found", "Poltergeist-friendly sign-up\n Use this in feature tests", "Poltergeist-friendly sign-in\n Use this in feature tests", "If the database is deleted, ensure that the design docs will be refreshed.", "Return the style name for this element, with periods\n changed to underscores to make it valid CSS.\n\n Side effect: registers this style as \"having been used\"\n in the document", "Entitities with specific type", "Converts Java Map object to Ruby Hash object.", "Parse the file by producing an artifact corresponding to the file", "Parse the file by producing an artifact corresponding to the string", "Get devices attached with ADB.\n @return [DeviceList] List of devices", "The unique, gateway-generated identifier for this credit card.\n\n You may define any of the CreditCard attributes by passing a hash\n with the attribute name as the key:\n\n     CreditCard.new(:card_number => '4111....')", "paginate with options\n\n page = active page\n per_page = how much entries per page", "Sends the Command's XML to GoogleCheckout via HTTPS with Basic Auth.\n\n Returns a GoogleCheckout::RequestReceived or a GoogleCheckout::Error object.", "Make a new message to send.\n\n The last argument is the actual message.\n\n Call +post+ on the resulting object to submit it to Google for sending.", "Generate a dynamic Virtus model, with the attributes defined by the input\n\n @param rc [Hash, Pathname] either a hash of attribute value pairs\n   or a Pathname to the raw taskrc file.\n @raise [TypeError] if rc is not of type Hash, String, or Pathname\n @raise [RuntimeError] if rc is a path and does not exist on the fs\n Turn a hash of attribute => value pairs into a TaskrcModel object.\n There can be only one TaskrcModel object per Taskrc, it's saved to the\n instance variable `config`\n\n @param taskrc_hash [Hash{Symbol=>String}]\n @return [Models::TaskrcModel] the instance variable config\n @api private", "Converts a .taskrc file path into a Hash that can be converted into a\n TaskrcModel object\n\n @param rc_file [String,Pathname] a valid pathname to a .taskrc file\n @return [Models::TaskrcModel] the instance variable config\n @api private", "Serialize the given attrs model back to the taskrc format\n\n @param attrs [Array] a splat of attributes\n @return [Array<String>] an array of CLI formatted strings\n @api public", "Check whether a given object is a path and it exists on the file system\n\n @param path [Object]\n @return [Boolean]\n @api private", "Find _all_ paths matching `name` and `version`. Returning an array.", "Header as CSV-string\n @return [String] CSV-string representation.", "Convert original header\n @param [Array<String>] header the original header\n @return [Array<String>] converted columns", "Convert the column value\n @param [String, Symbol] column the CSV header column value\n @param [Integer] index the CSV header column index\n @return [Symbol] the converted column", "Go to a section of the Mascot DAT file", "Read a section of the DAT file into memory. THIS IS NOT\n RECOMMENDED UNLESS YOU KNOW WHAT YOU ARE DOING.\n\n @param key [String or Symbol] The section name\n @return [String] The section of the DAT file as a String. The section\n                  includes the MIME boundary and  content type\n                  definition lines.", "Helper to determine if a filename is excluded according to the exclude configuration parameter.\n\n @return [Boolean]", "Initialize with your paginated collection.\n\n == Paramaters:\n items::\n   a `Pagination::Collection` object return by `Pagination.paginate`.\n Displayed the standard pagination markup as provided by the\n `Pagination` library.\n\n This uses Haml if Haml is required already. Else it uses ERB.\n\n == Returns:\n The actual HTML for the pagination.", "In the first form, iterates over all elements of the object, yields them\n to the block given, and overwrites the element's value with the value\n returned by the block.\n\n In the second form, returns an Enumerator.\n\n The return value of the block must be the same kind of object as was\n yielded to the block. So, if yielded a Vec3, the block must return a Vec3.\n If yielded a Numeric, it must return a Numeric.\n\n call-seq:\n   map! { |elem| block } -> self\n   map! -> Enumerator", "Create API query object by API query method\n\n @param    api_query_name    [String]              API query method name\n\n @return                     [Prototype::Query]    API query object", "Runs the configuration, generating the new project from the chosen template.", "Sets the install path to executing directory if @install_path varibale is nil or empty. This should result in projects being created in directory from which the jumpstart command was called, if the template specified does not set this option.\n Checks the install path set in @install_path.\n Checks that a directory with the same name as the project does not already exist in the install path.", "Creates a new blank template in whichever directory the default templates directory has been set to.", "Displays options for the main jumpstart menu.", "Captures user input for the main jumpstart menu and calls the appropriate method", "Displays options for the \"create a new jumpstart project from an existing template\" menu", "Captures user input for the \"create a new jumpstart project from an existing template\" menu and calls the appropriate method.\n When the input matches a template number a project will be created from that template", "Displays output for the \"create a new jumpstart template\" menu", "Captures user input for \"create a new jumpstart template\" menu and calls the appropriate action.\n If the template name provided meets the methods requirements then a directory of that name containing a jumpstart_config dir and matching yaml file are created.", "Displays output for the \"jumpstart default template options menu\"", "Sets the default template to be used by JumpStart and writes it to a YAML file.", "Displays output for the \"jumpstart templates directory options\" menu.", "Captures user input for the \"jumpstart templates directory options\" menu and calls the appropriate method.", "Sets the path for templates to be used by JumpStart.\n Copies templates in the existing template dir to the new location.\n The folder specified must not exist yet, but it's parent should.", "TOOD set_templates_dir_to_existing_dir Needs tests", "Parses the contents of the @template_path and sorts ready for template creation.", "Create files from whole templates", "Removes files specified in templates YAML", "Runs additional scripts specified in YAML. Runs one set after the install command has executed, another after the templates have been generated, and a final time after string replacement", "Looks for strings IN_CAPS that are specified for replacement in the templates YAML", "Exit after creating a project, dumping current setup information to YAML", "Updates or allocates a number", "Deallocates a number, once deallocated, a number cannot be used again, ever!", "Edgarj standard datetime format", "get enum Module.\n\n When Col(camelized argument col name) module exists, the Col is\n assumed enum definition.", "Pipeline\n Renders a Liquid template", "Take the posted data and move the relevant data into a hash", "Add conditional to basicStructure\n @param pConditional ConditionalData to add inside basicStructure", "Add repetition to basicStructure\n @param pRepetition RepetitionData to add inside basicStrure", "Add block to basicStructure\n @param pBlock BlockData to add inside basicStructure", "Set default values\ninitialize\n Method for setting global Symbol-to-string conversion algorithm\n @param [symbol, lambda] algorithm\n   Can be symbol corresponding to predefined algorithm or a lambda that accepts a symbol\n   as an argument and returns a string", "Get all locations of course", "Defines RSpec tasks", "Defines the rake tasks", "Updates the version number in the gemspec file, the VERSION constant in the main\n include file and the contents of the VERSION file.", "Updates the VERSION file with the new version", "Updates the VERSION constant in the main include file if it exists", "Set all the attributes at once.", "Set a field from the schema with the specified name.", "Gathers the persisted object from database and updates self with it's attributes.", "Updates attributes from self with the attributes from the parameters", "Find related object on the database and updates it with attributes in self, if it didn't\n find it on database it creates a new one.", "Updates created_at and updated_at", "This method allows you to handle extra-element such as you can't represent\n with elements defined in Atom namespace.\n\n   entry = Atom::Entry.new\n   entry.set('http://example/2007/mynamespace', 'foo', 'bar')\n\n Now your entry includes new element.\n <foo xmlns=\"http://example/2007/mynamespace\">bar</foo>\n\n You also can add attributes\n\n    entry.set('http://example/2007/mynamespace', 'foo', 'bar', { :myattr => 'attr1', :myattr2 => 'attr2' })\n\n And you can get following element from entry\n\n   <foo xmlns=\"http://example/2007/mynamespace\" myattr=\"attr1\" myattr2=\"attr2\">bar</foo>\n\n Or using prefix,\n\n   entry = Atom::Entry.new\n   ns = Atom::Namespace.new(:prefix => 'dc', :uri => 'http://purl.org/dc/elements/1.1/')\n   entry.set(ns, 'subject', 'buz')\n\n Then your element contains\n\n   <dc:subject xmlns:dc=\"http://purl.org/dc/elements/1.1/\">buz</dc:subject>\n\n And in case you need to handle more complex element, pass the REXML::Element object\n which you customized as third argument instead of text-value.\n\n   custom_element = REXML::Element.new\n   custom_child = REXML::Element.new('mychild')\n   custom_child.add_text = 'child!'\n   custom_element.add_element custom_child\n   entry.set(ns, 'mynamespace', costom_element)", "Same as 'set', but when a element-name confliction occurs,\n append new element without overriding.", "Get indicated elements as an object of the class you passed as thrid argument.\n\n   ns = Atom::Namespace.new(:uri => 'http://example.com/ns#')\n   obj = entry.get_object(ns, 'mytag', MyClass)\n   puts obj.class #MyClass\n\n MyClass should inherit Atom::Element", "Get all indicated elements as an object of the class you passed as thrid argument.\n\n   entry.get_objects(ns, 'mytag', MyClass).each{ |obj|\n     p obj.class #MyClass\n   }", "Convert to XML-Document and return it as string", "Get a xpath string to traverse child elements with namespace and name.", "Get media resource\n\n Example:\n\n   resource, content_type = client.get_media(media_uri)", "Create new entry\n\n Example:\n\n   entry = Atom::Entry.new\n   entry.title = 'foo'\n   author = Atom::Author.new\n   author.name = 'Lyo Kato'\n   author.email = 'lyo.kato@gmail.com'\n   entry.author = author\n   entry_uri = client.create_entry(post_uri, entry)", "Create new media resource\n\n Example:\n\n   media_uri = client.create_media(post_media_uri, 'myimage.jpg', 'image/jpeg')", "Update media resource\n\n Example:\n\n   entry = client.get_entry(media_link_uri)\n   client.update_media(entry.edit_media_link, 'newimage.jpg', 'image/jpeg')", "Get contents, for example, service-document, categories, and feed.", "reads a ttl file and makes it a JSON-LD file that we can parse", "For reference to the assumed RELS-EXT see the following spec in CurateND\n @see https://github.com/ndlib/curate_nd/blob/115efec2e046257282a86fe2cd98c7d229d04cf9/spec/repository_models/osf_archive_spec.rb#L97", "Constructs OsfArchive Record from ttl_data, data from the UI form,\n and task config data", "sets the creator- needs to read another ttl for the User data\n only contrubutors with isBibliographic true are considered", "Returns the user's Pivotal Tracker API token.  If this token has not been\n configured, prompts the user for the value.  The value is checked for in\n the _inherited_ Git configuration, but is stored in the _global_ Git\n configuration so that it can be used across multiple repositories.\n\n @return [String] The user's Pivotal Tracker API token", "Returns the Pivotal Tracker project id for this repository.  If this id\n has not been configuration, prompts the user for the value.  The value is\n checked for in the _inherited_ Git configuration, but is stored in the\n _local_ Git configuration so that it is specific to this repository.\n\n @return [String] The repository's Pivotal Tracker project id", "Returns the story associated with the branch\n\n @return [Story] the story associated with the current development branch", "special prompt that has hidden input", "Executes payment API query\n\n @param    query_name            [String]                Payment API query name\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for processing\n\n @return                         [Response]              Query response", "Executes payment gateway processor for PaynetEasy payment callback\n\n @param    callback_response     [CallbackResponse]      Callback object with data from payment gateway\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for processing\n\n @return                         [CallbackResponse]      Validated payment gateway callback", "Authenticate, to return authToken\n @param un username or Email\n @param pw Password\n @return Hash\n if success\n {\n   :auth_token => xxxxxxxx\n }", "Construct a WebSocket frame.\n @example\n   frame = LibWebSocket::Frame.new('foo')\n   frame.to_s # => \\x00foo\\xff", "Performs an LDAP add.", "Performs an LDAP modify.", "Performs an LDAP modrdn.", "Performs an LDAP compare.", "Upload a file\n @param [String] folder_path Either 'me/skydrive' or FOLDER_ID(id of the parent folder)\n @param [String] filename Name of the new file\n @param [File] The actual file to be uploaded\n @param [Hash] options Any additional options to be passed\n @option options [Boolean] :overwrite whether to overwrite the file\n @return [Skydrive::File] the created file with minimum details", "Sets accept and user_agent headers, and url\n\n @return [Hash] RestClient-formatted hash of options.", "Create API gateway request from payment transaction data\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for query\n\n @return                         [Request]               Request object", "Process API gateway response and update payment transaction\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for update\n @param    response              [Response]              API gateway response\n\n @return                         [Response]              API gateway response", "Validates payment transaction before request constructing\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for validation", "Creates request from payment transaction\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for request constructing\n\n @return                         [Request]               Request object", "Validates response before payment transaction updating\n if payment transaction is processing or approved\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction\n @param    response              [Response]              Response for validating", "Validates response before payment transaction updating\n if payment transaction is not processing or approved\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction\n @param    response              [Response]              Response for validating", "Updates payment transaction by query response data\n if payment transaction is processing or approved\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction\n @param    response              [Response]              Response for payment transaction updating", "Updates payment transaction by query response data\n if payment transaction is not processing or approved\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction\n @param    response              [Response]              Response for payment transaction updating", "Validates query object definition", "Check, is payment transaction client order id and query response client order id equal or not.\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for update\n @param    response              [Response]              API gateway response", "Set PaynetEasy payment id to payment transaction Payment\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for update\n @param    response              [Response]              API gateway response", "Provides summary fundraising information for specified politician.\n\n See : http://www.opensecrets.org/api/?method=candSummary&output=doc\n\n @option options [String] :cid (\"\") a CRP CandidateID\n @option options [optional, String] :cycle (\"\") blank values returns current cycle.", "Provides the top organizations contributing to specified politician.\n\n See : http://www.opensecrets.org/api/?method=candContrib&output=doc\n\n @option options [String] :cid (\"\") a CRP CandidateID\n @option options [optional, String] :cycle (\"\") 2008 or 2010.", "Provides the top industries contributing to a specified politician.\n\n See : http://www.opensecrets.org/api/?method=candIndustry&output=doc\n\n @option options [String] :cid (\"\") a CRP CandidateID\n @option options [optional, String] :cycle (\"\") blank values returns current cycle.", "Provides total contributed to specified candidate from specified industry for specified cycle.\n\n See : http://www.opensecrets.org/api/?method=candIndByInd&output=doc\n\n @option options [String] :cid (\"\") a CRP CandidateID\n @option options [String] :ind (\"\") a a 3-character industry code\n @option options [optional, String] :cycle (\"\") 2012, 2014 available. leave blank for latest cycle", "Provides sector total of specified politician's receipts.\n\n See : http://www.opensecrets.org/api/?method=candSector&output=doc\n\n @option options [String] :cid (\"\") a CRP CandidateID\n @option options [optional, String] :cycle (\"\") blank values returns current cycle.", "Provides summary fundraising information for a specific committee, industry and Congress number.\n\n See : http://www.opensecrets.org/api/?method=congCmteIndus&output=doc\n\n @option options [String] :cmte (\"\") Committee ID in CQ format\n @option options [String] :congno (\"\") Congress Number (like 110)\n @option options [String] :indus (\"\") Industry code", "Look up an organization by name.\n\n See : https://www.opensecrets.org/api/?method=getOrgs&output=doc\n\n @option options [String] :org (\"\") name or partial name of organization requested", "Provides summary fundraising information for the specified organization id.\n\n See : https://www.opensecrets.org/api/?method=orgSummary&output=doc\n\n @option options [String] :org (\"\") CRP orgid (available via 'get_orgs' method)", "Get a full, expanded path for the given resource name. This is either set\n in the configuration or determined dynamically based on the name.", "Get the first char of the file whether it is gzip'd or not.  No\n need to rewind the stream afterwards.", "Returns parsed data from the new pull request.", "Processes the Site if any of the files have changed.", "Draw buttons for form.\n\n When no CREATE/UPDATE permission, save button is disabled.\n It can be overwritten by options[:save].\n\n When no DELETE permission, delete button is disabled.\n It can be overwritten by options[:delete].\n\n options may have:\n :save::         html options for 'save' button.\n :search_form::  html options for 'search_form' button.\n :delete::       html options for 'delete' button.", "draw default field for col.type\n\n options[type] is passed to each rails helper.  Following types are\n supported:\n * :date\n * :datetime\n * :integer\n * :boolean\n * :text\n\n === INPUTS\n f::         FormBuilder object\n col::       column info returned by AR.columns, or symbol\n options::   options hash passed to each helper.", "draw calendar datetime select\n\n === INPUTS\n f::           Form builder object.\n col_or_sym::  column object returned by rec.class.columns, or symbol\n options::     passed to calendar_date_select", "draw 'edgarj_address' field\n\n The column, which is declared as 'edgarj_address', can be\n drawn by this helper.\n\n === INPUTS\n f::           FormBuilder\n col_or_sym::  column object returned by rec.class.columns, or symbol", "draw bitset checkboxes.\n\n When model class has integer field (e.g. 'flags') and\n Flags module which defines 'bitflag' constant,\n model.flags integer column is drawn as bitset checkboxes.\n Constant name will be translated by config/locales/*.yml\n See ModelPermission for example.\n\n 'flags' column value is calculated at client side by JavaScript.\n\n options is not used now.\n\n === INPUTS\n f::       Form builder object.\n col::     column object returned by rec.class.columns, or symbol\n bitset::  ruby module contains 'bitflag' integer constants\n options:: (not used)", "draw enum selection.\n\n 'Enum' in Edgarj is a module which integer constants are defined.\n draw_enum() draws selection rather than simple integer text field.\n\n Selection-option label is I18 supported by AR human_const_name API.\n See lib/edgarj/model.rb rdoc.\n\n === EXAMPLE\n Followings draws Question module's Priority selection\n on @question.priority integer column:\n\n   <%= edgarj_form do |f| %>\n       :\n     <%= draw_enum(f, :priority) %>\n       :\n   <% end %>\n\n === INPUTS\n f::           Form builder object.\n col_or_sym::  column object returned by rec.class.columns, or symbol\n enum::        enum module.  When nil, guess by column name.\n options::     draw_enum options and/or passed to select helper.\n\n ==== Supported options\n :choice_1st:: additional 1st choice (mainly used SearchForm enum selection)\n :class        AR class which will be used for human_const_name()\n\n === SEE ALSO\n get_enum()::          get enum definition\n draw_column_enum()::  draw enum column in list\n\n FIXME: choices for selection should be cached.", "draw Edgarj flags specific checkbox", "find column info from name", "replacement of button_to_function to avoid DEPRECATION WARNING.\n\n When the js is called just once, onClick is simpler than\n unobtrusive-javascript approach.", "This takes a hash of search parameters, and modifies\n the hash to have the correct key types for the current RETS server", "Take values like true and false, convert them to \"Y\" or \"N\". make collections into joint strings.", "return label of 'rec.attr', where attr is enum value.", "compare array or element for equivalence", "compare what remains", "Because sometimes we have carriage returns and line breaks but we really don't care\n @todo Do we care about line breaks?", "implement to generate search-conditions", "It starts the consumer loop.", "set config file with abs path", "add entities to the repo\n\n pass a single entry or list of file(s) with fully qualified path,\n which must exist,\n\n raises RepoAccessError if something goes wrong\n\n--\n \"svn/client.rb\"  Svn::Client\n  def add(path, recurse=true, force=false, no_ignore=false)\n    Client.add3(path, recurse, force, no_ignore, self)\n  end\n++", "delete entities from the repository\n\n pass single entity or list of files with fully qualified path,\n which must exist,\n\n raises RepoAccessError if something goes wrong", "commit entities to the repository\n\n params single or list of files (full relative path (to repo root) needed)\n\n optional message\n\n raises RepoAccessError if something goes wrong\n returns the revision of the commmit", "get list of entries before doing an update", "get list of entries after doing an update", "discard working copy changes, get current repository entry", "Runs the content through any necessary filters, templates, etc.", "Writes the rendered content to the output file.", "Generate new video file\n\n transcoder = WebVideo::Transcoder.new(\"demo.avi\")\n\n begin\n   transcoder.convert(\"demo.flv\", :resolution => \"480x360\") do |command|\n     command << \"-ar 22050\"\n     command << \"-ab 128k\"\n     command << \"-acodec libmp3lame\"\n     command << \"-vcodec flv\"\n     command << \"-r 25\"\n     command << \"-y\"\n   end\n  rescue WebVideo::CommandLineError => e\n    WebVideo.logger.error(\"Unable to transcode video: #{e.class} - #{e.message}\")\n end\n\n options:\n   :resolution - video resolution", "Returns an array of any currently outstanding invoices for the given customer.\n\ncode must be provided if this response contains more than one customer.", "Info about the given item for the given customer.\nMerges the plan item info with the subscription item info.\n\nitem_code must be provided if the customer is on a plan with more than one item.\n\ncode must be provided if this response contains more than one customer.", "The amount remaining for a given item for a given customer.\n\nitem_code must be provided if the customer is on a plan with more than one item.\n\ncode must be provided if this response contains more than one customer.", "The overage amount for the given item for the given customer.  0 if they are still under their limit.\n\nitem_code must be provided if the customer is on a plan with more than one item.\n\ncode must be provided if this response contains more than one customer.", "The current overage cost for the given item for the given customer.\n\nitem_code must be provided if the customer is on a plan with more than one item.\n\ncode must be provided if this response contains more than one customer.", "Get an array representation of a single customer's current subscription\n @throws CheddarGetter_Response_Exception if the response type is incompatible or if a $code\n is not provided and the response contains more than one customer\n @return array", "Is this customer's account pending paypal preapproval confirmation?", "Mock generate controller for test\n Otherwise test will call rails g controller", "rescue callback sub method to show message by flush on normal http request\n or by popup-dialog on Ajax request.", "Finds a resource by an id and any options passed in\n @param [Client] client The {Client} object to be used\n @param [Hash] option Any additional GET parameters to be added", "Finds, returning nil if it fails", "If rescue_with_original_id is set to true the original ID will be returned when its Obfuscated Id is not found\n\n We use this as the default behaviour on everything except Class.find()", "Brings back the authcode from Stripe and makes another call to Stripe to convert to a authtoken", "increment or decrement attributes on a collection\n\n @example [Usage]\n   * People.all.adjust(:salary => +1000)\n   * Children.all(:age.gte => 18).adjust(:allowance => -100)\n\n @param attributes <Hash> A hash of attributes to adjust, and their adjustment\n @param reload <FalseClass,TrueClass> If true, affected objects will be reloaded\n\n @api public", "Add parameters inside function.\n @param pValue Add a parameter inside function.\n @return if pValue is not String or Hash with more than one element.\n         return nil.", "Add conditional element inside function.\n @param pConditional An object of ConditionalData.\n @return If pConditional is not an instance of ConditionalData,\n         return nil.", "Add repetition element inside function.\n @param pRepetition An object of RepetitionData.\n @return If pRepetition is not RepetitionData instance return nil.", "Add block element inside function.\n @param pBlock An object of BlockData.\n @return If pBlock is not pBlockData instance return nil.", "Copy elements from an object of FunctionAbstract to specific element\n @param fromTo Reference from FunctionAbstract", "Add to a manager conditional or repetition.\n @param pElementToAdd Element wish we want to add.\n @param pMetaData String with name for of element we want to add.\n @param pBehaviour Flag with behaviour.", "Perform an HTTP request with a standardized response\n\n *Params*\n - <code>url</code>: the url on which to perform a get request", "Identifies the language of a piece of text.\n\n The following limitations apply:\n * The array _sentences_ can have at most 100 elements.\n * The text value of an array element cannot exceed 10,000 characters including spaces.\n * The entire text included in the request cannot exceed 50,000 characters including spaces.\n @see https://docs.microsoft.com/en-us/azure/cognitive-services/translator/reference/v3-0-detect\n\n @param sentences [Array<String, TranslatorText::Types::Sentence>] the sentences to process\n @return [Array<TranslatorText::Types::DetectionResult>] the detection results", "Create a new compatibility instance.\n\n content - The Markdown content to render.", "Initialize a new literate Haskell renderer.\n\n content - The literate Haskell code string\n markdowner - The class we'll use to render the HTML (defaults\n              to our RedCarpet wrapper).\n Render the given literate Haskell to a Markdown string.\n\n Returns a Markdown string we can render to HTML.", "Remove Bird-style comment markers from a line of text.\n\n   comment = \"> Haskell codes\"\n   remove_bird_tracks(comment)\n   # => \"Haskell codes\"\n\n Returns the given line of text sans bird tracks.", "Given an Array of lines, pulls from the front of the Array\n until the next line doesn't match our bird tracks regex.\n\n   lines = [\"> code\", \"> code\", \"\", \"not code\"]\n   slurp_remaining_bird_tracks(lines)\n   # => \"code\\ncode\"\n\n Returns the lines mashed into a string separated by a newline.", "Take one sample of CPU usage data for every processor in this computer\n and store them in the +usages+ attribute.", "Should years be included in dates?", "Parse PaynetEasy response from string to Response object\n\n @param    response    [HTTPResponse]    PaynetEasy response as HTTPResponse\n\n @return               [Response]        PaynetEasy response as Response", "Finishes a Pivotal Tracker story", "Reloads a SMS from server", "token is an omniauth hash", "Returns a fastA record ready to print.\n\n If the record is fastA like, the desc and qual can be specified.\n\n @return [String] a printable fastQ sequence record\n\n @example When the record is fastA like, no args\n   rec = Record.new header: \"Apple\", seq: \"ACTG\"\n   rec.to_fastq #=> \"@Apple\\nACTG\\n+\\nIIII\"\n\n @example When the record is fastA like, desc and qual specified\n   rec = Record.new header: \"Apple\", seq: \"ACTG\"\n   rec.to_fastq decs: \"Hi\", qual: \"A\" #=> \"@Apple\\nACTG\\n+Hi\\nAAAA\"\n\n @example When the record is fastA like, can specify fancy qual strings\n   rec = Record.new header: \"Apple\", seq: \"ACTGACTG\"\n   rec.to_fastq decs: \"Hi\", qual: \"!a2\" #=> \"@Apple\\nACTG\\n+Hi\\n!a2!a2!a\"\n\n @example When the record is fastQ like\n   rec = Record.new header: \"Apple\", seq: \"ACTG\", desc: \"Hi\", qual: \"IIII\"\n   rec.to_fastq #=> \">Apple\\nACTG\"\n\n @raise [ParseFasta::Error::ArgumentError] if qual is \"\"", "Create a new ModuleParser, with an optional module code", "save new record\n\n === Permission\n ModelPermission::CREATE on this controller is required.", "Show detail of one record.  Format of html & js should be supported.\n\n === Permission\n ModelPermission::READ on this controller is required.", "save existence modified record\n\n === Permission\n ModelPermission::UPDATE on this controller is required.", "Ajax method to save search conditions\n\n === call flow\n  Edgarj.SearchSavePopup.open() (javascript)\n   (show $('search_save_popup'))\n    Edgarj.SearchSavePopup.submit() (javascript)\n     (copy entered name into $('saved_page_info_name') in form)\n      call :action=>'search_save'\n\n ==== TRICKY PART\n There are two requirements:\n 1. use modal-dialog to enter name to decrese busy in search form.\n 1. send Search Form with name to server.\n\n To comply these, Edgarj.SearchSavePopup copies the entered name to\n 'saved_page_info_name' hidden field and then sends the form which includes\n the copied name.\n\n === Permission\n ModelPermission::READ on this controller is required.", "zip -> address completion\n\n === INPUTS\n params[:zip]::          key to find address info. hyphen is supported.\n params[:adrs_prefix]::  address fields DOM id prefix. e.g. 'org_adrs_0_'\n\n === call flow\n ==== on drawing\n   EdgarjHelper.draw_adrs()       app/helpers/edgarj_helper.rb\n                                 app/views/edgarj/_address.html.erb\n       Example:\n           :\n       <input type=text name='org[adrs_0_zip]'>\n           :\n\n ==== on clicking zip->address button\n   Edgarj.zip_complete()          public/javascripts/edgarj.js\n    Ajax.Request()\n     EdgarjController.zip_complete  app/controllers/edgarj_controller.rb\n      inline RJS to fill address info\n\n=begin\n    def zip_complete\n      zip           = params[:zip].gsub(/\\D/, '')\n      @address      = ZipAddress.find_by_zip(zip) || ZipAddress.new(\n                        :prefecture => '?',\n                        :city       => '',\n                        :other      => '')\n\n      # sanitize\n      @adrs_prefix  = params[:adrs_prefix].gsub(/[^a-zA-Z_0-9]/, '')\n    end\n=end\n download model under current condition\n\n <tt>respond_to...format.csv</tt> approach was not used since\n \\@list is different as follows:\n * csv returns all of records under the conditions\n * HTML returns *just* in specified 'page'.\n\n === Permission\n ModelPermission::READ on this controller is required.\n\n FIXME: file.close(true) deletes files *BEFORE* actually send file\n so that comment it out.  Need to clean these work files.", "derive drawer class from this controller.\n\n If controller cannot guess drawer class, overwrite this.\n\n === Examples:\n * AuthorsController   -> AuthorDrawer\n * UsersController     -> UserDrawer", "cache column type", "Creates an object and persists it.", "HTML5 representation of the timetable", "In this method it is checked the configuration file syntax.\n @param pPath [String] Path to \".kuniri\" file, it means, the\n         configurations.\n @return [Hash] Return a Hash with the configurations read in \".kuniri\",\n     otherwise, raise an exception.", "create page instance by page number.\n if page number you specified was not existed,\n nil would be returned. note, page start at 1, not zero.", "Initialize a Scraper object\n\n *Params*\n - <code>query</code>: a keyword arugment specifying the query to scrape\n\n Fetches articles from Extraction sources and scrapes the results\n\n *Yields*\n - Will yield individually extracted articles\n\n *Raises*\n - Will raise a <code>Transformers::ScrapePatternNotDefined</code> if an article is not in the root domains\n   - Will <code>yield</code> the error if a block is given\n   - Root domains are specified by the <code>article_scrape_patterns.yml</code> file\n   - This root domain will need to be trained, it would be helpful to have a PR created to train the domain\n   - You can train the domain by running <code>NewsScraper::Trainer::UrlTrainer.new(URL_TO_TRAIN).train</code>\n\n *Returns*\n - <code>transformed_articles</code>: The transformed articles fetched from the extracted sources", "Fetches articles from Extraction sources and trains on the results\n\n *Training* is a process where we take an untrained url (root domain\n is not in <code>article_scrape_patterns.yml</code>) and determine patterns and methods\n to match the data_types listed in <code>article_scrape_patterns.yml</code>, then record\n them to the <code>article_scrape_patterns.yml</code> file\n\n *Params*\n - <code>query</code>: a keyword arugment specifying the query to train on", "Create a schema on the class for a particular field.\n Define a single valued field in the schema.\n The first argument is the field name. This must be unique for the class accross all attributes.\n\n The optional second argument can be used to specify the class of the field values. It will default to\n String if not specified. Valid types are String, Integer, Float, Date, Time, DateTime, Boolean, Array, Hash,\n or any class that inherits from EmbeddedDocument.\n\n The last argument can be a hash with any of these keys:\n * :default -\n * :required -\n * :length -\n * :format -\n * :in -", "Define a multi valued field in the schema.\n The first argument is the field name. This must be unique for the class accross all attributes.\n\n The optional second argument should be the class of field values. This class must include EmbeddedDocument.\n If it is not specified, the class name will be guessed from the field name.\n\n The last argument can be :unique => field_name which is used to indicate that the values in the field\n must have unique values in the indicated field name.\n\n The value of the field will always be an EmbeddedDocumentArray and adding and removing values is as\n simple as appending them to the array. You can also call the build method on the array to keep the syntax the\n same as when dealing with ActiveRecord has_many associations.", "Returns an array of all the classes for the day", "Returns the earliest class in the module", "Saves the task\n\n Save the task, either creating a new task on the todoist service, or\n updating a previously retrieved task with new content, priority etc.", "Does a complete replacement of the attributes.  Multiple attributes can\n be given as either multiple arguments or as an array.", "Build SearchForm object from ActiveRecord 'klass' and attrs.\n\n === INPUTS\n klass:: ActiveRecord\n attrs:: hash of key=>value pair\n map attribute name to hash entry.\n This mechanism is required to be used in 'form_for' helper.\n\n When column type is integer and has digits value, return integer.\n This is required for selection helper.\n Even it is integer but has no value, keeps blank.\n\n When attribute name ends '=', assignment to hash works.\n\n === EXAMPLE\n s = Searchform.new(Product, :name=>'a')\n s.name\n s.conditions      # [\"name=?\", \"a\"]\n s.name = 'b'      # method_missing('name=', 'b') is called\n s.conditions      # [\"name=?\", \"b\"]", "Parse a WebSocket URL.\n @example Parse\n   url = LibWebSocket::URL.new\n   url.parse('wss://example.com:3000')\n   url.host   # => example.com\n   url.port   # => 3000\n   url.secure # => true", "Construct a WebSocket URL.\n @example Construct\n   url = LibWebSocket::URL.new\n   url.host = 'example.com'\n   url.port = '3000'\n   url.secure = true\n   url.to_s # => 'wss://example.com:3000'", "Get a new logger instance for supplied named logger or class name.\n\n All adapters must ensure that they provide the same API for creating\n new loggers. Each logger has a name, further possible options are:\n\n - `:to`, filename or IO, where to write the output to\n - `:level`, Fixnum, starting log level, @see `Loggr::Severity`\n - `:marker`, String, name of the category/marker\n\n If an adapter does not support setting a specific option, just\n ignore it.", "Try to get adapter class from Symbol, String or use Object as-is.", "name=\n Converts name into proper XML node name\n @param [String, Symbol] val Raw name", "name_parse_special_characters\n Custom Setter for @value instance method", "Puts every statement in a single line\n @param pLine Line of the file to be analysed.", "If a source object was given, it is used to search for the DN.\n Otherwise, an exception is raised.", "Join all DC elements with periods.", "Copies the original Hpricot jnlp into @local_jnlp and\n modifies it to reference resources in the local cache.", "Returns an array containing all the local paths for this jnlp's resources.\n\n Pass in the options hash: (:remove_jruby => true) and\n the first resource that contains the string /jruby/ will\n be removed from the returned array.\n\n Example:\n\n   resource_paths(:remove_jruby => true)\n\n This is useful when the jruby-complete jar has been included\n in the jnlp and you don't want to require that jruby into this\n specific instance which is already running jruby.\n\n Here's an example of a jruby resource reference:\n\n    \"org/jruby/jruby/jruby__V1.0RC2.jar\"\n\n Pass in the options hash: (:include_pack_gz => true) and the\n resources returned with be pack.gz jars instead of regular jars", "Writes a shell script to the local filesystem\n that will export a modified CLASSPATH environmental\n variable with the paths to the resources used by\n this jnlp.\n\n Writes a jnlp to current working directory\n using name of original jnlp.\n\n Pass in the optional hash: (:remove_jruby => true) and\n the first resource that contains the string /jruby/ will\n be removed from the classapath shell script.\n\n Example:\n\n   write_local_classpath_shell_scrip(:remove_jruby => true)", "Writes a local copy of the original jnlp .\n\n Writes jnlp to path of original jnlp into current working directory.\n A number of options can be passed modify the result.\n\n Example:\n\n   server = 'http://localhost:4321'\n   jnlp_cache = 'jnlp'\n   new_href = \"#{server}#{jnlp.path}\"\n   jnlp.write_jnlp( { :dir => jnlp_cache, :jnlp => { :codebase => server, :href => new_href }, :snapshot => true } )\n\n Writes a duplicate of the remote jnlp to a local path rooted at 'jnlp/'.\n With the codebase and href re-written referencing: 'http://localhost:4321'\n\n In addition a duplicate of the versioned jnlp is written without the version string as a snapshot\n jnlp and the version string is written to this file:\n\n   jnlp-name-CURRENT_VERSION.txt", "Writes a local file-based jnlp.\n\n Will write jnlp to current working directory\n using name of original jnlp with \"local-\" prefix.", "This will add all the jars for this jnlp to the effective\n classpath for this Java process.\n\n *If* you are already running in JRuby *AND* the jnlp references a\n JRuby resource the JRuby resource will not be required.", "Creates the text field based date picker with the calendar widget without a model object.", "Copies the file referenced in _source_ to _destination_\n _source_ can be a url or local file path\n _destination_ must be a local path\n\n Will copy file if the file does not exists\n OR if the the file exists but the signature has\n not been successfully verified.\n\n Returns file size if cached succesfully, false otherwise.", "Verifies signature of locallly cached resource\n\n Returns boolean value indicating whether the signature of the\n cached local copy of the resource verified successfully\n\n The value return is nil if no local cache has been created.\n\n Example:\n\n   true || false || nil", "draw 'clear' link for 'belongs_to' popup data-entry field\n\n === INPUTS\n f::           FormBuilder object\n col_name::    'belongs_to' column name\n popup_field:: Edgarj::PopupHelper::PopupField object\n parent_name:: initial parent name", "draw 'belongs_to' popup data-entry field\n\n This is usually used with draw_belongs_to_label().\n\n @param f          [FormBuilder] FormBuilder object\n @param popup_path [String]      popup path(url)\n @param col_name   [String]      'belongs_to' column name\n @param model      [AR]          data model class", "Is flag in column_value on?", "get bitset Module.\n\n When ColBitset(camelized argument col name + 'Bitset') module exists,\n the ColBitset is assumed enum definition.", "draw bitset column in list.\n\n === INPUTS\n rec::         AR object\n col_or_sym::  column object returned by rec.class.columns\n bitset::      Module which contains bitset constants\n\n === SEE ALSO\n get_bitset()::        get bitset definition\n draw_bitset()::       draw bitste checkboxes field\n draw_column_enum()::  draw bitset column in list", "draw enum column in list.\n\n When enum for col is defined, constant string (rather than rec.col value)\n is drawn.  See get_enum() for more detail of enum for the col.\n\n === EXAMPLE\n Question has status attribute and Question::Status enum.\n When question.status == 300,\n draw_column_enum(question, status_col, Question::Status) returns\n I18n.t('WORKING').\n\n Where:\n * question is Question AR object.\n * status_col is one of Question.columns object for status column.\n\n === INPUTS\n rec::         AR object\n col_or_sym::  column object returned by rec.class.columns\n enum::        Module which contains constants\n\n === SEE ALSO\n get_enum()::            get enum definition\n draw_enum()::           draw enum selection field\n draw_column_bitset()::  draw bitset column in list", "return address element string or ''", "model & adrs_prefix -> address string", "return true if login user has enough permission on current controller.", "Add serializer to a class.\n\n Usage:\n\n   has_serialized :settings do |settings|\n     settings.define :tw_share, default: true, type: :boolean\n     settings.define :fb_share, default: true, type: :boolean\n   end", "Parse the module table for any classes", "Create a Class from the given data element", "Create the week range array for the given week string", "Go through all the data, and generate the output\n @param pParser\n @return", "methods from application_helper", "Jinda Rake Task", "Given an object's type, detrmine and return its af-model", "This will start the jnlp locally in Java without\n using Java Web Start\n\n This method works in MRI by forking and using exec\n to start a separate javavm process.\n\n\n JRuby Note:\n\n In JRuby the jars are required which makes them available\n to JRuby -- but to make this work you will need to also\n included them on the CLASSPATH.\n\n The convienence method Jnlp#write_local_classpath_shell_script\n can be used to create a shell script to set the classpath.\n\n If you are using the JRuby interactive console you will need to\n exclude any reference to a separate jruby included in the jnlp.\n\n Example in JRuby jirb:\n\n   j = Jnlp::Otrunk.new('http://rails.dev.concord.org/sds/2/offering/144/jnlp/540/view?sailotrunk.otmlurl=http://continuum.concord.org/otrunk/examples/BasicExamples/document-edit.otml&sailotrunk.hidetree=false', 'cache'); nil\n   j.write_local_classpath_shell_script('document-edit_classpath.sh', :remove_jruby => true)\n\n Now exit jirb and execute this in the shell:\n\n   source document-edit_classpath.sh\n\n Now restart jirb:\n\n   j = Jnlp::Otrunk.new('http://rails.dev.concord.org/sds/2/offering/144/jnlp/540/view?sailotrunk.otmlurl=http://continuum.concord.org/otrunk/examples/BasicExamples/document-edit.otml&sailotrunk.hidetree=false', 'cache'); nil\n   j.run_local\n\n You can optionally pass in jnlp and main-class arguments\n If these paramaters are not present Otrunk#run_local will\n use:\n\n   net.sf.sail.emf.launch.EMFLauncher2\n\n as the default main class and the default argument in\n the original jnlp.", "Render the QR code as an inline image for iTerm2.\n Returns a string.", "Removes a class from the timetable", "Returns an array of the given day's classes", "Returns the class at the given day & time", "Returns the earliest class on the timetable", "Returns an array of time conflicts found in the timetable", "renders hashes with keys in alpha-sorted order", "Creates an HTML label\n @param string [String] the HTML to parse\n @return [Object] a HTML label", "Creates a new edge\n @param name [String] the name (identifier) of the edge\n @param tail [Node] the edge's tail node\n @param head [Node] the edge's head node\n @param attrs [Hash{String, Symbol => Object}] the attributes\n to associate with this edge\n @see http://www.graphviz.org/doc/info/attrs.html Node, Edge and Graph Attributes\n @return [Edge] the newly created edge", "Creates a new sub-graph\n @param name [String] the name (identifier) of the sub-graph\n @param attrs [Hash{String, Symbol => Object}] the attributes\n to associate with this sub-graph\n @see http://www.graphviz.org/doc/info/attrs.html Node, Edge and Graph Attributes\n @return [SubGraph] the newly created sub-graph", "Renders the graph to an images and saves the result to a file\n @param filename [String] the filename\n @param format [String] the image format to use, e.g. 'svg', 'pdf' etc.\n @param layout [String] the layout to use, e.g. 'dot' or 'neato' etc.\n @return [nil]", "Renders the graph to an image and returns the result as a string\n @param format [String] the image format to use, e.g. 'svg', 'pdf' etc.\n @param layout [String] the layout to use, e.g. 'dot' or 'neato' etc.\n @return [String] the rendered graph in the given format", "Setup basic configurations for make attribute work correctly. It is\n mandatory to call it with the correct parameters in the child class.\n @param pVariableBehaviour Reference to a variable behaviour.", "Analyse source code.\n @param pPath Path of file to be analysed.", "Start parse in the project.", "Get callback processor by callback type\n\n @param    callback_type   [String]              Callback type\n\n @return                   [CallbackPrototype]   Callback processor", "Load callback class file and return new callback object\n\n @param    callback_file     [String]              Callback class file\n @param    callback_class    [String]              Callback class\n @param    callback_type     [String]              Callback type\n\n @return                     [CallbackPrototype]   Callback object", "Compares this node with another node, returns true if the nodes are equal.\n Returns true if all children of the current object and the other object are equal.", "Returns true if all leaf values of the current object and the other object are equal.", "Run a given block and calculate the average execution time.\n The block will be executed 1 times by default.\n\n   benchmark { do something }\n   benchmark(100) { do something }", "Formats keys to melt arguments", "Constructs melt arguments from options hash", "Renders the project", "Selects certain options", "Prints a table and passes through the options hash", "Transforms certain options values", "Array of items in the collection\n @return [Array]", "Read a field. The field param must be a FieldDefinition and the context should be the record\n which is being read from.", "Write a field. The field param must be a FieldDefinition and the context should be the record\n which is being read from.", "Look for one of the mapped keys, and return the value or throw method missing error.", "Add global variable inside file.\n @param pVariable A single VariableGlobalData object or list to be added.", "return true if the role has enough permission on the controller.\n\n If user role is 'admin' then all operations are permitted.\n\n Always return false if the user-group is not ROLE.\n\n if requested_flags is omitted, just checks existence of\n model_permissions and doesn't check CRUD level.", "Any application that wants to access API endpoints that require authorised\n  access must receive an authorisation token from SAFE Launcher.\n\n Reading public data using the DNS API does not require an authorisation\n  token. All other API endpoints require authorised access.\n\n The application will initiate the authorisation request with information\n  about the application itself and the required permissions. SAFE Launcher\n  will then display a prompt to the user with the application information\n  along with the requested permissions. Once the user authorises the\n  request, the application will receive an authorisation token. If the user\n  denies the request, the application will receive an unauthorised error\n  response.\n\n Usage: my_client.auth.auth([\"SAFE_DRIVE_ACCESS\"])\n Fail: nil\n Success: {token: \"1222\", \"permissions\": []}\n\n Reference: https://maidsafe.readme.io/docs/auth", "Check whether the authorisation token obtained from SAFE Launcher is still\n  valid.\n\n Usage: my_client.auth.is_token_valid()\n Fail: false\n Success: true\n\n Reference: https://maidsafe.readme.io/docs/is-token-valid", "Revoke the authorisation token obtained from SAFE Launcher.\n\n Usage: my_client.auth.revoke_token()\n Fail: false\n Success: true\n\n Reference: https://maidsafe.readme.io/docs/revoke-token", "Create a public or private directory either in the application's root\n  directory or in SAFE Drive.\n Only authorised requests can create a directory.\n\n Usage: my_client.nfs.create_directory(\"/photos\")\n Adv.Usage: my_client.nfs.create_directory(\"/photos\", meta: \"some meta\", root_path: 'drive', is_private: true)\n Fail: {\"errorCode\"=>-505, \"description\"=>\"NfsError::FileAlreadyExistsWithSameName\"}\n Success: true\n\n Reference: https://maidsafe.readme.io/docs/nfs-create-directory", "Fetch a directory.\n Only authorised requests can invoke this API.\n\n Usage: my_client.nfs.get_directory(\"/photos\", root_path: 'drive')\n Fail: {\"errorCode\"=>-1502, \"description\"=>\"FfiError::PathNotFound\"}\n Success: {\"info\"=> {\"name\"=> \"my_dir\", ...}, ...}\n\n Reference: https://maidsafe.readme.io/docs/nfs-get-directory", "Create a file.\n Only authorised requests can invoke the API.\n\n Usage: my_client.nfs.create_file(\"/docs/hello.txt\", \"Hello World!\")\n Adv.Usage: my_client.nfs.create_file(\"/docs/hello.txt\", meta: \"some meta\", root_path: \"app\", content_type: \"text/plain\")\n Fail: {\"errorCode\"=>-505, \"description\"=>\"NfsError::FileAlreadyExistsWithSameName\"}\n Success: true\n\n Reference: https://maidsafe.readme.io/docs/nfsfile", "Fetch the metadata of a file.\n Only authorised requests can invoke the API.\n\n Usage: my_client.nfs.get_file_meta(\"/docs/hello.txt\")\n Adv.Usage: my_client.nfs.get_file_meta(\"/docs/hello.txt\", root_path: \"app\")\n Fail: {\"errorCode\"=>-505, \"description\"=>\"NfsError::FileAlreadyExistsWithSameName\"}\n Success:\n\n Reference: https://maidsafe.readme.io/docs/nfs-get-file-metadata", "Read a file.\n The file can be streamed in chunks and also fetched as partial content\n  based on the range header specified in the request.\n Only authorised requests can invoke the API.\n\n Usage: my_client.nfs.get_file(\"/docs/hello.txt\")\n Adv.Usage: my_client.nfs.get_file(\"/docs/hello.txt\", range: \"bytes 0-1000\", root_path: \"app\")\n Fail: {\"errorCode\"=>-1503, \"description\"=>\"FfiError::InvalidPath\"}\n Success: {\"headers\"=>{\"x-powered-by\"=>\"Express\", \"content-range\"=>\"bytes 0-4/4\", \"accept-ranges\"=>\"bytes\", \"content-length\"=>\"4\", \"created-on\"=>\"2016-08-14T12:51:18.924Z\", \"last-modified\"=>\"2016-08-14T12:51:18.935Z\", \"content-type\"=>\"text/plain\", \"date\"=>\"Sun, 14 Aug 2016 13:30:07 GMT\", \"connection\"=>\"close\"}, \"body\"=>\"Test\"}\n\n Reference: https://maidsafe.readme.io/docs/nfs-get-file", "Move or copy a file", "Delete a file.\n Only authorised requests can invoke the API.\n\n Usage: my_client.nfs.delete_file(\"/docs/hello.txt\")\n Adv.Usage: my_client.nfs.delete_file(\"/docs/hello.txt\", root_path: \"app\")\n Fail: {\"errorCode\"=>-1503, \"description\"=>\"FfiError::InvalidPath\"}\n Success: true\n\n Reference: https://maidsafe.readme.io/docs/nfs-delete-file", "Register a long name and a service.\n Only authorised requests can invoke the API.\n\n Usage: my_client.dns.register_service(\"my-domain\", \"www\", \"/sources\")\n Fail: {\"errorCode\"=>-1503, \"description\"=>\"FfiError::InvalidPath\"}\n Success: true\n\n Reference: https://maidsafe.readme.io/docs/dns-register-service", "create or update", "Save the PDF to the file\n @param file [String,IO] if file is a String, the PDF is moved to the path indicated (most efficient).\n        Otherwise, file is considered an instance of IO, and write is called on it with the PDF contents\n @return [String,IO] the file", "Compile the Latex template into a PDF file\n @yield [Pathname] complete path to the PDF file\n @raise [LatexError] if the xelatex process does not complete successfully", "Runs the ERB pre-process on the latex file\n @return [String] latex with ERB substitutions performed\n @raise [LatexError] if the xelatex process does not complete successfully", "Execute xelatex on the file.\n @param latex [String] contents of the template after running ERB on it\n @param dir   [String] path to the temporary working directory", "Generates the SQL UPDATE query.\n @return [String] The SQL update query", "Returns a hash of attributes.", "Note the values are not typecast and thus must be strings.", "Delegates to +read_attribute+ or +write_attribute+.  Pops an element out\n of its set if the attribute is marked SINGLE-VALUE.", "Refetches the attributes from the server.", "Sort all the parsed classes into modules", "Create new instance of Fetcher\n\n username - username\n password - password\n vadnumber - vadnumber\n Fetch and unzip report from itunes connect\n\n options - Hash of options:\n  - :type_of_report can only be REPORT_TYPE_SALES at the moment\n  - :date_type either DATE_TYPE_DAILY or DATE_TYPE_WEEKLY, default DATE_TYPE_DAILY\n  - :report_type either REPORT_OPT_IN or REPORT_SUMMARY, default REPORT_SUMMARY\n  - :report_date date in YYYYMMDD\n\n Returns text file downloaded and unzipped from iTunes", "create new Context\n @param directory [String] directory to use as a base for finding partials\n @param data [Hash]\n include another latex file into the current template", "Add attribute to class data, notice the possibility of call this\n method more than one time.\n @param pAttribute Attribute to be added inside class. This attribute\n         is a list of AttributeData.", "Assignes a set of tags to a single bundle,\n wipes away previous settings for bundle.\n\n   # create from a bundle\n   d.bundles_set(WWW::Delicious::Bundle.new('MyBundle'), %w(foo bar))\n\n   # create from a string\n   d.bundles_set('MyBundle', %w(foo bar))\n\n\n Raises::  WWW::Delicious::Error\n Raises::  WWW::Delicious::HTTPError\n Raises::  WWW::Delicious::ResponseError", "Renames an existing tag with a new tag name.\n\n   # rename from a tag\n   d.bundles_set(WWW::Delicious::Tag.new('old'), WWW::Delicious::Tag.new('new'))\n\n   # rename from a string\n   d.bundles_set('old', 'new')\n\n\n Raises::  WWW::Delicious::Error\n Raises::  WWW::Delicious::HTTPError\n Raises::  WWW::Delicious::ResponseError", "Returns a list of the most recent posts, filtered by argument.\n\n   # get the most recent posts\n   d.posts_recent()\n\n   # get the 10 most recent posts\n   d.posts_recent(:count => 10)\n\n\n === Options\n <tt>:tag</tt>::   a tag to filter by. It can be either a <tt>WWW::Delicious::Tag</tt> or a +String+.\n <tt>:count</tt>:: number of items to retrieve. (default: 15, maximum: 100).", "Returns a list of all posts, filtered by argument.\n\n   # get all (this is a very expensive query)\n   d.posts_all\n\n   # get all posts matching ruby\n   d.posts_all(:tag => WWW::Delicious::Tag.new('ruby'))\n\n\n === Options\n <tt>:tag</tt>:: a tag to filter by. It can be either a <tt>WWW::Delicious::Tag</tt> or a +String+.", "Returns a list of dates with the number of posts at each date.\n\n   # get number of posts per date\n   d.posts_dates\n   # => { '2008-05-05' => 12, '2008-05-06' => 3, ... }\n\n   # get number posts per date tagged as ruby\n   d.posts_dates(:tag => WWW::Delicious::Tag.new('ruby'))\n   # => { '2008-05-05' => 10, '2008-05-06' => 3, ... }\n\n\n === Options\n <tt>:tag</tt>:: a tag to filter by. It can be either a <tt>WWW::Delicious::Tag</tt> or a +String+.", "Deletes the post matching given +url+ from del.icio.us.\n +url+ can be either an URI instance or a string representation of a valid URL.\n\n This method doesn't care whether a post with given +url+ exists.\n If not, the execution will silently return without rising any error.\n\n   # delete a post from URI\n   d.post_delete(URI.parse('http://www.foobar.com/'))\n\n   # delete a post from a string\n   d.post_delete('http://www.foobar.com/')", "Initializes the HTTP client.\n It automatically enable +use_ssl+ flag according to +@base_uri+ scheme.", "Composes an HTTP query string from an hash of +options+.\n The result is URI encoded.\n\n   http_build_query(:foo => 'baa', :bar => 'boo')\n   # => foo=baa&bar=boo", "Sends an HTTP GET request to +path+ and appends given +params+.\n\n This method is 100% compliant with Delicious API reference.\n It waits at least 1 second between each HTTP request and\n provides an identifiable user agent by default,\n or the custom user agent set by +user_agent+ option\n when this instance has been created.\n\n   request('/v1/api/path', :foo => 1, :bar => 2)\n   # => sends a GET request to /v1/api/path?foo=1&bar=2", "Makes the real HTTP request to given +uri+ and returns the +response+.\n This method exists basically to simplify unit testing with mocha.", "Parses the response of an Update request\n and returns the update Timestamp.", "Prepares the params for a `tags_rename` call\n and returns a Hash with the params ready for the HTTP request.\n\n Raises::  WWW::Delicious::Error", "Prepares the +post+ param for an API request.\n\n Creates and returns a <tt>WWW::Delicious::Post</tt> instance from <tt>post_or_values</tt>.\n <tt>post_or_values</tt> can be either an Hash with post attributes\n or a <tt>WWW::Delicious::Post</tt> instance.", "Prepares the +bundle+ param for an API request.\n\n Creates and returns a <tt>WWW::Delicious::Bundle</tt> instance from <tt>name_or_bundle</tt>.\n <tt>name_or_bundle</tt> can be either a string holding bundle name\n or a <tt>WWW::Delicious::Bundle</tt> instance.", "Prepares the +tag+ param for an API request.\n\n Creates and returns a <tt>WWW::Delicious::Tag</tt> instance from <tt>name_or_tag</tt>.\n <tt>name_or_tag</tt> can be either a string holding tag name\n or a <tt>WWW::Delicious::Tag</tt> instance.", "Checks whether user given +params+ are valid against a defined collection of +valid_params+.\n\n === Examples\n\n   params = {:foo => 1, :bar => 2}\n\n   compare_params(params, [:foo, :bar])\n   # => valid\n\n   compare_params(params, [:foo, :bar, :baz])\n   # => raises\n\n   compare_params(params, [:foo])\n   # => raises\n\n Raises::  WWW::Delicious::Error", "Returns a list of deals.\n\n   The API returns an ordered list of deals currently running for a given Division.\n\n   Priority is based on position within the response (top deals are higher in priority).\n\n\n\n @see http://sites.google.com/site/grouponapi/divisions-api Groupon API docs\n\n\n\n @option options [String] :lat (Latitudinal coordinates based on IP of API request) Latitude of geolocation to find deals\n\n @option options [String] :lng (Longtitudinal coordinates based on IP of API request) Longitude of geolocation to find deals\n\n @return [Array<Hashie::Mash>] an array of deals", "Make sure that if we write to this array, we promote any inputs\n to their Sycl equivalents. This lets dot notation, styled YAML,\n and other Sycl goodies continue.", "Make sure that if we write to this hash, we promote any inputs\n to their Sycl equivalents. This lets dot notation, styled YAML,\n and other Sycl goodies continue.", "returns the earliest `created_at` of a given class\n returns `Time.now` if none is available", "Reads a file or from STDIN if piped", "Delegates to Open3", "Symbolizes a hash's keys", "return a single piece of configuration by key\n\n @param key [String] the configuration to return\n @return [String, Integer, FixNum, Array, Hash] the value of the configuration from the resolved configuration", "Handling the class creation.\n @param pType [String] Type of object\n @return Return an object of language.", "Concatenate an array of objects to the array. The objects must either be an EmbeddedDocument of the\n correct class, or a Hash.", "Similar add an EmbeddedDocument to the array and return the object. If the object passed\n in is a Hash, it will be used to make a new EmbeddedDocument.", "Do a put request\n @param [String] url the url to put\n @param [Hash] options Additonal options to be passed", "Filter the response after checking for any errors", "Handling the output tyoe.\n @param pType [String] Type of object\n @return Return an object of output.", "Send everything else to master.", "Process API gateway Response and update Payment transaction\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for update\n @param    callback_response     [CallbackResponse]      PaynetEasy callback\n\n @return                         [CallbackResponse]      PaynetEasy callback", "Validate callback response control code\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for control code checking\n @param    callback_response     [CallbackResponse]      Callback for control code checking", "Updates Payment transaction by Callback data\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for updating\n @param    callback_response     [CallbackResponse]      Callback for payment transaction updating", "Run the given block and cleanly report any errors", "Handles resources such as 'tickets'.\n @return [Collection] Collection instance for resource", "Start Kuniri tasks based on configuration file. After read\n configuration file, find all files in source directory.", "Publishes the branch and opens the pull request", "Check, if payment transaction is finished and payment is not new.\n\n @param    payment_transaction   [PaymentTransaction]    Payment transaction for validation", "Sets current tenant from ApplicationController into a Thread\n local variable.  Works only with thread-safe Rails as long as\n it gets set on every request\n @return [Symbol] the current tenant key in the thread", "Replace current_tenant with @tenant\n during the execution of @blk", "Convert a value to the proper class for storing it in the field. If the value can't be converted,\n the original value will be returned. Blank values are always translated to nil. Hashes will be converted\n to EmbeddedDocument objects if the field type extends from EmbeddedDocument.", "notice_success\n notice_error\n notice_warning\n notice_progress\n notice_notice    - default. An alias for `notice`", "Retrieves human readable attributes from the yaml file via Dictionary", "Checks if package is installed.\n @param package [String] package name to check\n @return [Boolean] if package is installed", "Tool specific package lookup methods below.", "Assures that the collections are empty before proceeding", "Empties the collections, only if they were empty to begin with", "Takes a schedule as a String.", "close html tags", "limit by paragraphs", "Removes HTML tags from a string. Allows you to specify some tags to be kept.\n @see http://codesnippets.joyent.com/posts/show/1354#comment-293", "def inverse_euclidian; left_inverse_euclidian; end", "ground ring must be a field", "Set the overwrite option to true to force overwriting existing translations.", "Restituisce un hash con tutti i parametri da implementare sulla ricerca", "Si occupa di aggiornare i valori interni di ricerca", "Merges the supplied argument hash into a single criteria\n\n Options:\n\n criteria_conditions: Hash of criteria keys, and parameter values\n\n Example:\n\n <tt>criteria.fuse(:where => { :field => \"value\"}, :limit => 20)</tt>\n\n Returns <tt>self</tt>", "Create the new +Criteria+ object. This will initialize the selector\n and options hashes, as well as the type of criteria.\n\n Options:\n\n type: One of :all, :first:, or :last\n klass: The class to execute on.\n Merges another object into this +Criteria+. The other object may be a\n +Criteria+ or a +Hash+. This is used to combine multiple scopes together,\n where a chained scope situation may be desired.\n\n Options:\n\n other: The +Criteria+ or +Hash+ to merge with.\n\n Example:\n\n <tt>criteria.merge({ :conditions => { :title => \"Sir\" } })</tt>", "Filters the unused options out of the options +Hash+. Currently this\n takes into account the \"page\" and \"per_page\" options that would be passed\n in if using will_paginate.\n\n Example:\n\n Given a criteria with a selector of { :page => 1, :per_page => 40 }\n\n <tt>criteria.filter_options</tt> # selector: { :skip => 0, :limit => 40 }", "Update the selector setting the operator on the value for each key in the\n supplied attributes +Hash+.\n\n Example:\n\n <tt>criteria.update_selector({ :field => \"value\" }, \"$in\")</tt>", "Return a boolean indicating whether the version of ActiveRecord matches\n the constraints in the args.\n\n == Arguments\n Optional comparator function as a symbol followed by a version number\n as an integer or float.\n\n If the version is an integer only the major version is compared.\n if the version is a float the major.minor version is compared.\n\n If called with no arguments returns a boolean indicating whether ActiveRecord\n is defined.\n\n == Example\n active_record?(3) => true if ActiveRecord major version is 3\n active_record?(3.0) => true if ActiveRecord major.minor version is 3.0\n active_record?(:>=, 3) => true if ActiveRecord major version is >= 3\n active_record?(:>=, 3.1) => true if ActiveRecord major.minor version is >= 3.1", "Initializes a new Client object\n\n @param options [Hash]\n @return [VulnDBHQ::Client]\n ************************************************************* PrivatePage\n Returns a private page\n\n @see http://support.securityroots.com/vulndbhq_api_v2.html#model-private-page\n @authentication_required Yes\n @raise [VulnDBHQ::Error::Unauthorized] Error raised when supplied user credentials are not valid.\n @return [VulnDBHQ::PrivatePage] The requested messages.\n @param id [Integer] A VulnDB HQ private page ID.\n @param options [Hash] A customizable set of options.\n @example Return the private page with the id 87\n VulnDBHQ.private_page(87)", "Initialize a new instance\n\n @param [Chain::DSL] chain_dsl\n   the chain dsl tailored for the environment\n\n @return [undefined]\n\n @api private\n Inherit a new instance from self, merging the {Chain::DSL}\n\n @param [Dispatcher::Registry] actions\n   the mutable action registry\n\n @param [Proc] block\n   a block to instance_eval inside a {DSL} instance\n\n @return [Environment]\n\n @api private", "Register a new chain under the given +name+\n\n @param [#to_sym] name\n   the new chain's name\n\n @param [Chain] other\n   the chain to build on top of\n\n @param [Chain] exception_chain\n   the chain to invoke in case of uncaught exceptions in handlers\n\n @return [Chain]\n   the registered chain\n\n @api private", "Create a message for a group\n\n @return [Hashie::Mash] Hash representing the message\n @see https://dev.groupme.com/docs/v3#messages_create\n @param group_id [String, Integer] Id of the group\n @param text [String] Text of the message\n @param attachments [Array<Hash>] Array of attachments", "List messages for a group\n\n @return [Array<Hashie::Mash>] Array of hashes representing the messages\n @see https://dev.groupme.com/docs/v3#messages_index\n @param group_id [String, Integer] Id of the group\n @param options [Hash] options hash that will be passed to the groupme call\n @param fetch_all [Boolean] if true, fetches all messages for the group", "Recursively creates the necessary directories and make the symlink.", "This function return the list of partials for a specific module.", "This function create a correct partial object for the header.", "This function return the list of widgets for a specific module.", "This function create a correct widget object for the header.", "This function returns the list of the items for the menu for a specific module.", "This function create a correct menu item object for the menu.", "This function create a correct menu sub itam object for the menu.", "This function check the title name and, if it need a translaction, it return the value.", "This function return the lists of assets for a specific module.", "access policy create", "Initializes a new Room instance.\n\n @param id [String] The room ID.\n @param users [Users] The User manager.\n @param matrix [Matrix] The Matrix API instance.\n Process join events for this room.\n @param data [Hash] Event data containing state and timeline events.", "Process leave events for this room.\n @param data [Hash] Event data containing state and timeline events up\n   until the point of leaving the room.", "Process an invite event for this room.\n @param event [Hash] Event data.", "Gets element value by element's name.\n If name is lambda - returns lambda's result\n If name is present in the resolvers' elements hash - returns element's value\n If name is present in the resolvers' params hash - returns params value\n Otherwise returns the argument without changes", "Gets dependency rules hash and returns true or false depending on\n the result of a recursive processing of the rules", "Method resolves AND or OR conditions.\n Walks through the arguments and resolves their dependencies.", "ancestor is included only when contributes some methods", "This function return a string used on the HTML option to\n set a an option value selected or not.", "load target with +name+.", "Locate a file with name in one of the target_dirs", "return the total number of possible permutations of", "pass calls to missing methods to the constructor iff\n the constructor's class directly defines that method", "accurately report ability to respond to methods passed\n to constructor", "Get various bits of info for a given movie id.\n\n @param [String] movie_id The id of the movie to get information for.\n @param [String] action The type of information to request.\n\n @note Valid action values are \"details\", \"reviews\", \"cast\", \"main\"\n\n @return [Hash] A hash of information for a specific movie id.", "Provides access to the various lists that Rotten Tomatoes provides.\n\n @param [String] action The type of list to request.\n\n @return [Array<BadFruit::Movie>] An array of programs contains in the requested list.", "Parse the movies out of a hash.\n\n @param [Hash] hash The has to convert into an array of movies.\n\n @return [Array<BadFruit::Movie>] An array of BadFruit::Movie objects.", "Parse the actors out of a movie hash.\n\n @param [Hash] hash The movie has to extract the actors out of.\n\n @return [Array<BadFruit::Actor>] An array of BadFruit::Actor objects.", "Get the response of a given URL.\n\n @param [String] url The URL to elicit a response from.\n\n @return [Hash] The response from the server, or nil if there is no response.", "Syncs against the server.\n\n If an API error occurs during sync, it will be rescued and broadcasted\n as `:sync_error`.", "Process the sync result.\n\n @param events [Hash] The events to sync.", "returns the name in small case of the class of the currently signed in resource\n@example : will return 'user' or 'admin'", "SHOULD THE RESOURCE SIGN IN OPTIONS BE SHOWN IN THE NAV BAR?", "Adds an argument to this parameter. Arguments can be accessed inside the\n application code using the args method.\n\n @param [String] arg The argument to add to the supplied arguments of this\n        parameter\n @raise [ExtraArgumentError] if the parameter has all required arguments\n        supplied and does not take optional arguments\n @return [Array] The supplied arguments of this parameter\n @see #[]\n @see #args\n @since 0.3.0", "Checks the arguments for this parameter\n\n @raise [MissingArgumentError] if there are not enough arguments for\n        this parameter\n @since 0.3.0", "If a named argument with the specified method name exists, a call to that\n method will return the value of the argument.\n\n @param (see ClassMethods#method_missing)\n @see #args\n @see #[]\n\n @example\n   option :user, [:name] do\n     @user = name\n   end", "This method is not ideal as it doesn't guarantee order in case of multi-channel subscription", "Create a new region with specified +pos+ as top left corner and +size+\n as width and height. The stored positions are copies of the passed\n position and size to avoid aliasing.\n\n Alternatively, can be initialized with 2 +Point+s.\n Return whether the region contains the specified +row+ and +col+\n Alternatively, can be passed a +Point+", "Duplicate a Region, must be done explicitly to avoid aliasing.\n Draw a rectangle on the specified +surface+ at the specified +z_order+\n and with the specified +colour+", "Return whether the passed Point +pt+ is contained within the current\n Region.", "select the optimisation algorithm to use", "Runs the experiment until the completion criteria\n are met. On completion, returns the best parameter\n set.", "create a guaranteed random temporary directory for storing outputs\n return the dirname", "set experiment ID with either user provided value, or date-time\n as fallback", "Registers a new callback in the registry. This will add a new method\n matching +key+ to the registry that can be used both outside the\n registry and when registering other callbacks dependant of the\n current entry. Results from the callback will not be cached, meaning\n that the callback may return a different object every time.\n\n @param [String|Symbol] key\n @param [Proc|nil] proc\n @return [nil]", "Registers a new callback in the registry. This will add a new method\n matching +key+ to the registry that can be used both outside the\n registry and when registering other callbacks dependant of the\n current entry. Results from the callnack will be cached, meaning\n that the callback will return the same object every time.\n\n @param [String|Symbol] key\n @param [Proc|nil] proc\n @return [nil]", "Creates an instance from hash of attributes, saves it\n and adds it to the record map. Attributes given as the\n second argument are merged into attributes from fixture.\n\n If record is valid because of duplicated property value,\n this method does a retry.\n\n @param     name        [Symbol]\n @param     attributes  [Hash]\n\n @api       public\n\n @return   [DataMapper::Resource]    added instance", "Creates an instance from given hash of attributes\n and adds it to records map without saving.\n\n @param     name        [Symbol]      name of the fauxture to use\n @param     attributes  [Hash]\n\n @api       private\n\n @return   [DataMapper::Resource]    added instance", "Creates a new project using the given configuration file.\n\n @param [String] root\n   The root directory of the project.\n\n @raise [ConfigNotFound]\n   The configuration file for the project could not be found\n   in any of the common directories.\n\n\n @param [Symbol, String] name\n   The name of the environment to use.\n\n @return [Environment]\n   The environment with the given name.\n\n @raise [UnknownEnvironment]\n   No environment was configured with the given name.\n\n @since 0.3.0", "Loads configuration from a YAML file.\n\n @param [String] path\n   The path to the configuration file.\n\n @return [Hash]\n   The loaded configuration.\n\n @raise [InvalidConfig]\n   The configuration file did not contain a YAML Hash.\n\n @since 0.4.1", "Loads the project configuration.\n\n @since 0.3.0", "manages the start cli command", "manages the stop cli command", "Return list of versions of dependencies of component.", "Return mapping of gems to dependency versions", "Return missing dependencies", "Return list of states which gem dependencies are in", "Adds a PushMessage to the queue\n @param message [PushMessage] the message to be added to the queue\n @return [Boolean] true if message was added to the queue (that is: if any of the registered services can handle the message), otherwise false\n @see PushMessage", "Flushes the queue by transmitting the enqueued messages using the registered services\n @return [FlushResult] the result of the operation", "Converts all the keys of a Hash to Symbols.\n\n @param [Hash{Object => Object}] hash\n   The hash to be converted.\n\n @return [Hash{Symbol => Object}]\n   The normalized Hash.", "Normalizes a value.\n\n @param [Hash, Array, Object] value\n   The value to normalize.\n\n @return [Hash, Array, Object]\n   The normalized value.\n\n @since 0.5.0", "Parses the value for the `server` setting.\n\n @return [Array<Symbol, Hash>]\n   The name of the server and additional options.\n\n @since 0.5.0", "Parses an address.\n\n @param [Hash, String] address\n   The address to parse.\n\n @return [Addressable::URI]\n   The parsed address.\n\n @since 0.5.0", "Parses the value for the `dest` setting.\n\n @param [Array, Hash, String] dest\n   The value of the `dest` setting.\n\n @return [Array<Addressable::URI>, Addressable::URI]\n   The parsed `dest` value.\n\n @since 0.5.0", "Parses a command.\n\n @param [Array, String] command\n   The command or commands to parse.\n\n @return [Array<String>]\n   The individual commands.\n\n @raise [InvalidConfig]\n   The command must be either an Array of a String.\n\n @since 0.5.0", "Get all of the reivews for a movie.\n\n @return [Array<BadFruit::Review>] A list of review for the movie.", "Unit objects defined by the manifest and organized by type.\n @return [Hash] keys are pluralized unit types from {UNIT_TYPES}", "Installs all units from the manifest.\n @return [Boolean, nil] if units were installed or nil if fails mid-install", "Checks all units in the manifest for any detectable install issues.\n @param quiet [Boolean] suppress some {#logger} output\n @return [Boolean] if units can be installed", "Creates a new unit object for the collection.\n @param type [Symbol] a unit type in {UNIT_TYPES}\n @param attributes [Hash] attributes for the unit from {UNIT_ATTRIBUTES}\n @return [Unit] the unit object of the appropriate subclass", "Load basic unit options from the manifest.\n @return [Hash] the options", "Installs a unit.\n @param unit [Unit] the unit to install\n @param type [Symbol] the unit type\n @param quiet [Boolean] suppress some {#logger} output\n @return [Boolean] if unit was installed", "Checks if a unit can be installed.\n @param unit [Unit] the unit to check\n @param type [Symbol] the unit type\n @param quiet [Boolean] suppress some {#logger} output\n @return [Boolean] if unit can be installed", "In which the bcome context is a shortcut to a more complex command", "Creates a new Controller\n\n @return [Controller] the Controller\n initialize\n Cleanup and validity checking of global options", "Runs the program", "Initialise the Biopsy settings with defaults,\n setting target and objectiv directories to those\n provided with Assemblotron", "Write out metadata from the optimisation run", "Run the subsampler on the input reads, storing\n the paths to the samples in the assembler_options\n hash.", "Merge the final assemblies", "Returns a hash of the settings", "Simplify drawing a rectangle in a single colour.\n\n * +point+     [Point] Top left corner\n * +size+      [Size] Width and Height\n * +z_index+   [Fixnum] Z-order\n * +colour+    [Gosu::Color] Colour of rectangle", "Simplify drawing a line.\n\n There are dire warnings in the Gosu documentation for draw_line() which\n suggest that line drawing should only be done for debugging purposes.\n\n * +p1+        [Point] Beginning point\n * +p2+        [Point] Endpoint\n * +z_index+   [Fixnum] Z-order\n * +colour+    [Gosu::Color] Colour of line", "Return the co-ordnates needed to place a given string in the centre of an\n area, both vertically and horizontally.\n\n * +text+    [String] String to centre\n * +rect+    [Size] Rectangular area size\n\n return::  [Point] The point to write the string, expressed as an offset\n           from the top-left corner of the rectangle.", "Execute a request on a distant object", "Execute a request on the local object", "Return diff of content in this gem against other", "Convienience method for parsing the pushToken out of a JSON POST body", "Generates yaml options file and returns its path", "Add a Brahmic scheme to Sanscript.\n\n Schemes are of two types: \"Brahmic\" and \"roman\". Brahmic consonants\n have an inherent vowel sound, but roman consonants do not. This is the\n main difference between these two types of scheme.\n\n A scheme definition is a Hash that maps a group name to a\n list of characters. For illustration, see `transliterate/schemes.rb`.\n\n You can use whatever group names you like, but for the best results,\n you should use the same group names that Sanscript does.\n\n @param name [Symbol] the scheme name\n @param scheme [Hash] the scheme data, constructed as described above\n @return [Hash] the frozen scheme data as it exists inside the module", "Add a roman scheme to Sanscript.\n\n @param name [Symbol] the scheme name\n @param scheme [Hash] the scheme data, constructed as in {add_brahmic_scheme}.\n                      The \"vowel_marks\" field can be omitted\n @return [Hash] the frozen scheme data as it exists inside the module", "Transliterate from one script to another.\n\n @param data [String] the String to transliterate\n @param from [Symbol] the source script\n @param to [Symbol] the destination script\n @option opts [Boolean] :skip_sgml (false) escape SGML-style tags in text string\n @option opts [Boolean] :syncope (false) activate Hindi-style schwa syncope\n @return [String] the transliterated string", "Runs a program locally.\n\n @param [String] program\n   The name or path of the program to run.\n\n @param [Array<String>] arguments\n   Additional arguments for the program.", "Creates the directory at the path on the remote server", "This function is used from cells to validates arguments on constructor.", "Checks if command exists.\n @param command [String] command name to check\n @return [String, nil] full path to command or nil if not found", "finds the resource on a controller using enclosing resources or resource class", "finds the resource from the enclosing resource.  Raise CantFindSingleton if there is no enclosing resource", "Finds the root of the project, starting at the current working\n directory and ascending upwards.\n\n @return [Pathname]\n   The root of the project.\n\n @since 0.3.0", "Perform a euclidean distance dimension reduction of multiple objectives", "Post a message from a bot.\n\n @return [Boolean] Success/Failure\n @see https://dev.groupme.com/docs/v3#bots_post\n @param id [String, Integer] ID of the bot\n @param text [String] Text to send to the group\n @option options [String] :picture_url Picture URL from image service", "Create a new bot.\n\n @return [Hashie::Mash] Hash representing the bot.\n @see https://dev.groupme.com/docs/v3#bots_create\n @param name [String] Name for the new bot\n @param group_id [String, Integer] ID of the group\n @option options [String] :avatar_url Avatar image URL for the bot\n @option options [String] :callback_url Callback URL for the bot", "Send a preview email", "Iterate over recipients and sends emails", "Perform custom replacements and send the email without throwing any exception", "Builds a Mail", "will return discount_payments of this cart id with a payments_status of 1.", "will return the sum of the amounts of all successfull discount_payments.", "This function takes a path to a yaml file and return the hash with yaml data\n or nil if file not exist.", "This function paginate an array and return the requested page.", "This function add a new GET param to an url string.", "Targets to check", "Load specified target", "the default \"from\" is the beginning of the current month, and the default \"to\" is the current time.\n@used_in : last_n_months, get_in_range\n@param[Hash]  query: the \"from\",\"to\" provided in the query if at all, otherwise nil, assumed that query has two keys : \"from\", \"to\", under a key called \"range\"\n@param[Integer] default_from : the default_from for the particular function that is firing this query, it is an epoch\n@param[Integer] default_to : the default_to for the particular function that is firing this query, it is an epoch\n@return[Hash] : default values for \"from\", \"to\"", "defaults for only.\nif it is empty or nil, then it becomes all attributes\notherwise it becomes the intersect of all attributes and the ones specified in the only\ncreated_at had to be added here, because otherwise it throws an error saying missing_attribute in the only. I think this has something to do with the fact that it is used in the query, so it will be included in the result.\n@used_in: get_in_range\n@param[query] : the provided query, expected to be of the structure:\n{\"only\" => [array],,,other key value pairs}\n@return[Hash] query : returns the query with the default values for the fields to be returned", "Make sure the user has a complete config before continuing.", "Initializes a new Users instance.\n Gets a user by ID or display name.\n\n @param id [String] A user's ID or display name.\n @return [User,nil] The User instance for the specified user, or\n   `nil` if the user could not be found.", "Process power level updates.\n\n @param room [Room] The room this event came from.\n @param data [Hash{String=>Fixnum}] Power level data, a hash of user IDs\n   and their associated power level.", "Process an invite event for a room.\n\n @param room [Room] The room from which the event originated.\n @param event [Hash] Event data.", "Get the user instance for a specified user ID.\n If an instance does not exist for the user, one is created and returned.\n\n @param id [String] The user ID to get an instance for.\n @return [User] An instance of User for the specified ID.", "Specifies that this controller has a particular enclosing resource.\n\n This can be called with an array of symbols (in which case options can't be specified) or\n a symbol with options.\n\n See Specification#new for details of how to call this.", "ensure that specifications array is determinate w.r.t route matching", "this is the before_action that loads all specified and wildcard resources", "loads a series of wildcard resources, from the specified specification idx\n\n To do this, we need to figure out where the next specified resource is\n and how many single wildcards are prior to that.  What is left over from\n the current route enclosing names will be the number of wildcards we need to load", "find the resource\n If we have a resource service, we call destroy on it with the reosurce id, so that any callbacks can be triggered\n Otherwise, just call destroy on the resource", "This function return the permission name for the user.", "Synchronize with the latest state on the server.\n\n For initial sync, call this method with the `since` parameter\n set to `nil`.\n\n @param filter [String,Hash] The ID of a filter to use, or provided\n   directly as a hash.\n @param since [String,nil] A point in time to continue sync from.\n   Will retrieve a snapshot of the state if not set, which will also\n   provide a `next_batch` value to use for `since` in the next call.\n @param full_state [Boolean] If `true`, all state events will be returned\n   for all rooms the user is a member of.\n @param set_presence [Boolean] If `true`, the user performing this request\n   will have their presence updated to show them as being online.\n @param timeout [Fixnum] Maximum time (in milliseconds) to wait before\n   the request is aborted.\n @return [Hash] The initial snapshot of the state (if no `since` value\n   was provided), or a delta to use for updating state.", "Performs a full text search on the server.\n @param from [String] Where to return events from, if given. This can be\n   obtained from previous calls to {#search}.\n @param options [Hash] Search options, see the official documentation\n   for details on how to structure this.\n @return [Hash] the search results.", "Helper method for performing requests to the homeserver.\n\n @param method [Symbol] HTTP request method to use. Use only symbols\n   available as keys in {METHODS}.\n @param path [String] The API path to query, relative to the base\n   API path, eg. `/login`.\n @param opts [Hash] Additional request options.\n\n @option opts [Hash] :params Additional parameters to include in the\n   query string (part of the URL, not put in the request body).\n @option opts [Hash,#read] :content Content to put in the request body.\n   If set, must be a Hash or a stream object.\n @option opts [Hash{String => String}] :headers Additional headers to\n   include in the request.\n @option opts [String,nil] :base If this is set, it will be used as the\n   base URI for the request instead of the default (`@base_uri`).\n\n @yield [fragment] HTTParty will call the block during the request.\n\n @return [HTTParty::Response] The HTTParty response object.", "Create an options Hash to pass to a server request.\n\n This method embeds the {#access_token access_token} into the\n query parameters.\n\n @param params [Hash{String=>String},nil] Query parameters to add to\n   the options hash.\n @param content [Hash,#read,nil] Request content. Can be a hash,\n   stream, or `nil`.\n @return [Hash] Options hash ready to be passed into a server request.", "Create a hash with body content based on the type of `content`.\n @param content [Hash,#read,Object] Some kind of content to put into\n   the request body. Can be a Hash, stream object, or other kind of\n   object.\n @return [Hash{Symbol => Object}] A hash with the relevant body key\n   and value.", "Parses a HTTParty Response object and returns it if it was successful.\n\n @param response [HTTParty::Response] The response object to parse.\n @return [HTTParty::Response] The same response object that was passed\n   in, if the request was successful.\n\n @raise [RequestError] If a `400` response code was returned from the\n   request.\n @raise [AuthenticationError] If a `401` response code was returned\n   from the request.\n @raise [ForbiddenError] If a `403` response code was returned from the\n   request.\n @raise [NotFoundError] If a `404` response code was returned from the\n   request.\n @raise [RateLimitError] If a `429` response code was returned from the\n   request.\n @raise [ApiError] If an unknown response code was returned from the\n   request.", "Parses a filter object for use in a query string.\n @param filter [String,Hash] The filter object to parse.\n @return [String] Query-friendly filter object. Or the `filter`\n   parameter as-is if it failed to parse.", "An application usually has multiple commands.\n\n == Example\n   app = CommandLion::App.build\n     # meta information\n\n     command :example1 do\n       # more code\n     end\n\n     command :example2 do\n       # more code\n     end\n   end\n\n   app.commands.map(&:name)\n   # => [:example1, :example2]", "Parse arguments off of ARGV.\n\n @TODO Re-visit this.", "Parse a given command with its given flags.\n @TODO Re-visit this.", "Stores a value for the key, either on the receiver or in the store.", "Merges another with self.", "Calls block once for each key-value pair stored in self.", "Equal if the to_hash values of self and another are equal.\n Returns self as a hash.  Any ConfigHash values are recursively\n hashified, to account for nesting.", "NOTE convert ECB encryption to AES gem or both to openssl", "this method is used for encipher and decipher since most of the code is identical\n only the value of the previous block and the internal ecb method differs", "Returns the list of answers for the given question sorted in descending\n order of ranking score.\n\n @param [String] question user question to be queried against your\n   knowledge base.\n @param [Integer] top number of ranked results you want in the output.\n\n @return [Array<Answer>] list of answers for the user query sorted in\n   decreasing order of ranking score.", "This helper is used to create a new cell with a pretty format.", "Overrides require_delete_permission in ApplicationController", "method_call_tag is the scanner event tag emitted by ReflexiveRipper", "Validate that the given string is a valid IP address.\n\n @raises ArgumentError, NotImplementedError", "Esegue un casting dei valori rispetto al tipo di campo da utilizzare per formtastic", "Gets the content of the specified URI as a string.\n @param uri [URI, String] the URI to download\n @return [String] the content of the URI", "Gets the content of the specified URI and saves it to a temporary file.\n @param uri [URI, String] the URI to download\n @return [String] the path to the downloaded file", "Gets the content of the specified URI and saves it to the specified file,\n overwriting it if it exists.\n @param uri [URI, String] the URI to download\n @param path [String] the path to save the download to\n @return [String] the path to the downloaded file", "This function returns the list of lato modules installed on main application.", "This function load languages for a specific module.\n This config are generated from the merge of application languages\n for the module and default languages of the module.", "This function load configs for a specific module.\n This configs are generated from the merge of application configs for the module\n and default configs of the module.", "Indexes all the metaphone equivalents of the words\n in value except for words included in Stopwords.\n\n @example\n\n   Lunar.index :Gadget do |i|\n     i.id 1001\n     i.text :title, \"apple macbook pro\"\n   end\n\n   # Executes the ff: in redis:\n   \n   # ZADD Lunar:Gadget:title:APL  1 1001\n   # ZADD Lunar:Gadget:title:MKBK 1 1001\n   # ZADD Lunar:Gadget:title:PR   1 1001\n   \n   # In addition a reference of all the words are stored\n   # SMEMBERS Lunar:Gadget:Metaphones:1001:title\n   # => (APL, MKBK, PR)\n\n @param [Symbol] att the field name in your document\n @param [String] value the content of the field name\n\n @return [Array<String>] all the metaphones added for the document.", "Adds a numeric index for `att` with `value`.\n\n @example\n\n   Lunar.index :Gadget do |i|\n     i.id 1001\n     i.number :price, 200\n   end\n\n   # Executes the ff: in redis:\n   \n   # ZADD Lunar:Gadget:price 200\n\n @param [Symbol] att the field name in your document.\n @param [Numeric] value the numeric value of `att`.\n\n @return [Boolean] whether or not the value was added", "Adds a sortable index for `att` with `value`.\n\n @example\n\n   class Gadget\n     def self.[](id)\n       # find the gadget using id here\n     end\n   end\n\n   Lunar.index Gadget do |i|\n     i.id 1001\n     i.text 'apple macbook pro'\n     i.sortable :votes, 50\n   end\n\n   Lunar.index Gadget do |i|\n     i.id 1002\n     i.text 'apple iphone 3g'\n     i.sortable :votes, 20\n   end\n\n   results = Lunar.search(Gadget, :q => 'apple')\n   results.sort(:by => :votes, :order => 'DESC')\n   # returns [Gadget[1001], Gadget[1002]]\n\n   results.sort(:by => :votes, :order => 'ASC')\n   # returns [Gadget[1002], Gadget[1001]]\n\n @param [Symbol] att the field you want to have sortability.\n @param [String, Numeric] value the value of the sortable field.\n\n @return [String] the response from the redis server.", "Return self or a new instance with +input+\n\n @param [Object] input\n   the input for the new instance\n\n @return [self]\n   if +input+ is {Undefined}\n\n @return [Request]\n   a new instance with +input+\n\n @api private", "This functon return a token with encrypted payload information.", "This function return the payload of a token.", "authenicate the client to call methods that require authentication\n @param [String] username the username of the client\n @param [String] password the password of the client\n @param [Symbol] method the method to use for authentication, currently\n   only plain is supported. So make sure you are using a secure socket.", "Executes a client call blocking. To issue an async call one needs to\n have start separate threads. THe Native client uses then multiplexing to\n avoid the other threads blocking.\n @api private\n @param [Object] path the path to identifiy the service\n @param [Symbol, String] method the method name to call on the service\n @param [Array<Object>] args the arguments that are passed to the remote\n   side\n @return [Object] the result of the call", "Initialize a wrapper around the Rotten Tomatoes API specific to movies.\n\n\n Search for a movie by name.\n\n @param [String] name The name of the movie to search for.\n @param [Integer] page_limit The number of results to return for API response page. (Defaults to 1)\n @param [Integer] page The page offset to request from the API. (Defaults to 1)\n\n @return [Array<BadFruit::Movie>] An array of movie objects matching the name parameter.", "search by id\n\n Search for a movie by Rotten Tomatoes id.\n\n @param [String] movie_id The id of the movie to search for.\n\n @return [BadFruit::Movie] A movie object from the response data.", "Search for a movie by way of a 3rd party id.\n\n @param [String] alias_id The alias id of the movie.\n @param [String] type The type of alias id that is being provided. (Defaults to 'imdb')\n\n @return [BadFruit::Movie] A movie object representing the 3rd party id.\n @note Currently only 'imdb' as a type is supported.", "convert to \"string-key\" not \"string_key\"", "Get the committees the Legislator sits on\n\n Returns:\n\n An array of Committee objects, each possibly\n having its own subarray of subcommittees", "Prompt the user for a PIN using a request token, and see if we can successfully authenticate them", "Display the user's timeline", "Send a tweet for the user", "Get 20 most recent statuses of user, or specified user", "Get the user's most recent status", "Get the access token for the user and save it", "Returns the 20 most recent @replies / mentions", "Display help section", "Runs benchmark-ips test on detection methods.", "Runs benchmark-ips test on roman-source transliteration methods.", "Handle the `||` statement.\n\n node - the node to evaluate.\n\n Returns :true if either side is known to be true, :false if both sides are\n known to be false, and nil otherwise.", "Handles the `!` statement.\n\n\n node - the node to evaluate.\n\n Returns the inverse of the child expression.", "Handle logic statements explicitly wrapped in parenthesis.\n\n node - the node to evaluate.\n\n Returns the result of the statement within the parenthesis.", "Creates a remote shell with the destination server.\n\n @yield [shell]\n   If a block is given, it will be passed the new remote shell.\n\n @yieldparam [LocalShell, RemoteShell] shell\n   The remote shell.\n\n @return [Array<RemoteShell, LocalShell>]\n   The remote shell. If the destination is a local `file://` URI,\n   a local shell will be returned instead.\n\n @since 0.3.0", "Runs a command on the destination server, in the destination\n directory.\n\n @return [true]\n\n @since 0.3.0", "Executes a Rake task on the destination server, in the destination\n directory.\n\n @return [true]\n\n @since 0.3.0", "Starts an SSH session with the destination server.\n\n @param [Array] arguments\n   Additional arguments to pass to SSH.\n\n @return [true]\n\n @since 0.3.0", "Sets up the deployment repository for the project.\n\n @param [Shell] shell\n   The remote shell to execute commands through.\n\n @since 0.3.0", "Updates the deployed repository for the project.\n\n @param [Shell] shell\n   The remote shell to execute commands through.\n\n @since 0.3.0", "Invokes a task.\n\n @param [Symbol] task\n   The name of the task to run.\n\n @param [Shell] shell\n   The shell to run the task in.\n\n @raise [RuntimeError]\n   The task name was not known.\n\n @since 0.5.0", "Deploys the project.\n\n @param [Array<Symbol>] tasks\n   The tasks to run during the deployment.\n\n @return [true]\n   Indicates that the tasks were successfully completed.\n\n @since 0.4.0", "Loads the framework configuration.\n\n @since 0.3.0", "Loads the server configuration.\n\n @raise [UnknownServer]\n\n @since 0.3.0", "This function set a cookie to create the superuser session.", "This function check the session for a superuser and set the variable @core__current_superuser.\n If session is not valid the user should be redirect to login path.", "Get the matcher for the supplied key and value. Will determine the class\n name from the key.", "Process a power level update in a room.\n\n @param room [Room] The room where the level updated.\n @param level [Fixnum] The new power level.", "Process an invite to a room.\n @param room [Room] The room the user was invited to.\n @param sender [User] The user who sent the invite.\n @param event [Hash] Event data.", "Updates metadata for this user.\n @param data [Hash{String=>String}] User metadata.", "Needed in the type conversion of MatrixAlgebra", "Deletes the current knowledge base and all data associated with it.\n\n @return [nil] on success", "Starts a new active span.\n\n @param operation_name [String] The operation name for the Span\n\n @param child_of [SpanContext, Span] SpanContext that acts as a parent to\n        the newly-started Span. If default argument is used then the currently\n        active span becomes an implicit parent of a newly-started span.\n\n @return [SpanManager::ManagedSpan] The newly-started active Span", "make handle_response public and add error message from body if possible", "so we have completed the rolling n minutes.", "Check to see if node with given name is defined.  flag tells the\n method about our expectation.  flag=true means that we make sure\n that name is defined.  flag=false is the opposite.", "Parse-time check to see if attr is available.  If not, error is\n raised.", "parse-time attr definition", "enumerate params by a single node", "Class implementation of +instrument_method+", "Hash of the Snippets objectified\n\n Returns a Hash of {'snippet_1' => CurrentUserInfo.new(snippets[:key]['options'])}", "draw from the distribution", "generate a single neighbour", "update the neighbourhood structure by adjusting the probability\n distributions according to total performance of each parameter", "return the correct 'best' location to form a new neighbourhood around\n deciding whether to continue progressing from the current location\n or to backtrack to a previous good location to explore further", "use the gradient of recent best scores to update the distributions", "check termination conditions\n and return true if met", "Attach LogSubscriber and ControllerRuntime to a notifications namespace\n\n @param name [Symbol] Notifications namespace\n @param log_subscriber [LogSubscriber] subscriber to be attached\n @param controller_runtime [Module] mixin that logs runtime", "Create a Railtie for LogSubscriber and ControllerRuntime mixin\n\n @param name [Symbol] Notifications namespace\n @param log_subscriber [LogSubscriber] subscriber to be attached\n @param controller_runtime [Module] mixin that logs runtime\n @return [Rails::Railtie] Rails initializer", "Gives the ability to sort the search results via a `sortable` field\n in your index.\n\n @example\n\n   Lunar.index Gadget do |i|\n     i.id 1001\n     i.text :title, \"Apple Macbook Pro\"\n     i.sortable :votes, 10\n   end\n\n   Lunar.index Gadget do |i|\n     i.id 1002\n     i.text :title, \"Apple iPad\"\n     i.sortable :votes, 50\n   end\n\n   results = Lunar.search(Gadget, :q => \"apple\")\n   sorted  = results.sort(:by => :votes, :order => \"DESC\")\n\n   sorted == [Gadget[1002], Gadget[1001]]\n   # => true\n\n @param [Hash] opts the various opts to pass to Redis SORT command.\n @option opts [#to_s] :by the field in the namespace you want to sort by.\n @option opts [#to_s] :order the direction you want to sort i.e. ASC DESC ALPHA\n @option opts [Array] :limit offset and max results to return.\n\n @return [Array] Array of objects as defined by the `finder`.\n @see http://code.google.com/p/redis/wiki/SortCommand", "Return any existing padding", "Strip the existing padding if present", "Initializes and returns a ConfigParser generated using the configs for\n self.  Arguments given to parser are passed to the ConfigParser\n initializer.", "Returns a hash of the default values for each config in self.", "Yields each config in configs to the block with nesting, after appened\n self to nesting.", "Clean the directory", "Given a string representing the 'content' attribute value of a meta tag\n with an `http-equiv` attribute, returns the charset specified within that\n value, or nil.", "Given a string, this returns the attribute value from the start of the string,\n and the position of the following character in the string", "+other+ graph node to edge to\n +weight+ positive float denoting edge weight\n Creates a two way edge between this node and another.", "+other+ The target node to find a route to\n Gives the path weight as a float of the shortest path to the other", "val can be a Rectangle or Point\n returns a Rectangle or Point that is within this Rectangle\n For Rectangles, the size is only changed if it has to be", "return 1-3 rectangles which, together, cover exactly the same area as self and b, but do not overlapp", "Retrieve the current version information of the service", "Retrieve a list of devices that are registered with the PogoPlug account", "Retrieve a list of services", "Takes the given path and returns the MD5\n hex digest of the file's contents.\n\n The path argument is first stripped, and any leading\n \"/\" has no effect.", "Invoke the action identified by +name+\n\n @example\n\n   module App\n     class Environment\n       def initialize(storage, logger)\n         @storage, @logger = storage, logger\n       end\n     end\n\n     class SomeUseCase\n       def self.call(request)\n         data = perform_work\n         request.success(data)\n       end\n     end\n   end\n\n   storage    = SomeStorageAbstraction.new\n   env        = App::Environment.new(storage, Logger.new($stdout))\n   config     = { :some_use_case => { :action => App::SomeUseCase } }\n   dispatcher = Substation::Dispatcher.coerce(config, env)\n\n   response = dispatcher.call(:some_use_case, :some_input)\n   response.success? # => true\n\n @param [Symbol] name\n   a registered action name\n\n @param [Object] input\n   the input model instance to pass to the action\n\n @return [Response]\n   the response returned when calling the action\n\n @raise [UnknownActionError]\n   if no action is registered for +name+\n\n @api public", "Creates a new knowledge base.\n\n @param [String] name friendly name for the knowledge base (Required)\n @param [Array<Array(String, String)>] qna_pairs list of question and answer pairs to be added to the knowledge base.\n   Max 1000 Q-A pairs per request.\n @param [Array<String>] urls list of URLs to be processed and indexed in the knowledge base.\n   In case of existing URL, it will be fetched again and KB will be updated with new data. Max 5 urls per request.\n\n @return [Client] client object", "Create an index on a collection.\n\n For compound indexes, pass pairs of fields and\n directions (+:asc+, +:desc+) as a hash.\n\n For a unique index, pass the option +:unique => true+.\n To create the index in the background, pass the options +:background => true+.\n If you want to remove duplicates from existing records when creating the\n unique index, pass the option +:dropDups => true+\n\n For GeoIndexing, specify the minimum and maximum longitude and latitude\n values with the +:min+ and +:max+ options.\n\n <tt>Person.index(:last_name)</tt>\n <tt>Person.index(:ssn, :unique => true)</tt>\n <tt>Person.index(:first_name => :asc, :last_name => :asc)</tt>\n <tt>Person.index(:first_name => :asc, :last_name => :asc, :unique => true)</tt>", "Create a new ProgressBar using the given options.\n\n @param [Hash, Numeric] options A Hash of options to customize the\n        progress bar or the maximum value of the progress bar\n @see Application::InstanceMethods#progress_bar\n\n @option options [String] :char ('#') The character used for progress bar\n         display\n @option options [Numeric] :maximum (100) The maximum value of this\n         progress bar\n @option options [IO] :ostream ($stdout) The output stream where the\n         progress bar should be displayed\n @option options [Numeric] :size (20) The actual size of the progress bar\n @option options [Numeric] :start (0) The start value of the progress bar\n Add an amount to the current value of the progress bar\n\n This triggers a refresh of the progress bar, if the added value actually\n changes the displayed bar.\n\n @param [Numeric] value The amount to add to the progress bar\n @return [ProgressBar] The progress bar itself\n\n @example Different alternatives to increase the progress\n  progress_bar + 1 # (will add 1)\n  progress_bar + 5 # (will add 5)\n  progress_bar.+   # (will add 1)", "write the content to a destination file\n\n @param [String] content content for the file\n @param [String] destination path to write contents to\n @param [Symbol] on_conflict what to do if the destination exists\n @return [Void]", "=begin\nWithin encipher and decipher we use a regexp comparision.\nArray lookups are must slower and byte comparision is a little faster,\nbut much more complicated\n\n\nAlphabet letter lookup algorithm comparision:\n\nComparison: (see benchmarks/string_comparision.rb)\nstring.bytes.first == A :  3289762.7 i/s\nstring =~ [A-Za-Z]      :  2010285.8 i/s - 1.64x slower\nLetter Array include?(A):    76997.0 i/s - 42.73x slower\n\n=end", "Creates a file handle and optionally attach an io.\n The provided file argument is expected to contain at minimum\n a name, type and parent_id. If it has a mimetype that will be assumed to\n match the mimetype of the io.", "Discover and load available assemblers.", "load_assemblers\n Collect all valid names for available assemblers\n\n @return [Array<String>] names and shortnames (if\n          applicable) for available assemblers.", "assemblers\n Return a help message listing installed assemblers.", "Given the name of an assembler, get the loaded assembler\n ready for optimisation.\n\n @param assembler [String] assembler name or shortname\n @return [Biopsy::Target] the loaded assembler", "Run optimisation and final assembly for each assembler", "Run optimisation for the named assembler\n\n @param [String] assembler name or shortname", "Initializes a new Rooms instance.\n\n @param users [Users] The User manager.\n @param matrix [Matrix] The Matrix API instance.\n Gets a room by its ID, alias, or name.\n\n @return [Room,nil] Returns the room instance if the room was found,\n   otherwise `nil`.", "Processes a list of room events from syncs.\n\n @param events [Hash] A hash of room events as returned from the server.", "Gets the Room instance associated with a room ID.\n If there is no Room instance for the ID, one is created and returned.\n\n @param id [String] The room ID to get an instance for.\n @return [Room] An instance of the Room class for the specified ID.", "Process `join` room events.\n\n @param events [Hash{String=>Hash}] Events to process.", "Process `invite` room events.\n\n @param events [Hash{String=>Hash}] Events to process.", "Process `leave` room events.\n\n @param events [Hash{String=>Hash}] Events to process.", "Delegate named_route helper method to the controller.  Create the delegation\n to short circuit the method_missing call for future invocations.", "This function generate the head for the table.", "This function generate the rows fr the table.", "This function generate the rows for a list of columns.", "This function generate row actions for a table row.", "This function generate the delete button for a record.", "This function generate new button.", "This function generate and return the search input.", "This function generate the search submit button.", "Recursively creates the necessary directories and install the file.", "def cont; @coeff.first.gcd_all(* @coeff[1..-1]); end\n  def pp; self / cont; end", "Report for a group of messages in a given time period.\n\n * +start_date+ is instance of Time\n * +end_date+ is instance of Time", "The developer of the knowledge base service can use this API to submit\n user feedback for tuning question-answer matching. QnA Maker uses active\n learning to learn from the user utterances that come on a published\n Knowledge base service.\n\n @param [Array<Array(String, String, String, String)>] feedback_records\n   \\[user_id, user_question, kb_question, kb_answer]\n\n @return [nil] on success", "ARIB STD-B10 2, appendix-C", "Call the chain\n\n Invokes all processors and returns either the first\n {Response::Failure} that it encounters, or if all\n goes well, the {Response::Success} returned from\n the last processor.\n\n @example\n\n   module App\n     SOME_ACTION = Substation::Chain.new [\n       Validator.new(MY_VALIDATOR),\n       Pivot.new(Actions::SOME_ACTION),\n       Presenter.new(Presenters::SomePresenter)\n     ]\n\n     env     = Object.new # your env would obviously differ\n     input   = { 'name' => 'John' }\n     request = Substation::Request.new(env, input)\n\n     response = SOME_ACTION.call(request)\n\n     if response.success?\n       response.output # => the output wrapped in a presenter\n     else\n       response.output # => if validation, pivot or presenter failed\n     end\n   end\n\n @param [Request] request\n   the request to handle\n\n @return [Response::Success]\n   the response returned from the last processor\n\n @return [Response::Failure]\n   the response returned from the failing processor's failure chain\n\n @return [Response::Exception]\n   the response returned from invoking the {#exception_chain}\n\n @api public", "Call the failure chain in case of an uncaught exception\n\n @param [Request] request\n   the initial request passed into the chain\n\n @param [Object] data\n   the processed data available when the exception was raised\n\n @param [Class<StandardError>] exception\n   the exception instance that was raised\n\n @return [Response::Exception]\n\n @api private", "Runs every command that supports the 'QSTN' value. This is a good way to\n get the sate of the receiver after connecting.", "Define a controller runtime logger for a LogSusbcriber\n\n @param name [String] title for logging\n @return [Module] controller runtime tracking mixin", "This function render a normal success response with a custom payload.", "This function render an error message with a possible custom payload.", "Runs the shell command.\n Works the same way as Kernel.system method but without showing the output.\n Returns true if it was successfull.", "This method, together with method missing, is used to allow segments\n to be ordered within a document. It allows an acts_as_list method to be\n passed to the segment_holder holding a segment, so as to alter its position.\n\n For example:\n   document.move_to_top document.segments.last\n\n will move the last segment so that it becomes the first within\n document.segments.\n\n\n The syntax is:\n\n   document.<acts_as_list_method> <the_segment_to_be_moved>\n\n The segment must already belong to the document", "Update without checking validations. The +Document+ will be saved without validations if it is a new record.", "Downloads all the data associated with the specified knowledge base\n\n @return [String] SAS url (valid for 30 mins) to tsv file in blob storage", "Get the terraform variables for this stack, and merge in with our EC2 access keys", "module ClassMethods\n Return bool indicating if spec file satisfies any file in gem", "Unpack files & return unpacked directory\n\n If block is specified, it will be invoked\n with directory after which directory will be removed", "Iterate over each file in gem invoking block with path", "Recursively creates the necessary directories and installs the component.\n Any files in the install directory not in the source directory are removed.\n Use rsync if available.", "Recursively sets file mode.\n @todo Make this more platform independent.", "Recursively sets file owner and group.\n @todo Make this more platform independent.", "long computation is cached, which cache is cleared every time a new player is registered", "player screen_name_first goes before player screen_name_second", "Retrieve page object by number", "returns the email after adding a webhook identifier variable.", "Executes a Ruby program.\n\n @param [Symbol, String] program\n   Name of the Ruby program to run.\n\n @param [Array<String>] arguments\n   Additional arguments for the Ruby program.\n\n @since 0.5.2", "Escapes a string so that it can be safely used in a Bourne shell\n command line.\n\n Note that a resulted string should be used unquoted and is not\n intended for use in double quotes nor in single quotes.\n\n @param [String] str\n   The string to escape.\n\n @return [String]\n   The shell-escaped string.\n\n @example\n   open(\"| grep #{Shellwords.escape(pattern)} file\") { |pipe|\n     # ...\n   }\n\n @note Vendored from `shellwords.rb` line 72 from Ruby 1.9.2.", "Builds a `rake` task name.\n\n @param [String, Symbol] name\n   The name of the `rake` task.\n\n @param [Array] arguments\n   Additional arguments to pass to the `rake` task.\n\n @return [String]\n   The `rake` task name to be called.", "Read specified length of bytes and return as Integer instance.\n Bit pointer proceed for that length.", "Read one bit and return as 0 or 1.\n Bit pointer proceed for one.", "Read specified length of bits and return as Binary instance.\n Bit pointer proceed for that length.\n\n *Warning*: \"bitlen\" must be integer of multiple of 8, and bit pointer must be pointing\n start of byte.", "In which the bcome context is passed to an external call", "Find a member by name\n @param\u00a0[String] option_name\n @return [Opto::Option]", "Sets up the relationship between the model and the mention model\n\n @param [Hash] opts a hash of options to be used by the relationship", "Generates the raw mentions to be loaded into the Mention objects\n\n @return [Hash] a hash of all the mentions found of the object in question.", "Publish all unpublished in the knowledgebase to the prod endpoint\n\n @return [nil] on success", "Returns a new ApnsPushMessage instance that encapsulates a single push notification to be sent to a single user.\n @param receiver_token [String] the apns push token (aka device token) to push the notification to\n @param environment [Fixnum] the environment to use when sending this push message. Defaults to ApnsEnvironment::PRODUCTION.\n @param identifier [Fixnum] a unique identifier to identify this push message during error handling. If nil, a random identifier is automatically generated.\n @param time_to_live [Fixnum] The time to live in seconds for this push messages. If nil, the time to live is set to zero seconds.\n Convenience method to attach common data (that is an alert, a sound or a badge value) to this message's payload.\n @param alert_text [String] the alert text to be displayed\n @param sound [String] the sound to be played\n @param badge [Fixnum] the badge value to be displayed\n @param category [String] the category this message belongs to (see UIUserNotificationCategory in apple's documentation)", "This function manage the widget index from front end.", "Removes a config much like remove_method removes a method.  The reader\n and writer for the config are likewise removed.  Nested configs can be\n removed using this method.\n\n Setting :reader or :writer to false in the options prevents those\n methods from being removed.", "Undefines a config much like undef_method undefines a method.  The\n reader and writer for the config are likewise undefined.  Nested configs\n can be undefined using this method.\n\n Setting :reader or :writer to false in the options prevents those\n methods from being undefined.\n\n ==== Implementation Note\n\n Configurations are undefined by setting the key to nil in the registry.\n Deleting the config is not sufficient because the registry needs to\n convey to self and subclasses to not inherit the config from ancestors.\n\n This is unlike remove_config where the config is simply deleted from the\n config_registry.", "Removes a config_type much like remove_method removes a method.", "Undefines a config_type much like undef_method undefines a method.\n\n ==== Implementation Note\n\n ConfigClasses are undefined by setting the key to nil in the registry.\n Deleting the config_type is not sufficient because the registry needs to\n convey to self and subclasses to not inherit the config_type from\n ancestors.\n\n This is unlike remove_config_type where the config_type is simply\n deleted from the config_type_registry.", "helper to recursively check for an infinite nest", "Format a message for logging\n\n @param event [ActiveSupport::Notifications::Event] subscribed event\n @param label [String] label for log messages\n @param body [String] the rest\n @return [String] formatted message for logging\n\n ==== Examples\n\n  event :test do |event|\n    message(event, 'Test', 'message body')\n  end\n  # => \"  Test (0.00ms)  message body\"", "Joins the command history together with ` && `, to form a\n single command.\n\n @return [String]\n   A single command string.", "Converts the URI to one compatible with SSH.\n\n @return [String]\n   The SSH compatible URI.\n\n @raise [InvalidConfig]\n   The URI of the shell does not have a host component.", "Starts a SSH session with the destination server.\n\n @param [Array] arguments\n   Additional arguments to pass to SSH.", "Defines a 'config attribute' or attribute on the class\n which this is defined in. Accessors to the single shared\n attribute will be added to the class as well as instances\n of the class. Specify the default value with the attr name\n or via an env variable\n\n @example\n   class Custom\n     extend ConfHelpers\n     conf_attr :data_dir, :default => '/etc/'\n   end\n   Custom.data_dir # => '/etc/'\n   ENV['POLISHER_DATA_DIR'] = '/usr/'\n   Custom.data_dir # => '/usr/'\n   Custom.data_dir == Custom.new.data_dir # => true", "Lookup something from the cache.\n\n If no block is provided, create one dynamically.  If a block is\n provided, it is only used the first time it is encountered.\n This allows you to dynamically define your caches while still\n returning the results of your query.\n\n @return a WillPaginate::Collection if the options include :page,\n  a Fixnum count if the request is for a count or the results of\n  the ActiveRecord query otherwise.", "Store the options and optional block for a call to the cache.\n\n If no block is provided, create one dynamically.\n\n @return an AridCache::Store::Blueprint.", "Return the object's class name.\n\n == Arguments\n * +object+ - an instance or class.  If it's an anonymous class, the name is nil\n   so we return 'anonymous_class' and 'anonymous_instance'.\n * +modifiers+ - one or more symbols indicating the order and type of modification\n   to perform on the result.  Choose from: :downcase (return lowercase name),\n   :pluralize (pluralize the name)", "Initializes the permission object\n\n calling the +authorized?+ method on the instance later will test for the authorization.\n\n == Parameters:\n\n   +user+ - user object, must respond to role_symbols\n   +action+ - action, such as :create, :show, etc. Should not be an alias\n   +klass+ - the class of the subject.\n   +subject+ - the subject tested for authorization\n   +parent+ - the parent object, normally declared through belongs_to\n\n See {Trust::Authorization} for more details\n\n Returns params_handler if the user is authorized to perform the action\n\n The handler contains information used by the resource on retrieing parametes later", "Checks is a member is authorized\n You will need to implement members_role in permissions yourself", "Return the 'state' of the gem as inferred by\n the targets which there are versions for.\n\n If optional :check argument is specified, version\n analysis will be restricted to targets satisfying\n the specified gem dependency requirements", "Return a list of all recognized files.", "Check if path is a valid directory.", "Check if path is a valid file.", "Entire form validation. Loops through the form pages and\n validates each page individually.", "Create a hash of form elements values", "Installs the collection.\n @param manifest [String] path to the manifest file to use\n @return [Boolean] value of {Collection#install} or {Collection#install?}", "Convert a number to a human readable size.\n\n Usage:\n\n   number_to_size(1) # 1 byte\n   number_to_size(2) # 2 bytes\n   number_to_size(1024) # 1 kilobyte\n   number_to_size(2048) # 2 kilobytes", "Creates a client\n\n @param config [CivicSIPSdk::AppConfig] app_config that sets all the parameters of the client\n Exchange authorization code in the form of a JWT Token for the user data\n requested in the scope request.\n\n @param jwt_token [String] a JWT token that contains the authorization code\n @return [CivicSIPSdk::UserData] user data returned from SIP", "Returns true if this field should not be processed because of the conditionals\n @return [Boolean]", "Accessor to defined resolvers for this option.\n @return [Array<Opto::Resolver>]", "Render detailed diagnostics for unhandled exceptions rescued from\n a controller action.", "Searches each module in +ancestors+ for members named +resource_name+\n Returns the named resource\n Throws a NameError if none of the resources in the list contains +resource_name+", "Searches the GovKit module for a resource with the name +name+, cleaned and camelized\n Returns that resource.\n If the resource isn't found, it's created.", "Gets the command to use from the list of arguments passed to the\n application. The first argument matching a command name or alias will\n cause the corresponding command to be selected.\n\n The command and all arguments equal to '--' will be removed from the\n array.\n\n @param [Hash<Symbol, Command>] commands A list of available commands\n @return [Command] The command found in the argument list\n @return [Fixnum] The position of the command in the argument list", "Turns arguments using a special syntax into arguments that are parseable.\n\n Single character parameters may be joined together like '-dv'. This\n method will split them into separate parameters like '-d -v'.\n\n Additionally a parameter argument may be attached to the parameter itself\n using '=' like '--path=/tmp'. This method will also split them into\n '--path /tmp'.", "Selects active parameters from a list of available parameters\n\n For every option found in the argument list {#scoped_args!} is called to\n find the arguments for that option.\n\n All parameters found will be removed from the array.\n\n @param [Hash<Symbol, Parameter>] params A list of available parameters\n @param [Fixnum] pos The position of the first argument that should be\n        checked. All arguments ahead of that position will be skipped.\n @return [Array<Parameter>] Parameters called from the given argument list\n @see #scoped_args", "Gets all arguments passed to a specific scope, i.e. a command or an\n option.\n\n All arguments in the scope will be removed from the array.\n\n @param [HasArguments] has_args\n @param [Fixnum] pos The position of the first argument that should be\n        checked. All arguments ahead of that position will be skipped.", "Class convenience method to search for the first solution to the\n constraints.", "Class convenience method to search for all the solutions to the\n constraints.", "calculate the block size by detecting the growth\n of the resulting ciphertext by sending messages\n which length increases by one until a change occurs", "Funzione di encoding semplice", "Calls the APNS feedback service and returns an array of expired push tokens\n @return [Array<String>] an array of expired push tokens", "This function generate the link to go to a specific page number", "INcrease the dimensions of the current Size in the width direction\n by +by_w+ and in the height direction by +by_h+.\n\n by_w and by_h can be a Fixnum, or another Size.", "DEcrease the dimensions of the current Size in the width direction\n by +by_w+ and in the height direction by +by_h+.\n\n by_w and by_h can be a Fixnum, or another Size.", "Change the dimensions using the dimensions of another Size.", "This function return the list of gems used by the application.", "This function return the path of the application logo for the sidebar.", "Create a new application command with the given name with a reference to\n the app it belongs to\n\n @param [Application::Base] app The application this command belongs to\n @param [Symbol, #to_sym] name The name of this command, used in application\n        arguments\n @param options (see HasArguments#initialize)\n @param [Proc] block The code block which should be executed by this\n        command\n @raise [ArgumentError] if the given application object isn't a Rubikon\n        application\n @raise [BlockMissingError] if no command code block is given and a\n        command file does not exist\n Generate help for this command\n\n @param [Boolean] show_usage If +true+, the returned String will also\n        include usage information\n @return [String] The contents of the help screen for this command\n @since 0.6.0", "Add a new parameter for this command\n\n @param [Parameter, Hash] parameter The parameter to add to this\n        command. This might also be a Hash where every key will be an\n        alias to the corresponding value, e.g. <tt>{ :alias => :parameter\n        }</tt>.\n @see Parameter", "If a parameter with the specified method name exists, a call to that\n method will return the value of the parameter.\n\n @param (see ClassMethods#method_missing)\n\n @example\n   option :user, [:who]\n   command :hello, [:mood] do\n     puts \"Hello #{user.who}\"\n     puts \"I feel #{mood}\"\n   end", "Resets this command to its initial state\n\n @see HasArguments#reset\n @since 0.4.0", "Checks whether a parameter with the given name exists for this command\n\n This is used to determine if a method call would successfully return the\n value of a parameter.\n\n @return +true+ if named parameter with the specified name exists\n @see #method_missing", "Forward validations.\n\n Usage:\n\n   attacher.validations", "a modification of the on path method to check if we are on any of the defined request or callback paths.\ntests each of the provided paths to see if we are on it.", "Save an attachment.\n\n Usage:\n\n   @object.avatar.save", "Destroy an attachment.\n\n Usage:\n\n   @object.avatar.destroy", "Acesss the URL for an attachment.\n\n Usage:\n\n   @object.avatar.url\n   @object.avatar.url(:small)\n   @object.avatar.url(:large)", "Access the path for an attachment.\n\n Usage:\n\n   @object.avatar.url\n   @object.avatar.url(:small)\n   @object.avatar.url(:large)", "Add client to clients list\n @param client_id [Integer]\n @param ip_address [String]", "Removes client data and disconnects client\n @param client_id [Integer] ID of client", "Creates a new table in the keyspace\n\n options:\n - :primary_keys: single value or array (for compound primary keys). If\n not defined, some column must be chosen as primary key in the table definition.", "send message to a specific client\n @param client_id [Integer] ID of client\n @param message [String] message to be sent to client\n @param reliable [Boolean] whether or not the packet is guaranteed to be received by the client\n @param channel [Integer] what channel to send on", "send message to all connected clients\n @param message [String] message to be sent to clients\n @param reliable [Boolean] whether or not the packet is guaranteed to be received by the clients\n @param channel [Integer] what channel to send on", "Return a new version number based on\n @param oldversion the old version (format: x.y.z)\n @param level      the level of bumping (either :major, :minor, :patch)", "Defines the input parameters expected for this API action.\n\n @example\n   expects do\n     string :query\n     integer :per_page, :optional => true, :default => 10\n   end\n\n See the {Apidiesel::Dsl::ExpectationBuilder ExpectationBuilder} instance methods\n for more information on what to use within `expect`.\n\n @macro [attach] expects\n   @yield [Apidiesel::Dsl::ExpectationBuilder]", "Defines the expected content and format of the response for this API action.\n\n @example\n   responds_with do\n     string :user_id\n   end\n\n See the {Apidiesel::Dsl::FilterBuilder FilterBuilder} instance methods\n for more information on what to use within `responds_with`.\n\n @macro [attach] responds_with\n   @yield [Apidiesel::Dsl::FilterBuilder]", "Ask whether or not to really continue", "Execute a given command, return exit code and print nicely stdout and stderr", "Execute in a given directory", "execute_in_dir\n Execute a given command - exit if status != 0", "Display a indexed list to select an i", "copy_from_template\n RVM init", "select_forge\n select_licence \n Select a given licence for the project", "select_licence\n license \n Generate the licence file\n\n Supported options:\n  * :force    [boolean] force action\n  * :filename [string]  License file name\n  * :organization [string]  Organization", "license\n guess_project_config \n Guess the project configuration", "Collects a job and deternines if the job should be moved on to the next\n Actor or if it should wait until more processing paths have\n finished. This method is executed asynchronously.\n @param [Job|Object] job data to process or pass on\n @param [Object] path_id identifier of the path the request came from", "Updates the token associated with the job. The job or the Collector\n subclass can use any data desired to keep track of the job's paths that\n have been completed. This method is executed asynchronously.\n @param [Object] job data to get the key for\n @param [Object] token current token value or nil for the first token value\n @param [Object] path_id an indicator of the path if used\n @return [Object] a token to keep track of the progress of the job", "Returns true if the job has been processed by all paths converging on\n the collector. This can be implemented in the Collector subclass or in\n the Job. This method is executed asynchronously.\n @param [Object] job data to get the key for\n @param [Object] token current token value or nil for the first token value\n @return [true|false] an indication of wether the job has completed all paths", "Reset all configurations back to defaults", "Upload files from target to the source.", "Removes files from target that don't exist on the source.", "Adds a value for key\n\n @param [String] key     Key that should be used for operation\n @param [String] value   Value that should be used for operation", "Qt special handling", "Returns array of source code directories assembled via given parameters\n\n @param [String] main_dir                Main directory where project source is located\n @param [Array]  sub_dirs                List of sub directories inside main_dir\n @param [Hash]   params                  Option hash to control how directories should be added\n @option params [Boolean]  :subdir_only  If true: only return sub directories, not main_dir in result\n\n @return [Array] List of sub directories assembled from each element in sub_dirs and appended to main_dir", "Returns list of include directories for name of libraries in parameter libs\n\n @param [Array] libs   List of library names\n\n @return [Array]       List of includes found for given library names", "Search files recursively in directory with given extensions\n\n @param [Array]  directories   Array of directories to search\n @param [Array]  extensions    Array of file extensions to use for search\n\n @return [Array]   list of all found files", "Search list of files relative to given directory\n\n @param [String] directory   Main directory\n @param [Array]  files       List with Filenames\n\n @return [Array] List of path names of all found files", "Read project file if it exists\n\n @param [String] file      Filename of project file\n @return [KeyValueReader]  New KeyValueReader object with values provided via read project file", "Loads dependency files if already generated\n\n @param [Array] deps   List of dependency files that have been generated via e.g. 'gcc -MM'", "Transforms an object file name to its source file name by replacing\n build directory base with the source directory base and then iterating list of\n known sources to match\n\n @param [String] obj         Object filename\n @param [String] source_dir  Project source base directory\n @param [String] obj_dir     Project build base directory\n @return [String]            Mapped filename", "Transforms a dependency file name into its corresponding source file name by replacing\n file name extension and object directory with dependency directory.\n Searches through list of source files to find it.\n\n @param [String] dep         Source filename\n @param [String] source_dir  Project source base directory\n @param [String] dep_dir     Project dependency base directory\n @return [String]            Mapped filename", "Change ADD_CFLAGS, ADD_CXXFLAGS, ADD_LDFLAGS according to settings in platform file.\n\n @param libs [Array]   Array of libraries to be considered", "Search dependent libraries as specified in ADD_LIBS setting\n of prj.rake file\n\n @param [String] settings    The project settings definition\n\n @return [Hash]                        Containing the following components mapped to an array:\n @option return [Array] :local         all local libs found by toolchain\n @option return [Array] :local_alibs   local static libs found by toolchain\n @option return [Array] :local_solibs  local shared libs found by toolchain\n @option return [Array] :all           local + external libs", "Returns absolute paths to given libraries, if they are local libraries\n of the current project.", "Returns absolute paths to dependend local libraries, i.e. libraries\n of the current project.", "A CQL string with inline parameters, representing the current statement\n as it would be executed in a CQL shell\n\n @note This CQL string does not include execution options like type hinting,\n  idempotency, consistency level, etc -- just the raw CQL instruction and values.\n @return [String]\n\n @example\n   statement.to_cql\n   #=> \"SELECT * FROM table WHERE first='evan' AND middle='thomas' and last='prothro\"", "Handles discovery for a user's claimed ID.", "Handles discovery for a domain", "Kickstart the discovery process by checking against Google's well-known location for hosted domains.\n This gives us the location of the site's XRDS doc", "Fetches the XRDS and verifies the signature and authority for the doc", "Process the URITemplate in the XRDS to derive the location of the claimed id's XRDS", "Iterate through the stack and build a single\n callable object which consists of each operation\n referencing the next one in the chain", "support for Mustache rendering of ad hoc user defined variables\n if the key exists in the hash, use if for a lookup", "In order to not pollute our templates with helpers. prefixed\n everywhere we want to try to distinguish helpers that are almost\n always used as parameters to other methods such as path helpers\n and not add them as elements", "=begin rdoc\nWrite the todo's in a logging file.\n\nDefault filename is $0.todo\n=end", "Save an item on the remote cobbler server\n This will first lookup if the item already exists on the remote server\n and use its handle store the attributes. Otherwise a new item is created.", "delete the item on the cobbler server", "copy the item on the cobbler server", "This method takes care of creating a new 'apprepo' folder with metadata\n and screenshots folders", "Rebuild the intervals tree", "Initializes a new Pref via passed-in parameters. Also\n initializes objects for each Validator and Behavior on\n this Pref.\n @param [Hash] params Parameters to initialize\n @return [void]\n Custom equality operator for this class.\n @param [Pref] other\n @return [Boolean]\n Delivers the prompt the user. Handles retries\n after incorrect answers, validation, behavior\n evaluation, and pre-/post-behaviors.\n @param [String] default The default option\n @return [void]", "Runs the passed text through this Pref's behaviors.\n @param [String] text The text to evaluate\n @return [String]", "Validates a text against the validators for this Pref\n @param [String] text The text to validate\n @return [Boolean]", "Attempts to instantiate a Pre or Post Action based on name; if\n successful, the new object gets placed in @validator_objects\n @param [Hash] action_hash The hash of action data (name, params, etc.)\n @return [void]", "Attempts to instantiate a Behavior based on name; if\n successful, the new object gets placed in @behavior_objects\n @param [Hash] behavior_hash The Behavior attributes\n @return [void]", "Iterates over each attribute present in the given symbol.", "Sets name of the pin represented by the given node, updating all values", "Adjusts the \"bounds\" of the given bus so the bus is of the provided width\n by modifying the bus's upper bound. If the node is not a bus, it will be\n made into a bus whose right bound is 0.\n\n node: The node to be modified.\n width: The width to apply.", "Render the wrapped data with the given view", "Adds a column to a table.\n\n options: same options you would pass to create a table with that column\n (i.e. :limit might be applicable)", "Create new SSE client.\n\n Note that creating new client does not establish connection to the\n server. Connection is established by the {#listen} call and torn down\n automatically when {#listen returns}.\n\n @param address [URI] endpoint to connect to\n @param parser [Parser] object that should be used to parse incoming data\n @param headers [Hash] additional headers that should be added to request\n Listen for events from the server.\n\n To perform some action when event arrives, specify a block that gets\n executed eact time new event is availble like this:\n\n     client.listen { |e| puts e }", "Gets the counts for each SRS level and item types.\n\n @param item_type [String] the SRS level that will be returned.\n @return [Hash] the SRS information for each level for the user.", "Gets all items for a specific SRS level.\n\n @param item_type [String] the SRS level for the items returned.\n @return [Array<Hash>] all the items matching the specified SRS for each level for the user.", "Places a job on the work queue. This method is executed asynchronously.\n @param [Object] job work to be processed", "Identifies a worker as available to process jobs when they become\n available. This method is executed asynchronously.\n @param [Actor] worker Actor that responds to the method to be called", "Make a POST request", "Make a DELETE request", "Build a connection instance, wrapped in the middleware that we want", "Deletes the specified child from children list\n\n @param child [Model,String,Symbol] the child to remove\n @return [Model] the deleted child, or nil if no matching component is\n   found.", "Adds a coupling to self between two ports.\n\n Depending on *p1* and *to* hosts, the function will create an internal\n coupling (IC), an external input coupling (EIC) or an external output\n coupling (EOC).\n\n @overload attach(p1, to:)\n   @param p1 [Port] the sender port of the coupling\n   @param to [Port] the receiver port of the coupling\n @overload attach(p1, to:, between:, and:)\n   @param p1 [Port,Symbol,String] the sender port of the coupling\n   @param to [Port,Symbol,String] the receiver port of the coupling\n   @param between [Coupleable,Symbol,String] the sender\n   @param and [Coupleable,Symbol,String] the receiver\n\n @raise [FeedbackLoopError] if *p1* and *p2* hosts are the same child\n   when constructing an internal coupling. Direct feedback loops are not\n   allowed, i.e, no output port of a component may be connected to an input\n   port of the same component.\n @raise [InvalidPortTypeError] if given ports are not of the expected IO\n   modes (:input or :output).\n @raise [InvalidPortHostError] if no coupling can be established from\n   given ports hosts.\n\n @note If given port names *p1* and *p2* doesn't exist within their\n   host (respectively *sender* and *receiver*), they will be automatically\n   generated.\n @example Attach two ports together to form a new coupling\n   attach component1.output_port(:out) to: component2.input_port(:in) # IC\n   attach self.input_port(:in) to: child.input_port(:in) # EIC\n   attach child.output_port(:out) to: self.output_port(:out) # EOC\n @example Attach specified ports and components to form a new coupling\n   attach :out, to: :in, between: :component1, and: :component2\n   attach :in, to: :in, between: self, and: child", "Provide JSON serialized data", "Responsible for returning a hash with keys indicating if the resource\n can be copied, if an ancestor exists, or if the copy destinatin is\n locked.\n\n Return hash should contain `can_copy`, `ancestor_exist`, and `locked`\n keys with boolean values.\n\n Used in COPY and MOVE (which inherits from COPY) requests.", "Get formatted information about process\n\n Params:\n\n +formatted+:: indicate weather print boring or pretty colorful process", "Getting source content", "General slicing method. Passing the argument changes the +current_slice+.", "Return a textual representation of the node including all children.", "The current schema version\n @return [Version]", "Record a version in the schema version store.\n This should only be done if the version has been sucesfully migrated\n @param [Version] The version to record\n @param [Boolean] set_execution_metadata Determines whether or not to populate\n   the version object with execution tracking info (+id+, +executed_at+, and +executor+).\n @return [Boolean] whether succesfull or not\n @raises [StandardError] if version could not be recorded. If this happens,\n   execution_metadata will not be preset on the version object.", "load version migration class from disk", "This init has been delayed because the SSL handshake is a blocking and\n expensive call", "All the polling work is done here", "Outputs a formatted-red error message.\n @param [String] m The message to output\n @return [void]", "Outputs a formatted-blue informational message.\n @param [String] m The message to output\n @return [void]", "Outputs a formatted-purple section message.\n @param [String] m The message to output\n @return [void]", "Outputs a formatted-green success message.\n @param [String] m The message to output\n @return [void]", "Outputs a formatted-yellow warning message.\n @param [String] m The message to output\n @return [void]", "or formula or filepath", "Parses a JSON string.\n @param [String] json the JSON formatted string\n @return [Hash]", "Extract special arguments for resolver objects,\n let the rest pass-through\n Defer the execution only after setting up\n context and root_value with resolvers and remote arguments", "Returns the path of the specification with the given name and version.\n\n @param  [String] name\n         the name of the Pod.\n\n @param  [Version,String] version\n         the version for the specification.\n\n @return [Pathname] The path of the specification.", "Load instance variables from the provided hash of dependencies.\n\n Raises if any required dependencies (+required_options+) are missing from +options+ hash.\n Optionally, takes and yields a block after loading options. Use this to validate dependencies.\n\n @param [List<String,Symbol>]\n   option_names list of keys representing required dependencies\n\n @param [Hash]\n   options A hash of dependencies\n\n @public", "Build out the endpoint structure from the root of the implementation", "Build our root node here. The root node is special in that it lives below\n the 'endpoints' directory, and so we need to manually check if it exists.", "Build out the traversal tree by module namespace", "Alias for combine_pdfs, for backwards compatibility", "Finds and checks if the given port is an output port\n\n @api private\n @param port [Port, String, Symbol] the port or its name\n @return [Port] the matching port\n @raise [NoSuchPortError] if the given port doesn't exists\n @raise [InvalidPortHostError] if the given port doesn't belong to this\n   model\n @raise [InvalidPortTypeError] if the given port isn't an output port", "Constructs a new CronSpecification with a textual cron specificiation.\n\n A broad cron syntax is supported:\n\n  *    *    *    *    *\n  -    -    -    -    -\n  |    |    |    |    |\n  |    |    |    |    +----- day of week (0 - 6) (Sunday=0)\n  |    |    |    +---------- month (1 - 12)\n  |    |    +--------------- day of month (1 - 31)\n  |    +-------------------- hour (0 - 23)\n  +------------------------- min (0 - 59)\n\n The following named entries can be used:\n\n * Day of week - sun, mon, tue, wed, thu, fri, sat\n * Month - jan feb mar apr may jun jul aug sep oct nov dec\n\n The following constructs are supported:\n\n * Ranges are supported (e.g. 2-10 or mon-fri)\n * Multiple values are supported (e.g. 2,3,8 or mon,wed,fri)\n * Wildcards are supported (e.g. *)\n * Step values are supported (e.g. */4)\n * Combinations of all but wildcard are supported (e.g. 2,*/3,8-10)\n\n A single space is required between each group.\n\n\n Return true if the specified time falls within the definition of the\n CronSpecification. The parameter defaults to the current time.", "Create the blocks hash by encrypting all the blocks data using SHA256", "Reads prompt data from and stores it.\n @param [<String, Hash, Array>] data Filepath to YAML, Hash, or Array\n @param [Configurator] configurator Source of defailt values\n @return [void]\n Runs through all of the prompt questions and collects\n answers from the user. Note that all questions w/o\n prerequisites are examined first; once those are\n complete, questions w/ prerequisites are examined.\n @return [void]", "Utility method for determining whether a prompt's\n prerequisites have already been fulfilled.\n @param [Hash] p The prompt\n @return [void]", "Asks the worker to invoke the method of an Act Object.", "Sets the value of an ISE project property.", "Attempts to minimize synthesis runtime of a _single run_.\n\n This will place all intermediary files in RAM- which means that synthesis\n results won't be preserved between reboots!", "Returns a path to the top-level file in the given project.\n\n absoulute_path: If set when the project file's path is known, an absolute path will be returned.", "Returns the best-guess path to the most recently generated bit file,\n or nil if we weren't able to find one.", "The basic implementation method.\n\n   slice <method_name>, <configuration>, [:config => <:style>]*\n\n where:\n * <method_name> - any method or local variable which returns source String (can be called with .send()).\n * <configuration> - Hash of configuration options and/or +:config+ parameter.\n\n === Example:\n\n   class Article < ActiveRecord::Base\n     slice :content, :as => :paged, :slice => {:maximum => 2000}, :resize => {:width => 600}\n   end\n\n === Where:\n * <tt>:content</tt> is a method name or local variable, that return a target String object.\n * <tt>:as</tt> is a name of basic accessor for result.\n * <tt>:slice</tt> is a hash of +slicing options+.\n * <tt>:resize</tt> is a hash of +resizing options+.\n\n You can define any configuration key you want.\n Otherwise, default configuration options (if available) will be picked up automatically.\n\n === All configuration keys:\n * <tt>:as</tt> is a name of basic accessor for sliced +object+.\n * <tt>:slice</tt> is a hash of slicing options*.\n * <tt>:resize</tt> is a hash of resizing options*.\n * <tt>:processors</tt> - processors names*.\n * <tt>:window</tt> - parameter for ActionView: The \"inner window\" size (4 by default).\n * <tt>:outer_window</tt> - parameter for ActionView: The \"outer window\" size (0 by default).\n * <tt>:left</tt> - parameter for ActionView: The \"left outer window\" size (0 by default).\n * <tt>:right</tt> - parameter for ActionView: The \"right outer window\" size (0 by default).\n * <tt>:params</tt> - parameter for ActionView: url_for parameters for the links (:controller, :action, etc.)\n * <tt>:param_name</tt> - parameter for ActionView: parameter name for slice number in the links. Accepts +symbol+, +string+, +array+.\n * <tt>:remote</tt> - parameter for ActionView: Ajax? (false by default)\n\n === Block-style configuration example:\n\n   slice *args do |config|\n     config.as = :paged\n     config.slice.merge! {:maximum => 1500}\n     config.resize = nil\n   end\n\n   # *args = method name or local variable, and/or +:config+ parameter.\n\n\n === Premature configuration (+:config+ parameter):\n Stylizied general configuration can be used for many implementations, such as:\n\n  # For example, we set the global stylized config:\n\n   HtmlSlicer.configure(:paged_config) do |config|\n     config.as = :page\n     config.slice = {:maximum => 300}\n     config.window = 4\n     config.outer_window = 0\n     config.left = 0\n     config.right = 0\n     config.param_name = :slice\n   end\n\n  # Now we can use it as next:\n\n   slice *args, :config => :paged_config\n\n   You can also pass another configuration options directrly as arguments\n   and/or the block to clarify the config along with used global:\n\n   slice *args, :as => :chapter, :config => :paged_config do |config|\n     config.slice.merge! {:unit => {:tag => 'h1', :class => 'chapter'}, :maximum => 1}\n   end\n\n === Skipping slicing:\n\n   To skip slicing (for example, if you want to use only resizing feature)\n   you can nilify +slice+ option at all:\n\n   slice :content, :slice => nil, :resize => {:width => 300}\n\n   Notice: without +:slice+ neither +:resize+ options, using HtmlSlicer becomes meaningless. :)\n\n === See README.rdoc for details about +:slice+ and +:resize+ options etc.", "Uniqable fields and options declaration\n @example:\n   uniqable :uid, :slug, to_param: :uid\n rubocop:disable Metrics/MethodLength", "open-uri will return a StringIO instead of a Tempfile if the filesize\n is less than 10 KB, so we patch this behaviour by converting it into a\n Tempfile.", "Fetch the CQL that can be used to recreate the current environment's keyspace\n @return [String] CQL commands\n @raise [RuntimeError] if the {Cassie.configuration[:keyspace]} keyspace could not be described.", "Return the remark-elements found in the document. If _keyword_ is\n nil then return all remarks, else only the ones with the right\n keyword.", "Find the _title_ of the current section. That element is either\n directly following or inside an _info_ element. Return the empty\n string if no title can be found.", "Check the document elements for content and type recursively,\n starting at the current node.  Returns an array with paragraph and\n section maps.", "Check whether the document has a DocBook default namespace", "Check whether the document has a XInclude namespace", "Finds the remarks by looking through all the Xincluded files\n\n The remarks returned can be filtered by keyword if an keyword array is\n passed as an argument.", "Helper for sum_sections", "Sum the word counts of lower sections", "Open the XML document, check for the DocBook5 namespace and finally\n apply Xinclude tretement to it, if it has a XInclude namespace.\n Returns a map with the file name, the file's modification time, and the section structure.", "Upload the binary to AppRepo", "convert Active Record type to GraphQL type", "version control system wrapper", "Builds a new version, wiht a version number incremented from this\n object's version. Does not propogate any other attributes\n @option bump_type [Symbol] :build Bump the build version\n @option bump_type [Symbol] :patch Bump the patch version, set build to 0\n @option bump_type [Symbol] :minor Bump the minor version, set patch and build to 0\n @option bump_type [Symbol] :major Bump the major version, set minor, patch, and build to 0\n @option bump_type [nil] nil Default, bumps patch, sets build to 0\n @return [Version]", "liberate the ruby-git's private command method with a few tweaks", "Initialize a new blockchain by creating a new array with the Genesis block\n\n #add_next_block => Adds a new block to the blockchain with the given data\n it will raise an error if the previous_block hash does not match the last_block in our blockchain", "Uses the 'mode' from a packet to call the method of the same name\n @param data [Hash] data from packet", "Calls Proc immediately then every milliseconds, async.\n @param milliseconds [Integer][Float] Time to wait before calling the block\n @param block [Proc]", "String to be logged\n @param string [String] text to log\n @param color [Gosu::Color] color of text in console", "Serialize event into form for transmission.\n\n Output of this method call can be written directly into the socket.", "Empty sandbox.\n\n @param [String] admin the name of a user who will be able to peek into the\n                       sandbox\n Copies a file or directory to the sandbox.\n\n @param [String] from path to the file or directory to be copied\n @param [Hash] options tweaks the permissions and the path inside the sandbox\n @option options [String] :to the path inside the sandbox where the file or\n     directory will be copied (defaults to the name of the source)\n @option options [Boolean] :read_only if true, the sandbox user will not be\n     able to write to the file / directory\n @return [String] the absolute path to the copied file / directory inside the\n                  sandbox", "Copies a file or directory from the sandbox.\n\n @param [String] from relative path to the sandbox file or directory\n @param [String] to path where the file/directory will be copied\n @param [Hash] options tweaks the permissions and the path inside the sandbox\n @return [String] the path to the copied file / directory outside the\n                  sandbox, or nil if the file / directory does not exist\n                  inside the sandbox", "Runs a command in the sandbox.\n\n @param [Array, String] command to be run; use an array to pass arguments to\n                        the command\n @param [Hash] options stdin / stdout redirection and resource limitations\n @option options [Hash] :limits see {Spawn.limit_resources}\n @option options [String] :in path to a file that is set as the child's stdin\n @option options [String] :in_data contents to be written to a pipe that is\n     set as the child's stdin; if neither :in nor :in_data are specified, the\n     child will receive the read end of an empty pipe\n @option options [String] :out path to a file that is set as the child's\n     stdout; if not set, the child will receive the write end of a pipe whose\n     contents is returned in :out_data\n @option options [Symbol] :err :none closes the child's stderr, :out\n     redirects the child's stderr to stdout; by default, the child's stderr\n     is the same as the parent's\n @return [Hash] the result of {Wait4.wait4}, plus an :out_data key if no :out\n                option is given", "Array including all the dates this Scheduler has ocurrences\n between st and en", "Dumps configuration to stdout", "Return true if password matches the hashed_password.\n If successful checks for an outdated password_hash and updates if\n necessary.", "Open the fuse", "Constructs a new CronSpecificationFactory\n\n\n Parses a unit of a cron specification.\n The supported patterns for parsing are one of:\n\n * Wildcard '*'\n * Single Scalar Value [0-9]+|(sun|mon|tue|wed|thu|fri|sat)|(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\n * Range value (0-9, mon-fri, etc.)\n * Step value (*/[0-9]+)", "path_to returns absolute installed path to various folders packaged with\n the RepoManager gem\n\n @example manually require and include before use\n\n     require 'repo_manager/views/view_helper'\n     include RepoManager::ViewHelper\n\n @example default to repo_manager root\n\n     path_to(\"views/templates/bla.rb\")\n\n @example repo_manager root\n\n     path_to(:repo_manager, \"views/templates/bla.rb\")\n\n @example :bootstrap\n\n     path_to(:bootstrap, \"bootstrap/css/bootstrap.css\")\n\n @overload path_to(*args)\n   @param [Symbol] base_path which gem folder should be root\n   @param [String] file_asset path to file asset parented in the given folder\n\n @return [String] absolute path to asset", "Used for Mongoid < 3.0", "Used for Mongoid >= 3.0", "Returns queue of given name.\n\n If queue doesn't exists it will create you a new one.\n Remember that for each allocated queue, there is new thread allocated.\n @param name [String, Symbol] if not passed, default queue will be returned.\n @return [GBDispatch::Queue]", "Run asynchronously given block of code on given queue.\n\n This is a proxy for {GBDispatch::Queue#perform_now} method.\n @param queue [GBDispatch::Queue] queue on which block will be executed\n @return [nil]\n @example\n   my_queue = GBDispatch::Manager.instance.get_queue :my_queue\n   GBDispatch::Manager.instance.run_async_on_queue my_queue do\n     #my delayed code here - probably slow one :)\n     puts 'Delayed Hello World!'\n   end", "Run given block of code on given queue and wait for result.\n\n This method use {GBDispatch::Queue#perform_now} and wait for result.\n @param queue [GBDispatch::Queue] queue on which block will be executed\n @example sets +my_result+ to 42\n   my_queue = GBDispatch::Manager.instance.get_queue :my_queue\n   my_result = GBDispatch::Manager.instance.run_sync_on_queue my_queue do\n     # my complicated code here\n     puts 'Delayed Hello World!'\n     # return value\n     42\n   end", "Run given block of code on given queue with delay.\n @param time [Fixnum, Float] delay in seconds\n @param queue [GBDispatch::Queue] queue on which block will be executed\n @return [nil]\n @example Will print 'Hello word!' after 5 seconds.\n   my_queue = GBDispatch::Manager.instance.get_queue :my_queue\n   my_result = GBDispatch::Manager.instance.run_after_on_queue 5, my_queue do\n     puts 'Hello World!'\n   end", "Given an array of hashes, returns an array of hash values.", "Extracts a lock token from an If headers.", "Executes the statment and populates result\n @param [Hash{Symbol => Object}] cassandra_driver execution options\n @return [Boolean] indicating a successful execution or not", "The session exection options configured for statement execution\n @return [Hash{Symbol => Object}]", "write only the attributes that we have set", "Attribute handler that delegates attribute reads to the values hash", "Returns the correct measurement for voltage, current, and power based on the corresponding power_configuration", "Returns a Ruby datatime derived from the string representing the time on the meter when the values were captured\n The raw string's format is YYMMDDWWHHMMSS where YY is year without century, and WW is week day with Sunday as the first day of the week", "Generic way of casting strings to numbers with the decimal in the correct place", "Add to the history", "generic function to run any of the gitflow commands", "master_branch\n guess_gitflow_config \n Guess the gitflow configuration", "Overwrite refile call method to supress format warnings and do post-processing", "Should be called for every jobmensa processor", "Returns a new Nokogiri document for parsing.", "History URL generator\n\n Generating URL for various types of requests within stocks.\n\n Using Yahoo Finance\n http://ichart.finance.yahoo.com/table.csv?s=%s&a=%s&b=%s&c=%s&d=%s&e=%s&f=%s&g=%s&ignore=.csv\n\n s = stock symbol\n\n Period start date\n a = start month\n b = start day\n c = start year\n\n Period end date\n d = end month\n e = end day\n f = end year\n\n g = type\n Type values allowed: 'd' for daily (the default), 'w' for weekly, 'm' for monthly and 'v' for dividends.", "Input parameters validation", "Renders an a collection using a given list of per-member fields.\n\n @param [Object] object the object to render\n @param [Hash] fields the set of fields, as from FieldExpander, to apply to each member of the collection.", "Renders an object using a given list of fields.\n\n @param [Object] object the object to render\n @param [Hash] fields the correct set of fields, as from FieldExpander", "Writes a message if the severity is high enough. This method is\n executed asynchronously.\n @param [Fixnum] severity one of the Logger levels\n @param [String] message string to log\n @param [Fixnum|String] tid thread id of the thread generating the message", "Sets the logger to use the stream specified. This method is executed\n asynchronously.\n @param [IO] stream stream to write log messages to", "Creates a new Logger to write log messages to using the parameters\n specified. This method is executed asynchronously.\n @param [String] filename filename of active log file\n @param [Fixmun] shift_age maximum number of archive files to save\n @param [Fixmun] shift_size maximum file size", "Sets the severity level of the logger. This method is executed\n asynchronously.\n @param [String|Fixnum] level value to set the severity to", "Set array of categories\n\n Params:\n +categories+:: array of StatModule::Category", "Get formatted information about findings\n\n Params:\n\n +formatted+:: indicate weather print boring or pretty colorful finding", "Gets the user's current items under 'Critical Items'.\n\n @param percentage [Integer] the maximum percentage of correctness.\n @return [Array<Hash>] critical items and their related information.", "Returns a CompiledMethod for the specified line. We search the\n current method +meth+ and then up the parent scope.  If we hit\n the top and we can't find +line+ that way, then we\n reverse the search from the top and search down. This will add\n all siblings of ancestors of +meth+.", "Enables a service to subscribe to a channel\n @param channel [String]\n @param service [Service]", "Look up a phone number and return the caller's name.\n\n @param [String] phone_number The phone number to look up\n @param [Hash] options Described below\n @option options [String] :account_sid Specify a different OpenCNAM\n   account_sid\n @option options [String] :auth_token Specify a different OpenCNAM\n   auth_token\n @option options [String, Symbol] :format (:text) The format to retrieve,\n   can be :text or :json\n @return [String, Hash] the phone number owner's name if :format is\n   :string, or a Hash of additional fields from OpenCNAM if :format\n   is :json (:created, :updated, :name, :price, :uri, and\n   :number)", "Transforms a two-digit number from 0 to 99", "Returns the \"combined\" number if it exists in the file, otherwise it will return the\n simple_number_to_words", "Merge submission PDFs, template PDFs, or custom files\n @param combine_pdfs_data\n @param [Hash] opts the optional parameters\n @return [CreateCombinedSubmissionResponse]", "Merge generated PDFs together\n @param combined_submission_data\n @param [Hash] opts the optional parameters\n @return [CreateCombinedSubmissionResponse]", "Create a new custom file from a cached presign upload\n @param create_custom_file_data\n @param [Hash] opts the optional parameters\n @return [CreateCustomFileResponse]", "Creates a new data request token for form authentication\n @param data_request_id\n @param [Hash] opts the optional parameters\n @return [CreateSubmissionDataRequestTokenResponse]", "Create a new PDF template from a cached presign upload\n @param create_template_data\n @param [Hash] opts the optional parameters\n @return [PendingTemplate]", "Expire a combined submission\n @param combined_submission_id\n @param [Hash] opts the optional parameters\n @return [CombinedSubmission]", "Expire a PDF submission\n @param submission_id\n @param [Hash] opts the optional parameters\n @return [Submission]", "Generates a new PDF\n @param template_id\n @param submission_data\n @param [Hash] opts the optional parameters\n @return [CreateSubmissionResponse]", "Look up a submission data request\n @param data_request_id\n @param [Hash] opts the optional parameters\n @return [SubmissionDataRequest]", "Check the status of a PDF\n @param submission_id\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :include_data\n @return [Submission]", "Check the status of a submission batch job\n @param submission_batch_id\n @param [Hash] opts the optional parameters\n @option opts [BOOLEAN] :include_submissions\n @return [SubmissionBatch]", "Check the status of an uploaded template\n @param template_id\n @param [Hash] opts the optional parameters\n @return [Template]", "Fetch the JSON schema for a template\n @param template_id\n @param [Hash] opts the optional parameters\n @return [Hash<String, Object>]", "Update a submission data request\n @param data_request_id\n @param update_submission_data_request_data\n @param [Hash] opts the optional parameters\n @return [UpdateDataRequestResponse]", "Returns left end of interval for next root.", "This request will provide information about one or more accounts under your platform in CSV format\n @see https://www.fusemail.com/support/api-documentation/requests#report report API documentation\n @param [Array] opts\n @option opts [String] :user ('all') The username you wish to query for information; you may also enter the username \"all\" to get information about all users under your platform\n @option opts [Boolean] :group_subaccount (true) Provide information not only for the Group Administration account but also for the group sub-accounts under the Group Administration account\n @option opts ['basic', 'extended'] :report_type ('basic') Level of detailed in returned results\n @return [Response]", "Load the platform authentication informaiton from a YAML file\n @see Request.auth_yaml_paths", "Download metadata only\n\n rubocop:disable Metrics/AbcSize\n rubocop:disable Metrics/MethodLength", "Check IPA existence locally\n\n @param local_ipa_path", "Downloads remote manifest, self.appcode required by options.\n\n @param sftp\n @param [String] remote_path\n @returns [JSON] json or nil", "Upload current IPA\n\n @param sftp\n @param [String] local_ipa_path\n @param [String] remote_ipa_path", "Upload current manifest.json\n\n @param sftp\n @param [String] manifest_path\n @param [String] remote_manifest_path", "Private methods - Local Operations", "Check if there is code_name in template branch", "Get formatted information about location", "Fetches the specified item type list from WaniKani's API\n\n @param type [String] The type of item to fetch.\n @param levels [Integer, Array<Integer>] a specific level or array of\n   levels to fetch items for.\n @return [Hash] list of items of the specified type and levels.", "Adds a periodic timer to the Eventmachine reactor loop and immediately\n starts grabbing expired resources and checking them.\n\n Gets all of the expired NetResources from the database and sends an HTTP\n GET requests for each one.  Subscribers to a NetResource will be notified\n if it has changed since the last time it was grabbed.", "Notifies each of a NetResource's subscribers that the resource has changed\n by doing an HTTP POST request to the subscriber's callback url.\n\n The POST body contains a key called \"data\" which contains the feed value.", "Determines whether a resource has changed by comparing its saved hash\n value with the hash value of the response content.", "Updates the resource's fields when the resource has changed.  The\n last_modified_hash is set to the hash value of the response body, the\n response body itself is saved so that it can be sent to consumers during\n notifications, and the resource's last_updated time is set to the current\n time.", "Build the default configuration hash, to be used to initiate the default.\n The hash is built depending on the loaded files.", "get\n get_or_save \n wrapper for get and save operations", "Returns most recently open project. If Project Navigator has a project open,\n that project will be used. This function re-loads the preferences file upon each call,\n to ensure we don't have stale data.\n\n TODO: When more than one ISE version is loaded, parse _all_ of the recent projects,\n and then return the project with the latest timestamp.", "Ingests a Prefs class and adds its answers to the\n configuration data.\n @param [Prefs] prefs The Prefs class to examine\n @return [void]", "Hook that fires when a non-existent method is called.\n Allows this module to return data from the config\n Hash when given a method name that matches a key.\n @param [<String, Symbol>] name The name of the method\n @param [Array] args The arguments\n @yield if a block is passed\n @return [Hash] The hash with the method's name as key", "Requires the ruby file, thus loading the Migration class into the ObjectSpace.\n\n @return [Version, Boolean] The Version object if successful. In other words, if\n   object representing the version returns a Cassie::Schema::Migration object.\n   Otherwise returns false.\n\n @raise [NameError] if the migration class could not be loaded", "Nullable attributes are sent as null in the request", "Let a window of size +window_size+ slide over the array +array+ and yield\n to the window array.", "Add the array +times+ to this clock's time measurements. +times+ consists\n of the time measurements in float values in order of TIMES.", "Returns a Hash of Sequence object for all of TIMES's time keys.", "Return true, if other's mean value is indistinguishable from this\n object's mean after filtering out the noise from the measurements with a\n Welch's t-Test. This mean's that differences in the mean of both clocks\n might not inidicate a real performance difference and may be caused by\n chance.", "Returns the measurements as an array of arrays.", "Takes the times an returns an array, consisting of the times in the order\n of enumerated in the TIMES constant.", "Take a single measurement. This method should be called with the code to\n benchmark in a block.", "Returns the q value for the Ljung-Box statistic of this +time+'s\n analysis.detect_autocorrelation method.", "Returns the arrays for the autocorrelation plot, the first array for the\n numbers of lag measured, the second for the autocorrelation value.", "Truncate the measurements stored in this clock starting from the integer\n +offset+.", "Find an offset from the start of the measurements in this clock to\n truncate the initial data until a stable state has been reached and\n return it as an integer.", "Load the data of file +fp+ into this clock.", "Return the length of the longest_name of all these methods' names.", "Output before +bc_method+ is run.", "Run only pre_run and post_run methods. Yield to the block, if one was\n given.", "Output after +bc_method+ is run.", "Output results to the file named +name+.", "Validate Dictionary xml with Apple's RelaxNG schema.\n\n Returns true if xml is valid.\n Returns List of Nokogiri::XML::SyntaxError objects if xml is not valid.", "Generates xml for Dictionary and Entry objects.\n\n Returns String.", "Method, which return digest, dependent on them length", "Parse generic action options for all decendant actions\n\n @return [OptionParser] for use by decendant actions", "asset options separated from assets to make it easier to override assets", "Render items result to a string\n\n @return [String] suitable for displaying on STDOUT or writing to a file", "Middleware initializer method which gets the `app` from previous\n middleware", "get result (depending on @command_mode)", "Creates a ruby string from the wrapped data. The encoding will always be ASCII_8BIT\n\n @return [String]", "Set common build variables", "Reduces the given list of libraries to bare minimum, i.e.\n the minimum needed for actual platform\n\n @libs   list of libraries\n\n @return reduced list of libraries", "Return array of library prerequisites for given file", "Creates compilation object\n\n @param  [Hash] params\n @option params [String] :source   source filename with path\n @option params [String] :object   object filename path\n @option params [Hash]   :settings project specific settings\n @option params [Array]  :includes include paths used", "from the reduced row echelon form we are left with a set\n of equivalent fractions to transform into a whole number\n we do this by using the gcdlcm method", "Now that we have the whole number from solve_equivalent_fractions\n we must apply that to each of the fractions to solve for the\n balanced equation", "returns an 2-D array where each element is a Rational", "The default handler for raised HTTP status exceptions. It will render a\n template if available, or respond with an empty response with the HTTP\n status corresponding to the exception.\n\n You can override this method in your <tt>ApplicationController</tt> to\n handle the exceptions yourself.\n\n <tt>exception</tt>:: The HTTP status exception to handle.", "Add a new event dropping off old events if that was declared\n marks are also dropped if buffer has a limit.", "Check if there is code_name in same branch", "render accepts source or block, evaluates the resulting string of ruby in the context provided", "read options from YAML config", "Yields each batch of records that was found by the options as an array.\n\n If you do not provide a block to find_in_batches, it will return an Enumerator for chaining with other methods.\n\n  query.fetch_in_batches do |records|\n   puts \"max score in group: #{records.max{ |a, b| a.score <=> b.score }}\"\n  end\n\n  \"max score in group: 26\"\n\n ==== Options\n * <tt>:batch_size</tt> - Specifies the size of the batch. Default to 1000.\n\n NOTE: Any limit specified on the query will affect the batched set.\n Cassandra internal paging is used for batching.", "Search for show", "Check if a value provided will suffice for the way\n this argument is defined.\n\n @param input, Just about anything...\n @returns Boolean. true if valid", "Returns array of rows or empty array\n\n   query.fetch(id: 1)\n   => [{id: 1, name: 'eprothro'}]", "Returns a ruby string containing the output of CFCopyDescription for the wrapped object\n\n @return [String]", "Uses CFHash to  return a hash code\n\n @return [Integer]\n eql? (and ==) are implemented using CFEqual\n\n\n equals? is defined as returning true if the wrapped pointer is the same", "Displays a chart of all the possible ANSI foreground\n and background color combinations.\n @return [void]", "Helper method to validate paramified params and to transfer any errors\n into the handler.", "Perform block after given period\n @param time [Fixnum]\n @param block [Proc]\n @yield if there is no block given it yield without param.\n @return [Concurrent::ScheduledTask]", "Sets the value of a key in a hash-of-hashes via a unix-style path.\n\n path: The path to the target key, in a unix-style path structure. See example below.\n value: The value to put into the key.\n target: The hash to operate on. If target isn't provided, we work with the base INI.\n\n Example:\n\n   set_by_path('foo/bar/tab', 3, a) would set\n   a[foo][bar][tab] = 3; setting foo and bar to", "Gets the value of a key in a hash-of-hashes via a unix-style path.\n\n path: The path to the target key, in a unix-style path structure. See example below.\n target: The hash to operate on. If target isn't provided, we work with the base INI.\n\n Example:\n\n   set_by_path('foo/bar/tab', 3, a) would set\n   a[foo][bar][tab] = 3; setting foo and bar to", "Processes a given name-value pair, adding them\n to the current INI database.\n\n Code taken from the 'inifile' gem.", "Check if a git directory has been initialized", "Check if the repositories already holds some commits", "Check the availability of a given git command", "Initialize a git repository", "Create a new branch", "Delete a branch.", "Grab a remote branch", "Publish a branch on the remote", "List the files currently under version", "list_tag\n Get the last tag commit, or nil if no tag can be found", "tag\n List of Git remotes", "Check if the subtrees have been initialized.\n Actually based on a naive check of sub-directory existence", "Pull the latest changes, assuming the git repository is not dirty", "Initializes a bucket array within", "Resize buckets to new_size.", "Calculates the width to use for buckets", "Returns the number of transitions per model along with the total\n\n @return [Hash<Symbol, Fixnum>]", "render a partial\n\n filename: unless absolute, it will be relative to the main template\n\n @example slim escapes HTML, use '=='\n\n   head\n   == render 'mystyle.css'\n\n @return [String] of non-escaped textual content", "full expanded path to the given partial", "Sets the client logger object.\n Execution is yielded to passed +block+ to set, customize, and returning a logger instance.\n\n == Returns:\n +logger+ instance variable.", "Core method of the module which attempts to check if a provided\n string matches any of the regex's as identified by the key\n\n @params key, Symbol key which maps to one of the keys in the validation_regex method below\n @params string, String to check\n @returns Boolean, true if string checks out", "A helper dictionary which returns and array of valid Regexp patterns\n in exchange for a valid key\n\n @returns Hash, dictionary of symbols and Regexp arrays", "load all the tasks in this gem plus the user's own repo_manager task folder\n\n NOTE: doesn't load any default tasks or non-RepoManager tasks", "display help for the given task", "display a list of tasks for user display", "display a list of tasks for CLI completion", "Search by provider", "Search for show by external db id", "Get all tv show info", "Returns the minimum time next in all children\n\n @return [Numeric] the min time next", "Returns the maximum time last in all children\n\n @return [Numeric] the max time last", "Order media types by quality values, remove invalid types, and return media ranges.", "Set messages for +key+ to +value+", "Delete messages for +key+", "Returns true if no errors are found, false otherwise.\n If the error message is a string it can be empty.", "Will add an error message to each of the attributes in +attributes+ that is empty.", "configure a new instance of the plugin\n @param [Hash] options the guard plugin options\n On start, display a message and optionally run the documentation lint", "Update all fields values with given params.\n @param params should looks like <tt>{price: 500, content: 'Hello'}</tt>", "Search page by template code_name in same branch of pages and templates.\n It allows to call page.category.brand.series.model etc.\n\n Return one page if founded in ancestors,\n and return array of pages if founded in descendants\n\n It determines if code_name is singular or nor\n @param cname template code name", "Returns page hash attributes with fields.\n\n Default attributes are name and title. Options param allows to add more.\n @param options default merge name and title page attributes", "Meta Tag helper", "Defines a new bitmask.\n\n @param [Symbol] name\n   The name of the bitmask.\n\n @param [Hash{Symbol => Integer}] flags\n   The flags and their masks.\n\n @param [Symbol] type\n   The underlying type.\n\n @return [BitMask]\n   The new bitmask.", "install all local versions since current\n\n a (current) | b | c | d (target) | e", "rollback all versions applied past the target\n and apply missing versions to get to target\n\n 0 | a (target) (not applied) | b | c | d (current) | e", "versions that are not applied yet\n but need to get applied\n to get up the target version\n\n | 0 (stop) | a (target) | b | c", "Declare new form field\n\n @param [Symbol] name Field name\n @param [Hash] options Options\n @option (see Ciesta::Field)", "Filters the list of changes by change type, modification time, or both.\n @param of_type [Types::Change] the change type\n @param in_range [Range<Time>] the range of modification times\n @return [Array<Resource>] the matching changes, or all changes\n   if neither +of_type+ nor +in_range+ is specified.", "Queues an operation and arguments to be called when the Actor is has no\n other requests to process.\n @param [Symbol] op method to queue for the Actor\n @param [Array] args arguments to the op method", "When an attempt is made to call a private method of the Actor it is\n places on the processing queue. Other methods cause a NoMethodError to\n be raised as it normally would.\n @param [Symbol] m method to queue for the Actor\n @param [Array] args arguments to the op method\n @param [Proc] blk ignored", "Initialize new Stat object\n\n Params:\n +process+:: StatModule::Process, required\n +hash+:: Hash, can be null\n\n Set array of findings\n\n Params:\n +findings+:: Array of StatModule::Finding", "Prints header of STAT object in json format\n Header contains statVersion, process and optional array of findings", "Prints one finding in json format.", "Get statistic information about findings\n\n Params:\n\n +formatted+:: indicate weather print boring or pretty colorful statistic", "Returns the Gravatar image URL using the Gravatar hash from the user's information.\n\n @param options [Hash] optional settings for the gravatar URL.\n @return [String, nil] the Gravatar URL, with the optional size parameter, nil if\n   the user information contains no Gravatar hash.", "A helper that renders the pagination links.\n\n   <%= slicer @article.paged %>\n\n ==== Options\n * <tt>:window</tt> - The \"inner window\" size (4 by default).\n * <tt>:outer_window</tt> - The \"outer window\" size (0 by default).\n * <tt>:left</tt> - The \"left outer window\" size (0 by default).\n * <tt>:right</tt> - The \"right outer window\" size (0 by default).\n * <tt>:params</tt> - url_for parameters for the links (:controller, :action, etc.)\n * <tt>:param_name</tt> - parameter name for slice number in the links. Accepts +symbol+, +string+, +array+.\n * <tt>:remote</tt> - Ajax? (false by default)\n * <tt>:ANY_OTHER_VALUES</tt> - Any other hash key & values would be directly passed into each tag as :locals value.", "Save the file\n\n @param dir [String] Directory path to save the file\n @param options [Hash] Options for saving\n @return int", "Covert to a flatten hash", "Returning the flattened structure to the tree structure\n\n @param [Hash] values flatten Hash\n @return [Hash] translated hash", "This is a wrapper to create collapsible content.", "Why did we need this again?", "Save specific attributes to an asset configuration file. Only the param\n 'attrs' and the current  contents of the config file are saved. Parent\n asset configurations are not saved.", "load an asset from a configuration folder", "load the raw contents from an asset_folder, ignore parents\n\n @return [Hash] of the raw text contents", "write raw contents to an asset_folder", "Generates xml for the Entry object.\n\n Returns String.", "returns a location with media attached for the given location id\n\n limit: the amount of media that should be fetched.\n request_parameters: optional parameters that will be passed to the request", "performs the actual request to the API.\n\n returns a Location object.", "perform the actual request. receives a URI as argument. Optional parameters\n and request parameter options can be passed.\n\n returns the raw http response", "parses the raw response by the remote. returns an object with a raw_response\n as method and the parsed body associated.", "Construct our default options, based upon the class methods", "Insruments block passed to the method into the current transaction.\n\n @param type Segment type (i.e 'ActiveRecord' or similar)\n @param name Specific name for the segment", "Return a convenient sorted list of all generator names.", "Yield each eligible subdirectory.", "Yield each generator within rails_generator subdirectories.", "Compare the tokens in a time-constant manner, to mitigate timing attacks.", "Override render method so as to inject emoticons, etc", "The user's response to the authorisation code request will be redirected to `redirect_uri`. If\n the request was successful there will be a `code` request parameter; otherwise `error`.\n\n redirect_uri - absolute URI to which the user will be redirected after authorisation\n state - passed back to `redirect_uri` as a request parameter\n scopes - list of scopes to which access is required", "Send a message to a specific client\n @param client_id [Integer] ID of client\n @param string [String] message to send\n @param reliable [Boolean] whether or not packet delivery is reliable\n @param channel [Integer] What channel to send on", "Send a message to all connected clients\n @param string [String] message to send\n @param reliable [Boolean] whether or not packet delivery is reliable\n @param channel [Integer] What channel to send on", "This ephemeral class allows us to create a row object that has the same attributes as the AR response\n to the query, including all the custom columns defined in the resource class report config.\n currently only used for the summary row, since we can't get that in the same AR query and have to\n add it to the collection after the query returns.", "These are the built-in filter params that define this report. They are merged at a later\n step with the runtime params entered by the user for a specific report run.\n nb. the sorter column here may be overridden by a runtime sort if requested by the user.", "These are the filters available at runtime, ie. not including the ones set to define this report.\n If updating the report, this is the set available to add as new report definition filters.", "This is the set of columns not chosed to use in the report. These are the ones available to add\n when updating a report.", "loop with each satisfied terms.\n @return [Enumerator] if block is not given.\n @return [nil] if block is given.", "Fetches remote app version from metadata", "=begin rdoc\nIf event is an Array, the output is adapted.\n\nThis outputter is only for internal use via Todonotes.\n=end", "Initialize a client which will be used to communicate with WaniKani.\n\n @param options [Hash] the API key (required) and API version (optional)\n   used to communicate with the WaniKani API.\n @return [Wanikani::Client] an instance of Wanikani::Client.\n Verifies if the client's API key is valid by checking WaniKani's API.\n\n @param api_key [String] the API key to validate in WaniKani.\n @return [Boolean] whether the API key is valid.", "Sets up the HTTP client for communicating with the WaniKani API.\n\n @return [Faraday::Connection] the HTTP client to communicate with the\n   WaniKani API.", "Contacts the WaniKani API and returns the data specified.\n\n @param resource [String] the resource to access.\n @param optional_arg [String] optional arguments for the specified resource.\n @return [Hash] the parsed API response.", "Handles exceptions according to the API response.\n\n @param response [Hash] the parsed API response from WaniKani's API.", "Access a field, lazily parsing if not yet parsed", "Access an element, lazily parsing if not yet parsed", "main repo_manager configuration setttings file", "Each endpoint needs to have a requester in order to ... make ... uh ... requests.\n Generic request wrapper", "Create an endpoint instance and foist it upon this node\n Not private, but not part of the public interface for an endpoint", "Get the parent chain that led to this endpoint", "performs the actual http request", "Writing if GameBalance", "Writing multiple files to given dir.", "Return analyzed attributes", "Serialize for wire", "link_to mongoid_cart.remove_item_path", "link_to mongoid_cart.add_item_path", "Callback will be called multiple times", "Convert a Numeral to a different base", "Expand to the specified number of digits,\n then truncate and remove repetitions.\n If no number of digits is given, then it will be\n converted to approximate numeral only if it is not\n repeating.", "Recurrently flattens hash by converting its keys to fully scoped ones.\n\n @return [Hash{String => String}]\n @param translations [Hash{String/Symbol => String/Hash}] with multiple\n   roots allowed\n @param current_scope for internal use\n\n @example\n   Scope.flatten(en: {common: {hello: \"hi\"}}, de: {hello: \"Hallo\"}) #=>\n     {\"en.common.hello\" => \"hi\", \"de.hello\" => \"Hallo\"}", "Combines each locale with all keys.\n\n @return [Array<String>]\n @param locales [Array<String, Symbol>]\n @param keys [Array<String, Symbol>]\n\n @example\n   Scope.cross_join([:de, :en], [:hello, :hi]) #=>\n     [\"de.hello\", \"de.hi\", \"en.hello\", \"en.hi\"]", "Create column analyzers", "Update numeric results\n @param ac analyzer class\n @param ar analyzer results\n @param val value to be analyzed", "Creates a link using +link_to+ for a page in a pagination collection. If\n the specified page is the current page then its class will be `current'.\n\n Options:\n   [:page_parameter]\n     The name of the GET parameter used to indicate the page to display.\n     Defaults to <tt>:page</tt>.\n   [:current_class]\n     The CSS class name used when a page is the current page in a pagination\n     collection. Defaults to <tt>:current</tt>.", "Returns an array of pages to link to. This array includes the separator, so\n make sure to keep this in mind when iterating over the array and creating\n links.\n\n For consistency\u2019s sake, it is adviced to use an odd number for\n <tt>:max_visible</tt>.\n\n Options:\n   [:max_visible]\n     The maximum amount of elements in the array, this includes the\n     separator(s). Defaults to 11.\n   [:separator]\n     The separator string used to indicate a range between the first or last\n     page and the ones surrounding the current page.\n\n   collection = Model.all.page(40)\n   collection.page_count # => 80\n\n   pages_to_link_to(collection) # => [1, '\u2026', 37, 38, 39, 40, 41, 42, 43, '\u2026', 80]", "Initializes a new `Client` for executing commands.\n\n @param [String] host\n   The host to connect to.\n\n @param [Integer] port\n   The port to connect to.\n\n Sends the `devdetails` command, returning an array of devices found in the\n service's response.\n\n @return [Response]\n   An array of devices.", "Sends the supplied `command` with optionally supplied `parameters` to the\n service and returns the result, if any.\n\n **Note:** Since `Object#send` is overridden, use `Object#__send__` to call\n an actual method.\n\n @param [Symbol, String] command\n   The command to send to the service.\n\n @param [Array] parameters\n   Optional parameters to send to the service.\n\n @return [Response]\n   The service's response.", "Output flash and object errors", "Output a page update that will display messages in the flash", "List of number links for the number range between next and previous", "Adds an observer to this set. If a block is passed, the observer will be\n created by this method and no other params should be passed\n\n @param [Object] observer\n   the observer to add\n\n @param [Symbol] func\n   the function to call on the observer during notification. The default\n   is :update.\n\n @return [Object]\n   the added observer", "Parses raw data and returns news items\n\n @return [Array]", "Returns the column indeces to drop to make this table have the given columns", "Returns a dried up version of the given row\n based on the row that came before in the table\n\n In a dried up row, any values that match the previous row are removed,\n stopping on the first difference", "Recursively fetch value for key path in the configuration object.\n\n This method serves as a base accessor to the properties that are defined in\n the central property collection.  It is used and built upon by other\n accessors defined in the class.\n\n Hash data is assumed to already be symbolized.\n\n * *Parameters*\n   - [Hash] *data*  Configuration property data\n   - [Array<String, Symbol>, String, Symbol] *keys*  Key path to fetch\n   - [ANY] *default*  Default value is no value is found for key path\n   - [false, Symbol, String] *format*  Format to filter final returned value or false for none\n\n * *Returns*\n   - [ANY]  Filtered value for key path from configuration object\n\n * *Errors*\n\n See:\n - #filter\n - Nucleon::Util::Data::filter", "Modify value for key path in the configuration object.\n\n This method serves as a base modifier to the properties that are defined in\n the central property collection.  It is used and built upon by other\n modifiers defined in the class.\n\n Hash data is assumed to already be symbolized.\n\n * *Parameters*\n   - [Hash] *data*  Configuration property data\n   - [Array<String, Symbol>, String, Symbol] *keys*  Key path to modify\n   - [ANY] *value*  Value to set for key path\n   - [Boolean] *delete_nil*  Delete nil value (serves as an internal way to delete properties)\n\n * *Returns*\n   - [ANY]  Existing value for key path from configuration object (before update)\n\n * *Errors*\n\n * *Yields*\n   - [Symbol]  *key*  Configuration key to modify\n   - [ANY] *value*  New value of configuration key\n   - [ANY] *existing*  Existing value being replaced for the configuration key\n\n See:\n - #symbol_map\n - Nucleon::Util::Data::symbol_map", "Fetch value for key path in the configuration object.\n\n * *Parameters*\n   - [Array<String, Symbol>, String, Symbol] *keys*  Key path to fetch\n   - [ANY] *default*  Default value is no value is found for key path\n   - [false, Symbol, String] *format*  Format to filter final returned value or false for none\n\n * *Returns*\n   - [ANY]  Filtered value for key path from configuration object\n\n * *Errors*\n\n See:\n - #fetch\n\n See also:\n - #array", "Set value for key path in the configuration object.\n\n * *Parameters*\n   - [Array<String, Symbol>, String, Symbol] *keys*  Key path to modify\n   - [ANY] *value*  Value to set for key path\n   - [Boolean] *delete_nil*  Delete nil value (serves as an internal way to delete properties)\n\n * *Returns*\n   - [Nucleon::Config]  Returns reference to self for compound operations\n\n * *Errors*\n\n * *Yields*\n   - [Symbol]  *key*  Configuration key to modify\n   - [ANY] *value*  New value of configuration key\n   - [ANY] *existing*  Existing value being replaced for the configuration key\n\n See:\n - #modify\n\n See also:\n - #array", "Append a value for an array key path in the configuration object.\n\n * *Parameters*\n   - [Array<String, Symbol>, String, Symbol] *keys*  Key path to modify\n   - [ANY] *value*  Value to set for key path\n\n * *Returns*\n   - [Nucleon::Config]  Returns reference to self for compound operations\n\n * *Errors*\n\n See:\n - #modify\n\n See also:\n - #array", "Prepend a value to an array key path in the configuration object.\n\n * *Parameters*\n   - [Array<String, Symbol>, String, Symbol] *keys*  Key path to modify\n   - [ANY] *value*  Value to set for key path\n   - [Boolean] *reverse*  Whether or not to reverse any input value arrays given before prepending\n\n * *Returns*\n   - [Nucleon::Config]  Returns reference to self for compound operations\n\n * *Errors*\n\n See:\n - #modify\n\n See also:\n - #array", "Delete key path from the configuration object.\n\n * *Parameters*\n   - [Array<String, Symbol>, String, Symbol] *keys*  Key path to remove\n   - [ANY] *default*  Default value to return if no existing value found\n\n * *Returns*\n   - [ANY]  Returns default or last value removed from configuration object\n\n * *Errors*\n\n See:\n - #modify\n\n See also:\n - #array", "Set default property values in the configuration object if they don't exist.\n\n If defaults are given as a string or symbol and the configuration object\n has a lookup method implemented (corl gem) then the defaults will be\n dynamically looked up and set.\n\n * *Parameters*\n   - [String, Symbol, Array, Hash] *defaults*  Data to set as defaults\n   - [Hash] *options*  Import options\n\n * *Returns*\n   - [Nucleon::Config]  Returns reference to self for compound operations\n\n * *Errors*\n\n See:\n - #import_base\n\n See also:\n - ::new\n - #set", "Return a symbolized array\n\n * *Parameters*\n   - [Array<String, Symbol>] *array*  Array of strings or symbols\n\n * *Returns*\n   - [Array<Symbol>]  Returns array of symbols\n\n * *Errors*", "==this is the primary interface for subscribing.\n\n params::\n     * +card+  (required)           ->    the token returned by stripe.js\n     * +plan+  (required)           ->    the id of the plan being subscribed to\n     * +email+  (optional)          ->    the client's email address\n     * +description+  (optional)    ->    a description to attach to the stripe object for future reference\n     * +coupon+  (optional)         ->    the id of a coupon if the subscription should be discounted\n     * +lines+   (optional)         ->    an array of (amount,description) tuples\n example::\n    :card => \"tok_abc123\",\n    :plan => \"MySaaS\",\n    :email => subscriber.email,\n    :description => \"a one year subscription to our flagship service at $99.00 per month\"\n    :lines => [\n       [ 20000, \"a one time setup fee of $200.00 for new members\" ]\n    ]", "Creates a simple workbook with one sheet.\n\n Predefines multiple styles that can be used to format cells.\n The +sheet+ and +styles+ are yielded to the provided block.\n\n See Axlsx::Workbook#predefined_styles for a list of predefined styles.", "Gets the predefined style list.\n\n The +predefined_styles+ hash contains :bold, :date, :float, :integer, :percent, :currency, :text, :wrapped, and :normal\n styles for you to use.", "Adds a row to the worksheet with combined data.\n\n Currently we support specifying the +values+, +styles+, and +types+ using this method.\n\n The +row_data+ value should be an array of arrays.\n Each subarray represents a value in the row with up to three values specifying the +value+, +style+, and +type+.\n Value is the only item required.\n   [['Value 1', :bold, :string], ['Value 2'], ['Value 3', nil, :string]]\n\n In fact, if a subarray is replaced by a value, it is treated the same as an array only containing that value.\n   [['Value 1', :bold, :string], 'Value 2', ['Value 3', nil, :string]]\n\n The +keys+ parameter defines the location of the data elements within the sub arrays.\n The default would be [ :value, :style, :type ].  If your array happens to have additional data or data arranged\n in a different format, you can set this to anything you like to get the method to process your data\n appropriately.\n   keys = [ :ignored, :value, :ignored, :ignored, :style, :ignored, :type ]\n\n Styles can be specified as a symbol to use the predefined styles, or as a style object you created.", "Joins the given source fixture to the target fixture on the specified fields.\n\n @param [Symbol] source the source file fixture in the join spec directory\n @param [Symbol] target the target file fixture in the join spec directory\n @param [<String>] fields the source fields (default is all source fields)\n @return [<<String>>] the output records", "creates a select control with states.  Default id is 'states'.  If 'retain' is passed for the class value the value of this\n control will be written into a cookie with the key 'states'.", "creates a select control with countries.  Default id is 'countries'.  If 'retain' is passed for the class value the value of this\n control will be written into a cookie with the key 'countries'.", "creates a select control with languages.  Default id is 'languages'.  If 'retain' is passed for the class value the value of this\n control will be written into a cookie with the key 'languages'.", "Logs a success message for a user.", "File name or json string or hash", "copied from the URL implementation... weird but I want to have\n classes not methods for this", "This method is usually used as a before filter from admin controllers to ensure that the logged in user is a super admin", "Renders the template\n\n @example Render the default template\n   view.render\n\n @example Render the foo template\n   view.render \"foo.slim\"\n\n @example You can use symbols and omit the extension\n   view.render :foo\n\n @example You can specify what the local variables for the template should be\n   view.render :foo, :bar => \"baz\"\n\n @example You can use the default template an specify locals\n   view.render :bar => \"baz\"\n\n @param [String, Symbol] name The name of the template.\n   The extension can be omitted.\n   This parameter can be omiitted and the default template will be used.\n @param [Hash] locals\n @return [String] The result of rendering the template\n @see #default_template_name", "Accessing a cell or a zone.", "Putting new content in a cell.", "Create a new node", "Removes an existing node", "Associate a role with a node in a environment", "Prepare the nodes in a environment", "Check the nodes already prepared and ask confirmation to re-do-it", "Keep asking for a hostname that not exist", "Ask for the ip until is valid", "login to my account\n get all the transactions", "String should be either a filename or YAML", "assumes matching_results_ids in the session\n drops a given remove_id from the session variable", "assumes matching_results_ids in the session\n puts back a given restore_id in the session variable", "mount a context as a sub context here\n\n @param [Symbol] id of component to mount context to\n @param [Symbol] ref of context to be mounted\n @param [{Symbol => String,Number,Boolean}] list of attributes to attach to tag", "Just to make the interface compatible", "Process the provided attributes casting them to their proper values if a\n field exists for them on the document. This will be limited to only the\n attributes provided in the suppied +Hash+ so that no extra nil values get\n put into the document's attributes.\n\n @example Process the attributes.\n   person.process_attributes(:title => \"sir\", :age => 40)\n\n @param [ Hash ] attrs The attributes to set.\n\n @since 2.0.0.rc.7", "Copies data to S3\n @param data [Object] The path to the file in the temporary work location\n @return [true] On success", "Builds the directory structure", "Checks if file is listed in the includes list and if so copies it from\n the given location. If not it creates a blank file.", "Parses the task string and runs the task.\n\n Will check *Skeleton::Tasks* module first before running tasks\n from the `tasks.rb` file in the template directory.", "Store a value in this native element\n\n @param [Object] value New value for native element.\n\n @return [Object] Returns +value+.\n\n @private", "Store new value in this pointer\n\n @param [Object] value New value for this pointer object.\n\n @return [Object] Returns +value+.\n\n @private", "If a block is passed in, it is given self.", "This defines a command line argument that takes a value.", "This defines a command line argument that's either on or off based on the presense\n of the flag.", "Create the settings for the Admin panel to work!", "create a new admin user", "Compares the expected and produced directory by using the rules\n defined in the context\n\n @param  [Block<(Diff)->()>] diff_block\n         The block, where you will likely define a test for each file to compare.\n         It will receive a Diff of each of the expected and produced files.", "Compares the expected and produced directory by using the rules\n defined in the context for unexpected files.\n\n This is separate because you probably don't want to define an extra\n test case for each file, which wasn't expected at all. So you can\n keep your test cases consistent.\n\n @param  [Block<(Array)->()>] diff_block\n         The block, where you will likely define a test that no unexpected files exists.\n         It will receive an Array.", "Prepare the temporary directory", "Copies the before subdirectory of the given tests folder in the raw\n directory.", "Applies the in the context configured transformations.", "Searches recursively for all files and take care for including hidden files\n if this is configured in the context.\n\n @param  [String] path\n         The relative or absolute path to search in (optional)\n\n @return [Array<Pathname>]", "Compares two files to check if they are identical and produces a clear diff\n to highlight the differences.\n\n @param  [Pathname] expected\n         The file in the after directory\n\n @param  [Pathname] relative_path\n         The file in the temp directory\n\n @param  [Block<(Pathname)->(to_s)>] block\n         the block, which transforms the files in a better comparable form\n\n @return [Diff]\n         An object holding a diff", "Retrieve the class for a relation, based on its defined RDF predicate\n\n @param [RDF::URI] predicate a URI for the RDF::Term\n @return [Ladder::Resource, Ladder::File, nil] related class", "Retrieve the attribute name for a field or relation,\n based on its defined RDF predicate\n\n @param [RDF::URI] predicate a URI for the RDF::Term\n @return [String, nil] name for the attribute", "Set values on a defined relation\n\n @param [String] field_name ActiveModel attribute name for the field\n @param [Array<Object>] obj objects (usually Ladder::Resources) to be set\n @return [Ladder::Resource, nil]", "Set values on a field; this will cast values\n from RDF types to persistable Mongoid types\n\n @param [String] field_name ActiveModel attribute name for the field\n @param [Array<Object>] obj objects (usually RDF::Terms) to be set\n @return [Object, nil]", "Cast values from Mongoid types to RDF types\n\n @param [Object] value ActiveModel attribute to be cast\n @param [Hash] opts options to pass to RDF::Literal\n @return [RDF::Term]", "Output content of object from stored file or readable input\n\n @return [String] string-encoded copy of binary data", "Formats the number using the short scale for any number over 1 million.", "generate sublime text2 sunippets from Sunippetdefine", "Count log lines are used to submit increments to Librato.\n\n You can submit increments as frequently as desired and every minute the\n current total will be flushed to Librato and reset to zero.\n\n @param event [String] The name of the event\n @param number [Integer] The number to increment the current count (defaults to 1)", "Measure log lines are used to submit individual measurements that comprise\n a statistical distribution. The most common use case are timings i.e.\n latency measurements, but it can also be used to represent non-temporal\n distributions such as counts.\n\n You can submit as many measures as you\u2019d like (typically they are\n submitted per-request) and every minute Librato will calculate/record a\n complete set of summary statistics over the measures submitted in that\n interval.\n\n The `measure` method also accepts a block of code which will automatically\n measure the amount of time spent running that block:\n\n     measure 'foo.bar.baz' do\n       Foo.bar #=> 'baz'\n     end\n\n For convenience, when `measure` is used with a block it will return the\n value returned by the block.\n\n @param event [String] The name of the event\n @param value [Integer, String] The value measured.", "Submit a message from the messenger.\n The thread will wait its turn if another event is being processed.\n @param message_string [String]\n @return [void]", "Adds value to the path", "Execute block with the current reg settings", "Runs the model validations plus the associated models validations and\n merges each messages in the errors hash\n\n @return [Boolean]", "Write +msg+ to standard output according to verbosity settings. Not meant\n to be used directly", "loads the troopfile and sets the environment up", "Create a test suite\n\n pattern - A pattern to filter the tests that are added to the suite\n\n Returns an Array of Test objects", "Checks all ignore patterns against a given relative path\n\n path - A relative path of a test\n\n Returns true if any patterns match the path, false otherwise", "Write typed value to memory\n\n @param [Node] value Value to write to memory.\n\n @return [Node] Returns +value+.", "update the currently used theme", "remove the theme from the theme folder stopping any future usage.", "Returns a randomly generated sentence of lorem ipsum text.\n The first word is capitalized, and the sentence ends in either a period or\n question mark. Commas are added at random.", "Asks for the project parameters and create the project skeleton", "Validate uri download or local box existence", "Obtain the current boxes downloaded or linked in the bebox user home", "Asks to choose an existing box in the bebox boxes directory", "Download a box by the specified uri", "Handler which executes the `fallback_policy` once the queue size reaches\n `max_queue`.\n\n @param [Array] args\n   The arguments to the task which is being handled.\n\n @!visibility private", "Submit a task to the executor for asynchronous processing.\n\n @param [Array] args\n   Zero or more arguments to be passed to the task\n\n @yield the asynchronous task to perform\n\n @raise [ArgumentError]\n   if no task is given\n\n @return [Boolean]\n   True if the task is queued, false if the executor is not running.", "Begin an immediate shutdown. In-progress tasks will be allowed to complete\n but enqueued tasks will be dismissed and no new tasks will be accepted.\n Has no additional effect if the thread pool is not running.", "takes two scientific names and returns true\n if names match and false if they don't", "takes two hashes of parsed scientific names, analyses them and\n returns back this function is useful when species strings are preparsed.", "Hook this gem in a test framework by a supported adapter\n\n @param  [Symbol] test_framework\n         the test framework", "Handles the response from Instapaper.\n\n @todo Put the raising logic in the Api class/module, then leave the response return\n to this method", "Actually heads out to the internet and performs the request\n @todo Perhaps put me in the Api class/module?", "Rate the tournament. Called after all players and results have been added.", "Calculate bonuses for all players and return the number who got one.", "Migrates this domain object's migratable references. This method is called by the\n Migrator and should not be overridden by subclasses. Subclasses tailor\n individual reference attribute migration by defining a +migrate_+_attribute_ method\n for the _attribute_ to modify.\n\n The migratable reference attributes consist of the non-collection saved independent\n attributes and the unidirectional dependent attributes which don't already have a value.\n For each such migratable attribute, if there is a single instance of the attribute\n type in the given migrated domain objects, then the attribute is set to that\n migrated instance.\n\n If the attribute is associated with a method in proc_hash, then that method is called\n on the migrated instance and input row. The attribute is set to the method return value.\n proc_hash includes an entry for each +migrate_+_attribute_ method defined by this\n Resource's class.\n\n @param [{Symbol => Object}] row the input row field => value hash\n @param [<Resource>] migrated the migrated instances, including this Resource\n @param [Class] target the migration target class\n @param [{Symbol => Proc}, nil] proc_hash a hash that associates this domain object's\n   attributes to a migration shim block", "Creates a new instance. Max is the total number of iterations of the\n loop. The depth represents how many other loops are above this one,\n this information is used to find the place to print the progress\n report.\n\n Used to register a new completed loop iteration.", "Prints de progress report. It backs up as many lines as the meters\n depth. Prints the progress as a line of dots, a percentage, time\n spent, and time left. And then goes moves the cursor back to its\n original line. Everything is printed to stderr.", "yield each key part\n dots inside braces or parenthesis are not split on", "Processes a line of stream data if it is relevant to this subscription. This method is thread-safe and is intended\n to be called by the session's processing thread.\n\n @param [String] line The line of stream data to process.\n\n @return [Boolean] Whether the passed line of stream data was processed by this subscription.\n\n @private", "Returns the control request arguments to use to perform the specified action on this subscription.\n\n @private", "Callback, assure that we add steps from parent class", "Displays the given text on the board.\n\n This is short-hand for the {WriteTextCommand}\n\n @param text [String] the text to display on the sign\n @param options [Hash] options for {WriteTextCommand}\n @option options [Integer] :display_pause (2) Time to pause (in seconds) between pages of text.  See {WriteTextCommand#display_pause}\n\n @return [self]", "Sends the specified Movingsign command to this sign's serial port\n\n @param [MovingsignApi::Command] command subclass to send\n\n @return [self]", "Initialize the wurtzite Geometry\n cation and anion are the  atomic\n species occupying the two different sub-lattices.\n lattice_const specifies the lattice constant", "Fetch Job messages\n @param offset Offset (Greater than or equal to) ID for Messages to fetch from\n @param job_id Job ID\n @param [Hash] opts the optional parameters\n @option opts [Integer] :limit Number of limits\n @return [Array<JobMessageEachResponse>]", "checks to see if the admin logged in has the necesary rights, if not it will redirect them with an error message", "Adds a filter to the given property access methods if it is a String or Date.", "Adds a number -> string filter to the given String property Ruby access methods.", "Adds a Java-Ruby Date filter to the given Date property Ruby access methods.\n The reader returns a Ruby date. The writer sets a Java date.", "Aliases the given Ruby property reader and writer to its underlying Java property reader and writer, resp.\n\n @param [Property] property the property to alias", "Makes a standard attribute for the given property descriptor.\n Adds a camelized Java-like alias to the standard attribute.\n\n @param (see #define_java_property)\n @return [Property] the new property", "Defines methods _aliaz_ and _aliaz=_ which calls the standard _attribute_ and\n _attribute=_ accessor methods, resp.\n Calling rather than aliasing the attribute accessor allows the aliaz accessor to\n reflect a change to the attribute accessor.", "Create an archive using the instance's configuration.\n\n @return [String] Path to the archive", "Break broker serialized identity down into individual parts if exists\n\n === Parameters\n id(Integer|String):: Broker alias or serialized identity\n\n === Return\n (Array):: Host, port, index, and priority, or all nil if broker not found", "Get broker serialized identity if client exists\n\n === Parameters\n id(Integer|String):: Broker alias or serialized identity\n\n === Return\n (String|nil):: Broker serialized identity if client found, otherwise nil", "Get serialized identity of connected brokers\n\n === Return\n (Array):: Serialized identity of connected brokers", "Get serialized identity of failed broker clients, i.e., ones that were never successfully\n connected, not ones that are just disconnected\n\n === Return\n (Array):: Serialized identity of failed broker clients", "Make new connection to broker at specified address unless already connected\n or currently connecting\n\n === Parameters\n host{String):: IP host name or address for individual broker\n port(Integer):: TCP port number for individual broker\n index(Integer):: Unique index for broker within set for use in forming alias\n priority(Integer|nil):: Priority position of this broker in set for use by this agent\n   with nil or a value that would leave a gap in the list meaning add to end of list\n force(Boolean):: Reconnect even if already connected\n\n === Block\n Optional block with following parameters to be called after initiating the connection\n unless already connected to this broker:\n   identity(String):: Broker serialized identity\n\n === Return\n (Boolean):: true if connected, false if no connect attempt made\n\n === Raise\n Exception:: If host and port do not match an existing broker but index does", "Subscribe an AMQP queue to an AMQP exchange on all broker clients that are connected or still connecting\n Allow connecting here because subscribing may happen before all have confirmed connected\n Do not wait for confirmation from broker client that subscription is complete\n When a message is received, acknowledge, unserialize, and log it as specified\n If the message is unserialized and it is not of the right type, it is dropped after logging a warning\n\n === Parameters\n queue(Hash):: AMQP queue being subscribed with keys :name and :options,\n   which are the standard AMQP ones plus\n     :no_declare(Boolean):: Whether to skip declaring this queue on the broker\n       to cause its creation; for use when client does not have permission to create or\n       knows the queue already exists and wants to avoid declare overhead\n exchange(Hash|nil):: AMQP exchange to subscribe to with keys :type, :name, and :options,\n   nil means use empty exchange by directly subscribing to queue; the :options are the\n   standard AMQP ones plus\n     :no_declare(Boolean):: Whether to skip declaring this exchange on the broker\n       to cause its creation; for use when client does not have create permission or\n       knows the exchange already exists and wants to avoid declare overhead\n options(Hash):: Subscribe options:\n   :ack(Boolean):: Whether client takes responsibility for explicitly acknowledging each\n     message received, defaults to implicit acknowledgement in AMQP as part of message receipt\n   :no_unserialize(Boolean):: Do not unserialize message, this is an escape for special\n     situations like enrollment, also implicitly disables receive filtering and logging;\n     this option is implicitly invoked if initialize without a serializer\n   (packet class)(Array(Symbol)):: Filters to be applied in to_s when logging packet to :info,\n     only packet classes specified are accepted, others are not processed but are logged with error\n   :category(String):: Packet category description to be used in error messages\n   :log_data(String):: Additional data to display at end of log entry\n   :no_log(Boolean):: Disable receive logging unless debug level\n   :exchange2(Hash):: Additional exchange to which same queue is to be bound\n   :brokers(Array):: Identity of brokers for which to subscribe, defaults to all usable if nil or empty\n\n === Block\n Block with following parameters to be called each time exchange matches a message to the queue:\n   identity(String):: Serialized identity of broker delivering the message\n   message(Packet|String):: Message received, which is unserialized unless :no_unserialize was specified\n   header(AMQP::Protocol::Header):: Message header (optional block parameter)\n\n === Return\n identities(Array):: Identity of brokers where successfully subscribed", "Unsubscribe from the specified queues on usable broker clients\n Silently ignore unknown queues\n\n === Parameters\n queue_names(Array):: Names of queues previously subscribed to\n timeout(Integer):: Number of seconds to wait for all confirmations, defaults to no timeout\n\n === Block\n Optional block with no parameters to be called after all queues are unsubscribed\n\n === Return\n true:: Always return true", "Check status of specified queues for connected brokers\n Silently ignore unknown queues\n If a queue whose status is being checked does not exist,\n the associated broker connection will fail and be unusable\n\n === Parameters\n queue_names(Array):: Names of queues previously subscribed to that are to be checked\n timeout(Integer):: Number of seconds to wait for all status checks, defaults to no timeout\n\n === Block\n Optional block to be called after all queue statuses are obtained with hash parameter\n containing statuses with queue name as key and value that is a hash with broker identity\n as key and hash of :messages and :consumers as value; the :messages and :consumers\n values are nil if there is a failure retrieving them for the given queue\n\n === Return\n true:: Always return true", "Publish message to AMQP exchange of first connected broker\n\n === Parameters\n exchange(Hash):: AMQP exchange to subscribe to with keys :type, :name, and :options,\n   which are the standard AMQP ones plus\n     :no_declare(Boolean):: Whether to skip declaring this exchange or queue on the broker\n       to cause its creation; for use when client does not have create permission or\n       knows the object already exists and wants to avoid declare overhead\n     :declare(Boolean):: Whether to delete this exchange or queue from the AMQP cache\n       to force it to be declared on the broker and thus be created if it does not exist\n packet(Packet):: Message to serialize and publish\n options(Hash):: Publish options -- standard AMQP ones plus\n   :mandatory(Boolean):: Return message if the exchange does not have any associated queues\n     or if all the associated queues do not have any consumers\n   :immediate(Boolean):: Return message for the same reasons as :mandatory plus if all\n     of the queues associated with the exchange are not immediately ready to consume the message\n   :fanout(Boolean):: true means publish to all connected brokers\n   :brokers(Array):: Identity of brokers selected for use, defaults to all brokers\n     if nil or empty\n   :order(Symbol):: Broker selection order: :random or :priority,\n     defaults to @select if :brokers is nil, otherwise defaults to :priority\n   :no_serialize(Boolean):: Do not serialize packet because it is already serialized,\n     this is an escape for special situations like enrollment, also implicitly disables\n     publish logging; this option is implicitly invoked if initialize without a serializer\n   :log_filter(Array(Symbol)):: Filters to be applied in to_s when logging packet to :info\n   :log_data(String):: Additional data to display at end of log entry\n   :no_log(Boolean):: Disable publish logging unless debug level\n\n === Return\n identities(Array):: Identity of brokers where packet was successfully published\n\n === Raise\n NoConnectedBrokers:: If cannot find a connected broker", "Delete queue in all usable brokers or all selected brokers that are usable\n\n === Parameters\n name(String):: Queue name\n options(Hash):: Queue declare options plus\n   :brokers(Array):: Identity of brokers in which queue is to be deleted\n\n === Return\n identities(Array):: Identity of brokers where queue was deleted", "Delete queue resources from AMQP in all usable brokers\n\n === Parameters\n name(String):: Queue name\n options(Hash):: Queue declare options plus\n   :brokers(Array):: Identity of brokers in which queue is to be deleted\n\n === Return\n identities(Array):: Identity of brokers where queue was deleted", "Remove a broker client from the configuration\n Invoke connection status callbacks only if connection is not already disabled\n There is no check whether this is the last usable broker client\n\n === Parameters\n host{String):: IP host name or address for individual broker\n port(Integer):: TCP port number for individual broker\n\n === Block\n Optional block with following parameters to be called after removing the connection\n unless broker is not configured\n   identity(String):: Broker serialized identity\n\n === Return\n identity(String|nil):: Serialized identity of broker removed, or nil if unknown", "Declare a broker client as unusable\n\n === Parameters\n identities(Array):: Identity of brokers\n\n === Return\n true:: Always return true\n\n === Raises\n Exception:: If identified broker is unknown", "Close all broker client connections\n\n === Block\n Optional block with no parameters to be called after all connections are closed\n\n === Return\n true:: Always return true", "Close an individual broker client connection\n\n === Parameters\n identity(String):: Broker serialized identity\n propagate(Boolean):: Whether to propagate connection status updates\n\n === Block\n Optional block with no parameters to be called after connection closed\n\n === Return\n true:: Always return true\n\n === Raise\n Exception:: If broker unknown", "Register callback to be activated when there is a change in connection status\n Can be called more than once without affecting previous callbacks\n\n === Parameters\n options(Hash):: Connection status monitoring options\n   :one_off(Integer):: Seconds to wait for status change; only send update once;\n     if timeout, report :timeout as the status\n   :boundary(Symbol):: :any if only report change on any (0/1) boundary,\n     :all if only report change on all (n-1/n) boundary, defaults to :any\n   :brokers(Array):: Only report a status change for these identified brokers\n\n === Block\n Required block activated when connected count crosses a status boundary with following parameters\n   status(Symbol):: Status of connection: :connected, :disconnected, or :failed, with\n     :failed indicating that all selected brokers or all brokers have failed\n\n === Return\n id(String):: Identifier associated with connection status request", "Reset broker client statistics\n Do not reset disconnect and failure stats because they might then be\n inconsistent with underlying connection status\n\n === Return\n true:: Always return true", "Connect to all configured brokers\n\n === Return\n (Array):: Broker clients created", "Determine priority of broker\n If broker not found, assign next available priority\n\n === Parameters\n identity(String):: Broker identity\n\n === Return\n (Integer):: Priority position of broker", "Iterate over clients that have the specified status\n\n === Parameters\n status(String):: Status for selecting: :usable, :connected, :failed\n identities(Array):: Identity of brokers to be considered, nil or empty array means all brokers\n\n === Block\n Optional block with following parameters to be called for each broker client selected\n   broker(BrokerClient):: Broker client\n\n === Return\n (Array):: Selected broker clients", "Select the broker clients to be used in the desired order\n\n === Parameters\n options(Hash):: Selection options:\n   :brokers(Array):: Identity of brokers selected for use, defaults to all brokers if nil or empty\n   :order(Symbol):: Broker selection order: :random or :priority,\n     defaults to @select if :brokers is nil, otherwise defaults to :priority\n\n === Return\n (Array):: Allowed BrokerClients in the order to be used", "Handle message returned by broker because it could not deliver it\n If agent still active, resend using another broker\n If this is last usable broker and persistent is enabled, allow message to be queued\n on next send even if the queue has no consumers so there is a chance of message\n eventually being delivered\n If persistent or one-way request and all usable brokers have failed, try one more time\n without mandatory flag to give message opportunity to be queued\n If there are no more usable broker clients, send non-delivery message to original sender\n\n === Parameters\n identity(String):: Identity of broker that could not deliver message\n to(String):: Queue to which message was published\n reason(String):: Reason for return\n   \"NO_ROUTE\" - queue does not exist\n   \"NO_CONSUMERS\" - queue exists but it has no consumers, or if :immediate was specified,\n     all consumers are not immediately ready to consume\n   \"ACCESS_REFUSED\" - queue not usable because broker is in the process of stopping service\n message(String):: Returned message in serialized packet format\n\n === Return\n true:: Always return true", "Overrides method missing to catch undefined methods. If +method_name+ is one\n of the keys on +attributes+, returns the value of that attribute. If +method_name+\n is not one of +attributes+, passes up the chain to super.\n\n method_name - Symbol of the name of the method we're testing for.\n args        - Array of arguments send with the original mesage.\n block       - Proc of code passed with original message.", "Creates a new visitor which matches source and target domain object references.\n The domain attributes to visit are determined by calling the selector block given to\n this initializer. The selector arguments consist of the match source and target.\n\n @param (see ReferenceVisitor#initialize)\n @option opts [Proc] :mergeable the block which determines which attributes are merged\n @option opts [Proc] :matchable the block which determines which attributes to match\n   (default is the visit selector)\n @option opts [:match] :matcher an object which matches sources to targets\n @option opts [Proc] :copier the block which copies an unmatched source\n @yield (see ReferenceVisitor#initialize)\n @yieldparam [Resource] source the matched source object\n Visits the source and target.\n\n If a block is given to this method, then this method returns the evaluation of the block on the visited\n source reference and its matching copy, if any. The default return value is the target which matches\n source.\n\n @param [Resource] source the match visit source\n @param [Resource] target the match visit target\n @yield [target, source] the optional block to call on the matched source and target\n @yieldparam [Resource] source the visited source domain object\n @yieldparam [Resource] target the domain object which matches the visited source\n @yieldparam [Resource] from the visiting domain object\n @yieldparam [Property] property the visiting property", "Visits the given source domain object.\n\n @param [Resource] source the match visit source\n @yield [target, source] the optional block to call on the matched source and target\n @yieldparam [Resource] source the visited source domain object\n @yieldparam [Resource] target the domain object which matches the visited source\n @yieldparam [Resource] from the visiting domain object\n @yieldparam [Property] property the visiting property", "Matches the given source and target attribute references.\n The match is performed by this visitor's matcher.\n\n @param source (see #visit)\n @param target (see #visit)\n @param [Symbol] attribute the parent reference attribute\n @return [{Resource => Resource}] the referenced source => target matches", "Runs the extractor on a single file and return processed source.", "JSON serializer to use.", "Initialize a formatter with the desired options.\n\n @param [Hash] options the options to create a formatter with\n @option options [Integer] :decimals (2) Number of decimal places\n @option options [Boolean] :fixed (false) Fixed decimal places\n @option options [String] :separator ('.') Decimal mark\n @option options [Integer] :grouping (3) Number of digits per group\n @option options [String] :delimiter (',') Delimiter between groups", "just loop through a directory and get rid of any stale symlinks", "max amount of messages to receive\n\n Listener initializer.\n\n ==== Parameters\n * +queue+ Connfu::Events instance to forward incoming events to be processed by the Dispatcher class\n * +app_stream+ valid HTTP stream url to connect and listen events\n * +token+ valid token to get access to a connFu Stream\n * +stream_endpoint+ endpoint to open a keepalive HTTP connection\n\n start listening.\n Should create a new thread and wait to new events to come\n ==== Parameters\n * +queue+ to send incoming events to the Dispatcher class", "Sets this dependent's owner attribute to the given domain object.\n\n @param [Resource] obj the owner domain object\n @raise [NoMethodError] if this Resource's class does not have an owner property\n   which accepts the given domain object", "Returns the domain object references for the given attributes.\n\n @param [<Symbol>, nil] the domain attributes to include, or nil to include all domain attributes\n @return [<Resource>] the referenced attribute domain object values", "Returns the attribute references which directly depend on this owner.\n The default is the attribute value.\n\n Returns an Enumerable. If the value is not already an Enumerable, then this method\n returns an empty array if value is nil, or a singelton array with value otherwise.\n\n If there is more than one owner of a dependent, then subclasses should override this\n method to select dependents whose dependency path is shorter than an alternative\n dependency path, e.g. if a Node is owned by both a Graph and a parent\n Node. In that case, the Graph direct dependents consist of the top-level nodes\n owned by the Graph but not referenced by another Node.\n\n @param [Symbol] attribute the dependent attribute\n @return [<Resource>] the attribute value, wrapped in an array if necessary", "Matches this dependent domain object with the others on type and key attributes\n in the scope of a parent object.\n Returns the object in others which matches this domain object, or nil if none.\n\n The match attributes are, in order:\n * the primary key\n * the secondary key\n * the alternate key\n\n This domain object is matched against the others on the above attributes in succession\n until a unique match is found. The key attribute matches are strict, i.e. each\n key attribute value must be non-nil and match the other value.\n\n @param [<Resource>] the candidate domain object matches\n @return [Resource, nil] the matching domain object, or nil if no match", "Applies the operator block to this object and each domain object in the reference path.\n This method visits the transitive closure of each recursive path attribute.\n\n @param [<Symbol>] path the attributes to visit\n @yieldparam [Symbol] attribute the attribute to visit\n @return the visit result\n @see ReferencePathVisitor", "Returns this domain object's attributes content as an attribute => value hash\n suitable for printing.\n\n The default attributes are this object's saved attributes. The optional\n reference_printer is used to print a referenced domain object.\n\n @param [<Symbol>, nil] attributes the attributes to print\n @yield [ref] the reference print formatter\n @yieldparam [Resource] ref the referenced domain object to print\n @return [{Symbol => String}] the attribute => content hash", "Validates that this domain object contains a non-nil value for each mandatory attribute.\n\n @raise [ValidationError] if a mandatory attribute value is missing", "Validates that this domain object either doesn't have an owner attribute or has a unique\n effective owner.\n\n @raise [ValidationError] if there is an owner reference attribute that is not set\n @raise [ValidationError] if there is more than effective owner", "Returns a value suitable for printing. If value is a domain object, then the block provided to this method is called.\n The default block creates a new ReferencePrinter on the value.", "Returns an attribute => value hash which identifies the object.\n If this object has a complete primary key, than the primary key attributes are returned.\n Otherwise, if there are secondary key attributes, then they are returned.\n Otherwise, if there are nondomain attributes, then they are returned.\n Otherwise, if there are fetched attributes, then they are returned.\n\n @return [<Symbol] the attributes to print", "Returns 0 if attribute is a Java primitive number,\n +false+ if attribute is a Java primitive boolean,\n an empty collectin if the Java attribute is a collection,\n nil otherwise.", "Returns the Java type of the given attribute, or nil if attribute is not a Java property attribute.", "Returns the object in others which uniquely matches this domain object on the given attributes,\n or nil if there is no unique match. This method returns nil if any attributes value is nil.", "Returns the attribute => value hash to use for matching this domain object.\n @see #search_attribute_values the method specification", "Renders the view as a CSV file.\n\n Set the +filename+ you would like to provide to the client, or leave it nil to use the action name.\n Set the +view_name+ you would like to render, or leave it nil to use the action name.", "Authorizes access for the action.\n\n * With no arguments, this will validate that a user is currently logged in, but does not check their permission.\n * With an argument of true, this will validate that the user currently logged in is an administrator.\n * With one or more strings, this will validate that the user currently logged in has at least one or more\n   of the named permissions.\n\n     authorize!\n     authorize! true\n     authorize! \"Safety Manager\", \"HR Manager\"\n\n If no user is logged in, then the user will be redirected to the login page and the method will return false.\n If a user is logged in, but is not authorized, then the user will be redirected to the home page and the method\n will return false.\n If the user is authorized, the method will return true.", "Validates that the current user is authorized for the current request.\n\n This method is called for every action except the :api action.\n For the :api action, this method will not be called until the actual requested action is performed.\n\n One of four scenarios are possible:\n 1.  If the +require_admin+ method applies to the current action, then a system administrator must be logged in.\n     1.  If a nobody is logged in, then the user will be redirected to the login url.\n     2.  If a system administrator is logged in, then access is granted.\n     3.  Non-system administrators will be redirected to the root url.\n 2.  If the +require_anon+ method applies to the current action, then a user cannot be logged in.\n     1.  If a user is logged in, a warning message is set and the user is redirected to their account.\n     2.  If no user is logged in, then access is granted.\n 3.  If the +allow_anon+ method applies to the current action, then access is granted.\n 4.  The action doesn't require a system administrator, but does require a valid user to be logged in.\n     1.  If nobody is logged in, then the user will be redirected to the login url.\n     2.  If a system administrator is logged in, then access is granted.\n     3.  If the action doesn't have any required permissions, then access is granted to any logged in user.\n     4.  If the action has required permissions and the logged in user shares at least one, then access is granted.\n     5.  Users without at least one required permission are redirected to the root url.\n\n Two of the scenarios are configured at design time. If you use +require_admin+ or +allow_anon+,\n they cannot be changed at runtime.  The idea is that anything that allows anonymous access will always allow\n anonymous access during runtime and anything that requires admin access will always require admin access during\n runtime.\n\n The third scenario is what would be used by most actions.  Using the +admin+ controller, which requires admin\n access, you can customize the permissions required for each available route.  Using the +users+ controller,\n admins can assign permissions to other users.", "returns hash of AWS credential", "Create a gem package.", "Create a gemspec file from project metadata.", "Lookup gemspec file. If not found returns default path.\n\n Returns String of file path.", "Load gemspec file.\n\n Returns a ::Gem::Specification.", "If the gemspec a YAML gemspec?", "Render the default content for this component as it is defined in the context.", "Initialises a new Engine instance\n @param delay [Float] the default delay before retrying\n @param exceptions [Hash<Exception, Boolean>] the default retriable\n   exceptions\n @param handlers [Hash<Exception|Symbol, Proc>] the default exception\n   handlers\n @param tries [Integer, Proc] the default maximum number of tries or\n   a proc which accepts an Exception and returns true if a retry is allowed\n   or false if not\n @return [void]\n Executes the class method do using instance default values", "Modulo operation for floating point numbers\n\n This operation takes account of the problem that '%' does not work with\n floating-point numbers in C.\n\n @return [Node] Array with result of operation.", "Convert array elements to different element type\n\n @param [Class] dest Element type to convert to.\n\n @return [Node] Array based on the different element type.", "Convert RGB array to scalar array\n\n This operation is a special case handling colour to greyscale conversion.\n\n @param [Class] dest Element type to convert to.\n\n @return [Node] Array based on the different element type.", "Get array with same elements but different shape\n\n The method returns an array with the same elements but with a different shape.\n The desired shape must have the same number of elements.\n\n @param [Array<Integer>] ret_shape Desired shape of return value\n\n @return [Node] Array with desired shape.", "Element-wise conditional selection of values\n\n @param [Node] a First array of values.\n @param [Node] b Second array of values.\n\n @return [Node] Array with selected values.", "Element-wise comparison of values\n\n @param [Node] other Array with values to compare with.\n\n @return [Node] Array with results.\n Lazy transpose of array\n\n Lazily compute transpose by swapping indices according to the specified\n order.\n\n @param [Array<Integer>] order New order of indices.\n\n @return [Node] Returns the transposed array.", "Reverse-cycle indices of array\n\n @param [Integer] n Number of times to cycle back indices of array.\n\n @return [Node] Resulting array expression with different order of indices.", "Perform element-wise operation on array\n\n @param [Proc] action Operation(s) to perform on elements.\n\n @return [Node] The resulting array.", "Perform cummulative operation on array\n\n @overload inject(initial = nil, options = {}, &action)\n   @param [Object] initial Initial value for cummulative operation.\n   @option options [Variable] :var1 First variable defining operation.\n   @option options [Variable] :var1 Second variable defining operation.\n   @option options [Variable] :block (action.call(var1, var2)) The operation to apply.\n\n @overload inject(initial = nil, symbol)\n   @param [Object] initial Initial value for cummulative operation.\n   @param [Symbol,String] symbol The operation to apply.\n\n @return [Object] Result of injection.", "Find range of values of array\n\n @return [Object] Range of values of array.", "Check values against boundaries\n\n @return [Node] Boolean array with result.\n Normalise values of array\n\n @param [Range] range Target range of normalisation.\n\n @return [Node] Array with normalised values.", "Clip values to specified range\n\n @param [Range] range Allowed range of values.\n\n @return [Node] Array with clipped values.", "Stretch values from one range to another\n\n @param [Range] from Target range of values.\n @param [Range] to Source range of values.\n\n @return [Node] Array with stretched values.", "Apply accumulative operation over elements diagonally\n\n This method is used internally to implement convolutions.\n\n @param [Object,Node] initial Initial value.\n @option options [Variable] :var1 First variable defining operation.\n @option options [Variable] :var2 Second variable defining operation.\n @option options [Variable] :block (yield( var1, var2 )) The operation to\n         apply diagonally.\n @yield Optional operation to apply diagonally.\n\n @return [Node] Result of operation.\n\n @see #convolve\n\n @private", "Compute table from two arrays\n\n Used internally to implement convolutions and other operations.\n\n @param [Node] filter Filter to form table with.\n @param [Proc] action Operation to make table for.\n\n @return [Node] Result of operation.\n\n @see #convolve\n\n @private", "Convolution with other array of same dimension\n\n @param [Node] filter Filter to convolve with.\n\n @return [Node] Result of convolution.", "Compute histogram of this array\n\n @overload histogram( *ret_shape, options = {} )\n   @param [Array<Integer>] ret_shape Dimensions of resulting histogram.\n   @option options [Node] :weight (UINT(1)) Weights for computing the histogram.\n   @option options [Boolean] :safe (true) Do a boundary check before creating the\n           histogram.\n\n @return [Node] The histogram.", "Perform element-wise lookup\n\n @param [Node] table The lookup table (LUT).\n @option options [Boolean] :safe (true) Do a boundary check before creating the\n         element-wise lookup.\n\n @return [Node] The result of the lookup operation.", "Warp an array\n\n @overload warp( *field, options = {} )\n   @param [Array<Integer>] ret_shape Dimensions of resulting histogram.\n   @option options [Object] :default (typecode.default) Default value for out of\n           range warp vectors.\n   @option options [Boolean] :safe (true) Apply clip to warp vectors.\n\n @return [Node] The result of the lookup operation.", "Compute integral image\n\n @return [Node] The integral image of this array.", "Perform connected component labeling\n\n @option options [Object] :default (typecode.default) Value of background elements.\n @option options [Class] :target (UINT) Typecode of labels.\n\n @return [Node] Array with labels of connected components.", "Select values from array using a mask\n\n @param [Node] m Mask to apply to this array.\n\n @return [Node] The masked array.", "Distribute values in a new array using a mask\n\n @param [Node] m Mask for inverse masking operation.\n @option options [Object] :default (typecode.default) Default value for elements\n         where mask is +false+.\n @option options [Boolean] :safe (true) Ensure that the size of this size is\n         sufficient.\n\n @return [Node] The result of the inverse masking operation.", "Mirror the array\n\n @param [Array<Integer>] dimensions The dimensions which should be flipped.\n\n @return [Node] The result of flipping the dimensions.", "Create array with shifted elements\n\n @param [Array<Integer>] offset Array with amount of shift for each dimension.\n\n @return [Node] The result of the shifting operation.", "Downsampling of arrays\n\n @overload downsample( *rate, options = {} )\n   @param [Array<Integer>] rate The sampling rates for each dimension.\n   @option options [Array<Integer>] :offset Sampling offsets for each dimension.\n\n @return [Node] The downsampled data.", "Takes a Transaction ready to be signed.\n\n Returns an Array of signature dictionaries.", "Takes a Transaction and any number of Arrays of signature dictionaries.\n Each sig_dict in an Array corresponds to the Input with the same index.\n\n Uses the combined signatures from all the signers to generate and set\n the script_sig for each Input.\n\n Returns the transaction.", "Takes any number of \"signature dictionaries\", which are Hashes where\n the keys are tree names, and the values are base58-encoded signatures\n for a single input.\n\n Returns an Array of the signatures in binary, sorted by their tree names.", "def delegatable?\n       !aop? && !custom_target? && !all? && !chain? && !args && !lambda?\n     end", "Fetches raw data from source.\n\n @return [Object]", "Parses raw data and returns sale items.\n\n @return [Array]", "Returns a random hypothesis with weighted probability", "Returns true if the experiment has the same name, goals, and hypotheses as this one", "Check the output file and see if they are older than\n the input files.\n\n @return [Boolean] whether output is up-to-date", "Generate notes documents.\n\n @return [void]", "Reset output files, marking them as out-of-date.\n\n @return [void]", "Remove output files.\n\n @return [void]", "Convert output into a hash of `file => format`.\n\n @todo Should we use #apply_naming_policy ?\n\n @return [Hash]", "The format of the file based on the extension.\n If the file has no extension then the value of\n `DEFAULT_FORMAT` is returned.\n\n @return [String]", "DNote Session instance.\n\n @return [DNote::Session]", "Raw HTTP methods", "send http request", "Binds a parameter to a target value.\n\n @see    Parameter#bind\n @raise  [KeyError] if the parameter is not found.\n @raise  [ScopeError] if the parameter is out of scope.\n\n @param  param [Symbol] the parameter to bind.\n @param  target [#value] the value object to bind to.\n @return [Parameter] the parameter that was bound.", "Produces a readable string representation of the parameterized object.\n\n @return [String] a string representation.", "Iterates over the parameterized objects currently bound to the parameters.\n\n @return [Enumerable] if no block is given.", "Creates a new token\n @param credential\n @param [Hash] opts the optional parameters\n @return [TokenResponse]", "Converts the configuration to a hash.", "Send this instance to a receiver object.\n\n @example\n\n   msg.send_to obj\n\n @param [Object] receiver\n   Object that the message will be sent to.\n\n @param [Boolean] publicly\n   When `true`, the message will be sent via {Object#public_send}. This is\n   the default behavior.\n\n   When `false`, the message will be sent via {Object#send}, allowing it\n   to invoke private and protected methods on the receiver.\n\n @return [Object]\n   Result of the method call.", "Set current object logger instance\n\n * *Parameters*\n   - [String, Nucleon::Util::Logger] *logger*  Logger instance or resource name for new logger\n\n * *Returns*\n   - [Void]  This method does not return a value\n\n * *Errors*\n\n See also:\n - Nucleon::Util::Logger::loggers\n - Nucleon::Util::Logger::new", "Set current object console instance\n\n * *Parameters*\n   - [String, Nucleon::Util::Console] *ui*  Console instance or resource name for new console\n\n * *Returns*\n   - [Void]  This method does not return a value\n\n * *Errors*\n\n See also:\n - Nucleon::Util::Console::new", "Contextualize console operations in a code block with a given resource name.\n\n * *Parameters*\n   - [String, Symbol] *resource*  Console resource identifier (prefix)\n   - [Symbol] *color*  Color to use; *:black*, *:red*, *:green*, *:yellow*, *:blue*, *:purple*, *:cyan*, *:grey*\n\n * *Returns*\n   - [Void]  This method does not return a value\n\n * *Errors*\n\n * *Yields*\n   - [Nucleon::Util::Console] *ui*  Current object console instance\n\n See also:\n - Nucleon::Util::Console::colorize", "Write out a log message", "Checks if deprecated extractor options have been set\n Checks if the mockup will be runned", "Deletes all items from `self` that are equal to `item`.\n\n @param [Object] item\n   The item to be removed from the queue.\n\n @return [Object]\n   True if the item is found else false.", "Percolate down to maintain heap invariant.\n\n @param [Integer] k\n   The index at which to start the percolation.\n\n @!visibility private", "Percolate up to maintain heap invariant.\n\n @param [Integer] k\n   The index at which to start the percolation.\n\n @!visibility private", "Adds a line text to this box\n\n === Args\n\n +obj+::\n   The obj to add (will be converted to string).\n +params+::\n   A hash of parameters. Currently supported are:\n     color: the text color (see #Yummi#COLORS)\n     width: the text maximum width. Set this to break the lines automatically.\n            If the #width is set, this will override the box width for this lines.\n     raw:   if true, the entire text will be used as one word to align the text.\n     align: the text alignment (see #Yummi#Aligner)", "Adds a line separator.\n\n === Args\n\n +params+::\n   A hash of parameters. Currently supported are:\n     pattern: the pattern to build the line\n     color: the separator color (see #Yummi#COLORS)\n     width: the separator width (#self#width will be used if unset)\n     align: the separator alignment (see #Yummi#Aligner)", "Renders output to the template or returns it as a string.", "Gets the application instance name.\n\n This can be set by creating a +config/instance.yml+ configuration file and setting the 'name' property.\n The instance name is used to create unique cookies for each instance of an application.\n The default instance name is 'default'.", "Is a restart currently pending.", "Updates the restart file to indicate we want to restart the web app.", "Write nest with label\n\n @param [String] label\n @param [#pretty_dump] nested\n\n @return [self]\n\n @api private", "Write string with indentation\n\n @param [String] string\n\n @return [self]\n\n @api private", "Builds prefix from @format[:context] and context", "Expect that method +name+ is called, optionally with +args+, and returns\n +retval+.\n\n   mock.expect :meaning_of_life, 42\n   mock.meaning_of_life # => 42\n\n   mock.expect :do_something_with, true, [some_obj, true]\n   mock.do_something_with some_obj, true # => true\n\n +args+ is compared to the expected args using case equality (ie, the\n '===' method), allowing for less specific expectations.\n\n   mock.expect :uses_any_string, true, [String]\n   mock.uses_any_string 'foo' # => true\n   mock.verify  # => true\n\n   mock.expect :uses_one_string, true, ['foo']\n   mock.uses_one_string 'bar' # => true\n   mock.verify  # => raises MockExpectationError", "Initialize a new Reporter\n\n type - The type (Symbol) of the suite\n\n Initialize counters for all result types\n Main interface for reporting\n Reports the result of a single test or generation\n\n test - A test object that has been run\n\n Returns nothing", "Available options\n redirect_success_path\n redirect_failure_path\n callback_response_path", "Sets whether location should be updated on the background or not.", "Extend unary method with capability to handle arrays\n\n @param [Module] mod The mathematics module.\n @param [Symbol,String] op The unary method to extend.\n @param [Symbol,String] conversion A method for doing the type conversion.\n @return [Proc] The new method.\n\n @private", "Extend binary method with capability to handle arrays\n\n @param [Module] mod The mathematics module.\n @param [Symbol,String] op The binary method to extend.\n @param [Symbol,String] conversion A method for doing the type balancing.\n @return [Proc] The new method.\n\n @private", "Adds the directories in the given path and all Java jar files contained in\n the directories to the Java classpath.\n\n @quirk Java The jar files found by this method are added to the classpath\n in sort order. Java applications usually add jars in sort order. For examle,\n the Apache Ant directory-based classpath tasks are in sort order, although\n this is not stipulated in the documentation. Well-behaved Java libraries are\n not dependent on the sort order of included jar files. For poorly-behaved\n Java libraries, ensure that the classpath is in the expected order. If the\n classpath must be in a non-sorted order, then call {#add_to_classpath}\n on each jar file instead.\n\n @param [String] path the colon or semi-colon separated directories", "Adds the given jar file or directory to the classpath.\n\n @param [String] file the jar file or directory to add", "Expands the given directories to include the contained jar files.\n If a directory contains jar files, then the jar files are included in\n the resulting array. Otherwise, the directory itself is included in\n the resulting array.\n\n @param [<String>] directories the directories containing jars to add\n @return [<String>] each directory or its jars", "Validates that the message broker will respond to the necessary methods.\n @raise [TypeError] if any methods are missing\n @return [void]", "Typography\n Headings not implemented\n Lead not implemented\n Small not implemented\n Bold not implemented\n Italics not implemented\n muted, text-warning, text-error, text-info, text-success not implemented\n Abbreviations not implemented\n Addresses not implemented\n Blockquotes not implemented\n Lists\n\n Public: Bootstrap Typography List, wraps List class to generate ul or ol\n         tags with html options.\n\n options - options can be accepted by ul or ol.\n         :type       - unordered, ordered, unstyled.\n                       ( default: 'unordered' )\n         :li_options - common li options in ul ( default: {} )\n         other options can be accepted by ul or ol.\n block   - yield with List object, used to add li tags into ul or ol.\n           Also can add nested lists.\n\n Examples\n\n   = list(type: 'ordered') do |i|\n     - i.add('line 1')\n     - i.add('line 2')\n     - i.add(link_to('line 3', hello_world_path), class: \"li-class\")\n     - i.add 'line 4' + list(type: 'unstyled') do |nested_li|\n       - nested_li.add('line 4.1')\n       - nested_li.add('line 4.2')\n   # => <ol>\n          <li>line 1</li>\n          <li>line 2</li>\n          <li class=\"li-class\">\n            <a href=\"/hello_world\">line 3</a>\n          </li>\n          <li>\n            line 4\n            <ul class=\"unstyled\">\n              <li>line 4.1</li>\n              <li>line 4.2</li>\n            </ul>\n          </li>\n        </ol>\n\n\n Returns html content of the list.", "set defaults for options", "make the model queries to pull back the data based on pagination and search results if given", "Retrieve a list of specific objects", "returns a redis key based on the parent\n object so it will include the proper index.", "Clean all clients currently checked into the pool.\n Its possible clients may be returned to the pool after cleaning", "Drain the pool of all clients currently checked into the pool.\n After draining, wake all sleeping threads to allow repopulating the pool\n or if shutdown allow threads to quickly finish their work\n Its possible clients may be returned to the pool after cleaning", "Kills the reaper and drains the pool.", "Remove and close extra clients\n Releases mutex each iteration because\n reaping is a low priority action", "Safely add client back to pool, only if\n that client is registered", "Safely pull client from pool, adding if allowed\n If a client is not available, check for dead\n resources and schedule reap if nesseccary", "Returns a new client if its allowed.\n _add is volatile; and may cause threading issues\n if called outside @mutex.synchronize {}", "Enumerate all lines which differ.\n\n @param  [Hash] options\n         see Diffy#initialize for help.\n\n @return [Diffy::Diff]", "Reloads instance's constructor to make it immutable\n\n @api private\n\n @param [Object, Array<Object>] args\n @param [Proc] block\n\n @return [Object]", "Calculate all keys that should be kept in whitelist mode\n In multiple iterations of redact -> decrypt - digest keys will remain\n and then get deleted in the second iteration, so we have to\n add the digest keys so they're not wiped out on later iteration", "Initialize the mecab tagger with the given option.\n\n How to specify options is as follows:\n\n @example\n   mecab = Nameko::Mecab.new(\"-d /usr/local/lib/mecab/dic/mecab-ipadic-neologd\")\n   mecab = Nameko::Mecab.new([\"-d /usr/local/lib/mecab/dic/mecab-ipadic-neologd\"])\n   mecab = Nameko::Mecab.new([\"-d\", \"/usr/local/lib/mecab/dic/mecab-ipadic-neologd\"])\n\n\n Parse the given string by MeCab.\n @param [String] str Parsed text\n @return [Array<MecabNode>] Result of Mecab parsing\n\n @example\n   node = mecab.parse(\"\u79c1\u4ee5\u5916\u79c1\u3058\u3083\u306a\u3044\u306e\")[0]\n\n   node.surface # => \"\u79c1\"\n   node.feature #=> {:pos=>\"\u540d\u8a5e\", :pos1=>\"\u4ee3\u540d\u8a5e\", :pos2=>\"\u4e00\u822c\", :pos3=>\"\", :conjugation_form=>\"\", :conjugation=>\"\", :base=>\"\u79c1\", :yomi=>\"\u30ef\u30bf\u30b7\", :pronunciation=>\"\u30ef\u30bf\u30b7\"}\n   node.posid #=> 59\n   node.id #=> 1", "Returns this document's siblings and itself.\n\n @example Retrieve document's siblings and itself within a certain scope.\n   book.siblings_and_self(scope: :author)\n\n @example Retrieve what would be document's siblings if it had another scope value.\n\n   book.siblings_and_self(\n     scope:        :author,\n     scope_values: {\n       author: other_author\n     }\n   )\n\n @param [ Hash ] options The options.\n\n @option options [ Array<Symbol>, Symbol ] scope One or more relations or\n   attributes that siblings of this object need to have in common.\n @option options [ Hash<Symbol, Object> ] scope_values Optional alternative\n   values to use to determine siblingship.\n\n @return [ Mongoid::Criteria ] Criteria to retrieve the document's siblings.", "Is this document a sibling of the other document?\n\n @example Is this document a sibling of the other document?\n   book.sibling_of?(other_book, scope: :author)\n\n @param [ Document ] other The document to check against.\n @param [ Hash ] options The options.\n\n @option options [ Array<Symbol>, Symbol ] scope One or more relations and\n   attributes that siblings of this object need to have in common.\n @option options [ Hash<Symbol, Object> ] scope_values Optional alternative\n   values for this document to use to determine siblings.\n @option options [ Hash<Symbol, Object> ] other_scope_values Optional\n   alternative values for the other document to use to determine\n   siblingship.\n\n @return [ Boolean ] True if the document is a sibling of the other\n   document.", "Makes this document a sibling of the other document.\n\n This is done by copying over the values used to determine siblingship\n from the other document.\n\n @example Make document a sibling of the other document.\n   book.become_sibling_of(book_of_other_author, scope: :author)\n\n @param [ Document ] other The document to become a sibling of.\n @param [ Hash ] options The options.\n\n @option options [ Array<Symbol>, Symbol ] scope One or more relations and\n   attributes that siblings of this object need to have in common.\n @option options [ Hash<Symbol, Object> ] other_scope_values Optional\n   alternative values to use to determine siblingship.\n\n @return [ Boolean ] True if the document was made a sibling of the other\n   document.", "Takes an array of gem sources and fetches the full index of\n gems from each one. It then combines the indexes together keeping\n track of the original source so that any resolved gem can be\n fetched from the correct source.\n\n ==== Parameters\n *sources<String>:: URI pointing to the gem repository\n Searches for a gem that matches the dependency\n\n ==== Parameters\n dependency<Gem::Dependency>:: The gem dependency to search for\n\n ==== Returns\n [Gem::Specification]:: A collection of gem specifications\n   matching the search", "Search each parent of some verb for a given element.\n Used for rule inheritance.", "Appends a new piece of ASCII data to this buffer and yields back any lines that are now complete.\n\n @param [String] data The new piece of ASCII data.\n\n @yieldparam [String] line The new line that is now complete.", "Randomly schedule worker over a window of time.\n Arguments are keys of the final options hash.\n\n @param spread_duration [Number] Size of window to spread workers out over\n @param spread_in [Number] Start of window offset from now\n @param spread_at [Number] Start of window offset timestamp\n @param spread_method [rand|mod] perform either a random or modulo spread,\n   default: *:rand*\n @param spread_mod_value [Integer] value to use for determining mod offset\n @return [String] Sidekiq job id", "Returns the underscored name used in the full i18n translation key\n\n Example:\n\n  UserProjectMotivation.translation_key # => \"user_project\"", "Create a predicate method for the current step name\n to test if it's complete", "Check a method like `complete_current_step_name` to mark\n a step complete.  This is not always needed but useful\n if you want to persist a completion for performance purposes.", "Build the tags", "Reads, verifies, and decodes each cargo section with a given name, passing each section's decoded data to the block", "Requires custom version of yaafe", "restore the post to the given post data", "Used by Rails view helpers", "Store a value at a key. If the key is a prop name, store it through the\n prop, which will check it's type.\n\n @param [Symbol | String] key\n @param [VALUE] value\n\n @return [VALUE]\n   The stored value.", "Sign the given parameters and returns the signature", "invokes the given API call and returns body of the response as text", "Prepares an API call with the given arguments then invokes it and returns its body", "Returns the URL that authenticates the application for the current user.\n This is used for web applications only", "Returns a URL that the desktop user should visit to activate current frob.\n This method should not be called before a frob has been requested", "Returns false if the current request should\n not be handled by the middleware", "Returns if the current node is the parent of the given node.\n If this is a new record, we can use started_at values to detect parenting.\n However, if it was already saved, we lose microseconds information from\n timestamps and we must rely solely in id and parent_id information.", "Nova instancia da classe ItemPedido\n @param [Hash] campos\n Montar o Hash de dados do ItemPedido no padr\u00e3o utilizado pelo SuperPay", "Returns all values for +key+ in an array", "actionpack 4 requires a more robust Errors object", "Add a property without defining it on the class.\n This will stay, will use the subject, and the regular infrastructure.\n @param [Symbol] accessor, the new field being created.\n @param [RDF::Statement] predicate, the predicate for the new field.\n @param [Any] The value to store", "Constructs and executes UPDATE statement for given\n attributes and a query\n\n @param [Hash(Property => Object)] attributes\n   hash of attribute values to set, keyed by Property\n @param [Collection] collection\n   collection of records to be updated\n\n @return [Integer]\n   the number of records updated\n\n @api semipublic", "Creates a new symbolicator for a given dSYM file.\n\n @param [String] dsym The path to a dSYM file (or DWARF file within).\n @param [String] project_dir The path to a project root that will be removed\n   from file paths underneath that root.\n @return [Hash<String, String>] A hash mapping architectures (such as \"i386\")\n   to the UUID for the symbolication of that architecture.", "Send announcement message.", "Message to send. Defaults to a generated release announcement.", "Apply environment settings.", "Puppet apply Fundamental step", "Create checkpoint for step", "Walking section \n Returns incoming edges of all vertices of this set", "Returns all back-adjacent vertices reachable from this set", "Returns all adjacent vertices reachable from this set", "Get the job's config, as a Hash", "Push a message onto a queue\n\n @param queue_name [String, Symbol] the name of the queue that the message should pushed onto\n @param message_body [String] the message as it will be pushed onto the queue, no serialization occurs as\n  part of this method. You need to encode or serialize your object to a string before sending it to this method\n @return [Types::SendMessageResult] the sent message object returned from s3", "Reserve a message from the specified queue\n\n @param queue_name [String, Symbol] the name of the SQS queue to reserve a message from\n @return [Messages::Sqs, NilClass] the message retrieved from the queue", "Delete a message from the queue\n\n @param message [Messages::Sqs] the message that should be deleted", "Updates the message visibility timeout to create some delay before an attempt will be made to reprocess the\n  message\n\n @param message [Messages::Sqs] the message for which the next retry should be delayed", "Resize file. Keeping aspect ratio.", "Create thumbnail, same name but with _thumb at the end", "Get element of this term\n\n Pass +i+ as argument to this lambda object.\n\n @param [Integer,Node] i Index of desired element.\n\n @return [Node,Object] Result of inserting +i+ for lambda argument.\n\n @private", "appends the log to confluence page if found, if not creates new page\n clears the log", "Creates new page with title set,\n if parrent_page_id is provided it adjusts ancestor accordingly and\n the same space short key", "Create an atom of the specified species at the given coordinates\n @param [Float] x The x coordinate of the atom in angstrom\n @param [Float] y The y coordinate of the atom in angstrom\n @param [Float] z The z coordinate of the atom in angstrom\n @param [String, nil] s The atomic species ex. \"C\", \"Si\", \"S\", etc. (can be nil)\n @param [Boolean, String, Array<String>] c The relaxation constraints. valid values are TRUE, FALSE, \".true.\", \".false.\", \"x\", \"y\", \"z\" or %w(x y z)\n @return [Atom] a new Atom\n A boolean value,\n True if the atom has relaxation constraints", "Return the distance to another atom", "An exact clone of the atom. Same ID and everything\n Return a new atom with the same species and relaxation constraints\n but with coordinates displaced by +x+, +y+, +z+", "Displace this atom in place", "Print a string representation of this atom formatted in the\n geometry.in format used by Aims", "build the commands to be sent to the host object", "returns an array of host objects", "runs the commands on a host and deals with output", "Adds a single row to the table\n @param [Array] row An array with a single row of data for the table. Should have the same number of entries as there are columns", "Adds multiple rows to the table\n @param [Array] rows A 2d Array containing multiple rows of data. Each Array should have the same number of entries as the table has columns", "Outputs the data within this table as a javascript array ready for use by google.visualization.DataTable\n This is where conversions of ruby date objects to javascript Date objects and escaping strings, and formatting options is done\n @return [String] a javascript array with the first row defining the table, and subsequent rows holding the table's data", "Registers each column explicitly, with data type, and a name associated\n @param [String] type the type of data column being registered, valid input here are entries from DataTable::COLUMN_TYPES\n @param [String] name the column name that will be used as a label on the graph", "Return the books in the format specified in spec.", "Collects all links on domain for domain.\n @return [Array] with links.\n @example URLs for example.com\n   crawler = Crawler.new('example.com')\n   crawler.collect_urls\n @example URLs for example.com with block (executes in its own thread)\n   crawler = Crawler.new('example.com')\n   crawler.collect_urls do |new_url|\n     puts \"New URL found: #{new_url}\"\n   end", "Build a hash of liner attributes\n @return [Hash] A hash of liner attributes\n @api public", "Generate output for this template", "Calls block on each graph vertex for with the 'filter and block' predicate\n evaluates to true.", "Removes all vertices returned by evaluating the _vertices_ selection\n expression.", "Calls block on each graph edge for with the 'filter and block' predicate\n evaluates to true.", "Removes all edges returned by evaluating the _edges_ selection\n expression.", "Standard exports \n Encodes this graph for dot graphviz", "Converts a hash to dot attributes", "Checks graph sanity", "Applies argument conventions about selection of vertices", "Applies argument conventions about selection of edges", "Applies argument conventions on _element_", "Generates a with opening and closing tags and potentially content.\n\n @example Tag with no attributes, no content\n   content_tag(:p) # => \"<p></p>\"\n\n @example Tag with content\n   content_tag(:p, \"Hello\") # => \"<p>Hello</p>\"\n\n @example Tag with block content\n   content_tag(:p) { \"Hello\" } # => \"<p>Hello</p>\"\n\n @example Tag with content and attributes\n   content_tag(:a, \"Log In\", href: \"/log_in\") # => \"<a href=\"/log_in\">Log In</a>\"\n\n @example Tag with content block and attributes\n   content_tag(:a, href: \"/log_in\") { \"Log In\" } # => \"<a href=\"/log_in\">Log In</a>\"\n\n @param name [Symbol, String] The name of the tag\n @param attrs [Hash] The attributes of the tag\n\n @return [String] The HTML tag", "Renders an alert message.\n\n * +type+ The type of message [info, success, warn, error, danger, etc]\n * +message+ The message to display.\n\n To provide messages including HTML, you need to prefix the type with 'safe_'.\n\n   render_alert(safe_info, '<strong>This</strong> is a message containing <code>HTML</code> content.')\n\n The message can be a string, hash, or array.  When an array is specified, then each array element is enumerated and\n joined together.  The real power comes in when you specify a hash.  A hash will print the key as a label and then\n enumerate the value (string, hash, or array) in an unordered list.  Hash values are processed recursively, allowing\n you to create alerts with lists within lists.\n\n   render_alert(info, { 'Section 1' => [ 'Line 1', 'Line 2', 'Line 3' ] })\n\n   <label>Section 1</label>\n   <ul>\n     <li>Line 1</li>\n     <li>Line 2</li>\n     <li>Line 3</li>\n   </ul>\n\n   render_alert(info, { 'Block A' => { 'Block A:1' => [ 'Line 1', 'Line 2' ] }})\n\n   <label>Block A</label>\n   <ul>\n     <li>\n       <label>Block A:1</label>\n       <ul>\n         <li>Line 1</li>\n         <li>Line 2</li>\n       </ul>\n     </li>\n   </ul>", "Requires at a minimum the creator_id", "Will not return private events, events that are full, deleted, or in the past\n and doesn't return extra fields", "Encrypts the hash using the data encryption key and salt.\n\n Returns a blob:\n | Byte 0   |   Byte 1    |        Byte 2       | Bytes 3...S | Bytes S+1...E  | Bytes E+1..E+4 |\n ------------------------------------------------------------------------------------------------\n | Version  | Salt Length | Iteration Magnitude |     Salt    | Encrypted Data |     CRC32      |", "Creates a new user manager.\n\n The user manager itself takes no options, however options will be passed to\n any registered authentication engines when they are instantiated.\n\n The options can be used to pre-register engines and provide configuration for them.\n The engines will have specific configurations, but the UserManager class recognizes\n the 'engines' key.\n\n     {\n       :engines => {\n         'example.com' => {\n           :engine => MySuperAuthEngine.new(...)\n         },\n         'example.org' => {\n           :engine => 'incline_ldap/auth_engine',\n           :config => {\n             :host => 'ldap.example.org',\n             :port => 636,\n             :base_dn => 'DC=ldap,DC=example,DC=org'\n           }\n         }\n       }\n     }\n\n When an 'engines' key is processed, the configuration options for the engines are pulled\n from the subkeys.  Once the processing of the 'engines' key is complete, it will be removed\n from the options hash so any engines registered in the future will not receive the extra options.\n\n Attempts to authenticate the user and returns the model on success.", "The begin_external_authentication method takes a request object to determine if it should process a login\n or return nil.  If it decides to process authentication, it should return a URL to redirect to.", "Registers an authentication engine for one or more domains.\n\n The +engine+ passed in should take an options hash as the only argument to +initialize+\n and should provide an +authenticate+ method that takes the +email+, +password+, and\n +client_ip+.  You can optionally define an +authenticate_external+ method that takes the\n current +request+ as the only parameter.\n\n The +authenticate+ method of the engine should return an Incline::User object on success or nil on failure.\n The +begin_external_authentication+ method of the engine should return a URL to redirect to on success\n or nil on failure.\n\n   class MyAuthEngine\n     def initialize(options = {})\n       ...\n     end\n\n     def authenticate(email, password, client_ip)\n       ...\n     end\n\n     def begin_external_authentication(request)\n       ...\n     end\n   end\n\n   Incline::UserManager.register_auth_engine(MyAuthEngine, 'example.com', 'example.net', 'example.org')", "This method seems to always get run first", "Returns a standard ruby Hash representation of the wrapped Hash.\n @return [Hash]", "Create an instance of an API client\n\n ==== Attributes\n * +options+ - Access credentials and options hash, required keys are: account_api_key, user_api_key\n ==== Example\n client = Smarteru::Client.new({account_api_key: 'abc', user_api_key: 'abc'})\n Make an API request\n\n ==== Attributes\n * +operation+  - Operation method eg getGroup\n * +data+ - Data hash\n ==== Example\n client.request(\"getGroup\", {\n   group: {\n     name: 'MyGroup'\n   }\n })", "Build body parameteres xml\n\n ==== Attributes\n * +parameters+ - Parameters hash", "Prepare parameter key\n\n ==== Attributes\n * +parameters+ - Parameters hash", "Initialize the zinc-blende Geometry\n cation and anion are the  atomic\n species occupying the two different sub-lattices.\n lattice_const specifies the lattice constant\n Return the traditional unit cell of bulk zinc blende", "Fill the given volume with atoms", "Return a unit cell for a slab of 001\n Specify the number of atomic monolayers,\n the vacuum thickness in angstrom,\n and the number of layers to constrain at the base of the slab", "Return a unit cell for a slab of 111\n dir is either \"A\" or \"B\" for the cation or anion terminated slab\n specify the number of atomic monolayers\n and the vacuum thickness in angstrom", "return a unit cell for a slab of 112\n specify the number of atomic monolayers and the vacuum thickness in angstrom", "Return a unit cell for a slab of 110\n specify the number of atomic monolayers\n and the vacuum thickness in angstrom", "Returns a new Hash generated from this Collection with a block whose arguments include the enumerated item\n and its index. Every value which is nil or empty is excluded.\n\n @example\n   [1, 2, 3].to_compact_hash_with_index { |item, index| item + index } #=> { 1 => 1, 2 => 3, 3 => 5 }\n @yield [item, index] the hash value\n @yieldparam item the enumerated value\n @yieldparam index the enumeration index\n @return [Hash] this {Enumerable} converted to a hash by the given block", "Sorts this collection in-place with a partial sort operator block\n\n @see #partial_sort\n @yield (see #partial_sort)\n @yieldparam (see #partial_sort)\n @raise [NoMethodError] if this Collection does not support the +sort!+ sort in-place method", "Sets an attribute inverse by calling the attribute writer method with the other argument.\n If other is non-nil, then the inverse writer method is called on self.\n\n @param other [Resource] the attribute value to set\n @param [Symbol] writer the attribute writer method\n @param [Symbol] inv_writer the attribute inverse writer method defined for the other object\n @private", "Sets a non-collection attribute value in a way which enforces inverse integrity.\n\n @param [Object] newval the value to set\n @param [(Symbol, Symbol)] accessors the reader and writer methods to use in setting the\n   attribute\n @param [Symbol] inverse_writer the inverse attribute writer method\n @private", "Sets a collection attribute value in a way which enforces inverse integrity.\n The inverse of the attribute is a collection accessed by calling inverse on newval.\n\n @param [Resource] newval the new attribute reference value\n @param [(Symbol, Symbol)] accessors the reader and writer to use in setting\n   the attribute\n @param [Symbol] inverse the inverse collection attribute to which\n   this domain object will be added\n @yield a factory to create a new collection on demand (default is an Array)\n @private", "A T T E N Z I O N E   A R E A   P R O T E T T A\n Recursively expand a path handle.\n\n @return [Array<String>]\n   An array of path segments, suitable for .join\n\n @api public", "Create a new `CountDownLatch` with the initial `count`.\n\n @param [Fixnum] count\n   The initial count\n\n @raise [ArgumentError]\n   If `count` is not an integer or is less than zero.\n\n Block on the latch until the counter reaches zero or until `timeout` is\n reached.\n\n @param [Fixnum] timeout\n   The number of seconds to wait for the counter or `nil` to block\n   indefinitely.\n @return [Boolean]\n   True if the count reaches zero else false on timeout.", "Dumps all diffs that have the given field and are of TYPE_EXTRA.", "Dumps all diffs that have the given field and are of TYPE_MISSING.", "Dumps all diffs that have the given field and are of TYPE_MISMATCH.", "Combines all dumps into one cohesive error message.", "Returns a new Visitor which determines which nodes to visit by applying the given block\n to this visitor. The filter block arguments consist of a parent node and an array of\n children nodes for the parent. The block can return nil, a single node to visit or a\n collection of nodes to visit.\n\n @example\n   visitor = Jinx::Visitor.new { |person| person.children }\n   # Joe has age 55 and children aged 17 and 24, who have children aged [1] and [6, 3], resp.\n   visitor.to_enum(joe) { |person| person.age } #=> [55, 20, 1, 24, 6, 3]\n   # The filter navigates to the children sorted by age of parents 21 or older.\n   filter = visitor.filter { |parent, children| children.sort { |c1, c2| c1.age <=> c2.age } if parent.age >= 21 }\n   filter.to_enum(joe) { |person| person.age } #=> [55, 24, 3, 6]\n\n @return [Visitor] the filter visitor\n @yield [parent, children] the filter to select which of the children to visit next\n @yieldparam parent the currently visited node\n @yieldparam [Array] children the nodes slated by this visitor to visit next\n @raise [ArgumentError] if a block is not given to this method", "Returns the children to visit for the given node.", "Visits the root node and all descendants.", "Returns the nodes which occur within a cycle, excluding the cycle entry point.\n\n @example\n   graph.paths #=> a -> b -> a, a -> c -> d -> c\n   Visitor.new(graph, &navigator).cyclic_nodes(a) #=> [b, d]\n @param root the node to visit\n @return [Array] the nodes within visit cycles", "Create a Duration object using self where self could represent weeks, days,\n hours, minutes, and seconds.\n\n *Example*\n\n     10.duration(:weeks)\n     => #<Duration: 10 weeks>\n     10.duration\n     => #<Duration: 10 seconds>", "Get the number of seconds of a given part, or simply just get the number of\n seconds.\n\n *Example*\n\n     d = Duration.new(:weeks => 1, :days => 1, :hours => 1, :seconds => 30)\n     => #<Duration: 1 week, 1 day, 1 hour and 30 seconds>\n     d.seconds(:weeks)\n     => 604800\n     d.seconds(:days)\n     => 86400\n     d.seconds(:hours)\n     => 3600\n     d.seconds\n     => 30", "Friendly, human-readable string representation of the duration.\n\n *Example*\n\n     d = Duration.new(:seconds => 140)\n     => #<Duration: 2 minutes and 20 seconds>\n     d.to_s\n     => \"2 minutes and 20 seconds\"", "saves configuration into a _yaml_ file named +filename+", "helper methods have h_ prefix\n @param key [String] col name (present in all sources) to join on\n @param paths [Array[String]] list of file paths. note: order is important\n @param klass [String] namespaced class name of ReindeerETL source\n @param path_opts [Array[Hash]] list of hashes (count equal to the\n   number of sources) containing opts for each source. opt format is\n   determined by the expectations of the source class. order is the\n   same as the @paths list\n @param expect_full_match [Boolean] true if every row in first\n   source is expected to be matched in every other source\n @param target_cols [Array[Array[String]]] Optional list of lists of\n   column string names to be appended to initial source. order of\n   outer list designates which source the internal cols come from.\n   all cols are always added from first source, so\n   target_cols.count == paths.count - 1\n @param namespace [String] module where methods to get target_cols reside", "Method for finding modules to load", "Add an SGE user", "Given a boolean expression and data to replace, return result", "Gets a default set of properties from the event", "Loads the encrypted data bag item and returns credentials for the\n environment or for a default key.\n\n @param [String] environment\n   The environment\n\n @param [String] source\n   The deployment source to load configuration for\n\n @return [Chef::DataBagItem]\n   The data bag item", "Looks for the given data bag in the cache and if not found, will load a\n data bag item named for the chef_environment, or '_wildcard' value.\n\n @param [String] environment\n   The environment.\n\n @param [String] data_bag\n   The data bag to load.\n\n @return [Chef::Mash]\n   The data bag item in Mash form.", "Copies the given file path to a new tempfile, returning the closed tempfile.", "Writes the given data to a new tempfile, returning the closed tempfile.", "This method handles the uploaded file object.  If you set the field name to uploaded_data, you don't need\n any special code in your controller.\n\n   <% form_for :attachment, :html => { :multipart => true } do |f| -%>\n     <p><%= f.file_field :uploaded_data %></p>\n     <p><%= submit_tag :Save %>\n   <% end -%>\n\n   @attachment = Attachment.create! params[:attachment]", "validates the size and content_type attributes according to the current model's options", "Say hello to the specified person.", "Loads styles from a YAML style-sheet,\n   and converts the keys to symbols", "Remove all tags from string", "Write to the out stream, and flush it", "Apply styles to a string\n\n   if the style is a default ANSI style, we add the start\n   and end sequence to the string.\n\n   if the style is a custom style, we recurse, sending\n   the list of ANSI styles contained in the custom style.\n\n   TODO: use ';' delimited codes instead of multiple \\e sequences", "true if child is children of page", "true if page is equal current_page or parent of current_page", "Returns the SQL for a LOAD DATA INFILE statement.", "hacked login, but the alternative is\n not having integration tests when\n using a Shibboleth based auth", "Establish Faraday connection", "Prints out a summary of the user's hodlings formatted nicely", "Data should be an array of arays, cols is the number of columns it has\n Prints the data to screen with equal spacing between them", "Returns the combined length of charaters in an array", "Select matching filters and filters including targets when\n options is a +Hash+\n @param target  [Object] an object to run the method on\n @param options [Object] a filter for selecting matching blocks", "Adds support for saving a Parse object in the background.\n @example\n  object.save_eventually do |success|\n     puts \"Saved successfully\" if success\n  end\n @yield A block to call after the save has completed.\n @yieldparam [Boolean] success whether the save was successful.\n @return [Boolean] whether the job was enqueued.", "save_eventually\n Adds support for deleting a Parse object in the background.\n @example\n  object.destroy_eventually do |success|\n     puts 'Deleted successfully' if success\n  end\n @yield A block to call after the deletion has completed.\n @yieldparam [Boolean] success whether the save was successful.'\n @return [Boolean] whether the job was enqueued.", "Gets an Export object and dumps the data\n Initially using mysqldump\n Incrementally using mysql -e afterwards", "Exports Table using mysqldump. This method is invoked only once.\n Dumps with create options, no need to create table manaully", "Exports table incrementally, similar to incremental_export method\n Dumps file in tmp directory specified in myreplicator.yml\n Note that directory needs 777 permissions for mysql to be able to export the file\n Uses \\\\0 as the delimiter and new line for lines", "Checks the returned resut from SSH CMD\n Size specifies if there should be any returned results or not", "zips the file on the source DB server", "Load ranges from config file", "Takes a string like \"2.days..3.weeks\"\n  and converts to Range object -> 2.days..3.weeks", "Resolves the Class for a type.\n\n Params:\n +type+:: +String+ A stringified type.\n +singular+:: +Boolean+ Pass true if you don't want to singularize the type.", "Builds a whitelisted resource_params hash from the permitted_attributes &\n permitted_relationships arrays.  Will automatically attempt to resolve\n string IDs to numerical IDs, in the case the model's slug was passed to\n the controller as ID.", "Processes a single line of header information. The return value indicates whether further data is required in\n order to complete the header.\n\n @param [String] line The line of header data to process.\n\n @return [Boolean] Whether the header is still incomplete and requires further data.", "Write the xml document needed for processing, fill in elements need and delete unused ones from the root_xml\n raises an error if any necessary elements are missing", "readonly\n Starts or stops timer depending on its current state.\n\n Will return an object of Cashboard::Struct if another timer was stopped\n during this toggle operation.\n\n Will return nil if no timer was stopped.", "Dump state to output\n\n @param [Formatter] formatter\n\n @return [undefined]\n\n @api private", "Retrieve information for an individual story of a given project.", "Sets up cache invalidation callbacks for the provided attributes", "Creates a name based on pattern provided.  Defaults to last, first.\n\n Symbols:\n   %l - last name\n   %f - first name\n   %m - middle name\n   %p - prefix\n   %s - suffix", "Returns the name in a sortable format.", "Manipulate the VCL configuration\n\n  .vcl :load, <configname>, <filename>\n  .vcl :inline, <configname>, <quoted_VCLstring>\n  .vcl :use, <configname>\n  .vcl :discard, <configname>\n  .vcl :list\n  .vcl :show, <configname>\n\n Returns an array of VCL configurations for :list, and the servers\n response as string otherwise\n\n Ex.:\n   v = Varnish::Client.new\n   v.vcl :list\n   #=> [[\"active\", 0, \"boot\"]]\n\n   v.vcl :load, \"newconf\", \"/etc/varnish/myconf.vcl\"", "Purge objects from the cache or show the purge queue.\n\n Takes one or two arguments:\n\n 1.\n  .purge :url, <regexp>\n  .purge :hash, <regexp>\n\n <regexp> is a string containing a varnish compatible regexp\n\n 2.\n  .purge <costum-purge-conditions>\n  .purge :list\n\n Returns true for purging, returns an array containing the purge queue\n for :list\n\n Ex.:\n   v = Varnish::Client.new\n   v.purge :url, '.*'\n\n   v.purge \"req.http.host ~ www.foo.com && req.http.url ~ images\"\n\n   v.purge :list\n   #=> [[1, \"req.url ~ .*\"]]", "Returns a hash of status information\n\n Ex.:\n   v = Varnish::Client.new\n   v.stats\n   => {\"Total header bytes\"=>0, \"Cache misses\"=>0 ...}", "Gets the last column in the table.", "Builds data starting at the specified column.\n\n The +start_column+ is the first column you want to be building.\n When you start a new row inside of a build_column block, the new row\n starts at this same column.", "Builds a row in the table.\n\n Valid options:\n\n row::\n   Defines the row you want to start on.  If not set, then it uses #current_row.\n\n Additional options are merged with the base cell options for this row.\n\n When it completes, the #current_row is set to 1 more than the row we started on.", "Builds a subtable within the current row.\n\n The +cell_options+ are passed to the current cell.\n The +options+ are passed to the new TableBuilder.", "Creates multiple cells.\n\n Individual cells can be given options by prefixing the keys with 'cell_#' where # is the cell number (starting at 1).\n\n See #cell for valid options.", "Generates a cell in the current row.\n\n Valid options:\n\n value::\n   The value to put in the cell, unless a code block is provided, in which case the result of the code block is used.\n\n rowspan::\n   The number of rows for this cell to cover.\n\n colspan::\n   The number of columns for this cell to cover.\n\n Additional options are embedded and passed on to Prawn::Table, see {Prawn PDF Table Manual}[http://prawnpdf.org/prawn-table-manual.pdf] for more information.", "ensure that all 2nd level arrays are the same size.", "Returns the corners of the empty cells", "Returns true if the board has a wining pattern", "aBlock allows values to be filtered based on key,default and new values", "reset values back to defaults", "Ensure the directory for the file exists", "The actual name of the file", "Returns a hash which associates each key in this hash with the value mapped by the others.\n\n @example\n   {:a => 1, :b => 2}.assoc_values({:a => 3, :c => 4}) #=> {:a => [1, 3], :b => [2, nil], :c => [nil, 4]}\n   {:a => 1, :b => 2}.assoc_values({:a => 3}, {:a => 4, :b => 5}) #=> {:a => [1, 3, 4], :b => [2, nil, 5]}\n\n @param [<Hasher>] others the other Hashers to associate with this Hasher\n @return [Hash] the association hash", "Returns an Enumerable whose each block is called on each key which maps to a value which\n either equals the given target_value or satisfies the filter block.\n\n @param target_value the filter value\n @yield [value] the filter block\n @return [Enumerable] the filtered keys", "Returns a new Hash that recursively copies this hash's values. Values of type hash are copied using copy_recursive.\n Other values are unchanged.\n\n This method is useful for preserving and restoring hash associations.\n\n @return [Hash] a deep copy of this Hasher", "defines the body of a Job's status email", "merely setup the form_for to use our new form builder", "The api version of the current request", "Initializes the task run and sets the start time\n\n @param [Symbol] log_level The log level for the task, defaults to notice\n Checks if the log level is an allowable level, then returns it or notice if it is not allowable\n\n @param [Sybmol] log_level Log level to check\n @return [Symbol] The given log level or notice if it is not allowable", "this calls task with error catching\n if an error is caught, sets success to false and records the error\n either way, sets an end time and saves the task run information\n\n After the run completes, whether or not the run succeeds, run finally\n If finally has an error, don't catch it", "update runner started_at\nto be whatever the notification is - 1.second\nwhich will force runner to be due", "Creates a new user in the store\n @param user User to add to the store\n @param [Hash] opts the optional parameters\n @return [UserResponse]", "Returns a single user\n @param id ID of user to fetch\n @param [Hash] opts the optional parameters\n @return [UserResponse]", "Updates a single user\n @param id ID of user to fetch\n @param user User parameters to update\n @param [Hash] opts the optional parameters\n @return [UserResponse]", "Returns the formatted date according to the given period of time expresed in a literal way\n\n @param [String] period = time expressed literally (e.g: in 2 days)\n @return [String] formatted time", "Method to know if the day is the required day\n\n @param [Time] time\n @param [String] day = to match in case statement\n @return [Boolean] = true if day is the required day", "Returns seconds to multiply by for the given string\n\n @param [String] period = the period of time expressed in a literal way\n @return [Fixnum] number to multiply by", "Return the Time object according to the splitted date in the given array\n\n @param [String] date\n @return [Time]", "Try to convert Missing methods to string and call to for method with converted string", "Updates the flags based on the controller configuration.", "Gets a string describing who is permitted to execute the action.", "Sets the group IDs accepted by this action.", "This is basically the core of everything. This call takes a number of\n arguments and characteristics about the submitted content and then\n returns a thumbs up or thumbs down. Almost everything is optional, but\n performance can drop dramatically if you exclude certain elements.\n\n ==== Arguments\n +options+ <Hash>:: describes the comment being verified\n\n The following keys are available for the +options+ hash:\n\n +user_ip+ (*required*)::\n   IP address of the comment submitter.\n +user_agent+ (*required*)::\n   user agent information.\n +referrer+ (<i>note spelling</i>)::\n   the content of the HTTP_REFERER header should be sent here.\n +permalink+::\n   permanent location of the entry the comment was submitted to\n +comment_type+::\n   may be blank, comment, trackback, pingback, or a made up value like\n   \"registration\".\n +comment_author+::\n   submitted name with the comment\n +comment_author_email+::\n   submitted email address\n +comment_author_url+::\n   commenter URL\n +comment_content+::\n   the content that was submitted\n Other server enviroment variables::\n   In PHP there is an array of enviroment variables called <tt>_SERVER</tt>\n   which contains information about the web server itself as well as a\n   key/value for every HTTP header sent with the request. This data is\n   highly useful to Akismet as how the submited content interacts with\n   the server can be very telling, so please include as much information\n   as possible.", "Internal call to Akismet. Prepares the data for posting to the Akismet\n service.\n\n ==== Arguments\n +akismet_function+ <String>::\n   the Akismet function that should be called\n\n The following keys are available to configure a given call to Akismet:\n\n +user_ip+ (*required*)::\n   IP address of the comment submitter.\n +user_agent+ (*required*)::\n   user agent information.\n +referrer+ (<i>note spelling</i>)::\n   the content of the HTTP_REFERER header should be sent here.\n +permalink+::\n   the permanent location of the entry the comment was submitted to.\n +comment_type+::\n   may be blank, comment, trackback, pingback, or a made up value like\n   \"registration\".\n +comment_author+::\n   submitted name with the comment\n +comment_author_email+::\n   submitted email address\n +comment_author_url+::\n   commenter URL\n +comment_content+::\n   the content that was submitted\n Other server enviroment variables::\n   In PHP there is an array of enviroment variables called <tt>_SERVER</tt>\n   which contains information about the web server itself as well as a\n   key/value for every HTTP header sent with the request. This data is\n   highly useful to Akismet as how the submited content interacts with\n   the server can be very telling, so please include as much information\n   as possible.", "Define an action for this class to map on to the Evvnt API for this class's\n resource.\n\n action - A Symbol or String representing the action name. Should be one of the\n          template actions if block is not provided.\n block  - A Proc to be used as the action method definition when custom behaviour\n          is required.\n\n Examples\n\n   class Package < Evvnt::Base\n     # Define using the template `all` method\n     define_action :all\n     define_action :mine do\n       # define the custom behaviour here\n     end\n   end\n\n Returns Symbol", "send GET HTTP request", "Returns list of available os versions filtered by conditions\n\n Each condition is treated as OR operation\n If no condition is specified all items are listed\n If TrueClass is supplied as one of the arguments it filters only last versions", "Returns `true` if provided value is a version string\n @param string [String, Symbol] value to check\n @return [TrueClass, FalseClass]", "Returns `true` if provided value is a registered OS\n @param string [String, Symbol] value to check\n @return [TrueClass, FalseClass]", "Returns true if item matches filter conditions\n @param filter [Hash{Symbol => String, Symbol}]\n @param item [Hash{Symbol => String, Symbol}]\n @return [true, false]", "Returns list of available os versions\n @param [TrueClass, FalseClass] latest specify if would like to receive only latest\n @return [Array<Hash{Symbol => String, Symbol}>] list of os versions in view of hash", "Helper method, similar to fetch_job, that retrieves the job identified by\n +job_id+, caches it, and updates counters before returning the job.\n If the job does not exist, nothing is cached, however counters will be updated,\n and nil is returned", "connects to mycroft aka starts tls if necessary", "Sends the app manifest to mycroft", "Sends a query to mycroft", "Sends a broadcast to the mycroft message board", "Initializes an instance of the given page class, drives the given browser\n instance to the page's url with any given query parameters appended,\n yields the page instance to a block if given, and returns the page instance.\n\n @param page_class [Class] the page class\n @param query_params [Hash, Array] the query parameters to append to the page url to viist\n @param browser [Object] the browser instance\n @yield [page] yields page instance to a block", "Initializes and returns an instance of the given page class. Yields the\n page instance to a block if given.\n\n @param page_class [Class] the page class\n @param browser [Object] the browser instance\n @yield [page] yields page instance to a block", "Loads all yml files in a directory into this store\n Will not recurse into subdirectories.\n @param [String] path to directory", "Loads a single yml file into the store\n @param [String] path to file", "Profile new command", "Profile remove command", "Profile list command", "Wrap the current line to +width+, with an optional +indent+. After\n wrapping, the current line will be the last line wrapped.", "Searches the shopsense API\n @param [String] search_string\n   The string to be in the query.\n @param  [Integer] index\n   The start index of results returned.\n @param  [Integer] num_results\n   The number of results to be returned.\n @return  A list of Product objects. Each Product has an id, name,\n   description, price, retailer, brand name, categories, images in small/medium/large,\n   and a URL that forwards to the retailer's site.", "This method returns information about a particular look and its products.\n @param [Integer] look_id\n   The ID number of the look. An easy way to get a look's ID is\n   to go to the Stylebook page that contains the look at the ShopStyle website and\n   right-click on the button that you use to edit the look. From the popup menu, select\n   \"Copy Link\" and paste that into any text editor. The \"lookId\" query parameter of that\n   URL is the value to use for this API method.\n @return [String]  single look, with title, description, a set of tags, and a list of products.\n   The products have the fields listed (see #search)", "This method returns information about a particular user's Stylebook, the\n looks within that Stylebook, and the title and description associated with each look.\n @param [String] username\n   The username of the Stylebook owner.\n @param  [Integer] index\n   The start index of results returned.\n @param  [Integer] num_results\n   The number of results to be returned.\n @return [String]\n   A look id of the user's Stylebook, the look id of each individual look within that Stylebook,\n   and the title and description associated with each look.", "This method returns information about looks that match different kinds of searches.\n @param [Integer] look_type\n   The type of search to perform. Supported values are:\n   New - Recently created looks.\n   TopRated - Recently created looks that are highly rated.\n   Celebrities - Looks owned by celebrity users.\n   Featured - Looks from featured stylebooks.\n @param [String] username\n   The username of the Stylebook owner.\n @param  [Integer] index\n   The start index of results returned.\n @param  [Integer] num_results\n   The number of results to be returned.\n @return [String]\n   A list of looks of the given type.", "This method returns the popular brands for a given category along with a sample product for the\n brand-category combination.\n @param [String] category\n   Category you want to restrict the popularity search for. This is an optional\n   parameter. If category is not supplied, all the popular brands regardless of category will be returned.\n @return [String] A list of trends in the given category. Each trend has a brand, category, url, and\n   optionally the top-ranked product for each brand/category.", "This method is used for making the http calls building off the DSL of this module.\n @param [String] method\n   The method which is to be used in the call to Shopsense\n @param [String] args\n   A concatenated group of arguments seperated by a an & symbol and spces substitued with a + symbol.\n @return [String] A list of the data returned", "Convert sequence of digits to its text representation.\n The nil value can be used in the digits sequence to\n represent the group separator.", "Determine the max count of characters for all task names.\n @return [integer] count of characters", "Print the current task list to console.", "Wait a given number of seconds for the `Event` to be set by another\n thread. Will wait forever when no `timeout` value is given. Returns\n immediately if the `Event` has already been set.\n\n @return [Boolean]\n   true if the `Event` was set before timeout else false", "Makes a calls to the object on the remote endpoint.\n @note will block until the call has completed\n @param method_name [String] method to call\n @param arguments [Array<Array,Boolean,Exception,ExposedObject,Float,Hash,Integer,nil,String>] arguments being passed\n @raise [ClosedObjectRequestBrokerError] if broker is closed before the request is sent or respose is received\n @raise [UnexposedObjectError] if an object being sent is an invalid type\n @raise [StaleObjectError] if an object being sent has been forgoten by this endpoint\n   (may not be forgoten by the remote endpoint yet)\n @raise [RemoteError] if an error was raised during call\n @raise [ArgumentError,StaleObjectError,UnexposedMethodError,UnexposedObjectError]\n   if one is raised by the remote endpoint when trying to call the method or return a value (but not during the call)\n @return [Array,Boolean,Exception,ExposedObject,Float,Hash,Integer,nil,String] value returned from the call on remote endpoint", "Runs a hook in the current shell instance.\n\n The hook method is passed the shell as the first argument then the arguments passed to this method.\n\n Return false unless the hook was executed.  Returns :break if one of the hook methods returns :break.", "add a breadcrumb to the breadcrumb hash", "restricts any CRUD functions if you are logged in as the username of demo and you have demonstration mode turned on", "Adds an asterix to the field if it is required.", "Connects to UserStreaming API.\n\n The block will be given the events or statuses from Twitter API in JSON format.", "Fetches raw data and parses as JSON object\n\n @return [Object]", "Parses raw data and returns game item.\n\n @param [Object]\n @return [Struct]", "Construct a nicer error.\n\n @param [Array] message\n   Main message segments. See {#format_message} and {#format_message_segment}\n   for an understanding of how they are, well, formatted.\n\n @param [Binding?] binding\n   When provided any details string will be rendered using it's\n   {Binding#erb} method.\n\n @param [nil | String | Proc<()=>String> | #to_s] details\n   Additional text details to add to the extended message. When:\n\n   1.  `nil` - no details will be added.\n\n   2.  `String` - the value will be used. If `binding:` is provided, it\n       will be rendered against it as ERB.\n\n   3.  `Proc<()=>String>` - if and when an extended message is needed\n       the proc will be called, and the resulting string will be used\n       as in (2).\n\n   4.  `#to_s` - catch all; if and when an extended message is needed\n       `#to_s` will be called on the value and the result will be used\n       as in (2).\n\n @param [Hash<Symbol, VALUE>] context\n   Any additional names and values to dump with an extended message.\n\n #initialize\n Format a segment of the error message.\n\n Strings are simply returned. Other things are inspected (for now).\n\n @param [Object] segment\n   The segment.\n\n @return [String]\n   The formatted string for the segment.\n\n @todo\n   This should talk to config when that comes about to find out how to\n   dump things.", "Get the message or the extended message.\n\n @note\n   This is a bit weird, having to do with what I can tell about the\n   built-in errors and how they handle their message - they have *no*\n   instance variables, and seem to rely on `#to_s` to get the message\n   out of C-land, however that works.\n\n   {Exception#message} just forwards here, so I overrode that with\n   {#message} to just get the *summary/super-message* from this method.\n\n @param [Boolean?] extended\n   Flag to explicitly control summary/super or extended message:\n\n   1.  `nil` - call {#add_extended_message?} to decide (default).\n   2.  `false` - return just the *summary/super-message*.\n   3.  `true` - always add the *extended message* (unless it's empty).\n\n @return [String]", "Trigger when a class inherit this class\n Rest class_attributes that should not be shared with subclass\n @param subclass [Clin::Command]", "Set or get the arguments for the command\n @param args [Array<String>] List of arguments to set. If nil it just return the current args.", "This just tries to determine if the server will honor\n requests as specified above so that the TCPServer initializer\n can error out early if it won't.", "This does the full setup process on the request, returning only\n when the connection is actually available.", "Creates attributes for given object\n\n @param[ActiveRecord] record AR instance record for which to display attributes\n @param[Hash] options Opions\n @option options [Hash] :html ({}) Hash with optional :class html class name for html block\n @yield [attr] Block which is yield inside of markup\n @yieldparam [SemanticAttributesBuilder] builder Builder for attributes for given AR record\n\n @example\n   <%= semantic_attributes_for @user do |attr| %>\n     <%= attr.attributes do %>\n       <%= attr.attribute :name %>\n       <%= attr.attribute :email %>\n     <% end %>\n   <% end %>\n\n @example\n   <%= semantic_attributes_for @user %>", "Asynchronous wait for reply\n\n Parameters:\n   user_id: the user defined id to correlate a response for\n\n Supply a nil user_id to receive any message from the queue\n\n Returns the message received\n\n Note: Call submit_request before calling this method", "all fields are required by default unless otherwise stated", "Defines an instance method `page_url` which returns the url passed to this\n method and takes optional query parameters that will be appended to the\n url if given.\n\n @param url [String] the page url\n @return [Symbol] the name of the defined method (ruby 2.1+)", "Merges the given source object into the target object.\n\n @param [Resource] source the domain object to merge from\n @param [Resource] target the domain object to merge into\n @return [Resource] the merged target", "Get node checkpoint parameter from the yml file", "Prepare the configured nodes", "Create the puppet hiera template file", "Create checkpoint for node", "Get necessary table and column information so we can define\n fast insertion methods\n\n name - Plural name of the model we're associating with\n options - see ActiveRecord docs", "Creates an algorithm instance\n Executes the random generation", "Kills the job if running\n Using PID", "Checks to see if the PID of the log is active or not", "Register a new comparator strategy\n\n @param [String,Symbol] name\n   The name which can be used to refer to the registered strategy\n\n @param [Comparator] klass\n   The strategy class which should be registered\n\n @raise user defined exception\n   Raise exception if an incompatible strategy class is given. Please\n   see #exception_to_raise_for_invalid_strategy for more information", "Assign one or more items to a group. This method is additive, so multitemle\n calls will grow the group, not replace it.", "Remove the items from the group provided by name, also deallocates them.", "Remove a group and free its allocated item addresses.", "Preloads the most recent `amount` keys.", "Log in to the server with a user name and password, remembering\n the session ID returned to us by SalesForce.", "Log in to the server with OAuth, remembering\n the session ID returned to us by SalesForce.", "Turns method calls on this object into remote SOAP calls.", "Tears down the shell session.\n\n This method is called after the session block is run before disconnecting the shell.\n\n The default implementation simply sends the quit command to the shell and waits up to 1 second for a result.\n\n This method will be called even if an exception is raised during the session.", "Sends a POST request to the specified Lightstreamer URL that concatenates multiple individual POST request bodies\n into one to avoid sending lots of individual requests. The return value is an array with one entry per body and\n indicates the error state returned by the server for that body's request, or `nil` if no error occurred.\n\n @param [String] url The URL to send the POST request to.\n @param [Array<String>] bodies The individual POST request bodies that are to be sent together in one request.\n        These should be created with {#request_body}.\n\n @return [Array<LightstreamerError, nil>] The execution result of each of the passed bodies. If an entry is `nil`\n         then no error occurred when executing that body.", "Returns the request body to send for a POST request with the given options.\n\n @param [Hash] query The POST request's query params.\n\n @return [String] The request body for the given query params.", "Parses the next error from the given lines that were returned by a POST request. The consumed lines are removed\n from the passed array.\n\n @param [Array<String>] response_lines\n\n @return [LightstreamerError, nil]", "convert bool to integer", "Returns true if the first URL is the child of the second URL\n @param url1 [Aspire::Caching::CacheEntry, String] the first URL\n @param url2 [Aspire::Caching::CacheEntry, String] the second URL\n @param api [Aspire::API::LinkedData] the API for generating canonical URLs\n @param strict [Boolean] if true, the URL must be a parent of this entry,\n   otherwise the URL must be a parent or the same as this entry\n @return [Boolean] true if the URL is a child of the cache entry, false\n   otherwise", "Returns the data for a URI from a parsed linked data API response\n which may contain multiple objects\n @param uri [String] the URI of the object\n @param ld [Hash] the parsed JSON data from the Aspire linked data API\n @return [Hash] the parsed JSON data for the URI", "Returns the path of a URI\n @param uri [String] the URI\n @return [String, nil] the URI path or nil if invalid", "Returns true if a URL is a list URL, false otherwise\n @param u [String] the URL of the API object\n @return [Boolean] true if the URL is a list URL, false otherwise", "Returns true if the first URL is the parent of the second URL\n @param url1 [Aspire::Caching::CacheEntry, String] the first URL\n @param url2 [Aspire::Caching::CacheEntry, String] the second URL\n @param api [Aspire::API::LinkedData] the API for generating canonical URLs\n @param strict [Boolean] if true, the first URL must be a parent of the\n   second URL, otherwise the first URL must be a parent or the same as the\n   second.\n @return [Boolean] true if the URL has the same parent as this entry", "Returns a parsed or unparsed URL for comparison\n @param url [Aspire::Caching::CacheEntry, String] the URL\n @param api [Aspire::API::LinkedData] the API for generating canonical URLs\n @param parsed [Boolean] if true, return a parsed URL, otherwise return\n   an unparsed URL string\n @return [Aspire::Caching::CacheEntry, String] the URL for comparison", "Returns the path from the URL as a relative filename", "Import documentation file", "Open or create a swagger.json file", "Raw Cell is the text from the csv file for this column\n\n method_name_or_ability_class is one of two things:\n 1. the symbol for the method to call for this column\n 2. The Class that represents this ability", "This is what responds to Zog.info, Zog.error, etc", "Defines an associated model\n\n @example\n   class User\n     include Associates\n\n     associate :user, only: :username\n   end\n\n @param model [Symbol, Class]\n @param [Hash] options\n @option options [Symbol, Array] :only Only generate methods for the given attributes\n\n @option options [Symbol, Array] :except Generate all the model's methods except\n   for the given attributes\n\n @option options [Symbol] :depends_on Specify one or more associate name on\n   which the current associate model depends to be valid. Allow to automatically\n   setup `belongs_to` associations between models\n\n @option options [String, Class] :class_name Specify the class name of the associate.\n   Use it only if that name can\u2019t be inferred from the associate's name\n\n @option options [Boolean] :delegate (true) Wether or not to delegate the associate's\n   attributes getter and setters methods to the associate instance", "Builds an associate\n\n @param model [Symbol, Class]\n @param options [Hash]\n @return [Item]", "Ensure associate attribute names don't clash with already declared ones\n\n @param associates_attribute_names [Array]\n @param attribute_names [Array]", "Ensure associate dependent names exists\n\n @param associates_names [Array]\n @param dependent_associate_names [Array]", "Define associated model attribute methods delegation\n\n @param associate [Item]", "Define associated model instance setter method\n\n @example\n\n   @association.user = User.new\n\n @param associate [Item]", "Define associated model instance getter method\n\n @example\n\n   @association.user\n\n @param associate [Item]", "Sends the activation email to a new user.", "Sends an invalid password reset attempt message to a user whether they exist or not.", "Creates and returns anonymous module containing\n delegators that point to methods from a class this module is included in\n or the given +base+.\n\n @param base [Object,Symbol] base object which delegators will point to (defaults to object on which\n  this method has been called). If symbol is given, then it should contain the name of a method that\n  will be called on current object.\n\n @return [Module] anonymous module with proxy module methods delegating actions to +base+ object", "Gets all method names known to configuration engine.\n\n @param local_only [Boolean] optional flag that if set, causes only methods added\n  by current class or module to be listed.\n\n @return [Array<Symbol>] delegated method names", "This DSL method is intended to be used in a class or module to indicate which methods\n should be delegated.\n\n @param methods [Array<Symbol,String>] list of method names\n @return [nil]", "Evaluates configuration block within a context of the given module.", "Shows the system status while optionally performing a long running code block.\n\n Accepted options:\n\n url_on_completion::\n     This is the URL you want to redirect to when the long running code completes.\n     If not set, then the completion button will have an empty HREF which means it will simply reload the status page.\n     It is therefore highly recommended that you provide this value when using this method.\n\n completion_button::\n     This is the label for the button that becomes visible when the long running code completes.\n     Defaults to 'Continue'.\n\n main_status::\n     This is the initial status to report for the system when a long running code block is provided.\n\n If a code block is provided, this will reset the system status and spawn a thread to run the code block.\n Before running the code block, it will acquire a GlobalStatus lock and set the initial status.\n When the code block exits, either through error or normal behavior, the GlobalStatus lock will be released.\n\n It will yield the +status+ object to the code block on a successful lock, or it will yield false to the code\n block to let it know that a lock could not be acquired.  You should check for this in your code block and\n handle the error as appropriate.\n\n Example 1:\n   def my_action\n     Spawling.new do\n       GlobalStatus.lock_for do |status|\n         if status\n           clear_system_status   # reset the log file.\n           # Do something that takes a long time.\n           ...\n         end\n       end\n     end\n     show_system_status(:url_on_completion => my_target_url)\n   end\n\n Example 2:\n   def my_action\n     show_system_status(:url_on_completion => my_target_url) do |status|\n       if status\n         # Do something that takes a long time.\n         ...\n       end\n     end\n   end\n\n The benefits of Example 2 is that it handles the thread spawning and status locking for you.", "Clears the system status log file.\n\n If the file does not exist, it is created as a zero byte file.\n This is important for the status checking, since if there is no log file it will report an error.", "Convert this integer into a string with every three digits separated by a delimiter\n on the left side of the decimal", "Overrides the default formatter behavior to log a JSON line.", "Returns the estimated number of cards and number of pages for exporting Business Cards as PDF", "Returns a URL for one-time download of Business Cards as PDF", "Does the user have business card auto-share mode turned on?", "Turn auto-share mode on or off", "Get user's contact information that is sent out with business cards", "Returns the color for the given value\n\n === Args\n\n A context or a value.", "Converts a list of filenames into a dataframe after parsing them\n according ot the csv options that were set\n @param data [Object] Extracted data that needs to be parsed\n @return [Remi::DataFrame] The data converted into a dataframe", "Converts the dataframe to a CSV file stored in the local work directory.\n If labels are present write the CSV file with those headers but maintain\n the structure of the original dataframe\n\n @param dataframe [Remi::DataFrame] The dataframe to be encoded\n @return [Object] The path to the file", "Creates a new executor\n @!macro executor_method_post", "Try to infer the final extension of the output file.", "Updates metadata of file and deletes old meta file from legacy mode.", "map a route\n @param [Symbol] ref to map route to for easy future reference", "set the root context, this is the initial context that will be renered by the router\n\n @note there is only ever one root, calling this multiple times will over right the original root\n @param [Symbol] reference to context", "Generate a unique fake user for testing", "Create a new log message", "Populates a message from the next line in the", "Create rbenv local", "Generate steps templates for hiera and manifests files", "Apply a step for the nodes in a environment", "Given an array of unspent Outputs and an array of Outputs for a\n Transaction, estimate the fee required for the transaction to be\n included in a block.\n\n Optionally takes an Integer tx_size specifying the transaction size in bytes\n   This is useful if you have the scriptSigs for the unspents, because\n   you can get a more accurate size than the estimate which is generated\n   here by default\n\n Optionally takes an Integer fee_per_kb specifying the chosen cost per 1000\n   bytes to use\n\n Returns the estimated fee in satoshis.", "POST's a resource from the URI and returns the result based on its content\n type. JSON content will be parsed and returned as equivalent Ruby objects.\n All other content types will be returned as text.\n\n Assuming an api where each resource is namespaced with 'api/v1' and where\n the url http://www.example.com/api/v1/foo/create responds with the\n following when a 'name' is sent with the request.\n\n Header:\n\n   Content-Type: application/json\n\n Body:\n\n   {\n     \"name\": \"New Foo\"\n   }\n\n == Example\n\n   class ExampleApi < HttpMagic::Api\n     url 'www.example.com'\n     namespace 'api/v1'\n   end\n\n   ExampleApi.foo.create.post(name: 'New Foo')\n   => { \"name\" => \"New Foo\" }", "PUT's a resource to the URI and returns the result based on its content\n type. JSON content will be parsed and returned as equivalent Ruby objects.\n All other content types will be returned as text.\n\n Assuming an api where each resource is namespaced with 'api/v1' and where\n a GET to the url http://www.example.com/api/v1/foo/99 responds with the\n following.\n\n Header:\n\n   Content-Type: application/json\n\n Body:\n\n   {\n     \"name\": \"Foo\"\n   }\n\n == Example\n\n   class ExampleApi < HttpMagic::Api\n     url 'www.example.com'\n     namespace 'api/v1'\n   end\n\n   ExampleApi.foo[99].put(name: 'Changed Foo')\n   => { \"name\" => \"Changed Foo\" }", "Adds a consumer.\n\n * If an instance of Consumer or its subclasses is given, it is used.\n * If Class is given, initialize its instance, and use it. In this case, the rest arguments are passed to the constructor of the given class.", "ATTRIBUTE MATCHER METHODS", "Dynamicly constructs ANSI methods for the color methods based on the ANSI\n code hash passed in.\n\n @param [Hash] hash\n   A hash where the keys represent the method names and the values are the\n   ANSI codes.\n\n @return [Boolean]\n   True if successful.", "Removes ANSI code sequences from a string.\n\n @param [String] string\n   The string to operate on.\n\n @yieldreturn [String]\n   The string to operate on.\n\n @return [String]\n   The supplied string stripped of ANSI codes.", "Validates a reCAPTCHA attribute.\n\n The value of the attribute should be a hash with two keys: :response, :remote_ip", "Handle a class including a module that has included Aliasable.  Since the\n contolling module has extended this module, this method ends up being\n called when the controlling module is included.\n\n As a minor side effect, an instance method named #included ends up on any\n class that directly includes Aliasable.  If you know an elegant way to\n avoid this, I welcome pull requests.  :-)\n\n :nodoc:", "Creates a new hash with all keys as symbols, can be\n any level of depth", "Meta-programming method for creating constructor shortcut methods\n\n @param [Class] target Element-type to create constructor shortcut for.\n\n @return [Proc] The new method.\n\n @private", "Record into db, information about object creation", "Returns true or false if a masterfile exist", "Returns the name of a masterfile if present", "Loads the filelist\n Returns a full list of file data", "Loads the masterfile directly", "Masterfile is the main file attached to a document", "Initializes the shell with the supplied options.\n\n These options are common to all shells.\n +prompt+::\n       Defaults to \"~~#\".  Most special characters will be stripped.\n +retrieve_exit_code+::\n       Defaults to false. Can also be true.\n +on_non_zero_exit_code+::\n       Defaults to :ignore. Can also be :raise.\n +silence_timeout+::\n       Defaults to 0.\n       If greater than zero, will raise an error after waiting this many seconds for a prompt.\n +command_timeout+::\n       Defaults to 0.\n       If greater than zero, will raise an error after a command runs for this long without finishing.\n +unbuffered_input+::\n       Defaults to false.\n       If non-false, then input is sent one character at a time, otherwise input is sent in whole strings.\n       If set to :echo, then input is sent one character at a time and the character must be echoed back\n       from the shell before the next character will be sent.\n\n Please check the documentation for each shell class for specific shell options.\n\n Allows you to change the :quit option inside of a session.\n\n This is useful if you need to change the quit command for some reason.\n e.g. - Changing the command to \"reboot\".\n\n Returns the shell instance.", "Send url to get response", "Return the comments in the format specified in spec.", "Finds document by id.\n Raises error if document is not found.", "Render navigational information in the form of breadcrumbs", "Set bucket policy for the given bucket", "Create a new profile", "Check if the profile name is valid", "Removes an existing profile", "Field symbolizer used to convert field names into symbols.  This method sets\n the symbolizer for the data subject and also sets the symbolizers for\n any associated parser and encoders.\n\n @return [Proc] the method for symbolizing field names", "Reassigns the dataframe associated with this DataSubject.\n @param new_dataframe [Object] The new dataframe object to be associated.\n @return [Remi::DataFrame] the associated dataframe", "Returns the union of the results of calling the given method symbol on each component.", "to generate 'user.user-data'", "Fill in a form field", "Fill in a Rails-ish set of date_select fields", "Wait for a specific element, the page to load\n or an AJAX request to return", "create a new database.yml that works with PG.", "Add observer.\n\n @param [Class] observer_class\n @return [self]", "Only require ssl if we are in production", "Iterates over the nodes above this in the tree hierarchy and yields them\n to a block. If no block is given an enumerator is returned.\n\n @yield  [Node] each parent node.\n @return [Enumerator] if no block is given.", "Accessor method for any of the n children under this node. If called\n without an argument and the node has anything but exactly one child an\n exception will be raised.\n\n @param index [Integer] the n:th child to be returned. If the index is\n   negative the indexing will be reversed and the children counted from the\n   last to the first.\n @return [Node] the child at the n:th index.", "Iterates over each edge in the tree.\n\n @yield  [Array<Node>] each connected node pair.\n @return [Enumerator] if no block is given.", "Add two roots together to create a larger tree. A new common root will be\n created and returned. Note that if the any of the root nodes are not\n frozen they will be modified, and as a result seize to be roots.\n\n @param  other [Node] a Node-like object that responds true to #root?\n @return [Node] a new root with the two nodes as children.", "Complete json file with datas to method and controller. Each action to\n controller is writing in temporary file.", "Complete definitions objects for each controller.", "Convert any object to a promise. When the object in question responds to\n `to_promise`, the result of that method will be returned. If not, a new\n deferred object is created and immediately fulfilled with the given\n object.\n\n @param [Object] obj\n @return [Promise]", "Will make path relative to project dir\n @return [String] relative path", "Tests if +options+ includes only valid keys. Raises an error if\n any key is not included within +valid_options+.\n +valid_options+ is a Hash that must include all accepted keys. values\n aren't taken into account.", "Return a description text for an expectation that two files were\n expected to be the same, but are not.\n\n @param  [Diff] diff\n         the diff which holds the difference\n\n @param  [Integer] max_width\n         the max width of the terminal to print matching separators\n\n @return [String]", "This will be called after successfull signin", "Render a template for file content", "Write content to a file", "Creates a new resource\n @param resource Resource to add\n @param [Hash] opts the optional parameters\n @return [ResourceResponse]", "Returns a single resource\n @param id_or_uri ID or URI of resource to fetch\n @param [Hash] opts the optional parameters\n @return [ResourceResponse]", "Returns aggregated resources to be monitored\n @param uri_prefix Prefix of Resource URI\n @param [Hash] opts the optional parameters\n @return [Array<AggregatedResourceEachResponse>]", "Updates a single resource\n @param id_or_uri ID or URI of resource to fetch\n @param resource Resource parameters to update\n @param [Hash] opts the optional parameters\n @return [ResourceResponse]", "Builds a UserPair given the related CMC data", "Post new topic", "Yield each reachable vertex to a block, breadth first", "create a class", "Generate and cache bonds for this geometry.\n A bond will be generated for every pair of atoms closer than +bond_length+", "Recompute the atoms that are behind all the clip planes\n Atoms that are in front of any clip-plane are considered invisible.", "Return an Atom whose coordinates are the center of the unit-cell.", "Return a new unit cell with all the atoms displaced by the amount x,y,z", "Repeat a unit cell nx,ny,nz times in the directions\n of the lattice vectors.\n Negative values of nx,ny or nz results in displacement in the\n negative direction of the lattice vectors", "Return a string formatted in the Aims geometry.in format.", "return a string in xyz format", "Find the difference between this cell and another cell\n Return a cell with Pseudo-Atoms whose positions are really the differences", "Set up the model for serialization to a HashWithIndifferentAccess.\n\n @example Using the default column name \":metadata\", specify the attributes in a separate step\n\n    class Thing < ActiveRecord::Base\n      has_metadata\n\n      # full accessors\n      metadata_accessor :breakfast_food, :wheat_products, :needs_milk\n\n      # read-only\n      metadata_reader :friends_with_spoons\n    end\n\n @example Specifying attributes for full attributes accessors in one step\n\n    class Thing < ActiveRecord::Base\n      has_metadata :metadata, :breakfast_food, :wheat_products, :needs_milk\n    end\n\n @example Specifying multiple metadata serializers (Ruby 1.9 only)\n\n    class Thing < ActiveRecord::Base\n      has_metadata :cows\n      has_metadata :chickens, :tasty, :feather_count\n\n      # read-only\n      cow_reader :likes_milk, :hates_eggs\n\n      # write-only\n      cow_writer :no_wheat_products\n\n      # extra full accessors for chickens\n      chicken_accessor :color, :likes_eggs\n    end\n\n @param [Symbol] serializer, the symbolized name (:metadata) of the database text column used for serialization\n @param [Array<Symbol>] optional list of attribute names to add to the model as full accessors\n\n @return [void]", "Adds input to be sent to the shell.", "Get or configure the current subject\n\n @note On first call this will create a new subject on base of the\n       shared configuration and store it in the ivar `@subject`.\n\n @param  [Block<(Subject) -> ()>]\n         This block, if given, will be evaluated on the caller.\n         It receives as first argument the subject itself.\n\n @return [Subject]\n         the subject", "Get or configure the current context for FileTreeSpecs\n\n @note On first call this will create a new context on base of the\n       shared configuration and store it in the ivar `@file_tree_spec_context`.\n\n @param  [Block<(FileTreeSpecContext) -> ()>]\n         This block, if given, will be evaluated on the caller.\n         It receives as first argument the context itself.\n\n @return [FileTreeSpecContext]\n         the spec context, will be lazily created if not already present.", "Acquire a read lock. If a write lock has been acquired will block until\n it is released. Will not block if other read locks have been acquired.\n\n @return [Boolean]\n   True if the lock is successfully acquired.\n\n @raise [Garcon::ResourceLimitError]\n   If the maximum number of readers is exceeded.", "Release a previously acquired read lock.\n\n @return [Boolean]\n   True if the lock is successfully released.", "Acquire a write lock. Will block and wait for all active readers and\n writers.\n\n @return [Boolean]\n   True if the lock is successfully acquired.\n\n @raise [Garcon::ResourceLimitError]\n   If the maximum number of writers is exceeded.", "Release a previously acquired write lock.\n\n @return [Boolean]\n   True if the lock is successfully released.", "Returns hash of all parameter names and values", "Returns the user who is responsible for any changes that occur.\n By default this calls `current_user` or `current_employee` and returns the result.\n\n Override this method in your controller to call a different\n method, e.g. `current_person`, or anything you like.", "Returns any information about the controller or request that you\n want ModelsAuditor to store alongside any changes that occur.  By\n default this returns an empty hash.\n\n Override this method in your controller to return a hash of any\n information you need.  The hash's keys must correspond to columns\n in your `auditor_requests` table, so don't forget to add any new columns\n you need.\n\n For example:\n\n     {:ip => request.remote_ip, :user_agent => request.user_agent}\n\n The columns `ip` and `user_agent` must exist in your `versions` # table.\n\n Use the `:meta` option to `PaperTrail::Model::ClassMethods.has_paper_trail`\n to store any extra model-level data you need.", "code - required", "Grab the library from the registry server", "I can't imagine a whole lot of use for this one.", "Adds JSON serialization to collections.\n\n @param [State, Hash, nil] state the JSON state or serialization options\n @return [String] the JSON representation of this {Jinx::Resource}", "Runs the export process using the required Exporter library", "Throws ExportIgnored if the job is still running\n Checks the state of the job using PID and state", "Run the command on the remote host.\n\n Return value is a hash of symbol -> value, where symbol might be:\n\n * :stdout -- the standard output of the run. if #merge_output is\n   supplied, this will be all the output. Will be an empty string by\n   default.\n * :stderr -- standard error. Will be an empty string by default.\n * :exit_status -- the exit status. Will be zero by default.", "Creates run time based on start and end time\n If there is no end_time, returns time between start and now\n @return [Time] The run time object", "Gets the label for an extra value.", "Gets the field type for an extra value.", "Gets an extra value.", "Send the same mail as is to all receivers, if any.", "Heuristic method to find actual receiver of the message.\n May return nil if could not determine.", "Sets uri as Rack wants.", "Returns uri from Rack environment.\n Throws ArgumentError for invalid uri.", "get menu object and display it for editing", "deletes the whole menu. Although there is a delete button on each menu option this just removes it from the list\n which is then interpreted when you save the menu as a whole.", "hook helper methods", "applies styles in a range to the attributed string", "Intended to be included in an ActiveRecord model class.\n\n Retries a block (which usually contains a transaction) under certain\n failure conditions, up to a configurable number of times with an\n exponential backoff delay between each attempt.\n\n Conditions for retrying:\n\n    1. Database connection lost\n    2. Query or txn failed due to detected deadlock\n       (Mysql/InnoDB and Postgres can both signal this for just about\n        any transaction)\n    3. Query or txn failed due to serialization failure\n       (Postgres will signal this for transactions in isolation\n        level SERIALIZABLE)\n\n options:\n    retry_count  - how many retries to make; default 4\n\n    backoff      - time period before 1st retry, in fractional seconds.\n                   will double at every retry. default 0.25 seconds.\n\n    exit_on_disconnect\n                 - whether to call exit if no retry succeeds and\n                   the cause is a failed connection\n\n    exit_on_fail - whether to call exit if no retry succeeds\n\n defaults:", "Execute some code in a DB transaction, with retry", "Initializes the TV class.\n\n @param [Object] cert SSL certificate for this client\n @param [String] host hostname or IP address of the Google TV\n @param [Number] port port number of the Google TV\n @return an instance of TV\n\n Connect this object to a Google TV", "Fling a URI to the Google TV connected to this object\n This is used send the Google Chrome browser to a web page", "Send a keystroke to the Google TV\n This is used for things like hitting the ENTER key", "Send a string to the Google TV.\n This is used for things like typing into text boxes.", "Move the mouse relative to its current position", "Scroll the mouse wheel a certain amount", "Send a request to the Google TV and don't wait for a response", "Send a message to the Google TV and return the response", "Adds the routes to the host app to point everything to caboose", "Returns a hash of errors keyed on field name.\n\n Return Example\n   {\n     :field_name_one => \"Error message\",\n     :field_name_two => \"Error message\"\n   }", "The clients method will return a list of all clients\n and can only be accessed by admins on the subscription.\n\n Optional paramaters:\n   open => [true|false]", "The projects method will return projects filtered by the parameters provided.\n Admin can see all projects on the subscription,\n while non-admins can only access the projects they are assigned.\n\n Optional parameters:\n   project_id\n   open [true|false]\n   project_billable [true|false]", "The tasks method will return a list of all the current tasks for a specified project\n and can only be accessed by admins on the subscription.\n\n Required parameters:\n   project_id\n\n Optional Parameters:\n   task_id\n   open [true|false]\n   task_billable [true|false]", "The entries method will return a list of all entries that meet the provided criteria.\n Either a start and end date have to be provided or an updated_at time.\n The entries will be in the start and end date range or they will be after\n the updated_at time depending on what criteria is provided.\n Each of the optional parameters will further filter the response.\n\n Required parameters:\n   start_date\n   end_date\n OR\n  updated_at\n\n Optional Parameters:\n   project_id\n   task_id\n   user_id\n   user_email\n   client_id\n   entry_billable [true|false]\n   billed [true|false]", "The users method will return a list of users.\n\n Optional parameters:\n   project_id", "Return a value from the cache, or calculate it and store it\n Recalculate if the cached value has expired", "Check if a value is cached and not expired", "Prune expired keys", "Create a new paste. If language isn't provided, it defaults to\n \"Plain Text\". If private isn't provided, it defaults to false.", "this doesn't actually give any more detailed info..", "Creates a label followed by small text.\n\n Set the :small_text option to include small text.", "Creates a form group including a label and a text field.\n\n To specify a label, set the +label_text+ option, otherwise the method name will be used.\n Prefix field options with +field_+ and label options with +label_+.\n Any additional options are passed to the form group.", "Creates a form group including a label and a multiple input field.\n\n To specify a label, set the +label_text+ option, otherwise the method name will be used.\n Prefix field options with +field_+ and label options with +label_+.\n Any additional options are passed to the form group.", "Creates a form group including a label and a checkbox.\n\n To specify a label, set the +label_text+ option, otherwise the method name will be used.\n Prefix field options with +field_+ and label options with +label_+.\n Any additional options are passed to the form group.", "Creates a form group including a label and a collection select field.\n\n To specify a label, set the +label_text+ option, otherwise the method name will be used.\n Prefix field options with +field_+ and label options with +label_+.\n Any additional options are passed to the form group.", "For new and set_role commands", "Creates an instance method called +name+ that\n returns an instance of the RedisObject +klass+", "Creates a class method called +name+ that\n returns an instance of the RedisObject +klass+", "Returns an instance based on +idx+ otherwise it\n creates and saves a new instance base on +idx+.\n See from_index", "idx can be a value or an Array of values used to create the index.\n We don't enforce a default suffix; that's left up to the instance.\n A nil +suffix+ will not be included in the key.", "A default initialize method. This will be replaced\n if a class defines its own initialize method after\n including Familia. In that case, the replacement\n must call initialize_redis_objects.\n This needs to be called in the initialize method of\n any class that includes Familia.", "Work with data in the data hash", "Initializes instance from a given year\n Returns the federal holidays for the given year on the dates they will actually\n be observed.", "These holidays are always fixed", "These holidays are potentially rolled if they come on a weekend.", "Old line-based config file format", "Create a new instance of the object tracker.\n\n Determine if the object tracker has already picked this object up.", "Add this object to the object tracker.", "Initialize a new graph, optionally preloading it with vertices and edges\n\n Graph.new() => Graph\n Graph.new(mixins: [MixinModule, ...], ...) => Graph\n\n +mixins+ is an array of modules that can be mixed into the various\n classes that makes up a graph. Initialization of a Graph, Vertex or Edge\n looks for submodules in each mixin, with the same name and extends\n any created object. Defaults to [Tangle::Mixin::Connectedness].\n\n Any subclass of Graph should also subclass Edge to manage its unique\n constraints.\n\n Return a subgraph, optionally filtered by a vertex selector block\n\n subgraph => Graph\n subgraph { |vertex| ... } => Graph\n\n Unless a selector is provided, the subgraph contains the entire graph.", "Add a vertex into the graph\n\n If a name: is given, or the vertex responds to :name,\n it will be registered by name in the graph", "Remove a vertex from the graph", "Add a new edge to the graph\n\n add_edge(vtx1, vtx2, ...) => Edge", "Remove an edge from the graph", "Disconnects this Lightstreamer session and terminates the session on the server. All worker threads are exited,\n and all subscriptions created during the connected session can no longer be used.", "Starts the processing thread that reads and processes incoming data from the stream connection.", "Processes a single line of incoming stream data. This method is always run on the processing thread.", "Attempts to process the passed line as a send message outcome message.", "Creates an embedded vote record and updates number of votes and vote value.\n\n @param [Int,Float] value vote value\n @param [Mongoid::Document] voted_by object from which the vote is done\n @return [Boolean] success flag", "Removes previously added vote.\n\n @param [Mongoid::Document] voted_by object from which the vote was done\n @return [Boolean] success flag", "Indicates whether the document has a vote from particular voter object.\n\n @param [Mongoid::Document] voted_by object from which the vote was done\n @return [Boolean]", "Runs a shell session.\n\n The block provided will be run asynchronously with the shell.\n\n Returns the shell instance.", "fast-forward this clock and all children clocks by the given time delta", "schedules an occurrence at the given time with the given object,\n defaulting to the current time", "dequeues the earliest occurrence from this clock or any child clocks.\n returns nil if it wasn't there, or its relative_time otherwise", "assuming the last attribute could be a hash", "opposite of abstraction is reification i.e. I'm getting the raw data of these variables", "Executes a command during the shell session.\n\n If called outside of the +new+ block, this will raise an error.\n\n The +command+ is the command to execute in the shell.\n\n The +options+ can be used to override the exit code behavior.\n In all cases, the :default option is the same as not providing the option and will cause +exec+\n to inherit the option from the shell's options.\n\n +retrieve_exit_code+::\n       This can be one of :default, true, or false.\n +on_non_zero_exit_code+::\n       This can be on ot :default, :ignore, or :raise.\n +silence_timeout+::\n       This can be :default or the number of seconds to wait in silence before timing out.\n +command_timeout+::\n       This can be :default or the maximum number of seconds to wait for a command to finish before timing out.\n\n If provided, the +block+ is a chunk of code that will be processed every time the\n shell receives output from the program.  If the block returns a string, the string\n will be sent to the shell.  This can be used to monitor processes or monitor and\n interact with processes.  The +block+ is optional.\n\n   shell.exec('sudo -p \"password:\" nginx restart') do |data,type|\n     return 'super-secret' if /password:$/.match(data)\n     nil\n   end", "Gets the output from a command.", "Decrypt the given string, using the salt and password supplied.\n\n @param [String] encrypted_text\n   The text to decrypt, probably produced with #decrypt.\n\n @param [String] password\n   Secret passphrase to decrypt with.\n\n @param [String] salt\n   The cryptographically secure pseudo-random string used to spice up the\n   encryption of your strings.\n\n @return [String]\n   The decrypted plain_text.\n\n @api public", "Generates a special hash known as a SPASH, a PBKDF2-HMAC-SHA1 Salted\n Password Hash for safekeeping.\n\n @param [String] password\n   A password to generating the SPASH, salted password hash.\n\n @return [Hash]\n   `:salt` contains the unique salt used, `:pbkdf2` contains the password\n   hash. Save both the salt and the hash together.\n\n @see Garcon::Crypto#validate_salt\n\n @api public", "A T T E N Z I O N E   A R E A   P R O T E T T A\n Create a new cipher machine, with its dials set in the given direction.\n\n @param [Symbol] direction\n   Whether to `:encrypt` or `:decrypt`.\n\n @param [String] pass\n   Secret passphrase to decrypt with.\n\n @api private", "Prepend the initialization vector to the encoded message.\n\n @api private", "Pull the initialization vector from the front of the encoded message.\n\n @api private", "Convert the password into a PBKDF2-HMAC-SHA1 salted key used for safely\n encrypting and decrypting all your ciphers strings.\n\n @api private", "Environment list command", "make a CSS style-let from a Hash of CSS settings", "returns array of tokens while deleting the tokenized part from buffer", "Select Graphic Rendition associated with the text\n echo the string onto the _screen_ with initial cursor as _cursor_\n _cursor_ position will be changed as the string is echoed", "maximum row number\n applies self an escape sequence code that ends with _letter_ as String\n and with some _pars_ as Integers", "a Hash of CSS stylelet", "register the _char_ at a specific location on Screen", "def inline\n    lines = HtmlElement.decode(@data).split(/\\r*\\n/o)\n    lines.shift if lines.first == \"\"\n    HikiBlockParser.new.parse_lines(lines).join\n  end", "Retrieve all parameters\n\n @return [Array<Node>] Objects for handling the parameters.\n\n @private", "Generate an HTML Tag", "Process a request from the local application to forget an exposed object.\n @param object [LocalObject,RemoteObject]\n @param quiet [Boolean] suppress any message to the remote endpoint\n @raise [UnexposedObjectError] if object is not exposed or has never been sent on this {Connection}\n @return [void]", "Processes a request from the remote endpoint to forget an exposed object.\n Called when a forget message has been received by the messenger.\n @param message [Message::Forget]\n @param quiet [Boolean] suppress any message to the remote endpoint\n @raise [ProtocolError] if reference does not exist with id received\n @return [void]", "Duplicate array expression if it is not in row-major format\n\n @return [Node] Duplicate of array or +self+.", "Convert to Ruby array of objects\n\n Perform pending computations and convert native array to Ruby array of\n objects.\n\n @return [Array<Object>] Array of objects.", "Display information about this object\n\n @return [String] String with information about this object.", "Check arguments for compatible shape\n\n The method will throw an exception if one of the arguments has an incompatible\n shape.\n\n @param [Array<Class>] args Arguments to check for compatibility.\n\n @return [Object] The return value should be ignored.", "Force delayed computation unless in lazy mode\n\n @return [Node,Object] Result of computation\n\n @see #demand\n\n @private", "yields the given amount of time on the global Shreduler, using the\n provided Clock if given", "sleeps, waiting on the given event on the default EventClock of\n the global Shreduler", "runs the next scheduled Shred, if one exists, returning that Shred", "runs shreds until the given target time, then fast-forwards to\n that time", "Validate that the transaction is plausibly signable.", "Verify that the script_sigs for all inputs are valid.", "Takes one of\n\n * an instance of Input\n * an instance of Output\n * a Hash describing an Output", "Takes either an Output or a Hash describing an output.", "A convenience method for authorizing inputs in a generic manner.\n Rather than iterating over the inputs manually, the user can\n provide this method with an array of values and a block that\n knows what to do with the values.\n\n For example, if you happen to have the script sigs precomputed\n for some strange reason, you could do this:\n\n   tx.set_script_sigs sig_array do |input, sig|\n     sig\n   end\n\n More realistically, if you have an array of the keypairs corresponding\n to the inputs:\n\n   tx.set_script_sigs keys do |input, key|\n     sig_hash = tx.sig_hash(input)\n     key.sign(sig_hash)\n   end\n\n Each element of the array may be an array, which allows for easy handling\n of multisig situations.", "Takes a set of Bitcoin addresses and returns the value expressed in\n the inputs for this transaction.", "Takes a set of Bitcoin addresses and returns the value expressed in\n the outputs for this transaction.", "Add an output to receive change for this transaction.\n Takes a bitcoin address and optional metadata Hash.", "Extract path to routes and change format to parameter path", "Succeeds if it catches an error AND that error is\n a `kind_of?` the `expected` error. Fails otherwise.", "The `tst` methods itself.\n Takes a `name` and a block.\n Runs the block.\n Records the result.", "Adds the given attribute to this Class.\n\n @param [Symbol] attribute the attribute to add\n @param [Class] type (see Property#initialize)\n @param flags (see Property#initialize)\n @return [Property] the attribute meta-data", "Initializes the property meta-data structures.", "Creates a new convenience property in this source class which composes\n the given property and the other property. The new property symbol is\n the same as the other property symbol. The new property reader and\n writer methods delegate to the respective composed property reader and\n writer methods.\n\n @param [Property] property the reference from the source to the intermediary\n @param [Property] other the reference from the intermediary to the target\n @yield [target] obtain the intermediary object from the target\n @yieldparam [Resource] target the target object\n @return [Property] the new property\n @raise [ArgumentError] if the other property does not have an inverse", "Returns the most specific attribute which references the given target type, or nil if none.\n If the given class can be returned by more than on of the attributes, then the attribute\n is chosen whose return type most closely matches the given class.\n\n @param [Class] klass the target type\n @param [AttributeEnumerator, nil] attributes the attributes to check (default all domain attributes)\n @return [Symbol, nil] the most specific reference attribute, or nil if none", "Sets the given attribute type to klass. If attribute is defined in a superclass,\n then klass must be a subclass of the superclass attribute type.\n\n @param [Symbol] attribute the attribute to modify\n @param [Class] klass the attribute type\n @raise [ArgumentError] if the new type is incompatible with the current attribute type", "Removes the given attribute from this Resource.\n An attribute declared in a superclass Resource is hidden from this Resource but retained in\n the declaring Resource.", "Registers an alias to an attribute.\n\n @param (see #alias_attribute)", "Strip IRC color codes from a string, modifying it in place.\n @param [String] string The string you want to strip.\n @return [String] A string stripped of all IRC color codes.", "Generate a binding containing the locally bound procs and constants", "Save this record to the EVVNT API as a new record using the +create+ action.", "Save this record to the EVVNT API as an existing record using the +update+ action.", "Request the raw hero data from godville", "Atomic compare and set operation. State is set to `next_state` only if\n `current state == expected_current`.\n\n @param [Symbol] next_state\n @param [Symbol] expected_current\n\n @return [Boolean]\n   TRrue is state is changed, false otherwise\n\n @!visibility private", "executes the block within mutex if current state is included in\n expected_states\n\n @return block value if executed, false otherwise\n\n @!visibility private", "Create a wrapper around a delegated object\n @api public\n @param obj [Delegated] delegated object\n Relay methods to `@__delegated_object__` if they exist\n @api private\n @raise [NoMethodError] if the delegated object does not respond to\n   the method being called\n @param name [Symbol] method name\n @param args [Array<Object>] arguments to method\n @yield to method call\n @return result of method call", "Remove an observer from the stack.\n\n @param [#call] observer the callable object that should be removed.\n @return [#call, nil] the original object or `nil`", "Add an element to the stack with an optional priority.\n\n @param [#call] observer is the callable object that acts as observer.\n @param [Fixnum] priority is a number indicating return order. A higher number\n   means lower priority.\n @return [#call] the original `observer` passed in.\n @raise `ArgumentError` when not using a `Fixnum` for `priority`\n @raise `ArgumentError` when not using callable object for `observer`", "Validates attributes to determine if the values match the requirements of a safe name.", "Validate the given command.\n @param cmd [Array] only one command should be given.\n @return [String] extracts out of Array", "Validate the options; otherwise fails.", "Start the process with the given block.\n @param [Block]", "Stop the process.\n @param [Block] will execute prior to shutdown, if given.", "Split off the local name portion of an XML tag.", "Array of hash data to csv format", "Convert number string to number", "Remove uncessary columns and invalid rows from csv format data", "Configure a Friendly Base model associated with an ActiveRecord model.\n\n @overload friendly_details(klass, attributes)\n   @param [Class] klass FriendlyAttributes::Base instance used to extend the ActiveRecord model\n   @param [Hash] attributes hash of types and attributes names with which to extend the ActiveRecord, through FriendlyAttributes::Base\n\n @overload friendly_details(klass, attributes, options)\n   @param [Hash] options configuration options for extending the FriendlyAttributes extension (see {DetailsDelegator#initialize})\n\n @return [DetailsDelegator]", "Search recursively for .bebox file to see\n if current directory is a bebox project or not", "Initializes the client with the given credentials.\n\n @param user_name [String] the name of the user account used for accessing the API\n @param api_key [String] the API key corresponding to the user account - can be obtained from http://www.bibsonomy.org/settings?selTab=1\n\n @param format [String] The requested return format. One of:\n   'xml', 'json', 'ruby', 'csl', 'bibtex'. The default is 'ruby'\n   which returns Ruby objects defined by this library. Currently,\n   'csl' and 'bibtex' are only available for publications.\n\n\n Get a single post\n\n @param user_name [String] the name of the post's owner\n @param intra_hash [String] the intrag hash of the post\n @return [BibSonomy::Post, String] the requested post", "Get posts owned by a user, optionally filtered by tags.\n\n @param user_name [String] the name of the posts' owner\n @param resource_type [String] the type of the post. Currently supported are 'bookmark' and 'publication'.\n @param tags [Array<String>] the tags that all posts must contain (can be empty)\n @param start [Integer] number of first post to download\n @param endc [Integer] number of last post to download\n @return [Array<BibSonomy::Post>, String] the requested posts", "Get the posts of the users of a group, optionally filtered by tags.\n\n @param group_name [String] the name of the group\n @param resource_type [String] the type of the post. Currently supported are 'bookmark' and 'publication'.\n @param tags [Array<String>] the tags that all posts must contain (can be empty)\n @param start [Integer] number of first post to download\n @param endc [Integer] number of last post to download\n @return [Array<BibSonomy::Post>, String] the requested posts", "Get posts for a user or group, optionally filtered by tags.\n\n @param grouping [String] the type of the name (either \"user\" or \"group\")\n @param name [String] the name of the group or user\n @param resource_type [String] the type of the post. Currently supported are 'bookmark' and 'publication'.\n @param tags [Array<String>] the tags that all posts must contain (can be empty)\n @param start [Integer] number of first post to download\n @param endc [Integer] number of last post to download\n @return [Array<BibSonomy::Post>, String] the requested posts", "Get a document belonging to a post.\n\n @param user_name\n @param intra_hash\n @param file_name\n @return the document and the content type", "Get the preview for a document belonging to a post.\n\n @param user_name\n @param intra_hash\n @param file_name\n @param size [String] requested preview size (allowed values: SMALL, MEDIUM, LARGE)\n @return the preview image and the content type `image/jpeg`", "Convenience method to allow sloppy specification of the resource\n type.", "Constructor - sets up the record and tries to connect to\n the correct database\n\n @param  klass [Class] Class whose table we are renaming\n @param  old_name [String, Symbol] The old table name\n @param  new_name [String, Symbol] The new table name\n\n\n Returns the name of the table that currently exists of our\n two options (old or new)\n\n @return [String] The name of the existing table", "Set the correct table name for the Class we are controlling\n\n @raise [TableRenamable::NoTableError] Error if neither name works\n\n @return [Boolean] True if we set the table name", "change the state of a light\n note that colormode will automagically update", "change the name of the light", "pretty-print the light's status", "gets and displays the post object with the necessary dependencies", "deletes the post", "A nested array with one row for each column suitable for nillification.", "the chap.json and node.json is assumed to be in th same folder as\n chap.yml if a relative path is given", "Creates a Config object.\n\n Loads and parses manifest.yml, reads and sets configurable parameters\n from ENV.\n\n Raises an error if any of the required configurable parameters are missing.\n\n @param manifest_filename [String,nil] path to the manifest.yml or nil to skip loading manifest\n\n Loads and parses manifest.yml, reads and sets configurable parameters\n from ENV.", "Returns list of missing required params", "Returns annotated manifest", "Reads parameters from the ENV according to the current manifest", "Runs while there are jobs in the queue\n Waits for a second and checks for available threads\n Exits when all jobs are allocated in threads", "Clears dead threads,\n frees thread pool for more jobs\n Exits when no more threads are left", "outputs a debug message and details of each one of the +vars+ if included.\n +stck_lvls+ is the number of stack levels to be showed\n +vars+ is a list of vars to be pretty printed. It is convenient to\n make the first to be a String with an informative message.", "Returns the Friendly instance corresponding to the specified attribute\n\n @param [Symbol, String] attr name of the attribute\n @return [Class] FriendyAttributes::Base instance", "Returns true if the FriendlyAttributes specified instance is loaded.\n\n @param [Class, Symbol, String] friendly_model Class or name of the FriendlyAttributes model\n @return [true, false] is the FriendlyAttributes instance loaded", "loads the session data created by shibboleth\n ensures that the user's id is set in session\n and updates the user's shibboleth attributes", "a convenience method for quickly creating a new HTML element", "Initialize a new process\n\n cmd - An array of shellwords of a command\n timeout - Time until the process is automatically killed\n out - Path to send stdout of process\n err - Path to send stderr of process\n Runs a process and with a specified command and timeout\n\n Returns nothing", "rewrite the theme helper to use the themes function file", "to pubkey in hex, 32 bytes", "Prepare the vagrant nodes", "window property getter with easy way for XGetWindowProperty\n which return nil, if the specified property name does not exist,\n a String or a Array of Number", "Validates that the specified parameters are valid for this input description.\n @param args [Hash] the arguments to validate", "Goes through, and assigns the value for each declared parameter to an accessor\n with the same name, validating that required parameters are not missing", "Goes through, and makes sure that required output parameters exist", "convert rake task arguments to a standard hash.", "Refresh the page until the element is present.\n\n @example\n   browser.button(:id => 'foo').refresh_until_present\n\n @param [Fixnum] timeout seconds to wait before timing out\n\n @see Watir::WaitWithRefresh\n @see Watir::Element#present?", "Refresh the page while the element is present.\n\n @example\n   browser.button(:id => 'foo').refresh_while_present\n\n @param [Integer] timeout seconds to wait before timing out\n\n @see Watir::WaitWithRefresh\n @see Watir::Element#present?", "Refreshes the page until the element is present.\n\n @example\n   browser.button(:id => 'foo').when_present_after_refresh.click\n   browser.div(:id => 'bar').when_present_after_refresh { |div| ... }\n   browser.p(:id => 'baz').when_present_after_refresh(60).text\n\n @param [Fixnum] timeout seconds to wait before timing out\n\n @see Watir::WaitWithRefresh\n @see Watir::Element#present?", "Create a new LockFile\n\n @param [String] lockfile filename\n Does another process have a lock?\n True if we can't get an exclusive lock", "Retrieve cached value", "SetUp the params to be not nil", "List out the errors for the model.\n\n model_name::   The singular name for the model (e.g. - \"user_account\")\n model_errors:: The errors collection from the model.\n\n   json.api_errors! \"user_account\", user.errors", "Constructor for native RGB value\n\n @param [RGB] value Initial RGB value.\n Duplicate object\n\n @return [RGB_] Duplicate of +self+.\n Store new value in this object\n\n @param [Object] value New value for this object.\n\n @return [Object] Returns +value+.\n\n @private", "Fast extraction for red channel of RGB array\n\n @return [Node] Array with red channel.", "Fast extraction for green channel of RGB array\n\n @return [Node] Array with green channel.", "Fast extraction for blue channel of RGB array\n\n @return [Node] Array with blue channel.", "Assignment for blue channel values of RGB array\n\n @param [Object] Value or array of values to assign to blue channel.\n\n @return [Object] Returns +value+.", "Compute colour histogram of this array\n\n The array is decomposed to its colour channels and a histogram is computed.\n\n @overload histogram( *ret_shape, options = {} )\n   @param [Array<Integer>] ret_shape Dimensions of resulting histogram.\n   @option options [Node] :weight (Hornetseye::UINT(1)) Weights for computing the\n           histogram.\n   @option options [Boolean] :safe (true) Do a boundary check before creating the\n           histogram.\n\n @return [Node] The histogram.", "Perform element-wise lookup with colour values\n\n @param [Node] table The lookup table (LUT).\n @option options [Boolean] :safe (true) Do a boundary check before creating the\n         element-wise lookup.\n\n @return [Node] The result of the lookup operation.", "Creates a currency entry field.\n\n *Valid options:*\n\n currency_symbol::\n       A string used to prefix the input field.  Defaults to '$'.\n\n All other options will be passed through to the {FormHelper#text_field}[http://apidock.com/rails/ActionView/Helpers/FormHelper/text_field] method.\n\n The value will be formatted with comma delimiters and two decimal places.\n\n   f.currency :pay_rate", "Creates a standard form group with a label and text field.\n\n The +options+ is a hash containing label, field, and group options.\n Prefix label options with +label_+ and field options with +field_+.\n All other options will apply to the group itself.\n\n Group options:\n\n class::\n     The CSS class for the form group.  Defaults to 'form-group'.\n\n style::\n     Any styles to apply to the form group.\n\n For label options, see #label_w_small.\n For field options, see {FormHelper#text_field}[http://apidock.com/rails/ActionView/Helpers/FormHelper/text_field].", "Creates a standard form group with a label and password field.\n\n The +options+ is a hash containing label, field, and group options.\n Prefix label options with +label_+ and field options with +field_+.\n All other options will apply to the group itself.\n\n Group options:\n\n class::\n     The CSS class for the form group.  Defaults to 'form-group'.\n\n style::\n     Any styles to apply to the form group.\n\n For label options, see #label_w_small.\n For field options, see {FormHelper#password_field}[http://apidock.com/rails/ActionView/Helpers/FormHelper/password_field].", "Creates a form group including a label and a text area.\n\n The +options+ is a hash containing label, field, and group options.\n Prefix label options with +label_+ and field options with +field_+.\n All other options will apply to the group itself.\n\n Group options:\n\n class::\n     The CSS class for the form group.  Defaults to 'form-group'.\n\n style::\n     Any styles to apply to the form group.\n\n For label options, see #label_w_small.\n For field options, see {FormHelper#text_area}[http://apidock.com/rails/ActionView/Helpers/FormHelper/text_area].", "Creates a standard form group with a label and currency field.\n\n The +options+ is a hash containing label, field, and group options.\n Prefix label options with +label_+ and field options with +field_+.\n All other options will apply to the group itself.\n\n Group options:\n\n class::\n     The CSS class for the form group.  Defaults to 'form-group'.\n\n style::\n     Any styles to apply to the form group.\n\n For label options, see #label_w_small.\n For field options, see #currency_field.", "Creates a standard form group with a label and a static text field.\n\n The +options+ is a hash containing label, field, and group options.\n Prefix label options with +label_+ and field options with +field_+.\n All other options will apply to the group itself.\n\n Group options:\n\n class::\n     The CSS class for the form group.  Defaults to 'form-group'.\n\n style::\n     Any styles to apply to the form group.\n\n For label options, see #label_w_small.\n\n Field options:\n\n value::\n   Allows you to specify a value for the static field, otherwise the value from +method+ will be used.", "Creates a standard form group with a datepicker field.\n\n The +options+ is a hash containing label, field, and group options.\n Prefix label options with +label_+ and field options with +field_+.\n All other options will apply to the group itself.\n\n Group options:\n\n class::\n     The CSS class for the form group.  Defaults to 'form-group'.\n\n style::\n     Any styles to apply to the form group.\n\n For label options, see #label_w_small.\n For field options, see #date_picker.", "Creates a standard form group with a multiple input control.\n\n The +options+ is a hash containing label, field, and group options.\n Prefix label options with +label_+ and field options with +field_+.\n All other options will apply to the group itself.\n\n Group options:\n\n class::\n     The CSS class for the form group.  Defaults to 'form-group'.\n\n style::\n     Any styles to apply to the form group.\n\n For label options, see #label_w_small.\n For field options, see #multi_input_field.", "Creates a standard form group with a checkbox field.\n\n The +options+ is a hash containing label, field, and group options.\n Prefix label options with +label_+ and field options with +field_+.\n All other options will apply to the group itself.\n\n Group options:\n\n class::\n     The CSS class for the form group.\n\n h_align::\n     Create a checkbox aligned to a certain column (1-12) if set.\n     If not set, then a regular form group is generated.\n\n For label options, see #label_w_small.\n For field options, see {FormHelper#check_box}[http://apidock.com/rails/ActionView/Helpers/FormHelper/check_box].", "Adds a recaptcha challenge to the form configured to set the specified attribute to the recaptcha response.\n\n Valid options:\n theme::\n     Can be :dark or :light, defaults to :light.\n type::\n     Can be :image or :audio, defaults to :image.\n size::\n     Can be :compact or :normal, defaults to :normal.\n tab_index::\n     Can be any valid integer if you want a specific tab order, defaults to 0.", "Add CLICommand object to CLIHandler.", "Display commands info", "Display options info", "Main method to run application.", "Select and return command object in application.", "Check ARGV to exess options.", "Parsing options in command line.", "Drives the evaluation of each test, emitting TAP-compliant messages\n for each test", "Emits a TAP-compliant OK message", "Emits a TAP-compliant NOT OK message", "Resolve a method name to a reference object.\n\n @param [#to_s] name\n   The method name, preferably prefixed with `.` or `#` to indicate if it's\n   a singleton or class method.\n\n @param [nil | :singleton | :class | :instance | #to_sym ] default_type\n   Identifies singleton/instance methods when the name doesn't.\n\n   `:singleton` and `:class` mean the same thing.\n\n   Tries to convert values to symbols before matching them.\n\n   If `nil`, `name:` **MUST** identify the method type by prefix.\n\n @return [ ::Method | ::UnboundMethod ]\n   The method object.\n\n @raise [NRSER::ArgumentError]", "Parse the raw URL as a URI object", "Return all classes that inherit from this class", "Return all classes that directly inherit from this class", "Return all live instances of the class\n Passing false will not include instances of sub classes", "Find the git dir", "Lookup whether the key exists.\n @param [String, Symbol] key\n @param [Hash, nil] opts.  :normalize => false will lookup the key as provided.\n @return [Boolean]", "Imports a Java class constant on demand. If the class does not already\n include this module's mixin, then the mixin is included in the class.\n\n @param [Symbol, String] sym the missing constant\n @return [Class] the imported class\n @raise [NameError] if the symbol is not an importable Java class", "Initializes this importer on demand. This method is called the first time a class\n is referenced.", "Loads the Ruby source files in the given directory.\n\n @param [String] dir the source directory", "Introspects the given class meta-data.\n\n @param [Class] klass the Java class or interface to introspect", "get route hash and paramaterize url if needed\n\n @param [Array<String,Number,Boolean>] params to replace named params in the returned url\n @return [Symbol => Number,String,Route] hash specificly formatted:\n  {\n    url: of the route with named params replaced,\n    title: the name of page if the url has one,\n    params: a list of all the params used in the route,\n    route: the #Route object\n  }", "match this route against a given path\n\n @param [String,Regex] path to match against\n @return [Hash,false] (see #get) or false if there is no match", "execute's route's associated handlers\n\n @param [Symbol => String] params from the route with there respective keys\n @param [String] path containing params placed into there respective named positions", "We should be aliasing configure_dependency_for_has_many but that method\n is private so we can't. We alias has_many instead trying to be as fair\n as we can to the original behaviour.", "run the cmd", "Works like link_to, but href is optional. If no href supplied, content is used as href\n\n   link_to \"grub\", \"/food\", :class => \"eats\"   # <a href=\"/food\" class=\"eats\">grub</a>\n   link_to \"http://foo.com\"                    # <a href=\"http://foo.com\">http://foo.com</a>\n   link_to \"home\"                              # <a href=\"/home\">home</a>", "Checks if files are changed and reloads if so.", "Re-calculates file list", "Execute a block in the context of an object whose methods represent the\n commands in a DSL.\n\n @note Use with an *imperative* DSL (commands modify the context object)\n\n Use this method to execute an *imperative* DSL, which means that:\n\n   1. Each command mutates the state of the DSL context object\n   2. The return value of each command is ignored\n   3. The final return value is the original context object\n\n\n @param dsl            [Object] context object whose methods make up the DSL\n @param fallback_dsl   [Object] context object that the DSL should fallback to\n @param args           [Array]  arguments to be passed to the block\n @param block          [Proc]   the block of DSL commands to be executed against the\n                                `dsl` context object\n @return               [Object] the `dsl` context object after executing the block", "Process to lock a user in the Equitrac System\n\n @param attr [Hash] this attribute MUST include: { user_id: \"userid\" }\n @return [String] Formatted for EQCmd.exe command execution", "Process to set a new balance for a user in the Equitrac System\n\n @param attr [Hash] this attribute MUST include: { user_id: \"userid\" }\n @note attr new_bal defaults to 0, if not included in the attributes\n @return [String] Formatted for EQCmd.exe command execution", "Time it starts at day, or '...'", "Time it finishes at day, or '...'", "Time it finishes and or starts at day, or '...'", "Get the requested `Executor` based on the values set in the options hash.\n\n @param [Hash] opts\n   The options defining the requested executor.\n\n @option opts [Executor] :executor\n   When set use the given `Executor` instance. Three special values are\n   also supported: `:fast` returns the global fast executor, `:io` returns\n   the global io executor, and `:immediate` returns a new\n   `ImmediateExecutor` object.\n\n @return [Executor, nil]\n   The requested thread pool, or nil when no option specified.\n\n @!visibility private", "Use the return value from each_key as the new key name", "strip any sort of html, we don't want javascrpt injection", "First starts up a server if needed then blocks until it is available and returns it", "Internal use only, client code does not need to use this function. Informs\n the Meter object that a new message has been received by the serial port.", "Initializes connection to database\n\n @since 1.0\n Opens connection to database\n\n @since 1.0", "Reloads information about database.\n\n @since 1.0", "Sends an invoice", "Finds an invoice by invoice number", "Check module path for module", "Creates an array consisting of only files contained in a directory and its subdirectories.\n\n Expects an array of filenames or dirnames or a combination of both.", "Expects the directory path and filename, checks to see if its another directory or filename,\n if directory, calls directory_to_filenames.", "Determines a valid profile_name. Falls back to default", "Adds a source using a specific timestamp.\n\n The first line of the SQL should be a comment specifying the timestamp for the source.\n   -- 2016-12-19 15:45\n   -- 2016-12-19\n   -- 201612191545\n   -- 20161219\n\n The timestamp will be converted into a 12-digit number, if time is not specified it will be right-padded\n with zeroes to get to the 12-digit number.\n\n The +sql+ should be a valid create/alter table/view/function statement.", "Adds all SQL files found in the specified directory to the sources for this updater.\n\n The +path+ should contain the SQL files.  If there are subdirectories, you should\n include them individually.\n\n The source files should specify a timestamp in the first comment.\n   -- 2016-12-19 15:45\n   -- 2016-12-19\n   -- 201612191545\n   -- 20161219\n\n The timestamp will be converted into a 12-digit number, if time is not specified it will be right-padded\n with zeroes to get to the 12-digit number.", "Called to extract files from the source filesystem.\n @return [Array<String>] An array of paths to a local copy of the files extacted", "Copies data to the SFTP Server\n @param data [Object] The path to the file in the temporary work location\n @return [true] On success", "Runs the comparison.", "generate a tempfile with all the html that we need so that phantom can inject\neasily and not have to max out a single command", "Create a new BibSonomy instance.\n\n @param user_name [String] the BibSonomy user name\n @param api_key [String] the API key of the user (get at https://www.bibsonomy.org/settings?selTab=1)\n\n Download `count` posts for the given `user` and `tag(s)` and render them with {http://citationstyles.org/ CSL}.\n\n @param grouping [String] the type of the name (either \"user\" or \"group\")\n @param name [String] the name of the group or user\n @param tags [Array<String>] the tags that all posts must contain (can be empty)\n @param count [Integer] number of posts to download\n @return [String] the rendered posts as HTML", "only show PDF files", "Search for a matching node by a given role or tag.\n\n @param [Symbol] type\n   The filter type, can be `:role` or `:tag`.\n\n @param [String] filter\n   The role or tag to filter on.\n\n @param [Boolean] single\n   True if we should return only a single match, or false to return all\n   of the matches.\n\n @yield an optional block to enumerate over the nodes.\n\n @return [Array, Proc]\n   The value of the passed block or node.\n\n @api public", "Retrieve the version number of the cookbook in the run list.\n\n @param name [String]\n   name of cookbook to retrieve the version on.\n\n @return [Integer]\n   version of the cookbook.\n\n @api public", "Shortcut to return cache path, if you pass in a file it will return\n the file with the cache path.\n\n @example\n   file_cache_path\n     => \"/var/chef/cache/\"\n\n   file_cache_path 'patch.tar.gz'\n     => \"/var/chef/cache/patch.tar.gz\"\n\n   file_cache_path \"#{node[:name]}-backup.tar.gz\"\n     => \"/var/chef/cache/c20d24209cc8-backup.tar.gz\"\n\n @param [String] args\n   name of file to return path with file\n\n @return [String]\n\n @api public", "Invokes the public method whose name goes as first argument just like\n `public_send` does, except that if the receiver does not respond to\n it the call returns `nil` rather than raising an exception.\n\n @note `_?` is defined on `Object`. Therefore, it won't work with\n instances of classes that do not have `Object` among their ancestors,\n like direct subclasses of `BasicObject`.\n\n @param [String] object\n   The object to send the method to.\n\n @param [Symbol] method\n   The method to send to the object.\n\n @api public", "Returns a hash using col1 as keys and col2 as values.\n\n @example zip_hash([:name, :age, :sex], ['Earl', 30, 'male'])\n   => { :age => 30, :name => \"Earl\", :sex => \"male\" }\n\n @param [Array] col1\n   Containing the keys.\n\n @param [Array] col2\n   Values for hash.\n\n @return [Hash]", "Creates a temp directory executing the block provided. When done the\n temp directory and all it's contents are garbage collected.\n\n @yield [Proc] block\n   A block that will be run\n\n @return [Object]\n   Result of the block operation\n\n @api public", "Template method for creating a new record on the API.\n\n params - A Hash of params to send to the API.\n\n Returns {Evvnt::Base} subclass", "Template method for fetching an index of record from the API.\n\n params - A Hash of params to send to the API.\n\n Returns Array", "Template method for creating a given record\n\n record_id - An Integer or String representing the record ID on the API.\n params    - A Hash of params to send to the API.\n\n Returns {Evvnt::Base} subclass", "Creates write method with type-checking\n @param definition [Definition]\n @param klass [Class, Module]\n @return [Definition]", "def assert_route\n\t\tend", "Conveys debug information to the user.\n\n @param [Integer] depth the current depth of the resolution process.\n @return [void]", "Role list command", "Role new command", "For add_profile remove_profile and remove_role commands", "Role list profiles command", "Make sure the file name is valid", "Initializes the cache.\n\n @param [Hash] opts\n   The options to configure the cache.\n\n @option opts [Integer] :max_entries\n   Maximum number of elements in the cache.\n\n @option opts [Numeric] :ttl\n   Maximum time, in seconds, for a value to stay in the cache.\n\n @option opts [Numeric] :tti\n   Maximum time, in seconds, for a value to stay in the cache without\n   being accessed.\n\n @option opts [Integer] :interval\n   Number of cache operations between calls to {#expire!}.\n\n Loads a hash of data into the stash.\n\n @param [Hash] data\n   Hash of data with either String or Symbol keys.\n\n @return nothing.", "Retrieves a value from the cache, if available and not expired, or yields\n to a block that calculates the value to be stored in the cache.\n\n @param [Object] key\n   The key to look up or store at.\n\n @yield yields when the value is not present.\n\n @yieldreturn [Object]\n   The value to store in the cache.\n\n @return [Object]\n   The value at the key.", "Removes a value from the cache.\n\n @param [Object] key\n   The key to remove.\n\n @return [Object, nil]\n   The value at the key, when present, or `nil`.", "Reset segments.\n\n   call-seq:\n     reset_segments(max-period)\n     reset_segments(max-period, min-period)\n     reset_segments([period1, period2, ...])", "Format duration.\n\n *Identifiers*\n\n     %w -- Number of weeks\n     %d -- Number of days\n     %h -- Number of hours\n     %m -- Number of minutes\n     %s -- Number of seconds\n     %t -- Total number of seconds\n     %x -- Duration#to_s\n     %% -- Literal `%' character\n\n *Example*\n\n     d = Duration.new(:weeks => 10, :days => 7)\n     => #<Duration: 11 weeks>\n     d.strftime(\"It's been %w weeks!\")\n     => \"It's been 11 weeks!\"", "Verifies the response from a recaptcha challenge in a controller.\n\n It will return true if the recaptcha challenge passed.  It always returns true in the 'test' environment.\n\n If a +model+ is provided, then an error will be added to the model if the challenge fails.\n Because this is handled outside of the model (since it's based on the request and not the model),\n you should first check if the model is valid and then verify the recaptcha challenge to ensure you\n don't lose the recaptcha error message.\n\n   if model.valid? && verify_recaptcha_challenge(model)\n     model.save\n     redirect_to :show, id: model\n   else\n     render 'edit'\n   end", "Just a static mock of the get_queue_attributes API", "Initialize takes a single hash of name to value.\n\n e.g. MetaEnum::Type.new(red: 0, green: 1, blue: 2)\n\n Additional data can also be associated with each value by passing an array\n of [value, extra data]. This can be used for additional description or\n any other reason.\n\n e.g. MetaEnum::Type.new(small: [0, \"Less than 10], large: [1, \"At least 10\"]\n\n value_normalizer is a callable object that normalizes values. The default\n converts all values to integers. To allow string values use method(:String).\n\n element_class is the class with which to create elements. It should be a\n sub-class of MetaEnum::Element (or otherwise match it's behavior).\n [] is a \"do what I mean\" operator. It returns the Element from this type depending on the key.\n\n When key is a symbol, it is considered the name of the Element to return.\n Since symbols are used from code, it is considered an error if the key is\n not found and it raises an exception.\n\n When key can be converted to an integer by value_normalizer, then it is\n considered the value of the Element to return. Retrieving by value is\n presumed to converting from external data where a missing value should not\n be considered fatal. In this case it returns a MissingElement is with value\n as the key. This allows a Type to only specify the values it needs while\n passing through the others unmodified.\n\n Finally, when key is a MetaEnum::Element, it is simply returned (unless it\n belongs to a different Type in which case an ArgumentError is raised).\n\n See #values_by_number and #values_by_name for non-fuzzy value selection.", "Unshorten a shortened URL.\n\n @param url [String] A shortened URL\n\n @param [Hash] opts\n\n @option opts [Integer] :max_level\n   max redirect times\n\n @option opts [Integer] :timeout\n   timeout in seconds, for every request\n\n @option opts [Boolean] :use_cache\n   use cached result if available\n\n @return Original url, a url that does not redirects", "replaces CR, LF, CRLF with \";\" and cut's string to requied length by adding \"...\" if string would be longer", "Initialize instance variables for use later\n Sends a POST request to analyze text with certain features enabled", "Default features if no features specified", "Visits the pre configured URL to make this page available\n @raise ::CapybaraPageObjects::Exceptions::MissingUrl\n @return [::CapybaraObjects::PageObject] self - allows chaining of methods", "Fetch a page from the given url using libcurl", "Validates attributes to determine if they contain valid email addresses.\n\n Does not perform an in depth check, but does verify that the format is valid.", "Interpolate provides a means of externally using Ruby string\n interpolation mechinism.\n\n @example\n   node[:ldap][:basedir] = '/opt'\n   node[:ldap][:homedir] = '%{basedir}/openldap/slap/happy'\n\n   interpolate(node[:ldap])[:homedir]  # => \"/opt/openldap/slap/happy\"\n\n @param [String] item\n   The string to interpolate.\n\n @param [String, Hash] parent\n   The string used for substitution.\n\n @return [String]\n   The interpolated string.\n\n @api public", "Provides recursive interpolation of node objects, using standard\n string interpolation methods.\n\n @param [String] item\n   The string to interpolate.\n\n @param [String, Hash] parent\n   The string used for substitution.\n\n @return [String]\n\n @api private", "starts a transaction only if we are not already within one.", "why define this method?\n if we use the elements method directly, it will be conflicted with RSpec.Mather.BuiltIn.All.elements.\n I have not found one good method to solve the confliction.", "instead of the rails traditional form\n in js mode, there is no prefix before the element name", "Returns the column by name\n\n +column_for\n\n @param [ Symbol ] column_name column name that stores the bitfield integer", "Returns a \"reset mask\" for a list of fields\n\n +reset_mask_for :fields\n\n @example\n  user.reset_mask_for :field\n\n @param [ Symbol ] column     name of the column these fields are in\n @param [ Symbol ] field(s) name of the field(s) for the mask", "Returns an \"increment mask\" for a list of fields\n\n +increment_mask_for :fields\n\n @example\n  user.increment_mask_for :field\n\n @param [ Symbol ] column     name of the column these fields are in\n @param [ Symbol ] field(s) name of the field(s) for the mask", "Returns an \"only mask\" for a list of fields\n\n +only_mask_for :fields\n\n @example\n  user.only_mask_for :field\n\n @param [ Symbol ] column     name of the column these fields are in\n @param [ Symbol ] field(s) name of the field(s) for the mask", "Counts resources grouped by a bitfield\n\n +count_by :column, :fields\n\n @example\n   user.count_by :counter, :monthly\n\n @param [ Symbol ] column     name of the column these fields are in\n @param [ Symbol ] field(s)   name of the field(s) to reset", "Sets one or more bitfields to 0 within a column\n\n +reset_bitfield :column, :fields\n\n @example\n   user.reset_bitfield :column, :daily, :monthly\n\n @param [ Symbol ] column     name of the column these fields are in\n @param [ Symbol ] field(s)   name of the field(s) to reset", "Increases one or more bitfields by 1 value\n\n +increment_bitfield :column, :fields\n\n @example\n   user.increment_bitfield :column, :daily, :monthly\n\n @param [ Symbol ] column     name of the column these fields are in\n @param [ Symbol ] field(s)   name of the field(s) to reset", "Sets the current connect user, updates the app user, and also updates the\n session and cookie state.", "Register a new encoder format.", "Read the config options from RComp's configuration file\n\n Returns a Hash of config options", "returns a new image for the moved image", "Persists each associated model\n\n @return [Boolean] Wether or not all models are valid and persited", "return all connections, or those matching list of roles;\n connections with no roles match all, or find intersection with roles list", "Extract news data from a feed item", "Initializes the Pair class\n\n @param [Object] cert SSL certificate for this client\n @param [String] host hostname or IP address of the Google TV\n @param [String] client_name name of the client your connecting from\n @param [String] service_name name of the service (generally 'AnyMote')\n @return an instance of Pair\n\n Start the pairing process\n\n Once the TV recieves the pairing request it will display a 4 digit number.\n This number needs to be feed into the next step in the process, complete_pairing().", "Complete the pairing process\n @param [String] code The code displayed on the Google TV we are trying to pair with.", "Format and send the message to the GoogleTV\n\n @param [String] msg message to send\n @param [Object] type type of message to send\n @return [Object] the OuterMessage response from the TV", "Wrap the message in an OuterMessage\n\n @param [String] msg message to send\n @param [Object] type type of message to send\n @return [Object] a properly formatted OuterMessage", "Encode the secret from the TV into an OpenSSL Digest\n\n @param [String] secret pairing code from the TV's screen\n @return [Digest] OpenSSL Digest containing the encoded secret", "Return +id+ back to the allocator so it can be allocated again in the future.\n @note trying to free an unallocated id will cause undefined behavior\n @return [void]", "Gets the full title of the page.\n\n If +page_title+ is left blank, then the +app_name+ attribute of your application is returned.\n Otherwise the +app_name+ attribute is appended to the +page_title+ after a pipe symbol.\n\n     # app_name = 'My App'\n     full_title              # 'My App'\n     full_title 'Welcome'    # 'Welcome | My App'", "Shows a glyph with an optional size.\n\n The glyph +name+ should be a valid {bootstrap glyph}[http://getbootstrap.com/components/#glyphicons] name.\n Strip the prefixed 'glyphicon-' from the name.\n\n The size can be left blank, or set to 'small' or 'large'.\n\n   glyph('cloud')    # '<i class=\"glyphicon glyphicon-cloud\"></i>'", "Formats a number with the specified number of decimal places.\n\n The +value+ can be any valid numeric expression that can be converted into a float.", "Creates a panel with the specified title.\n\n Valid options:\n type::\n     Type can be :primary, :success, :info, :warning, or :danger.  Default value is :primary.\n size::\n     Size can be any value from 1 through 12.  Default value is 6.\n offset::\n     Offset can be any value from 1 through 12.  Default value is 3.\n     Common sense is required, for instance you would likely never use an offset of 12, but it is available.\n     Likewise an offset of 8 with a size of 8 would usually have the same effect as an offset of 12 because\n     there are only 12 columns to fit your 8 column wide panel in.\n open_body::\n     This can be true or false.  Default value is true.\n     If true, the body division is opened (and closed) by this helper.\n     If false, then the panel is opened and closed, but the body division is not created.\n     This allows you to add tables and divisions as you see fit.\n\n Provide a block to render content within the panel.", "Returns true iff the record and only the record was successfully deleted.", "subscribe fires a event on a EM channel whenever a message is fired on a pattern matching `name`.\n @name (default: \"sock-hook/\") + '*'", "Navigation link helper\n\n Returns an `li` element with an 'active' class if the supplied\n controller(s) and/or action(s) are currently active. The content of the\n element is the value passed to the block.\n\n options - The options hash used to determine if the element is \"active\" (default: {})\n           :controller   - One or more controller names to check (optional).\n           :action       - One or more action names to check (optional).\n           :path         - A shorthand path, such as 'dashboard#index', to check (optional).\n           :html_options - Extra options to be passed to the list element (optional).\n block   - An optional block that will become the contents of the returned\n           `li` element.\n\n When both :controller and :action are specified, BOTH must match in order\n to be marked as active. When only one is given, either can match.\n\n Examples\n\n   # Assuming we're on TreeController#show\n\n   # Controller matches, but action doesn't\n   nav_link(controller: [:tree, :refs], action: :edit) { \"Hello\" }\n   # => '<li>Hello</li>'\n\n   # Controller matches\n   nav_link(controller: [:tree, :refs]) { \"Hello\" }\n   # => '<li class=\"active\">Hello</li>'\n\n   # Shorthand path\n   nav_link(path: 'tree#show') { \"Hello\" }\n   # => '<li class=\"active\">Hello</li>'\n\n   # Supplying custom options for the list element\n   nav_link(controller: :tree, html_options: {class: 'home'}) { \"Hello\" }\n   # => '<li class=\"home active\">Hello</li>'\n\n Returns a list item element String", "Adds session unless it already exists and returns\n the session", "Deletes and shutdowns the pool if its found.", "Remove and close extra clients", "Call all subscriptions for the given signal\n @param signal_name Symbol\n @param args Hash", "Subscribe to a particular signal\n @param signal_name Symbol\n @param step Symbol May be :first_pass or :second_pass\n @param block Proc", "init default values\n add sunippet information", "Sends the notice data off to Whoops for processing.\n\n @param [Hash] data The notice to be sent off", "Requires an inserter id from an upload call", "Incase both a file and bin version are availble file version is taken\n\n @return rjs_command to invoke r.js optimizer with", "Matches object is of this type.\n\n @param [Object] object object for type matching\n @return [Boolean] +true+ if match, +false+ in otherwise", "Create an item into the collection\n\n @param data [Hash, Array] item or array of items\n @return [Hash, Array]", "Add where clause to the current query.\n\n Supported modifiers on fields: .gt, .gte, .lt, .lte, .ne, .in, .not_in, .nin, .like, .between, .not_between\n\n @param fields [Hash] fields and values to filter\n @param [String] operation (and, or)\n\n @example\n     hook.collection(:movies).where({\n       :name => \"Hook\",\n       :year.gt => 1990\n     })\n\n @example Using Range\n     hook.collection(:movies).where({\n       :name.like => \"%panic%\",\n       :year.between => 1990..2014\n     })\n\n @return [Collection] self", "Add order clause to the query.\n\n @param fields [String] ...\n @return [Collection] self", "Creates a new URIx interface.\n Claim the USB interface for this program. Must be\n called to begin using the interface.", "Sets the state of a GPIO pin.\n\n @param pin [Integer] ID of GPIO pin.\n @param state [Boolean] State to set pin to. True == :high", "Sets the mode of a GPIO pin to input or output.\n\n @param pin [Integer] ID of GPIO pin.\n @param mode [Symbol] :input or :output", "Attempts to authenticate with the Montage API\n\n * *Returns* :\n   - A hash containing a valid token or an error string, oh no!", "Instantiates a response object based on the yielded block\n\n * *Args*    :\n   - +resource_name+ -> The name of the Montage resource\n * *Returns* :\n   * A Montage::Response Object containing:\n     - A http status code\n     - The response body\n     - The resource name", "Creates an Faraday connection instance for requests\n\n * *Returns* :\n   - A Faraday connection object with an instance specific configuration", "Writes a note attached to the value ID of the specific person or relationship.\n\n ====Params\n * <tt>options</tt> - Options for the note including the following:\n   * <tt>:personId</tt> - the person ID if attaching to a person assertion.\n   * <tt>:spouseIds</tt> - an Array of spouse IDs if creating a note attached to a spouse\n     relationship assertion.\n   * <tt>:parentIds</tt> - an Array of parent IDs if creating a note attached to a parent\n     relationship assertion. If creating a note for a child-parent or parent-child\n     relationship, you will need only one parent ID in the array along with a :childId option.\n   * <tt>:childId</tt> - a child ID.\n   * <tt>:text</tt> - the text of the note (required).\n   * <tt>:assertionId</tt> - the valueId of the assertion you are attaching this note to.", "Combines person into a new person\n\n ====Params\n * <tt>person_array</tt> - an array of person IDs.", "get and disply certain comment", "update the comment. You are able to update everything about the comment as an admin", "delete the comment", "bulk_update function takes all of the checked options and updates them with the given option selected. The options for the bulk update in comments area are\n - Unapprove\n - Approve\n - Mark as Spam\n - Destroy", "mark_as_spam function is a button on the ui and so need its own function. The function simply marks the comment as spam against the record in the database.\n the record is then not visable unless you explicity tell the system that you want to see spam records.", "Sort routes by tags", "store tracker code blocks", "Truncate a numeral and return also a round_up value with information about\n the digits beyond the truncation point that can be used to round the truncated\n numeral. If the numeral has already been truncated, the round_up result of\n that prior truncation should be passed as the second argument.", "Adjust a truncated numeral using the round-up information", "Creates an attribute corresponding to a database column.\n N.B No table is created in the database\n\n == Arguments\n\n <tt>name</tt>      ::  column name, such as supplier_id in supplier_id int(11).\n <tt>default</tt>   ::  type-casted default value, such as new in sales_stage varchar(20) default 'new'.\n <tt>sql_type</tt>  ::  used to extract the column length, if necessary. For example 60 in company_name varchar(60). null determines if this column allows NULL values.\n\n == Usage\n   class Task < ActiveRecord::Base\n     no_table\n     column :description,  :text\n     column :description,  :string, 'foo', false\n   end", "this should be depracated", "Enqueues new messages\n @param messages Messages to enqueue\n @param [Hash] opts the optional parameters\n @return [BulkinsertResponse]", "make path real according to file system", "allows special symbols in path\n currently only ... supported, which looks upward in the filesystem for the following relative path from the basepath", "Wrap the table in a div", "Add all marks provided by a Hash instance _marks_.", "Converts this Markable to a Hash. When _nonil_ is true, nil mark values\n do not lead to hash entries.", "Look through the @html document looking for the author\n Precedence Information here on the wiki: (TODO attach wiki URL if it is accepted)\n Returns nil if no author is detected", "Returns the Gravatar for the given user.\n\n Based on the tutorial from [www.railstutorial.org](www.railstutorial.org).\n\n The +user+ is the user you want to get the gravatar for.\n\n Valid options:\n *   +size+ The size (in pixels) for the returned gravatar.  The gravatar will be a square image using this\n     value as both the width and height.  The default is 80 pixels.\n *   +default+ The default image to return when no image is set. This can be nil, :mm, :identicon, :monsterid,\n     :wavatar, or :retro.  The default is :identicon.", "Extracts a session from the array of arguments if one exists at the end.\n\n @param args [Array] an array of arguments of any type.\n\n @return [Session] a session if the last argument is a valid session and pops it out of args.\n   Otherwise it returns the current session.", "Mirrors of the object found on other sites", "Creating or updating a mirror object. Relationships are mirrored\n but content is unique. When updating need to grab mirrors based on\n self.slug_was, new objects will use self.slug.", "Mirrors should be destroyed", "Reads from a file on the device.", "Executes an elevated command using the 'sudo' command.", "Uses the PS1= command to set the prompt for the shell.", "Returns a hashed value with data", "Returns the state of the object at some point in the past\n\n @param [#to_i] point\n   Either a positive number of target version,\n   or a negative number of version (snapshots) before the current one\n   +0+ stands for the first version.\n\n @return [Object, nil]", "Fetch a value from a forest\n\n :call-seq:\n   fetch(key) => value\n   fetch(key, default) => value\n   fetch(key) { |key| } => value\n\n The first form raises a +KeyError+ unless +key+ has a value.", "Flattening a forest produces a tree with the equivalent view of key paths", "Return a breadth-first Enumerator for all the trees in the forest,\n and any nested forests", "Return all visible key paths in the forest", "Converts a hex string into a byte string.\n\n Whitespace in the string is ignored.\n The string must only contain characters valid for hex (ie - 0-9, A-F, a-f).\n The string must contain an even number of characters since each character only represents half a byte.", "Remembers a user in a persistent session.", "Returns the user corresponding to the remember token cookie.", "Authenticates with the RJMetrics Data Import API", "Retrieves the column at the given index. Aliases can be used", "Sets the table header. If no aliases are defined, they will be defined as the texts\n in lowercase with line breaks and spaces replaced by underscores.\n\n Defining headers also limits the printed column to only columns that has a header\n (even if it is empty).\n\n === Args\n\n +header+::\n   Array containing the texts for displaying the header. Line breaks are supported\n\n === Examples\n\n   table.header = ['Name', 'Email', 'Work Phone', \"Home\\nPhone\"]\n\n This will create the following aliases: :key, :email, :work_phone and :home_phone", "Sets a component to colorize a column.\n\n The component must respond to +call+ with the column value (or row if used with\n #using_row) as the arguments and return a color or +nil+ if default color should be\n used. A block can also be used.\n\n\n === Args\n\n +indexes+::\n   The column indexes or its aliases\n +params+::\n   A hash with params in case a block is not given:\n     - :using defines the component to use\n     - :with defines the color to use (to use the same color for all columns)\n\n === Example\n\n   table.colorize :description, :with => :magenta\n   table.colorize([:value, :total]) { |value| :red if value < 0 }", "Defines a colorizer to null values.\n\n === Args\n\n +params+::\n   A hash with params in case a block is not given:\n     - :using defines the component to use\n     - :with defines the format to use", "Sets a component to format a column.\n\n The component must respond to +call+ with the column value\n as the arguments and return a color or +nil+ if default color should be used.\n A block can also be used.\n\n === Args\n\n +indexes+::\n   The column indexes or its aliases\n +params+::\n   A hash with params in case a block is not given:\n     - :using defines the component to use\n     - :with defines the format to use (to use the same format for all columns)\n\n === Example\n\n   table.format :value, :with => '%.2f'\n   table.format [:value, :total], :with => '%.2f'", "Defines a formatter to null values.\n\n === Args\n\n +params+::\n   A hash with params in case a block is not given:\n     - :using defines the component to use\n     - :with defines the format to use", "Return a colorized and formatted table.", "Calculates the table width using the rendered lines", "Gets the content string for the given color map and content", "Builds the header output for this table.\n\n Returns the color map and the header.", "maps the context for each row", "Builds the data output for this table.\n\n Returns the color map and the formatted data.", "ensure the given block raises as expected\n\n @note if block given it will have precedence over arguments\n\n @example assertion pass if block raises whatever\n   assert {some code}.raise\n\n @example assertion pass if block raises NameError\n   assert {some code}.raise NameError\n\n @example assertion pass if block raises NameError and error message matches /blah/\n   assert {some code}.raise NameError, /blah/\n\n @example assertion pass if block raises whatever error that matches /blah/\n   assert {some code}.raise nil, /blah/\n\n @example assertion pass if validation block returns a positive value\n   assert {some code}.raise {|e| e.is_a?(NameError) && e.message =~ /blah/}\n\n\n @example assertion pass if nothing raised\n   refute {some code}.raise\n   # same\n   fail_if {some code}.raise\n\n @example assertion fails only if block raises a NameError.\n   it may raise whatever but NameError. if nothing raised assertion will fail.\n\n   fail_if {some code}.raise NameError\n\n @example assertion pass if raised error does not match /blah/\n   if nothing raised assertion will fail.\n\n   fail_if {some code}.raise nil, /blah/\n\n @example assertion will pass if raised error is not a NameError\n   and error message does not match /blah/\n   if nothing raised assertion will fail as well.\n\n   fail_if {some code}.raise NameError, /blah/", "ensure given block thrown as expected\n\n @note if block given it will have precedence over arguments\n\n @example assertion pass if any symbol thrown\n   assert {some code}.throw\n\n @example assertion pass only if :x symbol thrown\n   assert {some code}.throw(:x)\n\n @example assertion pass only if given block validates thrown symbol\n   assert {some code}.throw {|sym| sym == :x}", "Copy attributes with eval\n\n @retun [Hash] hash\n\n @example\n   node :some_node d:\n     param_1 1\n     param_2 run{ param_1 + 2}\n   end\n\n   node.attrs #=> {:param_1 => 1, :param_2 => Proc}\n   node.eval_attrs #=> {:param_1 => 1, :param_2 => 3}", "grabs access_token from header if one is present", "order of params to be called can differ, so naming is ambiguous", "Add code to read all components of a typed value from memory\n\n @return [Array<GCCValue>] An array of objects referencing values in C.\n\n @private", "Add code to write all components of a typed value to memory\n\n @param [Node] value Value to write to memory.\n\n @return [Object] The return value should be ignored.\n\n @private", "Create code for conditional selection of value\n\n @param [GCCValue,Object] a First value.\n @param [GCCValue,Object] b Second value.\n\n @return [GCCValue] C value referring to result.\n\n @private", "Generate code for conditional statement\n\n @param [Proc] action1 Block to run when condition is fullfilled.\n @param [Proc] action2 Block to run otherwise.\n\n @return [Object] Returns +self+.\n\n @private", "Generate code for computing exponentiation\n\n @param [Object,GCCValue] other Second operand for binary operation.\n\n @return [GCCValue] C value refering to the result.\n\n @private", "Create code for conditional selection of RGB value\n\n @param [GCCValue,Object] a First value.\n @param [GCCValue,Object] b Second value.\n\n @return [GCCValue] C value referring to result.\n\n @private", "Create code for conditional selection of complex value\n\n @param [GCCValue,Object] a First value.\n @param [GCCValue,Object] b Second value.\n\n @return [GCCValue] C value referring to result.\n\n @private", "Builds an env object from the information provided. Derived handlers\n can override this to provide additional information.", "Reads from a connection, yielding chunks of data as it goes,\n until the connection closes. Once the connection closes, it returns.", "Accepts a connection from a client and handles requests on it until\n the connection closes.", "Runs the application through the configured handler.\n Can only be run once at a time. If you try to run it more than\n once, the second run will block until the first finishes.", "Initializes an instance from a year and a month. Raises an error if the\n month is not in the allowed range, i.e. it must be between 1 and 12 inclusive.", "Constructs a client.\n\n Any of the options documented in ExactTargetSDK#config may be overridden\n using the options parameter.\n\n Since ExactTarget's API is stateless, constructing a client object will not\n make any remote calls.\n Invokes the Create method.\n\n The provided arguments should each be sub-classes of APIObject, and each\n provided object will be created in order.\n\n Possible exceptions are:\n   HTTPError         if an HTTP error (such as a timeout) occurs\n   SOAPFault         if a SOAP fault occurs\n   Timeout           if there is a timeout waiting for the response\n   InvalidAPIObject  if any of the provided objects don't pass validation\n\n Returns a CreateResponse object.", "Invokes the Retrieve method.\n\n Note that this implementation abstracts away the useless RetrieveRequest\n sub-wrapper, and introduces a RequestResponse wrapper to contain the\n output parameters.\n\n Does not currently support requests that have too many results for one\n batch.\n\n Possible exceptions are:\n   HTTPError         if an HTTP error (such as a timeout) occurs\n   SOAPFault         if a SOAP fault occurs\n   Timeout           if there is a timeout waiting for the response\n   InvalidAPIObject  if any of the provided objects don't pass validation\n\n Returns a RetrieveResponse object.", "Invokes the Update method.\n\n The provided arguments should each be sub-classes of APIObject, and each\n provided object will be updated in order.\n\n Possible exceptions are:\n   HTTPError         if an HTTP error (such as a timeout) occurs\n   SOAPFault         if a SOAP fault occurs\n   Timeout           if there is a timeout waiting for the response\n   InvalidAPIObject  if any of the provided objects don't pass validation\n\n Returns an UpdateResponse object.", "Invokes the Delete method.\n\n The provided arguments should each be sub-classes of APIObject, and each\n provided object will be updated in order.\n\n Possible exceptions are:\n   HTTPError         if an HTTP error (such as a timeout) occurs\n   SOAPFault         if a SOAP fault occurs\n   Timeout           if there is a timeout waiting for the response\n   InvalidAPIObject  if any of the provided objects don't pass validation\n\n Returns a DeleteResponse object.", "Invokes the Perform method.\n\n The provided arguments should each be definitions that are sub-classes\n of APIObject.\n\n Possible exceptions are:\n   HTTPError         if an HTTP error (such as a timeout) occurs\n   SOAPFault         if a SOAP fault occurs\n   Timeout           if there is a timeout waiting for the response\n   InvalidAPIObject  if any of the provided objects don't pass validation\n\n Returns a PerformResponse object.", "Constructs and saves the savon client using provided config.", "Builds the SOAP request for the given method, delegating body\n rendering to the provided block.\n\n Handles errors and re-raises with appropriate sub-class of\n ExactTargetSDK::Error.\n\n Returns the raw savon response.", "Prepare value for translation.\n @return [String, Array<String, nil>, nil] value for Google Translate or nil for non-string values", "Parse translated value from the each_translated enumerator\n @param [Object] untranslated\n @param [Enumerator] each_translated\n @return [Object] final translated value", "Searches the database to determine if an object with the specified name exists.", "Executes a stored procedure.\n\n For MS SQL Server, this will return the return value from the procedure.\n For other providers, this is the same as +execute+.", "Check if a particular controller is the current one\n\n args - One or more controller names to check\n\n Examples\n\n   # On TreeController\n   current_controller?(:tree)           # => true\n   current_controller?(:commits)        # => false\n   current_controller?(:commits, :tree) # => true", "Yo to specific user\n @param [String] username usename to send yo\n @param [Hash] options allowed only link for now\n @return [Boolean] if request has succeed", "Connect with error handling\n @param [Proc] block", "Return all the published inputs, in order of publication.", "Allows to execute any block of code after transaction completes.\n If no transaction is actually open, the code runs immediately.\n\n Accepts the following options that modifies this behavior:\n\n * <tt>:only</tt> - Execute this code only on commit or only on\n   rollback. Accepts one of the following symbols: <tt>:commit</tt>,\n   <tt>:rollback</tt>.\n * <tt>:if_no_transaction</tt> - Specifies what to do if there is no\n   active transaction. Accepts one of the following symbols:\n   <tt>:run</tt> (default), <tt>:skip</tt> (do not run).\n\n Example of use:\n\n   ActiveRecord::Base.transaction do\n     # executes some code\n     puts \"runs within transaction\"\n     after_transaction do\n       # things to do after transaction\n       puts \"runs after transaction\"\n     end\n     # executes more code\n     puts \"again runs within transaction\"\n   end\n\n will output\n\n   runs within transaction\n   again runs within transaction\n   runs after transaction", "Registers a coercion with the Garcon library.\n\n @param [Class] origin\n   The class to convert.\n\n @param [Class] target\n   What the origin will be converted to.", "Writes this job's JSON representation to S3", "Top-level, long-running method for performing the backup.", "Step 1 of the overall process - create a disconnected copy of the RDS", "Queries RDS for any pre-existing entities associated with this job.\n Also waits for the original RDS to become ready.", "Snapshots the original RDS", "Creates a new RDS from the snapshot", "Updates the Master Password and applies the configured RDS Security Group", "Wait for the new RDS Security Group to become 'active'", "Wait for the new RDS Parameter Group to become 'in-sync'", "Writes a new status message to the log, and writes the job info to S3", "Sends a status email", "Perform a search and return the names of the nodes that match the search.", "Return all maximal key paths in a tree\n\n :call-seq:\n   keys => Array of KeyTree::Path", "prepares the commands to correctly reference the application and path", "print the command on the screen", "execute the command, or not, and return the results, or not", "Return the Nokogiri html document", "Return the entire links found in the page; exclude empty links", "Return all images found in the page", "Return plain text of the page without html tags", "Sets the message channel_name attribute.\n The result is a list of application channels that should be advised about\n the inbound message\n\n * if message[\"type\"].eql?(\"twitter\"): message[\"channel_type\"] is an\n array of all the application twitter channels that has associated the message twitter account.\n   i.e.\n     Application channels:\n       @app_channels = [\n                 {\"uid\"=>\"twitter-channel-1\", \"type\"=>\"twitter\", \"accounts\"=>[{\"name\"=>\"juandebravo\"}, {\"name\"=>\"connfudev\"}]},\n                 {\"uid\"=>\"twitter-channel-2\", \"type\"=>\"twitter\", \"accounts\"=>[{\"name\"=>\"telefonicaid\"}]}]\n     Incoming message:\n       message.channel_type = \"twitter\"\n       message.from = \"juandebravo\"\n\n      set_channels!(message) => message.channel_name = [\"twitter-channel-1\"]\n\n ==== Parameters\n * +message+ Connfu::Message with no channel_name info\n ==== Return\n * Connfu::Message with the channel_name filled with the relevant app channels", "Executes the blocks that are associated to that channel and event type\n @param *message* incoming message to be processed", "Add a check to test against\n\n @param [Array] data\n   the data which should be used as check, will be passed to the concrete comparator strategy\n\n @param [Symbol] type\n   the comparator strategy (needs to be registered first)\n\n @param [Array] keywords\n   what to look for in the data, will be passed to the concrete comparator strategy\n\n @param [Hash] options\n   exception, should not be considered as match\n\n @option options [Hash] exceptions\n   the exceptions from keywords\n\n @option options [String] tag\n   a tag to identify the check\n\n @raise [Exceptions::UnknownCheckType]\n   if a unknown strategy is given (needs to be registered first)", "The result of all checks defined\n\n @return [Result]\n   the result class with all the data need for further analysis", "Augments the migration by setting the spouse household.\n\n @param [{Symbol => Object}] row the input row field => value hash\n @param [<Resource>] migrated the migrated instances", "Add another timings object to this one", "Returns the best available value of the total energy", "this method is invoked whenever a new instance method is added to a class", "A convenience method for making a hash with the\n given methods on self as the keys and return for\n the given methods as the values", "Fired to each element of the group. Values are duplicated by default.\n Put dup to false to avoid this behavior.", "Dispatches a command to the current adapter to rebuild the index.\n\n @return <Integer> representing number of items processed.", "Macro for defining a class attribute as an indexed field.\n\n Also creates the corresponding attribute finder method, which defaults\n to the field name. This can be defined with the\n :finder_name => \"anothername\" option.\n\n Refer to {IndexField} for more information on defining fields.", "Build the final application that get's run by the Rack Handler", "Returns true if the instance event is defined.\n Returns false otherwise.", "This helper method is similar to attr_reader and attr_accessor.  It allows\n for instance events to be declared inside the body of the class.", "Obtains the list of events that are unique to this object.\n If all = true, then this list will also include events that\n were defined within a module that the object extended.", "Returns the Event that has the specified name.  A NameError will be raised\n if the object does not define any event that has the given name.", "Registers the given event handler so that it will be\n invoked when the event is raised.", "Removes a single instance of the specified event handler\n from the list of event handlers.  Therefore, if you've\n registered the same event handler 3 times, then you will\n need to unregister it 3 times as well.", "returns a boolean as to whether the current view is a month archive", "returns a boolean as to whether the current view is a year archive", "returns a boolean as to whether the current view is the homepage", "returns the comment form that is created in the theme folder.", "return what type of taxonomy it is either - category or tag", "Get the mime type from a file name", "Process a document, fetching its content and enqueueing it for\n sub processing", "Enqueue new documents for each link\n found in the current document", "Determine if a document can be enqueued", "Determine if a document is actually the type of document\n that can be archived", "Breaks the event loop and finishes the spec. It yields to any given block first,\n then stops AMQP, EM event loop and cleans up AMQP state.", "Gets the first authentication source for this user manager.", "Attempts to authenticate the user and returns the model on success.", "Gets the list of ldap groups that map to system administrators.", "Rack-like call to run the Interactor's use-case.", "Get information about the authenticated user\n\n @return [PivotalApi::Resources::Me]", "Generate a regular expression to match any of the passed symbols.\n\n   symbols.regexp(:nan, :plus, :minus) #=> \"(NaN|+|-)\"\n\n The special symbol :digits can also be passed to generate all the digits,\n in which case the :base option can be used to generate digits\n only for some base smaller than the maximum defined for digits.\n\n   symbols.regexp(:digits, :point, base: 10) # => \"(0|1|...|9)\"\n\n The option :no_capture can be used to avoid generating a capturing\n group; otherwise the result is captured group (surrounded by parenthesis)\n\n   symbols.regexp(:digits, no_capture: true) # => \"(?:...)\"\n\n The :case_sensitivity option is used to generate a regular expression\n that matches the case of the text as defined by ghe case_sensitive\n attribute of the Symbols. If this option is used the result should not be\n used in a case-insensitive regular expression (/.../i).\n\n   /#{symbols.regexp(:digits, case_sensitivity: true)}/\n\n If the options is not used, than the regular expression should be\n be made case-insensitive according to the Symbols:\n\n  if symbols.case_sensitive?\n    /#{symbols.regexp(:digits)}/\n else\n    /#{symbols.regexp(:digits)}/i", "Prepends input with a url fragment\n\n input - An absolute url, e.g. /images/awesome.gif\n url   - The fragment to prepend the input, e.g. /blog\n\n Returns the modified url, e.g /blog", "expands simple arrays into full hash definitions\n @api private\n @param definition [Array<String,Hash>]\n @return [Hash]", "expands nested simple definition into a full hash\n @api private\n @param definition [Hash]\n @return [Hash]", "Walks through the match definition, collecting errors for each field\n @api private\n @param definition [Hash] defines how to lookup value in json and on object\n @param current_expected [Object] the serialized object being checked\n @current_key [String,nil] optional parent key passed while checking nested definitions\n @return [nil] returns nothing, adds to error list as side effect", "Iterates through a list of objects while checking fields\n @api private\n @param error_key [String]\n   the first name of the field reported in the error\n   each errors are reported #{error_key}[#{idx}].#{each_key}\n @param each_definition [Hash]\n   :each is a function that returns the list of items\n   :attributes is a hash with the same structure as the top-level match_def hash\n @return [nil] returns nothing, adds to error list as side effect", "Checks fields on a single instance\n @api private\n @param key_prefix [String] optional parent key if iterating through nested association\n @param error_key [String] the name of the field reported in the error\n @param match_function [Hash]\n   a function returning the value for the key for the object being serialized\n @param expected_instance [Object]\n   the top level instance, or an each instance from #check_each\n the index if iterating through a list, otherwise nil\n @return [nil] returns nothing, adds to error list as side effect", "Adds the given number of banking days, i.e. bank holidays don't count.\n If days is negative, subtracts the given number of banking days.\n If days is zero, returns self.", "Calculates a percentage match between string a and string b.", "Returns the best match from array b to string a based on percent.", "Returns a hash of array 'b' with the percentage match to a. If sort is true,\n the hash is sorted desc by match percent.", "Filter out everything except these columns", "require these columns", "Patched cause we dont need no attribute name magic .. and its just simpler\n orig version is looking up the humanized name of the attribute in the error\n message, which we dont supply => only field name is used in returned error msg", "Parse mode changes.\n @param [Array] modes The modes you want to parse. A string of mode\n   changes (e.g. `'-i+k+l'`) followed by any arguments (e.g. `'secret', 25`).\n @return [Array] Each element will be a hash with two keys: `:set`,\n   a boolean indicating whether the mode is being set (instead of unset);\n   and `:mode`, the mode character.", "Parse channel mode changes.\n @param [Array] modes The modes you want to parse.\n @option opts [Hash] :chanmodes The channel modes which are allowed. This is\n   the same as the \"CHANMODES\" isupport option.\n @option opts [Hash] :statmodes The channel modes which are allowed. This is\n   the same as the keys of the \"PREFIX\" isupport option.\n @return [Array] Each element will be a hash with three keys: `:set`,\n   a boolean indicating whether the mode is being set (instead of unset);\n   `:mode`, the mode character; and `:argument`, the argument to the mode,\n   if any.", "Condense mode string by removing duplicates.\n @param [String] modes A string of modes you want condensed.\n @return [Strings] A condensed mode string.", "Calculate the difference between two mode strings.\n @param [String] before The \"before\" mode string.\n @param [String] after The \"after\" mode string.\n @return [String] A modestring representing the difference between the\n   two mode strings.", "Returns the domain type for this property's collection Java property descriptor name.\n By convention, Jinx domain collection propertys often begin with a domain type\n name and end in 'Collection'. This method strips the Collection suffix and checks\n whether the prefix is a domain class.\n\n For example, the type of the property named +distributionProtocolCollection+\n is inferred as +DistributionProtocol+ by stripping the +Collection+ suffix,\n capitalizing the prefix and looking for a class of that name in this classifier's\n domain_module.\n\n @return [Class] the collection item type", "Define one or more new plugin types in a specified namespace.\n\n * *Parameters*\n   - [String, Symbol] *namespace*  Namespace that contains plugin types\n   - [Hash<String, Symbol|String, Symbol>] *type_info*  Plugin type, default provider pairs\n\n * *Returns*\n   - [Nucleon::Environment]  Returns reference to self for compound operations\n\n * *Errors*\n\n See:\n - #define_plugin_type", "Return the load information for a specified plugin provider if it exists\n\n * *Parameters*\n   - [String, Symbol] *namespace*  Namespace that contains plugin types\n   - [String, Symbol] *plugin_type*  Plugin type name of provider\n   - [String, Symbol] *provider*  Plugin provider to return load information\n\n * *Returns*\n   - [nil, Hash<Symbol|ANY>]  Returns provider load information if provider exists, nil otherwise\n\n * *Errors*\n\n See:\n - Nucleon::Config#get\n\n See also:\n - #sanitize_id", "Return the load information for namespaces, plugin types, providers if it exists\n\n * *Parameters*\n   - [nil, String, Symbol] *namespace*  Namespace to return load information\n   - [nil, String, Symbol] *plugin_type*  Plugin type name to return load information\n   - [nil, String, Symbol] *provider*  Plugin provider to return load information\n   - [ANY] *default*  Default results if nothing found (empty hash by default)\n\n * *Returns*\n   - [nil, Hash<Symbol|Symbol|Symbol|Symbol|ANY>]  Returns all load information if no parameters given\n   - [nil, Hash<Symbol|Symbol|Symbol|ANY>]  Returns namespace load information if only namespace given\n   - [nil, Hash<Symbol|Symbol|ANY>]  Returns plugin type load information if namespace and plugin type given\n   - [nil, Hash<Symbol|ANY>]  Returns provider load information if namespace, plugin type, and provider given\n\n * *Errors*\n\n See:\n - Nucleon::Config#get_hash\n\n See also:\n - #sanitize_id", "Check if a specified plugin provider has been loaded\n\n * *Parameters*\n   - [String, Symbol] *namespace*  Namespace that contains plugin types\n   - [String, Symbol] *plugin_type*  Plugin type name to check\n   - [String, Symbol] *provider*  Plugin provider name to check\n\n * *Returns*\n   - [Boolean]  Returns true if plugin provider has been loaded, false otherwise\n\n * *Errors*\n\n See:\n - Nucleon::Config#get_hash\n\n See also:\n - #sanitize_id", "Return a plugin instance by name if it exists\n\n * *Parameters*\n   - [String, Symbol] *namespace*  Namespace that contains the plugin\n   - [String, Symbol] *plugin_type*  Plugin type name\n   - [String, Symbol] *plugin_name*  Plugin name to return\n\n * *Returns*\n   - [nil, Nucleon::Plugin::Base]  Returns a plugin instance of name specified if it exists\n\n * *Errors*\n\n See:\n - Nucleon::Plugin::Base\n - Nucleon::Config#get_hash\n\n See also:\n - #sanitize_id", "Remove a plugin instance from the environment\n\n * *Parameters*\n   - [String, Symbol] *namespace*  Namespace that contains the plugin\n   - [String, Symbol] *plugin_type*  Plugin type name\n   - [String, Symbol] *instance_name*  Plugin instance name to tremove\n\n * *Returns*\n   - [nil, Nucleon::Plugin::Base]  Returns the plugin instance that was removed from environment\n\n * *Errors*\n\n * *Yields*\n   - [Nucleon::Plugin::Base] *plugin*  Plugin object being removed (cleanup)\n\n See:\n - Nucleon::Plugin::Base\n - Nucleon::Config#delete\n\n See also:\n - #sanitize_id", "Return active plugins for namespaces, plugin types, providers if specified\n\n * *Parameters*\n   - [nil, String, Symbol] *namespace*  Namespace to return plugin instance\n   - [nil, String, Symbol] *plugin_type*  Plugin type name to return plugin instance\n   - [nil, String, Symbol] *provider*  Plugin provider to return plugin instance\n\n * *Returns*\n   - [nil, Hash<Symbol|Symbol|Symbol|Symbol|Nucleon::Plugin::Base>]  Returns all plugin instances if no parameters given\n   - [nil, Hash<Symbol|Symbol|Symbol|Nucleon::Plugin::Base>]  Returns namespace plugin instances if only namespace given\n   - [nil, Hash<Symbol|Symbol|Nucleon::Plugin::Base>]  Returns plugin type instances if namespace and plugin type given\n   - [nil, Hash<Symbol|Nucleon::Plugin::Base>]  Returns provider instances if namespace, plugin type, and provider given\n\n * *Errors*\n\n See:\n - Nucleon::Config#get_hash\n\n See also:\n - #sanitize_id", "Return a fully formed class name as a machine usable constant\n\n * *Parameters*\n   - [String, Symbol, Array] *name*  Class name components\n   - [String, Symbol] *separator*  Class component separator (default '::')\n\n * *Returns*\n   - [Class Constant]  Returns class constant for fully formed class name of given components\n\n * *Errors*\n\n See also:\n - #class_name", "Sanitize a class identifier for internal use.\n\n * *Parameters*\n   - [String, Symbol] *class_component*  Class identifier to sanitize\n\n * *Returns*\n   - [String]  Returns a sanitized string representing the given class component\n\n * *Errors*", "Return a class constant representing a plugin provider class generated from\n namespace, plugin_type, and provider name.\n\n The provider name can be entered as an array if it is included in sub modules.\n\n * *Parameters*\n   - [String, Symbol] *namespace*  Plugin namespace to constantize\n   - [String, Symbol] *plugin_type*  Plugin type to constantize\n   - [String, Symbol, Array] *provider*  Plugin provider name to constantize\n\n * *Returns*\n   - [String]  Returns a class constant representing the plugin provider\n\n * *Errors*\n\n See also:\n - #class_const\n - #sanitize_class", "Create a new role", "Removes an existing role", "Add a profile to a role", "Creates a druby connection to the process, starting it up if necessary", "Generates a link tag to a ReCAPTCHA Mailhide URL for the given email\n address.\n\n If a block is given it will use it to generate the content, and takes\n these attributes:\n\n * +email+ - The email address to hide\n * +options+ - See options below\n\n When no block is given it accepts two forms:\n\n   # Just email\n   recaptcha_mailhide(email, options = {})\n\n   # Email and content\n   recaptcha_mailhide(content, email, options = {})\n\n In the first instance it will process the email with\n <code>truncate_email</code> and use it as the link content.\n\n ==== Options\n\n Accepts every option supported by <code>link_to</code>, plus:\n\n [:popup]\n\n   Set it to <code>true</code> to have the link open a popup window\n   (through JavaScript and the <code>onclick</code> event).\n\n   Can also be a hash of sub-options, which can be <code>:width</code> and\n   <code>:height</code>, setting the size of the popup window.\n\n In case of not supplying your own content you can also pass options for\n <code>truncate_email</code>, e.g.:\n\n   recaptcha_mailhide('foo@example.com', omission: '-', truncate_domain: true)", "Retrieve information for all projects.", "Provides convenient method for concisely defining element getters\n\n @param root_elem_var_name [Symbol] the name of the instance variable\n   containing the element on which methods should be caleld\n   (typically the browser instance).\n @param element_definitions [Hash] the hash used to define element getters\n   on the class instance where each key represents the name of the method\n   to be defined and whose value is an array containing first, the\n   element tag name and second, the selectors with which to locate it.", "Calculates the prices according to the `scale` definition.", "Calculates the prices according to the `set` definition.", "Calculates the prices according to the `choices` definition.", "Ask the user for the price.", "Return the bounding box for this volume", "A volume contains a point if it lies behind all the planes", "Returns the `ContentProvider` at the given position, or a `Null`\n `ContentProvider` if none exists.", "Creates or Updates a single job\n @param job Job parameters\n @param [Hash] opts the optional parameters\n @return [JobResponse]", "Returns a single job\n @param id_or_uri ID or URI of job to fetch\n @param [Hash] opts the optional parameters\n @return [JobResponse]", "Action statt plan", "Ask for confirmation of any action", "Ask to write some input with validation", "Asks to choose an option", "Check if the puppet resource has a valid name", "will loop for number of seconds", "Converts coordinates to coordinates relative to inside the map.", "Converts given coordinates to ranges if necessary.", "Sets the given bi-directional association attribute's inverse.\n\n @param [Symbol] attribute the subject attribute\n @param [Symbol] the attribute inverse\n @raise [TypeError] if the inverse type is incompatible with this Resource", "Clears the property inverse, if there is one.", "Detects an unambiguous attribute which refers to the given referencing class.\n If there is exactly one attribute with the given return type, then that attribute is chosen.\n Otherwise, the attribute whose name matches the underscored referencing class name is chosen,\n if any.\n\n @param [Class] klass the referencing class\n @return [Symbol, nil] the inverse attribute for the given referencing class and inverse,\n   or nil if no owner attribute was detected", "Redefines the attribute writer method to delegate to its inverse writer.\n This is done to enforce inverse integrity.\n\n For a +Person+ attribute +account+ with inverse +holder+, this is equivalent to the following:\n   class Person\n     alias :set_account :account=\n     def account=(acct)\n       acct.holder = self if acct\n       set_account(acct)\n     end\n   end", "Copies the given attribute metadata from its declarer to this class. The new attribute metadata\n has the same attribute access methods, but the declarer is this class and the inverse is the\n given inverse attribute.\n\n @param [Property] prop the attribute to copy\n @param [Symbol] the attribute inverse\n @return [Property] the copied attribute metadata", "Modifies the given attribute writer method to update the given inverse.\n\n @param (see #set_attribute_inverse)", "Initializes and logs in to Epicmix\n Login to epic mix", "Gets all your season stats", "Returns +true+ if the value has at least the specified length\n\n @param value [String] the value\n @param length [Integer] the length\n @return [Boolean]", "Returns +true+ if the value has at most the specified length\n\n @param value [String] the value\n @param length [Integer] the length\n @return [Boolean]", "Returns +true+ if the value has exactly the specified length\n\n @param value [String] the value\n @param length [Integer] the length\n @return [Boolean]", "Save the email and a randomly generated token", "stop the watcher", "Watch the sockets and send strings for processing", "Checks in PATH returns true if the command is found.\n\n @param [String] command\n   The name of the command to look for.\n\n @return [Boolean]\n   True if the command is found in the path.", "Return pretty inspection\n\n @return [String]\n\n @api private", "Coerce any method calls for body attributes", "Update a side with the values from the other side.\n Populates the log with updated fields and values.\n\n @param [String|Symbol] side to update l OR r\n @param [Array<Field>, nil] flds fields to update, default nil update all fields", "Consider whether this input can be ignored.\n\n Returns true if it can.", "Render this input using Tilt", "Read input file, extracting YAML meta-data header, and template content.", "process_hash_row - helper VALIDATE HASHES \n Converts hash keys and vals into parsed line.", "line_parse - helper VALIDATE HASHES \n Parses line to row, then updates final results.", "Waits for the prompt to appear at the end of the output.\n\n Once the prompt appears, new input can be sent to the shell.\n This is automatically called in +exec+ so you would only need\n to call it directly if you were sending data manually to the\n shell.\n\n This method is used internally in the +exec+ method, but there may be legitimate use cases\n outside of that method as well.", "Sets the prompt to the value temporarily for execution of the code block.", "the loop through migrations happens so fast\n\tthat they all have the same timestamp which\n\twon't work when you actually try to migrate.\n\tAll the timestamps MUST be unique.", "Converts the input to an RGB color represented by an integer\n\n @param [String, Integer] color Can be a RRGGBB hex string or an integer\n @return [Integer]\n\n @example\n   interpret_color(255)      # => 255\n   interpret_color(\"ABCDEF\") # => 15715755", "Runs the application loop.\n Clears the system view each iteration.\n Calls route on the router instance.\n\n If the user is trying to reset or quit the application responds accordingly.\n Clears Input class variables before exit.", "Writes msg to the log device. Each line in msg is formatted separately.\n\n @param (see Logger#format_message)\n @return (see Logger#format_message)", "Enumerates the key, value pairs in the has.", "Enumerates keys that match a regex, passing the match object and the\n value.", "Collects attributes for serialization.\n Attributes can be overwritten in the serializer.\n\n @return [Hash]", "Collects associations for serialization.\n Associations can be overwritten in the serializer.\n\n @return [Hash]", "Renders a specific association.\n\n @return [Hash]\n\n @example\n   render_association(:employee)\n   render_association([:employee, :company])\n   render_association({ :employee => :address })", "Fetches property from the serializer or resource.\n This method makes it possible to overwrite defined attributes or associations.", "Fetches association and eager loads data.\n Doesn't eager load when includes is empty or when the association has already been loaded.\n\n @example\n   fetch_association(:comments, :user)", "Execute the specified components of the job.\n\n @param components [Array<symbol>] list of components to execute (e.g., `:transforms`, `:load_targets`)\n\n @return [self]", "Returns a updated user object\n username = key of user", "Adds the given property as a dependent.\n\n If the property inverse is not a collection, then the property writer\n is modified to delegate to the dependent owner writer. This enforces\n referential integrity by ensuring that the following post-condition holds:\n *  _owner_._attribute_._inverse_ == _owner_\n where:\n * _owner_ is an instance this property's declaring class\n * _inverse_ is the owner inverse attribute defined in the dependent class\n\n @param [Property] property the dependent to add\n @param [<Symbol>] flags the attribute qualifier flags", "Adds the given owner class to this dependent class.\n This method must be called before any dependent attribute is accessed.\n If the attribute is given, then the attribute inverse is set.\n Otherwise, if there is not already an owner attribute, then a new owner attribute is created.\n The name of the new attribute is the lower-case demodulized owner class name.\n\n @param [Class] the owner class\n @param [Symbol] inverse the owner -> dependent attribute\n @param [Symbol, nil] attribute the dependent -> owner attribute, if known\n @raise [ValidationError] if the inverse is nil", "Adds the given attribute as an owner. This method is called when a new attribute is added that\n references an existing owner.\n\n @param [Symbol] attribute the owner attribute", "Construct a new `AbstractMethodError`.\n\n @param [Object] instance\n   Instance that invoked the abstract method.\n\n @param [Symbol | String] method_name\n   Name of abstract method.\n\n #initialize", "Gets the Octokit and colors for the program.\n @param opts [Hash] The options to use. The ones that are used by this\n   method are: :token, :pass, and :user.\n @return [Hash] A hash containing objects formatted as\n   { git: Octokit::Client, colors: JSON }\n Gets the user and checks if it exists in the process.\n @param user [Any] The user ID or name.\n @return [Hash] Their username and avatar URL.\n @return [Boolean] False if it does not exist.", "Gets the number of forkers, stargazers, and watchers.\n @param repository [String] The full repository name.\n @return [Hash] The forks, stars, and watcher count.", "Gets the number of followers and users followed by the user.\n @param username [String] See #get_user_and_check\n @return [Hash] The number of following and followed users.", "Gets the langauges and their bytes for the user.\n @param username [String] See #get_user_and_check\n @return [Hash] The languages and their bytes, as formatted as\n   { :Ruby => 129890, :CoffeeScript => 5970 }", "Gets the languages and their bytes for the user's organizations.\n @param username [String] See #get_user_and_check\n @return [Hash] See #get_user_langs", "Gets the defined color for the language.\n @param lang [String] The language name.\n @return [String] The 6 digit hexidecimal color.\n @return [Nil] If there is no defined color for the language.", "Gets the percentages for each language in a hash.\n @param langs [Hash] The language hash obtained by the get_langs methods.\n @return [Hash] The language percentages formatted as\n   { Ruby: 50%, CoffeeScript: 50% }", "Rasises exception if can't retrieve repomd.xml", "Rewrites the request according to the response coming from SecureTrading according to the required auth_type\n This only applies if the inital request was a ST3DCARDQUERY\n It deletes elements which are not needed for the subsequent request and\n adds the required additional information if an ST3DAUTH is needed", "Cleans out the specified directory", "HTTPI doesn't support multipart posts. We can work around it by using another gem\n and handing off something that looks like a HTTPI response", "Creates an OrderParser instance based on a clause argument.  The instance\n can then be parsed into a valid ReQON string for queries\n\n * *Args* :\n   - +clause+ -> A hash or string ordering value\n * *Returns* :\n   - A Montage::OrderParser instance\n * *Raises* :\n   - +ClauseFormatError+ -> If a blank string clause or a hash without\n     a valid direction is found.\n\n Validates clause arguments by checking a hash for a full word match of\n \"asc\" or \"desc\".  String clauses are rejected if they are blank or\n consist entirely of whitespace\n\n * *Returns* :\n   - A boolean", "Parses a hash clause\n\n * *Returns* :\n   - A ReQON formatted array\n * *Examples* :\n    @clause = { test: \"asc\"}\n    @clause.parse\n    => [\"$order_by\", [\"$asc\", \"test\"]]", "Parses a string clause, defaults direction to asc if missing or invalid\n\n * *Returns* :\n   - A ReQON formatted array\n * *Examples* :\n    @clause = \"happy_trees desc\"\n    @clause.parse\n    => [\"$order_by\", [\"$desc\", \"happy_trees\"]]", "Array with delete subjects. Defined in config file", "Returns a short summary for this Command\n\n Typically generated by parsing #documentation for 'Summary: something',\n but it can also be set manually\n\n :api: public", "Sets the color for the lightbulp.\n @see Color#initialize\n @return [Boolean] success of the operation", "Stores the current state of the lightbulp.\n @return [Boolean] success of the operation", "This will be called by a worker when a job needs to be processed", "Checks to see if array2 is subset of array1", "Converts permission to gitolite friendly permission", "Create a new environment", "Removes an existing environment", "Store in cache", "Compressed joined files", "All files joined", "search for locations", "general search for restaurants", "Sets up a client\n\n @param [String] API key\n Get any rest accessible object\n\n @param [String] object name\n @param [Hash] optional search parameters\n @return [Mash] your data", "Match strings to multiple IRC masks.\n @param [Array] masks The masks to match against.\n @param [Array] strings The strings to match against the masks.\n @param [Symbol] casemapping The IRC casemapping to use in the match.\n @return [Hash] Each mask that was matched will be present as a key,\n   and the values will be arrays of the strings that matched.", "Merges data with given scope.\n\n @example\n   scope.merge!(another_scope)", "Duplicates scope.\n\n\n Actually defines the association but without default_options.", "Fetch and instantiate a single resource from a path.", "Fetch and update this resource from a path.", "torna un array on cada element es una tupla formada per\n un element de cada enumerable. Si se li passa un bloc\n se li passa al bloc cada tupla i el resultat del bloc\n s'emmagatzema a l'array tornat.", "Get a field on current page.\n\n @param display [String] display name", "1. Generate random AES key to encrypt message\n 2. Use Public Key from the Private key to encrypt AES Key\n 3. Prepend encrypted AES key to the encrypted message\n\n Output message format will look like the following:\n\n  {RSA Encrypted AES Key}{RSA Encrypted IV}{AES Encrypted Message}", "0. Base64 decode the encrypted message\n 1. Split the string in to the AES key and the encrypted message\n 2. Decrypt the AES key using the private key\n 3. Decrypt the message using the AES key", "Metodo para guardar el titulo de la referencia\n @param [titulo] titulo Titulo de la referencia a introducir", "Metodo que nos devuelve la referencia del articulo periodistico formateado\n @return String de la referencia del articulo periodistico formateado", "Metodo que nos devuelve la referencia del documento electronico formateado\n @return String de la referencia del documento electronico formateado", "Nest a given resource path within a parent resource.\n\n path   - A String representing an API resource path.\n params - A Hash of params to send to the API.\n\n Examples\n\n   nest_path_within_parent(\"bags/1\", {user_id: \"123\"}) # => /users/123/bags/1\n\n Returns String", "Dispatch message to given callback. All named callbacks matching the name will\n be run in all namespaces in indeterminate order\n @param [ Symbol ] name The name of the callback\n @param [ Symbol ] namespace The namespace in which the named callback should be found. Optional, if omitted then all matching named callbacks in all namespaces will be executed\n @return [ Hash ] A hash whose keys are the namespaces in which callbacks were executed, and whose values are the results of those executions. If empty, then no callbacks were executed.", "Query if a callback of given name is registered in any namespace\n @param [ Symbol ] name The name of the callback to check", "gets data from each frame id given only falls back\n to the id3v1 tag if no id3v2 frames were found", "Run a suite of tests\n\n suite - An Array of Test objects\n type - The type (Symbol) of the suite\n options - A Hash of runner options\n\n Returns nothing", "Compare the result and expected output of a test that has been run\n\n test - A Test object that has been run\n precondition :: expected_exists?(test) is true\n\n Returns success or failure as a symbol", "Compare a tests expected and result stdout\n Sets the result of the comparison to out_result in the test\n\n test - A test object that has been run\n\n Returns nothing", "Compare a tests expected and result stderr\n Sets the result of the comparison to err_result in the test\n\n test - A test object that has been run\n\n Returns nothing", "Tries to find the default root key.\n\n @example\n   default_root_key(User) # => 'user'", "Create a new set of timed tasks.\n\n @!macro [attach] executor_options\n\n @param [Hash] opts\n   The options used to specify the executor on which to perform actions.\n\n @option opts [Executor] :executor\n   When set use the given `Executor` instance. Three special values are\n   also supported: `:task` returns the global task pool, `:operation`\n   returns the global operation pool, and `:immediate` returns a new\n  `ImmediateExecutor` object.\n\n Post a task to be execute run after a given delay (in seconds). If the\n delay is less than 1/100th of a second the task will be immediately post\n to the executor.\n\n @param [Float] delay\n   The number of seconds to wait for before executing the task.\n\n @yield the task to be performed.\n\n @raise [ArgumentError] f the intended execution time is not in the future.\n\n @raise [ArgumentError] if no block is given.\n\n @return [Boolean]\n   True if the message is post, false after shutdown.", "Run a loop and execute tasks in the scheduled order and at the approximate\n scheduled time. If no tasks remain the thread will exit gracefully so that\n garbage collection can occur. If there are no ready tasks it will sleep\n for up to 60 seconds waiting for the next scheduled task.\n\n @!visibility private", "actually create the new admin with the given param data", "get and disply certain admin", "update the admins object", "Delete the admin, one thing to remember is you are not allowed to destory the overlord.\n You are only allowed to destroy yourself unless you are the overlord.", "Creates the wrapper, executing the pfSense shell.\n\n The provided code block is yielded this wrapper for execution.\n\n Executes a series of commands on the pfSense shell.", "Sets a configuration section to the pfSense device.\n\n Returns the number of changes made to the configuration.", "Enabled public key authentication for the current pfSense user.\n\n Once this has been done you should be able to connect without using a password.", "Creates a glyph icon using the specified +name+ and +size+.\n\n The +size+ can be nil, :small, :smaller, :big, or :bigger.\n The default size is nil.", "Add a list option.\n @see Clin::OptionList#initialize", "Add a list options that don't take arguments\n Same as .list_option but set +argument+ to false\n @see Clin::OptionList#initialize", "Add a general option\n @param option_cls [Class<GeneralOption>] Class inherited from GeneralOption\n @param config [Hash] General option config. Check the general option config.", "Remove a general option\n Might be useful if a parent added the option but is not needed in this child.", "To be called inside OptionParser block\n Extract the option in the command line using the OptionParser and map it to the out map.\n @return [Hash] Where the options shall be extracted", "loop through the available lights and make corresponding objects", "Create a html table for records, using model class for naming things.\n\n Examples:\n\n <tt>table_for Product, @products do |table|\n   table.head :name, :size, :description, :price\n   table.body do |row|\n     row.cell :name\n     row.cells :size, :description\n     row.cell number_to_currency(row.record.price)\n   end\n   table.foot do\n     link_to \"Add product\", new_product_path\n   end\n end</tt>\n\n <tt>table_for Product, @products do |table|\n   table.columns :name, :size, :description, :price\n   table.foot do\n     link_to \"Add product\", new_product_path\n   end\n end</tt>\n\n Returns:\n\n A string containing the html table\n\n (Call this method from your erb templates by wrapping each line in <%= %> or <% %>)", "Makes this domain object's String values for the given attributes unique.\n\n @param [<Symbol>] the key attributes to uniquify", "Store 'value' under 'key'.\n\n Multiple values can we stored for the same key by calling #store multiple times\n with the same key value.", "resize PNG file and write new sizes to directory\n\n @see https://ruby-doc.org/core-2.2.0/Kernel.html#method-i-sprintf\n @param input_filename   [String]        input filename; required: file is PNG file format\n @param sizes_array      [Array<Array<Integer,Integer]>>, Array<Integer>]\n   rectangles use Array with XY: `[x,y]`\n   squares use single Integer `N`\n   mixed indices is valid\n   example: `[24, [24,24], [480,270], 888] # a[0] => 24x24; a[1] => 24x24; a[2] => 480x270; a[3] => 888x888`\n @param output_dirname   [String]        (optional)\n   directory name including expanded path\n   default: new dir named input_filename's basename + \"_sizes\" in same dir as input_filename\n @param append_filenames [String]        (optional,required-with-supplied-default)\n   append resized filenames with Kernel#sprintf format_string\n   available args: `{:x => N, :y => N}`\n   default: `\"-%<x>dx%<y>d\"`\n @param  force_overwrite [Boolean]       overwrite existing resized images\n @param  clear           [Boolean]       default: `true`\n @param  force_clear     [Boolean]       clear output_dirname of contents before write; default: false\n @return                 [String]        output_dirname; default: false", "qp, short for quick-print, prints this Hasher with a filter that calls qp on each key and value.\n\n @return [String] the quick-print result", "Updates the object on server, after attributes have been set.\n Returns boolean if successful\n\n Example:\n   te = Cashboard::TimeEntry.new_from_url(time_entry_url)\n   te.minutes = 60\n   update_success = te.update", "Destroys Cashboard object on the server.\n Returns boolean upon success.", "Utilizes ActiveSupport to turn our objects into XML\n that we can pass back to the server.\n\n General concept stolen from Rails CoreExtensions::Hash::Conversions", "Deletes an element with the key\n It returns the http response.", "It returns the notes of an element if anything are given\n Notes list can be empty\n It returns nil if no element with this elementKey was found", "Returns Notes resource.\n Every Element can have zero, one or more notes.\n You can notes only access in context of its element which ownes the notes", "Returns the file object.\n Every element can have a Masterfile and one or more preview files", "returns results in a straight up hash.", "merges multiple ResultsHash's", "Capitalizes all the words and replaces some characters in the string to\n create a nicer looking title. +titleize+ is meant for creating pretty\n output. It is not used in the Rails internals.\n\n +titleize+ is also aliased as +titlecase+.\n\n   titleize('man from the boondocks')   # => \"Man From The Boondocks\"\n   titleize('x-men: the last stand')    # => \"X Men: The Last Stand\"\n   titleize('TheManWithoutAPast')       # => \"The Man Without A Past\"\n   titleize('raiders_of_the_lost_ark')  # => \"Raiders Of The Lost Ark\"", "Initializes new instance of Filter class.\n Returns list of filter attributes.\n\n @return [HashWithIndifferentAccess]", "returns that type of page that you are currenly viewing", "Matches a message against all listeners\n and invokes the first listener that mathes", "Creates a new Mutex\n\n @param [String] lockfile filename\n Protect a block\n\n @example\n\n    require 'rubygems'\n    require 'mutagem'\n\n    mutex = Mutagem::Mutex.new(\"my_process_name.lck\")\n    mutex.execute do\n      puts \"this block is protected from recursion\"\n    end\n\n @param block the block of code to protect with the mutex\n @return [Boolean] 0 if lock sucessful, otherwise false", "Returns a byte array representing this command, appropriate for sending to the sign's serial port\n\n @return [Array<Byte>]", "Reads the list of records from the resource file.", "Reads the data for a given record.\n\n @param rec [ResourceRecord] the record to read the data for.", "Computes the checksum for the resource file.\n\n @yield [done] Provides feedback about the progress of the operation.", "Read template and inject new name\n @return [String] source code for new task", "Authorize the current action.\n\n * If +group_list+ is not provided or only contains +false+ then any authenticated user will be authorized.\n * If +group_list+ contains +true+ then only system administrators will be authorized.\n * Otherwise the +group_list+ contains a list of accepted groups that will be authorized.\n   Any user with one or more groups from the list will be granted access.", "REFACTOR to selector class", "Check if TXT value has been set correctly", "Check if process exists then fail, otherwise clean up.\n @return [Boolean] `false` if no PID file exists, `true` if it cleaned up.", "Trap common signals as default.", "Initialize the document with a URL, and\n the parent page this URL was included on in case of\n assets\n Find the links in a page and extract all the hrefs", "Write a document to file", "Add an option to the command.\n\n     option '-x'    # flag-style option\n     option '--y'   # long option\n     option '/z'    # Windows-style option\n     options 'abc'  # unprefixed option\n\n If the option +:os_prefix+ is true\n then the default system option switch will be used.\n\n     option 'x', os_prefix: true # will produce -x or /x\n\n A value can be given as an option and will be space-separated from\n the option name:\n\n     option '-x', value: 123 # -x 123\n\n To avoid spacing the value use the +:join_value+ option\n\n     option '-x', join_value: 123 # -x123\n\n And to use an equal sign as separator, use +:equal_value+\n\n     option '-x', equal_value: 123 # -x=123\n\n If the option value is a file name, use the analogous\n +:file+, +:join_file+ or +:equal_file+ options:\n\n     option '-i', file: 'path/filename'\n\n Several of this options can be given simoultaneusly:\n\n     option '-d', join_value: 'x', equal_value: '1' # -dx=1", "An +os_option+ has automatically a OS-dependent prefix", "Add an unquoted argument to the command.\n This is not useful for commands executed directly, since the arguments\n are note interpreted by a shell in that case.", "Execute the command.\n\n By default the command is executed by a shell. In this case,\n unquoted arguments are interpreted by the shell, e.g.\n\n   SysCmd.command('echo $BASH').run # /bin/bash\n\n When the +:direct+ option is set to true, no shell is used and\n the command is directly executed; in this case unquoted arguments\n are not interpreted:\n\n   SysCmd.command('echo $BASH').run # $BASH\n\n The exit status of the command is retained in the +status+ attribute\n (and its numeric value in the +status_value+ attribute).\n\n The standard output of the command is captured and retained in the\n +output+ attribute.\n\n By default, the standar error output of the command is not\n captured, so it will be shown on the console unless redirected.\n\n Standard error can be captured and interleaved with the standard\n output passing the option\n\n     error_output: :mix\n\n Error output can be captured and keep separate inthe +error_output+\n attribute with this option:\n\n     error_output: :separate\n\n The value returned is by defaut, like in Kernel#system,\n true if the command gives zero exit status, false for non zero exit status,\n and nil if command execution fails.\n\n The +:return+ option can be used to make this method return other\n attribute of the executed command.\n\n The +:stdin_data+ option can be used to pass a String as the\n command's standar input.", "Run parser machine for check in interactive mode.", "Creates block of attributes with optional header. Attributes are surrounded with ordered list.\n\n @overload attributes(options = {}, &block)\n   Creates attributes list without header, yields block to include each attribute\n\n   @param [Hash] options Options for formating attributes block\n   @option options [String] :name (nil) Optional header of attributes section\n   @option options [String] :class ('') Name of html class to add to attributes block\n   @option options [String] :header_class ('') Name of html class to add to header\n   @yield Block which can call #attribute to include attribute value\n\n   @example\n     <%= attr.attributes do %>\n       <%= attr.attribute :name %>\n       <%= attr.attribute :email %>\n     <% end %>\n\n   @example\n     <%= attr.attributes :name => \"User\" do %>\n       <%= attr.attribute :name %>\n       <%= attr.attribute :email %>\n     <% end %>\n\n   @example\n     <%= attr.attributes :for => :user do |user| %>\n       <%= user.attribute :name %>\n       <%= user.attribute :email %>\n       <%= user.attribute :profile do %>\n         <%= link_to h(user.record.name), user_path(user.record) %>\n       <% end %>\n     <% end %>\n\n   @example\n     <%= attr.attributes :for => @user do |user| %>\n       <%= user.attribute :name %>\n       <%= user.attribute :email %>\n       <%= user.attribute :profile do %>\n         <%= link_to h(@user.name), user_path(@user) %>\n       <% end %>\n     <% end %>\n\n   @example\n     <%= attr.attributes :for => :posts do |post| %>\n       <%= post.attribute :author %>\n       <%= post.attribute :title %>\n     <% end %>\n\n   @example\n     <%= attr.attributes :for => @posts do |post| %>\n       <%= post.attribute :author %>\n       <%= post.attribute :title %>\n     <% end %>\n\n   @example\n     <%= attr.attributes :for => @posts do |post| %>\n       <%= post.attribute :birthday, :format => false %>\n     <% end %>\n\n   @example\n     <%= attr.attributes :for => @posts do |post| %>\n       <%= post.attribute :birthday, :format => :my_fancy_birthday_formatter %>\n     <% end %>\n\n @overload attributes(header, options = {}, &block)\n   Creates attributes list with header and yields block to include each attribute\n\n   @param [String] header Header of attributes section\n   @param [Hash] options Options for formating attributes block\n   @option options [String] :class ('') Name of html class to add to attributes block\n   @option options [String] :header_class ('') Name of html class to add to header\n   @option optinos [Symbol,Object] :for Optional new record for new builder\n     passed as argument block. This new record can be symbol of method name for actual\n     record, or any other object which is passed as new record for builder.\n   @yield Block which can call #attribute to include attribute value\n   @yieldparam builder Builder instance holding actual record (retivable via #record)\n\n   @example\n     <%= attr.attributes \"User info\" do %>\n       <%= attr.attribute :name\" %>\n       <%= attr.attribute :email %>\n     <% end %>\n\n   @example\n     <%= attr.attributes \"User\", :for => :user do |user| %>\n       <%= user.attribute :name %>\n       <%= user.attribute :email %>\n       <%= user.attribute :profile do %>\n         <%= link_to h(user.record.name), user_path(user.record) %>\n       <%  end %>\n     <% end %>\n\n   @example\n     <% attr.attributes \"User\", :for => @user do |user| %>\n       <%= user.attribute :name %>\n       <%= user.attribute :email %>\n       <%= user.attribute :profile do %>\n         <%= link_to h(@user.name), user_path(@user) %>\n       <% end %>\n     <% end %>\n\n   @example\n     <%= attr.attributes \"Post\", :for => :posts do |post| %>\n       <%= post.attribute :author %>\n       <%= post.attribute :title %>\n     <% end %>\n\n   @example\n     <%= attr.attributes \"Post\", :for => @posts do |post| %>\n       <%= post.attribute :author %>\n       <%= post.attribute :title %>\n     <% end %>\n\n @overload attributes(*symbols, options = {})\n   Creates attributes list without header, attributes are given as list of symbols (record properties)\n\n   @param [Symbol, ...] symbols List of attributes\n   @param [Hash] options Options for formating attributes block\n   @option options [String] :name (nil) Optional header of attributes section\n   @option options [String] :class ('') Name of html class to add to attributes block\n   @option options [String] :header_class ('') Name of html class to add to header\n\n   @example\n     <%= attr.attributes :name, :email %>\n\n   @example\n     <%= attr.attributes :name, :email, :for => :author %>\n\n   @example\n     <%= attr.attributes :name, :email, :for => @user %>\n\n   @example\n     <%= attr.attributes :title, :for => :posts %>\n\n   @example\n     <%= attr.attributes :title, :for => @posts %>\n\n @overload attributes(header, *symbols, options = {})\n   Creates attributes list with header, attributes are given as list of symbols (record properties)\n\n   @param [String] header Header of attributes section\n   @param [Symbol, ...] symbols Optional list of attributes\n   @param [Hash] options Options for formating attributes block\n   @option options [String] :class ('') Name of html class to add to attributes block\n   @option options [String] :header_class ('') Name of html class to add to header\n\n   @example\n     <%= attr.attributes \"User info\" :name, :email %>\n\n   @example\n     <%= attr.attributes \"Author\", :name, :email, :for => :author %>\n\n   @example\n     <%= attr.attributes \"Author\", :name, :email, :for => @user %>\n\n   @example\n     <%= attr.attributes \"Post\", :title, :for => :posts %>\n\n   @example\n     <%= attr.attributes \"Post\", :title, :for => @posts %>\n\n @example All together\n   <%= attr.attributes \"User info\", :name, :email, :class => \"user_info\", :header_class => \"header important\" %>\n\n @example With block\n   <%= attr.attributes \"User info\" :class => \"user_info\", :header_class => \"header important\" do %>\n     <%= attr.attribute :name %>\n     <%= attr.attribute :email %>\n   <% end %>\n\n @see #attribute", "Creates list entry for single record attribute\n\n @overload attribute(method, options = {})\n   Creates entry for record attribute\n\n   @param [Symbol] method Attribute name of given record\n   @param [Hash] options Options\n   @option options [Hash] :html ({}) Hash with optional :class, :label_class and :value_class names of class for html\n   @option options [String] :label Label for attribute entry, overrides default label name from symbol\n   @option options [Symbol,Object] :value If it's Symbol, then it's used as either name of hash key to use on attribute\n           (if it's hash) or method name to call on attribute. Otherwise it's used as value to use instead of\n           actual attribute's.\n   @option options [Boolean] :display_empty (false) Indicates if print value of given attribute even if it is blank?\n   @option options [Symbol,false,nil] :format (nil) Type of formatter to use to display attribute's value. If it's false,\n           then don't format at all (just call #to_s). If it's nil, then use default formatting (#l for dates,\n           #number_with_precision/#number_with_delimiter for floats/integers). If it's Symbol, then use it to select\n           view helper method and pass aattribute's value to it to format.\n\n   @example\n     <%= attr.attribute :name %>\n\n   @example\n     <%= attr.attribute :name, :label => \"Full user name\" %>\n\n   @example\n     <%= attr.attribute :name, :value => @user.full_name %>\n\n   @example\n     <%= attr.attribute :address, :value => :street %>\n\n   @example\n     <%= attr.attribute :avatar, :value => :url, :format => :image_tag %>\n\n @overload attribute(method, options = {}, &block)\n   Creates entry for attribute given with block\n\n   @param [Symbol] method Attribute name of given record\n   @param [Hash] options Options\n   @option options [Hash] :html ({}) Hash with optional :class, :label_class and :value_class names of classes for html\n   @option options [String] :label Label for attribute entry, overrides default label name from symbol\n   @yield Block which is executed in place of value for attribute\n\n   @example\n     <%= attr.attribute :name do %>\n       <%= link_to @user.full_name, user_path(@user) %>\n\n @overload attribute(options = {}, &block)\n   Creates entry for attribute with given block, options[:label] is mandatory in this case.\n\n   @param [:Hash] options Options\n   @option options [Hash] :html ({}) Hash with optional :class, :label_class and :value_class names of classes for html\n   @option options [String] :label Mandatory label for attribute entry\n   @yield Block which is executed in place of value for attribute\n\n   @example\n     <%= attr.attribute :label => \"User link\" do %>\n       <%= link_to @user.full_name, user_path(@user) %>\n\n @example\n   <%= attr.attribute :name, :display_empty => true %>\n\n @example\n   <%= attr.attribute :label => \"User link\" do %>\n     <%= link_to @user.full_name, user_path(@user) %>\n\n Options can be set globally with Attrtastic.default_options", "add support for scopes, search and pagination", "add support for history", "Returns a key path without the leading +prefix+\n\n :call-seq:\n   Path - other => Path", "Is +other+ a prefix?\n\n :call-seq:\n   prefix?(other) => boolean", "Creates a new Climber instance, optionally yielding the instance for\n configuration if a block is given\n\n   Climber.new('beanstalk://localhost:11300', 'stalk_climber')\n     #=> #<StalkClimber::Job beanstalk_addresses=\"beanstalk://localhost:11300\" test_tube=\"stalk_climber\">\n :call-seq:\n   max_job_ids() => Hash{Beaneater::Connection => Integer}\n\n Returns a Hash with connections as keys and max_job_ids as values\n\n   climber = Climber.new('beanstalk://localhost:11300', 'stalk_climber')\n   climber.max_job_ids\n     #=> {#<Beaneater::Connection host=\"localhost\" port=11300>=>1183}", "Define a new task.\n\n @example Define an entirely new task\n task :push\n\n @example Define a publish task\n task :publish, :is => :update, :if => only_changed(:published)\n\n @example Define a joined manage task\n task :manage, :is => [:update, :create, :delete]\n\n @see #can More examples for the :if option\n @see DEFAULT_TASKS Default tasks\n\n @param [Symbol] name The name of the task.\n @param [Hash] options\n @option options [Symbol, Array<Symbol>] :is Optional parent tasks. The options of the parents will be inherited.\n @option options [String, Hash, Array<String,Hash>] :if The conditions for this task.", "Creates an internal Permission\n\n @param [Hash] target Either the permissions or the restrictions hash\n @param [Array] args The function arguments to the #can, #can_not methods", "Flattens the tasks. It sets the ancestors and the alternative tasks", "Set the ancestors on task.\n\n @param [Task] task The task for which the ancestors are set\n @param [Task] ancestor The ancestor to process. This is the recursive parameter", "Set the alternatives of the task.\n Alternatives are the nearest ancestors, which are used in permission definitions.\n\n @param [Task] task The task for which the alternatives are set\n @param [Task] ancestor The ancestor to process. This is the recursive parameter", "Set the descendant_role as a descendant of the ancestor", "Return an array of hashed that contains some information about the classes that consume more than `max_size` bytess", "displays all the current categories and creates a new category object for creating a new one", "create tag or category - this is set within the form", "update the term record with the given parameters", "delete the term", "set the title and breadcrumbs for the edit screen", "uploads the given file to the current bucket as its basename", "return date based on filename", "Creates read method\n @param definition [Definition]\n @param klass [Class, Module]\n @return [Definition]", "Formats a number to the specified number of decimal places.\n\n The +value+ can be either any valid numeric expression that can be converted to a float.", "Splits a name into First, Middle, and Last parts.\n\n Returns an array containing [ First, Middle, Last ]\n Any part that is missing will be nil.\n\n   'John Doe'          => [ 'John', nil, 'Doe' ]\n   'Doe, John'         => [ 'John', nil, 'Doe' ]\n   'John A. Doe'       => [ 'John', 'A.', 'Doe' ]\n   'Doe, John A.'      => [ 'John', 'A.', 'Doe' ]\n   'John A. Doe Jr.'   => [ 'John', 'A.', 'Doe Jr.' ]\n   'Doe Jr., John A.'  => [ 'John', 'A.', 'Doe Jr.' ]\n\n Since it doesn't check very hard, there are some known bugs as well.\n\n   'John Doe Jr.'      => [ 'John', 'Doe', 'Jr.' ]\n   'John Doe, Jr.'     => [ 'Jr.', nil, 'John Doe' ]\n   'Doe, John A., Jr.' => [ 'John', 'A., Jr.', 'Doe' ]\n\n It should work in most cases.", "This method returns a Chat instance, or false if it could not parse the\n file.", "Extract required data from the file. Run by parse.", "Time a block of code and send the duration as a value\n\n @example\n   StatHat.new.time('some identifying name') do\n     # code\n   end\n\n @param [String] name the name of the stat\n @param [Hash] opts a hash of options\n @option [Symbol] :ez Send data via the ez api (default: true)", "Adds new +entity+ in the section specified.\n E. g., call to\n\n     add_spice :linewide, :\u00b0, :deg, :degrees\n\n in HTML implementation adds a support for specifying something like:\n\n     \u00b0 15\n     \u00b0 30\n     \u00b0\u00a045\n\n which is to be converted to the following:\n\n     <degrees>\n       <deg>15</deg>\n       <deg>30</deg>\n       <deg>45</deg>\n     </degrees>\n\n @param [Symbol] section the section (it must be one of {Mapping.SPICES}) to add new key to\n @param [Symbol] key the name for the key\n @param [Symbol] value the value\n @param [Symbol] enclosure_value optional value to be added for the key into enclosures section", "Creates a new declarer attribute which qualifies this attribute for the given declarer.\n\n @param declarer (see #restrict)\n @param [<Symbol>] flags the additional flags for the restricted attribute\n @return (see #restrict)", "Sets the inverse of the subject attribute to the given attribute.\n The inverse relation is symmetric, i.e. the inverse of the referenced Property\n is set to this Property's subject attribute.\n\n @param [Symbol, nil] attribute the inverse attribute\n @raise [MetadataError] if the the inverse of the inverse is already set to a different attribute", "This method is called when the owner flag is set.\n The inverse is inferred as the referenced owner type's dependent attribute which references\n this attribute's type.\n\n @raise [MetadataError] if this attribute is dependent or an inverse could not be inferred", "Shortens a URL, returns the shortened token", "Run when a thread worker exits.\n\n @!visibility private", "A T T E N Z I O N E   A R E A   P R O T E T T A\n @!visibility private", "Check the thread pool configuration and determine if the pool\n has enought capacity to handle the request. Will grow the size\n of the pool if necessary.\n\n @return [Boolean] true if the pool has enough capacity else false\n\n @!visibility private", "Scan all threads in the pool and reclaim any that are dead or\n have been idle too long. Will check the last time the pool was\n pruned and only run if the configured garbage collection\n interval has passed.\n\n @!visibility private", "Create a single worker thread to be added to the pool.\n\n @return [Thread] the new thread.\n\n @!visibility private", "Content that is used during page rendering. Outputting existing content\n as a default.", "Merges the values of the other attributes into this object and returns self.\n The other argument can be either a Hash or an object whose class responds to the\n +mergeable_attributes+ method.\n The optional attributes argument can be either a single attribute symbol or a\n collection of attribute symbols.\n\n A hash argument consists of attribute name => value associations.\n For example, given a Mergeable +person+ object with attributes +ssn+ and +children+, the call:\n   person.merge_attributes(:ssn => '555-55-5555', :children => children)\n is equivalent to:\n   person.ssn ||= '555-55-5555'\n   person.children ||= []\n   person.children.merge(children, :deep)\n An unrecognized attribute is ignored.\n\n If other is not a Hash, then the other object's attributes values are merged into\n this object. The default attributes is this mergeable's class\n {Propertied#mergeable_attributes}.\n\n The merge is performed by calling {#merge_attribute} on each attribute with the matches\n and filter block given to this method.\n\n @param [Mergeable, {Symbol => Object}] other the source domain object or value hash to merge from\n @param [<Symbol>, nil] attributes the attributes to merge (default {Propertied#nondomain_attributes})\n @param [{Resource => Resource}, nil] the optional merge source => target reference matches\n @yield [value] the optional filter block\n @yieldparam value the source merge attribute value\n @return [Mergeable] self\n @raise [ArgumentError] if none of the following are true:\n   * other is a Hash\n   * attributes is non-nil\n   * the other class responds to +mergeable_attributes+", "Webhooks are handled in a non-compatible way with the other APIs", "Turn a string into IRC upper case, modifying it in place.\n @param [String] irc_string An IRC string (nickname, channel, etc).\n @param [Symbol] casemapping An IRC casemapping.\n @return [String] An upper case version of the IRC string according to\n   the casemapping.", "Turn a string into IRC upper case.\n @param [String] irc_string An IRC string (nickname, channel, etc)\n @param [Symbol] casemapping An IRC casemapping\n @return [String] An upper case version of the IRC string according to\n   the casemapping.", "Turn a string into IRC lower case, modifying it in place.\n @param [String] irc_string An IRC string (nickname, channel, etc)\n @param [Symbol] casemapping An IRC casemapping\n @return [String] A lower case version of the IRC string according to\n   the casemapping", "Turn a string into IRC lower case.\n @param [String] irc_string An IRC string (nickname, channel, etc).\n @param [Symbol] casemapping An IRC casemapping.\n @return [String] A lower case version of the IRC string according to\n   the casemapping", "Helper to render the js_message response.\n\n Pass in a type of message (:ok, :error, :redirect) and any other\n data you need. Default data attributes in the response are:\n\n   * html\n   * message\n   * to (used for redirects)\n\n Examples:\n\n   # Send a successful response with some html\n   render_js_message :ok, :html => \"<p>It worked!</p>\"\n\n   # Send a redirect\n   render_js_message :redirect, :to => \"http://www.google.com\"\n\n   # Send an error response with a message\n   render_js_message :error, :message => \"Something broke!\"\n\n Of course, if you don't need other data sent back in the response\n this works as well:\n\n   render_js_message :ok", "Return the `scaled_base` digit corresponding to a group of `base_scale` `exponent_base` digits", "Convert base `exponent_base` digits to base `scaled_base` digits\n the number of digits must be a multiple of base_scale", ".instance_var_name\n Execute the decorator.\n\n @param [Method] target_method\n   The decorated method, already bound to the receiver.\n\n   The `method_decorators` gem calls this `orig`, but I thought\n   `target_method` made more sense.\n\n @param [*] receiver\n   The object that will receive the call to `target`.\n\n   The `method_decorators` gem calls this `this`, but I thought `receiver`\n   made more sense.\n\n   It's just `target.receiver`, but the API is how it is.\n\n @param [Array] args\n   Any arguments the decorated method was called with.\n\n @param [Proc?] block\n   The block the decorated method was called with (if any).\n\n @return\n   Whatever `target_method` returns.", "Define a column", "Create a single user's kernel instance, remember to set OP or OPc before\n attempting to use the security functions.\n\n To change the algorithm variables as described in TS 35.206 subclass\n this Kernel class and modify `@c`, `@r` or `@kernel` after calling\n super. E.G.\n\n   class MyKernel < Kernel\n     def initialize(key)\n       super\n       @r = [10, 20, 30, 40, 50]\n     end\n   end\n\n When doing this, `@kernel` should be set to a 128-bit MAC function with\n the same API as `OpenSSL::Cipher`, if this is not the case, you may\n need to overload {#enc} as well to match the API.\n Set the Operator Variant Algorithm Configuration field.\n\n Either this or {#opc=} must be called before any of the security\n functions are evaluated.", "Removes any cache files that aren't needed anymore", "Reads in the cache fixture files to in-memory cache.", "Dumps out any cached items to disk.", "returns a hash of the different themes as a hash with the details kept in the theme.yml file", "retuns a hash of the template files within the current theme", "checks if the current theme being used actually exists. If not it will return an error message to the user", "Returns generic notifications if the flash data exists", "appends any extra menu items that are set in the applications configurations", "url includes any params - full url", "user likes a likeable\n\n example\n ===========\n\n \tuser.like(likeable)", "user unlike a likeable\n\n example\n ===========\n\n \tuser.unlike(likeable)", "It should return the selected birth assertion unless it is\n not set in which case it will return the first", "It should return the selected death assertion unless it is\n not set in which case it will return the first", "Select the mother for the summary view. This should be called on a Person record that\n contains a person id and version.\n\n Make sure you set both the mother and father before saving the person. Otherwise you will\n set a single parent as the summary.\n\n ====Params\n <tt>person_id</tt> - the person id of the mother that you would like to set as the summary\n\n ===Example\n   person = com.familytree_v2.person 'KWQS-BBR', :names => 'none', :genders => 'none', :events => 'none'\n   person.select_mother_summary('KWQS-BBQ')\n   person.select_father_summary('KWQS-BBT')\n   com.familytree_v2.save_person person\n\n This is the recommended approach, to start with a \"Version\" person (no names, genders, or events)", "Select the father for the summary view. This should be called on a Person record that\n contains a person id and version.\n\n Make sure you set both the mother and father before saving the person. Otherwise you will\n set a single parent as the summary.\n\n ====Params\n <tt>person_id</tt> - the person id of the father that you would like to set as the summary\n\n ===Example\n   person = com.familytree_v2.person 'KWQS-BBR', :names => 'none', :genders => 'none', :events => 'none'\n   person.select_father_summary('KWQS-BBQ')\n   person.select_mother_summary('KWQS-BBT')\n   com.familytree_v2.save_person person\n\n This is the recommended approach, to start with a \"Version\" person (no names, genders, or events)", "Select the spouse for the summary view. This should be called on a Person record that\n contains a person id and version.\n\n ====Params\n <tt>person_id</tt> - the person id of the spouse that you would like to set as the summary\n\n ===Example\n   person = com.familytree_v2.person 'KWQS-BBR', :names => 'none', :genders => 'none', :events => 'none'\n   person.select_spouse_summary('KWQS-BBQ')\n   com.familytree_v2.save_person person\n\n This is the recommended approach, to start with a \"Version\" person (no names, genders, or events)", "Add a sealing to parents ordinance\n\n ====Params\n * <tt>options</tt> - accepts a :date, :place, :temple, :mother, and :father option\n\n ====Example\n\n   person.add_sealing_to_parents :date => '14 Aug 2009', :temple => 'SGEOR', :place => 'Salt Lake City, Utah'", "only ordinance type is Sealing_to_Spouse", "Constructor. If IO object is given instead of filepath, uses\n it as native one and +mode+ argument is ignored.\n\n @param [String, IO, StringIO] filepath path to file or IO object\n @param [String] mode file access mode (see equivalent Ruby method)\n @param [Integer] rwsize size of block operated during one tick\n\n\n Reads data from file.\n\n It will reopen the file if +EBADF: Bad file descriptor+ of\n +File+ class IO object will occur.\n\n @overload read(length, &block)\n   Reads specified amount of data from file.\n   @param [Integer] length length for read from file\n   @param [Proc] filter filter which for postprocessing each\n       read chunk\n   @param [Proc] block callback for returning the result\n   @yield [String] read data\n @overload read(&block)\n   Reads whole content of file.\n   @param [Proc] filter filter which for processing each block\n   @param [Proc] block callback for returning the result\n   @yield [String] read data", "Writes data to file. Supports writing both strings or copying\n from another IO object. Returns length of written data to\n callback if filename given or current position of output\n string if IO used.\n\n It will reopen the file if +EBADF: Bad file descriptor+ of\n +File+ class IO object will occur on +File+ object.\n\n @param [String, IO, StringIO] data data for write or IO object\n @param [Proc] filter filter which for preprocessing each\n   written chunk\n @param [Proc] block callback called when finish and for giving\n   back the length of written data\n @yield [Integer] length of really written data", "Verify that all methods were called as expected. Raises\n +MockExpectationError+ if not called as expected.", "Returns an aggregated metric for a given type.\n\n @param [Symbol] task The key value of the task to retrieve\n @param [Symbol] type The metric to return.\n   Options are :avg, :min, :max, :first, :last, :sum, :all and :count.\n @return [Float, Integer, Array] Returns either the aggregation (Numeric) or an Array in the case of :all.", "Removes all history for a given task\n\n @param [Symbol] task The name of the task to clear history from.\n @return [NilClass] Returns nil", "Start a new timer for the referenced task. If a timer is already running for that task it will be stopped first.\n\n @param [Symbol] task The name of the task to start.\n @return [Integer] Returns 0", "Stop the referenced timer.\n\n @param [Symbol] task The name of the task to stop.\n @return [Float, NilClass] The amount of time the task had been running or nil if no matching task was found.", "Creates a file based on a '.example' version saved in the same folder\n Will optionally open the new file in the default editor after creation", "Looks for the specificed file and creates it if it does not exist", "Loads a strategy. Because the strategy files are loaded in\n the specified order, it's possible to override tasks.\n This is how inheritance of strategies is realized.\n\n @param strategy [Symbol] the strategy to load", "Defines a task\n\n @param name [Symbol] task name\n @param options [Hash] task options\n @param block [Block] the code to be executed when the task is started", "Defines a stage\n\n @param name [Symbol] stage name\n @param options [Hash] stage options\n @param block [Block] the stage configuration", "Dot product of two n-element arrays", "Cross product of two arrays of length 3", "Encode Russian UTF-8 string to XML Entities format,\n converting weird Unicode chars along the way", "display an debugging message to the logger, if there is one.\n @yield return a message or hash", "display an informational message to the logger, if there is one.\n @yield return a message or hash", "display an error message to the logger, if there is one.", "adds results under the subkey until pop is called", "Used internally to log the input parameters to a command", "Used internally to log the output parameters for a command.", "Merge Hash value with existing Hash value.\n\n merge!(val)\n merge!(key, val)\n merge!(key1, key2, val)\n merge!([key], val)\n merge!([key1, key2], val)", "Parses a message", "Sends a message of a specific type", "List resources required to be monitored\n\n @param [String] uri_prefix\n @return [Array of TriglavClient::ResourceEachResponse] array of resources\n @see TriglavClient::ResourceEachResponse", "By default, loops through all registered properties, and renders\n each that has been explicitly set.\n\n May be overridden.", "Compose an IRC protocol line.\n @param [IRCSupport::Line] line An IRC protocol line object\n   (as returned by {#decompose}).\n @return [String] An IRC protocol line.", "Parse an IRC protocol line into a complete message object.\n @param [String] raw_line An IRC protocol line.\n @return [IRCSupport::Message] A parsed message object.", "Build and send an initialization message.\n @note make sure +@connection.local_entry+ is sendable before calling this\n @return [void]", "Processes a initialization message from the remote endpoint.\n @param message [Messages::Initialization]\n @raise [ProtocolError] if a {LocalObject} does not exist with id received for the entry object\n @return [void]", "Run the callback only if we have not run it once before", "Creates a new Migrator from the given options.\n\n @param [{Symbol => Object}] opts the migration options\n @option opts [Class] :target the required target domain class\n @option opts [<String>, String] :mapping the required input field => caTissue attribute mapping file(s)\n @option opts [String, Migration::Reader] :input the required input file name or an adapter which\n   implements the {Migration::Reader} methods\n @option opts [<String>, String] :defaults the optional caTissue attribute => value default mapping file(s)\n @option opts [<String>, String] :filters the optional caTissue attribute input value => caTissue value filter file(s)\n @option opts [<String>, String] :shims the optional shim file(s) to load\n @option opts [String] :unique the optional flag which ensures that migrator calls the +uniquify+ method on\n   those migrated objects whose class includes the +Unique+ module\n @option opts [String] :create the optional flag indicating that existing target objects are ignored\n @option opts [String] :bad the optional invalid record file\n @option opts [String, IO] :extract the optional extract file or object that responds to +<<+\n @option opts [<String>] :extract_headers the optional extract CSV field headers\n @option opts [Integer] :from the optional starting source record number to process\n @option opts [Integer] :to the optional ending source record number to process\n @option opts [Boolean] :quiet the optional flag which suppress output messages\n @option opts [Boolean] :verbose the optional flag to print the migration progress\n Imports this migrator's CSV file and calls the given block on each migrated target\n domain object. If no block is given, then this method returns an array of the\n migrated target objects.\n\n @yield [target, row] operates on the migration target\n @yieldparam [Resource] target the migrated target domain object\n @yieldparam [{Symbol => Object}] row the migration source record", "Cleans up after the migration by removing the methods injected by migration\n shims.", "Loads the shim files.\n\n @param [<String>, String] files the file or file array", "Migrates all rows in the input.\n\n @yield (see #migrate)\n @yieldparam (see #migrate)", "Makes the rejects CSV output file.\n\n @param [String] file the output file\n @return [IO] the reject stream", "Imports the given CSV row into a target object.\n\n @param [{Symbol => Object}] row the input row field => value hash\n @return the migrated target object if the migration is valid, nil otherwise", "Sets the migration references for each valid migrated object.\n\n @param row (see \u0010#migrate_row)\n @param [Array] migrated the migrated objects\n @return [Array] the valid migrated objects", "Creates an instance of the given klass from the given row.\n The new klass instance and all intermediate migrated instances are added to the\n created set.\n\n @param [Class] klass\n @param [{Symbol => Object}] row the input row\n @param [<Resource>] created the migrated instances for this row\n @return [Resource] the new instance", "Migrates each input field to the associated domain object attribute.\n String input values are stripped. Missing input values are ignored.\n\n @param [Resource] the migration object\n @param row (see #create)\n @param [<Resource>] created (see #create)", "Fills the given reference Property path starting at obj.\n\n @param row (see #create)\n @param created (see #create)\n @return the last domain object in the path", "Sets the given migrated object's reference attribute to a new referenced domain object.\n\n @param [Resource] obj the domain object being migrated\n @param [Property] property the property being migrated\n @param row (see #create)\n @param created (see #create)\n @return the new object", "Loads the defaults configuration files.\n\n @param [<String>, String] files the file or file array to load\n @return [<Class => <String => Object>>] the class => path => default value entries", "Loads the defaults config file into the given hash.\n\n @param [String] file the file to load\n @param [<Class => <String => Object>>] hash the class => path => default value entries", "Loads the filter config files.\n\n @param [<String>, String] files the file or file array to load\n @return [<Class => <String => Object>>] the class => path => default value entries", "Loads the filter config file into the given hash.\n\n @param [String] file the file to load\n @param [<Class => <String => <Object => Object>>>] hash the class => path => input value => caTissue value entries", "Create new chat room\n\n @param name [String] Name of chat room\n @param members_admin_ids [Array<Integer>]\n   Array of member ID that want to admin authority\n @param params [Hash] Hash of optional parameter\n @option params [String] :description (nil) Summary of chat room\n @option params [Symbol] :icon_preset (nil) Kind of Icon of chat room\n   (group, check, document, meeting, event, project, business, study,\n   security, star, idea, heart, magcup, beer, music, sports, travel)\n @option params [Array<Integer>] :members_member_ids (nil)\n   Array of member ID that want to member authority\n @option params [Array<Integer>] :members_readonly_ids (nil)\n   Array of member ID that want to read only\n @return [Hashie::Mash]", "Update chat room members\n\n @param room_id [Integer] ID of chat room\n @param members_admin_ids [Array<Integer>]\n   Array of member ID that want to admin authority\n @param params [Hash] Hash of optional parameter\n @option params [Array<Integer>] :members_member_ids (nil)\n   Array of member ID that want to member authority\n @option params [Array<Integer>] :members_readonly_ids (nil)\n   Array of member ID that want to read only\n @return [Hahsie::Mash]", "Create new task of chat room\n\n @param room_id [Integer] ID of chat room\n @param body [String] Contents of task\n @param to_ids [Array<Integer>] Array of account ID of person in charge\n @param params [Hash] Hash of optional parameter\n @option params [Integer, Time] :limit (nil) Deadline of task (unix time)\n @return [Hashie::Mash]", "Get file information\n\n @param room_id [Integer] ID of chat room\n @param file_id [Integer] ID of file\n @param params [Hash] Hash of optional parameter\n @option params [Boolean] :create_download_url (false)\n   Create URL for download", "Calculate easter sunday for the given year", "Converts an options-style nested array into a hash\n for easy name lookup\n @param [Array] a an array like [['name', 'val']]\n @return [Hash] a hash like { val => name }", "Reads orders from `filename` that date back to max `months` months.\n\n @param filename [String]       The filename to read from\n @param months   [Integer, nil] Number of months look back or nil for all", "Calculates prices according to given strategy.\n\n @param strategy [String] Strategy name\n @param halffare [true, false] True if tickets were bought with a halffare card", "Sets the block to call when data is received.\n\n If no block is provided, then the shell will simply log all output from the program.\n If a block is provided, it will be passed the data as it is received.  If the block\n returns a string, then that string will be sent to the shell.\n\n This method is called internally in the +exec+ method, but there may be legitimate use\n cases outside of that method as well.", "Pushes the buffers for output capture.\n\n This method is called internally in the +exec+ method, but there may be legitimate use\n cases outside of that method as well.", "Pops the buffers and merges the captured output.\n\n This method is called internally in the +exec+ method, but there may be legitimate use\n cases outside of that method as well.", "Pops the buffers and discards the captured output.\n\n This method is used internally in the +get_exit_code+ method, but there may be legitimate use\n cases outside of that method as well.", "Calls the block resolving the parameters by getting the parameter name from the\n given context.\n\n === Example\n\n   context = :max => 10, :curr => 5, ratio => 0.15\n   percentage = BlockHandler.call_block(context) { |max,curr| curr.to_f / max }", "Calls the added components by sending the configured message and the given args.", "Set the scriptSig for this input using a string of bytes.", "Append element to stacks and result tree\n\n @param [Symbol] type", "Attempts to clean the provided client, checking the options first for a clean block\n then checking the known clients", "Attempts to close the provided client, checking the options first for a close block\n then checking the known clients", "Attempts to determine if a client should be reaped, block should return a boolean", "Obtain the environment from command parameters or menu", "Obtain the default environment for a project", "Converte os arquivos de texto markdown para texto latex", "Precisa gerar arquivos com quebra de linha antes e depois\n porque pandoc utiliza", "end of intitialize", "Grabs the proper query operator from the string\n\n * *Args* :\n   - +part+ -> The query string\n * *Returns* :\n   - An array containing the supplied logical operator and the Montage\n     equivalent\n * *Examples* :\n    @part = \"tree_happiness_level > 9\"\n    get_query_operator(@part)\n    => [\">\", \"$gt\"]", "Parse a single portion of the query string.  String values representing\n a float or integer are coerced into actual numerical values.  Newline\n characters are removed and single quotes are replaced with double quotes\n\n * *Args* :\n   - +part+ -> The value element extracted from the query string\n * *Returns* :\n   - A parsed form of the value element\n * *Examples* :\n    @part = \"9\"\n    parse_part(@part)\n    => 9", "Get all the parts of the query string\n\n * *Args* :\n   - +str+ -> The query string\n * *Returns* :\n   - An array containing the column name, the montage operator, and the\n     value for comparison.\n * *Raises* :\n   - +QueryError+ -> When incomplete queries or queries without valid\n     operators are initialized\n * *Examples* :\n    @part = \"tree_happiness_level > 9\"\n    get_parts(@part)\n    => [\"tree_happiness_level\", \"$gt\", 9]", "Parse a hash type query\n\n * *Returns* :\n   - A ReQON compatible array\n * *Examples* :\n    @test = Montage::QueryParser.new(tree_status: \"happy\")\n    @test.parse_hash\n    => [[\"tree_status\", \"happy\"]]", "Parse a string type query.  Splits multiple conditions on case insensitive\n \"and\" strings that do not fall within single quotations. Note that the\n Montage equals operator is supplied as a blank string\n\n * *Returns* :\n   - A ReQON compatible array\n * *Examples* :\n    @test = Montage::QueryParser.new(\"tree_happiness_level > 9\")\n    @test.parse_string\n    => [[\"tree_happiness_level\", [\"$__gt\", 9]]]", "Takes a string value and splits it into an array\n Will coerce all values into the type of the first type\n\n * *Args* :\n   - +value+ -> A string value\n * *Returns* :\n   - A array form of the value argument\n * *Examples* :\n    @part = \"(1, 2, 3)\"\n    to_array(@part)\n    => [1, 2, 3]", "Tell a class that it's resources may be nested within another named resource\n\n parent_resource - A Symbol with the name of the parent resource.", "Wait to receive data from the client\n @param max_len  Maximum number of bytes to receive\n @returns        Received data (length <= max_len) or nil upon failure", "Validates attributes to determine if the values contain valid IP addresses.\n\n Set the :no_mask option to restrict the IP address to singular addresses only.", "override ARes method to parse only the client part", "Deep dup all the values.", "Create a default message if none was provided.\n\n Uses whatever recognized {#context} values are present, falling back\n to {NicerError#default_message} if none are.\n\n @return [String]", "Return json payload\n\n +text+:: Text you want to send\n +options+:: Options you want on payload\n +env+:: Environments :prod, :dev\n +type+:: Notification type :normal, :silent, :nosound", "Subscribe an AMQP queue to an AMQP exchange\n Do not wait for confirmation from broker that subscription is complete\n When a message is received, acknowledge, unserialize, and log it as specified\n If the message is unserialized and it is not of the right type, it is dropped after logging an error\n\n === Parameters\n queue(Hash):: AMQP queue being subscribed with keys :name and :options,\n   which are the standard AMQP ones plus\n     :no_declare(Boolean):: Whether to skip declaring this queue on the broker\n       to cause its creation; for use when caller does not have permission to create or\n       knows the queue already exists and wants to avoid declare overhead\n exchange(Hash|nil):: AMQP exchange to subscribe to with keys :type, :name, and :options,\n   nil means use empty exchange by directly subscribing to queue; the :options are the\n   standard AMQP ones plus\n     :no_declare(Boolean):: Whether to skip declaring this exchange on the broker\n       to cause its creation; for use when caller does not have create permission or\n       knows the exchange already exists and wants to avoid declare overhead\n options(Hash):: Subscribe options:\n   :ack(Boolean):: Whether caller takes responsibility for explicitly acknowledging each\n     message received, defaults to implicit acknowledgement in AMQP as part of message receipt\n   :no_unserialize(Boolean):: Do not unserialize message, this is an escape for special\n     situations like enrollment, also implicitly disables receive filtering and logging;\n     this option is implicitly invoked if initialize without a serializer\n   (packet class)(Array(Symbol)):: Filters to be applied in to_s when logging packet to :info,\n     only packet classes specified are accepted, others are not processed but are logged with error\n   :category(String):: Packet category description to be used in error messages\n   :log_data(String):: Additional data to display at end of log entry\n   :no_log(Boolean):: Disable receive logging unless debug level\n   :exchange2(Hash):: Additional exchange to which same queue is to be bound\n   :brokers(Array):: Identity of brokers for which to subscribe, defaults to all usable if nil or empty\n   :fiber_pool(FiberPool):: Pool of initialized fibers to be used for asynchronous message\n     processing (non-nil value will override constructor option setting)\n\n === Block\n Required block with following parameters to be called each time exchange matches a message to the queue\n   identity(String):: Serialized identity of broker delivering the message\n   message(Packet|String):: Message received, which is unserialized unless :no_unserialize was specified\n   header(AMQP::Protocol::Header):: Message header (optional block parameter)\n\n === Raise\n ArgumentError:: If a block is not supplied\n\n === Return\n (Boolean):: true if subscribe successfully or if already subscribed, otherwise false", "Unsubscribe from the specified queues\n Silently ignore unknown queues\n\n === Parameters\n queue_names(Array):: Names of queues previously subscribed to\n\n === Block\n Optional block to be called with no parameters when each unsubscribe completes\n\n === Return\n true:: Always return true", "Check status of specified queues\n Silently ignore unknown queues\n If a queue whose status is being checked does not exist in the broker,\n this broker connection will fail and become unusable\n\n === Parameters\n queue_names(Array):: Names of queues previously subscribed to\n\n === Block\n Optional block to be called each time that status for a queue is retrieved with\n parameters queue name, message count, and consumer count; the counts are nil\n if there was a failure while trying to retrieve them; the block is not called\n for queues to which this client is not currently subscribed\n\n === Return\n (Boolean):: true if connected, otherwise false, in which case block never gets called", "Publish message to AMQP exchange\n\n === Parameters\n exchange(Hash):: AMQP exchange to subscribe to with keys :type, :name, and :options,\n   which are the standard AMQP ones plus\n     :no_declare(Boolean):: Whether to skip declaring this exchange or queue on the broker\n       to cause its creation; for use when caller does not have create permission or\n       knows the object already exists and wants to avoid declare overhead\n     :declare(Boolean):: Whether to delete this exchange or queue from the AMQP cache\n       to force it to be declared on the broker and thus be created if it does not exist\n packet(Packet):: Message to serialize and publish (must respond to :to_s(log_filter,\n   protocol_version) unless :no_serialize specified; if responds to :type, :from, :token,\n   and/or :one_way, these value are used if this message is returned as non-deliverable)\n message(String):: Serialized message to be published\n options(Hash):: Publish options -- standard AMQP ones plus\n   :no_serialize(Boolean):: Do not serialize packet because it is already serialized\n   :log_filter(Array(Symbol)):: Filters to be applied in to_s when logging packet to :info\n   :log_data(String):: Additional data to display at end of log entry\n   :no_log(Boolean):: Disable publish logging unless debug level\n\n === Return\n (Boolean):: true if publish successfully, otherwise false", "Close broker connection\n\n === Parameters\n propagate(Boolean):: Whether to propagate connection status updates, defaults to true\n normal(Boolean):: Whether this is a normal close vs. a failed connection, defaults to true\n log(Boolean):: Whether to log that closing, defaults to true\n\n === Block\n Optional block with no parameters to be called after connection closed\n\n === Return\n true:: Always return true", "Connect to broker and register for status updates\n Also set prefetch value if specified and setup for message returns\n\n === Parameters\n address(Hash):: Broker address\n   :host(String:: IP host name or address\n   :port(Integer):: TCP port number for individual broker\n   :index(String):: Unique index for broker within given set for use in forming alias\n reconnect_interval(Integer):: Number of seconds between reconnect attempts\n\n === Return\n true:: Always return true", "Receive message by optionally unserializing it, passing it to the callback, and optionally\n acknowledging it\n\n === Parameters\n queue(String):: Name of queue\n header(AMQP::Protocol::Header):: Message header\n message(String):: Serialized packet\n options(Hash):: Subscribe options\n   :ack(Boolean):: Whether caller takes responsibility for explicitly acknowledging each\n     message received, defaults to implicit acknowledgement in AMQP as part of message receipt\n   :no_unserialize(Boolean):: Do not unserialize message, this is an escape for special\n     situations like enrollment, also implicitly disables receive filtering and logging;\n     this option is implicitly invoked if initialize without a serializer\n\n === Block\n Block with following parameters to be called with received message\n   identity(String):: Serialized identity of broker delivering the message\n   message(Packet|String):: Message received, which is unserialized unless :no_unserialize was specified\n   header(AMQP::Protocol::Header):: Message header (optional block parameter)\n\n === Return\n true:: Always return true", "Unserialize message, check that it is an acceptable type, and log it\n\n === Parameters\n queue(String):: Name of queue\n message(String):: Serialized packet\n options(Hash):: Subscribe options\n   (packet class)(Array(Symbol)):: Filters to be applied in to_s when logging packet to :info,\n     only packet classes specified are accepted, others are not processed but are logged with error\n   :category(String):: Packet category description to be used in error messages\n   :log_data(String):: Additional data to display at end of log entry\n   :no_log(Boolean):: Disable receive logging unless debug level\n\n === Return\n (Packet|nil):: Unserialized packet or nil if not of right type or if there is an exception", "Handle message returned by broker because it could not deliver it\n\n === Parameters\n header(AMQP::Protocol::Header):: Message header\n message(String):: Serialized packet\n\n === Return\n true:: Always return true", "Execute packet receive callback, make it a separate method to ease instrumentation\n\n === Parameters\n callback(Proc):: Proc to run\n args(Array):: Array of pass-through arguments\n\n === Return\n (Object):: Callback return value", "Verifies the given value is that of a successful HTTP response.\n\n\n @param response [Net::HTTPResponse]\n   The response to evaluate as \"successful\" or not.\n\n\n @raise [Crapi::BadHttpResponseError]\n\n @return [nil]", "Serializes the given payload per the requested content-type.\n\n\n @param payload [Hash, String]\n   The payload to format. Strings are returned as-is; Hashes are serialized per the given *as*\n   content-type.\n\n @param as [String]\n   The target content-type.\n\n\n @return [String]", "Parses the given response as its claimed content-type.\n\n\n @param response [Net::HTTPResponse]\n   The response whose body is to be parsed.\n\n\n @return [Object]", "Prints this classifier's content to the log.", "Perform a threaded iteration across all connections in the climber's\n connection pool. This method cannot be used for enumerable enumeration\n because a break called within one of the threads will cause a LocalJumpError.\n This could be fixed, but expected behavior on break varies as to whether\n or not to wait for all threads before returning a result. However, still\n useful for operations that always visit all elements.\n An instance of the element is yielded with each iteration.\n\n   jobs = ClimberEnumerable.new(:each_job)\n   instance = jobs.new(climber)\n   instance.each_threaded do |job|\n     ...\n   end", "Returns a temporary url to the object that expires on the\n timestamp given. Defaults to 5min expire time.", "inversion of control method required by the AuditorAPI to validate the configuration", "Determines if this group belongs to the specified group.", "Gets a list of all the groups this group provides effective membership to.", "Sets the user IDs for the members of this group.", "Set up the Konfig system\n @param [String] path the path to the directory containing config files", "Encrypt the given string using the AES-256-CBC algorithm.\n\n @param [String] plain_text\n   The text to encrypt.\n\n @param [String] password\n   Secret passphrase to encrypt with.\n\n @param [String] salt\n   A cryptographically secure pseudo-random string (SecureRandom.base64)\n   to add a little spice to your encryption.\n\n @return [String]\n   Encrypted text, can be deciphered with #decrypt.\n\n @api public", "Generate the hiera data template for the environment", "Define a path, whose occurrences in the output should be replaced by\n either its basename or a given placeholder.\n\n @param  [String] path\n         The path\n\n @param  [String] name\n         The name of the path, or the basename of the given path", "Run the command.\n\n @param  [String] command_line\n         THe command line to execute\n\n @return [[String, Process::Status]]\n         The output, which is emitted during execution, and the exit status.", "Merges the given with the configured arguments and returns the command\n line to execute.\n\n @param  [String] head_arguments\n         The arguments to pass to the executable before the default arguments.\n\n @param  [String] tail_arguments\n         The arguments to pass to the executable after the default arguments.\n\n @return [String]\n         The command line to execute.", "Apply the configured replacements to the output.\n\n @param  [String] output\n         The output, which was emitted while execution.\n\n @return [String]\n         The redacted output.", "Retrieves translation from the storage or return default value.\n\n @return [String] translation or default value if nothing found\n\n @example\n   translator.put(en: {hello: \"world\"})\n   translator.get(\"hello\", :en) #=> \"world\"\n   translator.get(\"bye\", :en) #=> \"\"\n\n @example Providing the default if nothing found\n   translator.get(\"hello\", :de, default: \"nothing\") #=> \"nothing\"\n\n @overload get(key, locale, opts = {})\n   @param key [String, Symbol]\n   @param locale [String, Symbol]\n\n @overload get(keys, locale, opts = {})\n   @param keys [Array<String, Symbol>] use this to redefine an array returned\n     by {#keys_to_try}.\n   @param locale [String, Symbol]\n\n   @example\n     translator.put(en: {fail: \"Fail\"})\n     translator.get([\"big.fail\", \"mine.fail\"], :en) #=> \"\"; tried \"en.big.fail\", then \"en.mine.fail\"\n\n @overload get(key, locales, opts = {})\n   @param key [String, Symbol]\n   @param locales [Array<String, Symbol>] use this to redefine an array returned\n     by {#locales_to_try}.\n\n   @example\n     translator.put(en: {hello: \"world\"})\n     translator.get(:hello, :de) #=> \"\"; tried only \"de.hello\"\n     translator.get(:hello, [:de, :en]) #=> \"world\"; tried \"de.hello\", then \"en.hello\"\n\n   @example Disable locale fallbacks locally\n     translator.put(en: {hello: \"world\"}) # suppose this instance has fallback to :en locale\n     translator.get(:hello, :de) #=> \"world\"; tried \"de.hello\", then \"en.hello\"\n     translator.get(:hello, [:de]) #=> \"\"; tried only \"de.hello\"\n\n @overload get(keys, locales, opts = {})\n   @param keys [Array<String, Symbol>]\n   @param locales [Array<String, Symbol>]\n\n   @note Keys fallback has a higher priority than locales one, that is, Mova\n     tries to find a translation for any given key and only then it fallbacks\n     to another locale.\n\n @param opts [Hash]\n @option opts [String] :default use this to redefine default value returned\n   by {#default}.\n\n @see #locales_to_try\n @see #keys_to_try\n @see #default", "Writes translations to the storage.\n\n @return [void]\n @param translations [Hash{String, Symbol => String, Hash}] where\n   root key/keys must be a locale\n\n @example\n   translator.put(en: {world: \"world\"}, uk: {world: \"\u0441\u0432\u0456\u0442\"})\n   translator.get(\"world\", :uk) #=> \"\u0441\u0432\u0456\u0442\"", "same as original, but don't call .target! on custom builder", "Multiply complex values\n\n @param [Object] Second operand for binary operation.\n\n @return [InternalComplex] The result\n\n @private", "Divide complex values\n\n @param [Object] Second operand for binary operation.\n\n @return [InternalComplex] The result\n\n @private", "Constructor for native complex number\n\n @param [Complex,InternalComplex] value Complex number.\n Duplicate object\n\n @return [COMPLEX_] Duplicate of +self+.\n Store new value in this object\n\n @param [Object] value New value for this object.\n\n @return [Object] Returns +value+.\n\n @private", "Fast extraction for real values of complex array\n\n @return [Node] Array with real values.", "Assignment for real values of complex array\n\n @param [Object] Value or array of values to assign to real components.\n\n @return [Object] Returns +value+.", "Fast extraction of imaginary values of complex array\n\n @return [Node] Array with imaginary values.", "Only set the BALANCER_PROFILE if not set already at the CLI. CLI takes\n highest precedence.", "Iniciar los punteros de la lista, inicio y final\n Metodo para imprimir la lista con formato\n @return la lista formateada en un string", "Metodo que nos permite insertar algo al inicio de la lista\n @param [val] val recibe el valor a insertar en la lista", "Metodo que nos permite insertar algo al final de la lista\n @param [val] val recibe el valor a insertar en la lista", "Metodo que nos devuelve la cantidad de elementos en la lista\n @return cantidad de elementos en la lista", "Metodo que devuelve lo contenido en una posicion de la lista\n @param [pos] pos del elemento deseado\n @return nodo de la posicion de la lista", "Metodo que nos ordenada la lista segun los criterios de la APA", "Heavily modified from SearchLogic.", "Constructs and executes DELETE statement for given query\n\n @param [Collection] collection\n   collection of records to be deleted\n\n @return [Integer]\n   the number of records deleted\n\n @api semipublic", "Accepts hash of fields to send.\n Returns parsed response body, always a hash.", "Initialises a new UserLookup instance\n @see (Hash#initialize)\n @param filename [String] the filename of the CSV file to populate the hash\n @return [void]\n Returns an Aspire::Object::User instance for a URI\n @param uri [String] the URI of the user\n @param factory [Aspire::Object::Factory] the data object factory\n @return [Aspire::Object::User] the user", "Populates the store from an All User Profiles report CSV file\n @param filename [String] the filename of the CSV file\n @return [void]", "Proxies missing methods to the store\n @param method [Symbol] the method name\n @param args [Array] the method arguments\n @param block [Proc] the code block\n @return [Object] the store method result", "Adds CSV fields which mirror the Aspire user profile JSON API fields\n @param row [Array] the fields from the All User Profiles report CSV\n @param data [Hash] the JSON representation of the user profile\n @return [Hash] the JSON data hash", "Adds CSV fields which aren't part of the Aspire user profile JSON API\n @param row [Array] the fields from the All User Profiles report CSV\n @param data [Hash] the JSON representation of the user profile\n @return [Hash] the JSON data hash", "Cluster ID number\n instance method", "merge order is = defaults, template, custom", "Add a new cache\n\n @param [Symbol] cache\n   the cache to be created\n\n @param [Symbol] strategy\n   the cache strategy to be used", "Returns an uncolored version of the string, that is all\n ANSI-sequences are stripped from the string.", "Pass the current value to the given block, replacing it with the block's\n result. Raise an exception if the update fails.\n\n @yield [Object]\n   Calculate a new value for the atomic reference using given (old) value.\n @yieldparam [Object] old_value\n   The starting value of the atomic reference.\n\n @raise [Garcon::ConcurrentUpdateError]\n   If the update fails\n\n @return [Object] the new value", "Atomically sets the value to the given updated value if the current value\n is equal the expected value.\n\n @param [Object] old_value\n   The expected value.\n @param [Object] new_value\n   The new value.\n\n @return [Boolean]\n   `true` if successful, `false` indicates that the actual value was not\n   equal to the expected value.", "Fulfill this promise with an optional value. The value will be stored in\n the deferred and passed along to any registered `done` callbacks.\n\n When fulfilling a deferred twice, nothing happens.\n\n @raise [CannotTransitionError] when it was already fulfilled.\n @return [Deferred] self", "Reject this promise with an optional reason. The reason will be stored in\n the deferred and passed along to any registered `fail` callbacks.\n\n When rejecting a deferred twice, nothing happens.\n\n @raise [CannotTransitionError] when it was already fulfilled.\n @return [Deferred] self", "Register a callback to be run when the deferred is rejected.\n\n @yieldparam [Object] reason\n @return [Promise] a new promise representing the return value\n   of the callback, or -- when that return value is a promise itself\n   -- a promise mimicking that promise.", "Register a callback to be run when the deferred is resolved.\n\n @yieldparam [Object] value\n @yieldparam [Object] reason\n @return [Promise] a new promise representing the return value\n   of the callback, or -- when that return value is a promise itself\n   -- a promise mimicking that promise.", "Fetch a component from within this component\n @TODO Make this operate within the scope\n @TODO Pass the scope on to any found instances\n @param [String|Symbol] ctype The component alias to find\n @param [Any] args Any further arguments are passed on to the instance of the component\n @return [CapybaraObjects::ComponentObject] An instance inheriting from the component object", "clean up errors that are older than time_window_in_secons", "Stores an object in the surrounding example's metadata, which can be used\n by the output formatter as an illustration for the example.\n @param content The object that will act as an illustration.\n @param args [Array<Hash, Symbol>] Additional options.\n @return The given illustration object.", "Register a observer for a given signal.\n\n Instead of adding a method or Proc object to the stack, you could\n also use a block. Either the observer argument or the block is required.\n\n Optionally, you could pass in an options hash as the last argument, that\n can specify an explicit priority. When omitted, an internal counter starting\n from 1 will be used. To make sure your observer is called last, specify\n a high, **positive** number. To make sure your observer is called first, specify\n a high, **negative** number.\n\n @example Using a block as an observer\n   dispatcher.connect('post.publish') do |event|\n     puts \"Post was published\"\n   end\n\n @example Using a method as an observer\n   class Reporter\n     def log(event)\n       puts \"Post published\"\n     end\n   end\n   dispatcher.connect('post.publish', Reporter.new.method(:log))\n\n @example Determining observer call order using priority\n   dispatcher.connect('pulp', :priority => 10) do\n     puts \"I dare you!\"\n   end\n   dispatcher.connect('pulp', :priority => -10) do\n     puts \"I double-dare you!\"\n   end\n   # output when \"pulp\" is triggered:\n   \"I double-dare you!\"\n   \"I dare you!\"\n\n @overload connect(signal, observer, options = {})\n   @param [String] signal is the name used by the observable to trigger\n     observers\n   @param [#call] observer is the Proc or method that will react to\n     an event issued by an observable.\n   @param [Hash] options is an optional Hash of additional options.\n   @option options [Fixnum] :priority is the priority of this observer\n     in the stack of all observers for this signal. A higher number means\n     lower priority. Negative numbers are allowed.\n @overload connect(signal, options = {}, &block)\n   @param [String] signal is the name used by the observable to trigger\n     observers\n   @param [Hash] options is an optional Hash of additional options.\n   @option options [Fixnum] :priority is the priority of this observer\n     in the stack of all observers for this signal. A higher number means\n     lower priority. Negative numbers are allowed.\n @return [#call] the added observer", "Removes an observer from a signal stack, so it no longer gets triggered.\n\n @param [String] signal is the name of the stack to remove the observer\n   from.\n @param [#call] observer is the original observer to remove.\n @return [#call, nil] the removed observer or nil if it could not be found", "Construct GCC type\n\n @param [Class] typecode Native type (e.g. +UBYTE+).\n\n @private\n Get C identifier for native type\n\n @return [String] String with valid C syntax to declare type.\n\n @private", "Get array of C identifiers for native type\n\n @return [Array<String>] Array of C declarations for the elements of the type.\n\n @private", "Get code for converting Ruby VALUE to C value\n\n This method returns a nameless function. The nameless function is used for\n getting the code to convert a given parameter to a C value of this type.\n\n @return [Proc] Nameless function accepting a C expression to be converted.\n\n @private", "Sets initial weights\n\n Accepts Hash as an argument, where keys are items and corresponding values\n are their weights (positive integers).\n\n @param [Hash] weights\n Add item with weight\n\n @param [Object] item\n @param [Integer] weight", "Extract item based on weights distribution\n\n @return [Object]", "Direct entries in this HostGroup's hostlist attribute", "A recursive listing of all hosts associated with this HostGroup", "Extracts and returns the first provable DateTime from a string", "The Format at _idx_, or - if _idx_ is a String -\n the Format with name == _idx_", "Execute a block next.\n If no other thread is executing a block, the block will be executed immediately.\n If another thread is executing a block, add the thread to the front of the queue and executes\n the block when the current thread has finished its block.\n @note if multiple threads are queued via this method their order is undefined\n @yield [] executed when permitted\n @raise [Exception] anything raised in block\n @return [Object] return value from block", "Expands the variable-in-file-name notation.", "Looks for the first occurrence of program within path.\n\n @param [String] cmd\n   The name of the command to find.\n\n @param [String] path\n   The path to search for the command.\n\n @return [String, NilClass]\n\n @api public", "In block form, yields each program within path. In non-block form,\n returns an array of each program within path. Returns nil if not found\n found.\n\n @example\n   whereis('ruby')\n     # => [\n         [0] \"/opt/chefdk/embedded/bin/ruby\",\n         [1] \"/usr/bin/ruby\",\n         [2] \"/Users/sharding/.rvm/rubies/ruby-2.2.0/bin/ruby\",\n         [3] \"/usr/bin/ruby\"\n     ]\n\n @param [String] cmd\n   The name of the command to find.\n\n @param [String] path\n   The path to search for the command.\n\n @return [String, Array, NilClass]\n\n @api public", "Returns an RDFSource represented by the resource URI.\n @param [String, #to_s] resource_uri URI to request\n @return [RDF::Graph] The resulting graph", "Deletes a subject from the context.\n @param [String, #to_s] resource_uri URI of resource to delete.\n @return [True, False] Result of deleting.\n @todo Should this only delete triples from the given context?", "Gets the email address in a partially obfuscated fashion.", "Gets the effective group membership of this user.", "Does this user have the equivalent of one or more of these groups?", "Generates a remember token and saves the digest to the user model.", "Determines if the supplied token digests to the stored digest in the user model.", "Disables the user.\n\n The +other_user+ is required, cannot be the current user, and must be a system administrator.\n The +reason+ is technically optional, but should be provided.", "Creates a reset token and stores the digest to the user model.", "Gets the failed logins for a user since the last successful login.", "Add hook. In all hook whill be passed +self+\n @raise [ArgumentError] if invalid hook name or not block given\n @param hook [Symbol] hook name", "Make new empty infobase\n wrpped in +before_make+ and +after_make+ hooks\n @raise [MethodDenied] if infobase {#read_only?}", "Remove infobase\n wrpped in +before_rm+ and +after_rm+ hooks\n @raise [MethodDenied] if infobase {#read_only?}", "Dump infobase to +.dt+ file", "Restore infobase from +.dt+ file\n @raise [MethodDenied] if {#read_only?}", "Create a new memoized method. To use, extend class with Memoizable,\n then, in initialize, call memoize\n\n @return [undefined]", "Initialize a new Nucleon environment\n\n IMORTANT:  The environment constructor should accept no parameters!\n\n * *Parameters*\n   - [String, Symbol] *actor_id*  Name of the plugin manager\n   - [Boolean] *reset*  Whether or not to reinitialize the manager\n\n * *Returns*\n   - [Void]  This method does not return a value\n\n * *Errors*\n\n See also:\n - Nucleon::Facade#logger\n - Nucleon::Environment\n\n Perform any cleanup operations during manager shutdown\n\n This only runs when in parallel mode.\n\n * *Parameters*\n\n * *Returns*\n   - [Void]  This method does not return a value\n\n * *Errors*\n\n See also:\n - #active_plugins\n - #remove", "Define a new plugin provider of a specified plugin type.\n\n * *Parameters*\n   - [String, Symbol] *namespace*  Namespace that contains plugin types\n   - [String, Symbol] *plugin_type*  Plugin type name to fetch default provider\n   - [String] *base_path*  Base load path of the plugin provider\n   - [String] *file*  File that contains the provider definition\n\n * *Returns*\n   - [Nucleon::Manager, Celluloid::Actor]  Returns reference to self for compound operations\n\n * *Errors*\n\n * *Yields*\n   - [Hash<Symbol|ANY>] *data*  Plugin load information\n\n See:\n - Nucleon::Environment#define_plugin", "This method will only authenticate once, and cache the result.\n\n @return self", "Set the ttl for access token.", "takes a controller\n builds the lines to be put into the file", "add or replace node by full key", "Decode a message from an IRC connection, modifying it in place.\n @param [String] string The IRC string you want to decode.\n @param [Symbol] encoding The source encoding.\n @return [String] A UTF-8 Ruby string.", "Encode a message to be sent over an IRC connection, modifying it in place.\n @param [String] string The string you want to encode.\n @param [Symbol] encoding The target encoding.\n @return [String] A string encoded in the encoding you specified.", "Fetch this message from the server and update all its attributes", "Append this message to the remote mailbox", "Uses IMAP's COPY command to copy the message into the named mailbox", "S E R V I C E  M E T H O D S\n Render templates.", "Authorizations below here", "thePi is Pi in ANS-5.1-1979.", "theU235_alpha is alpha in ANS-5.1-1979 Table 7.", "theU235_lamda is lamda in ANS-5.1-1979 Table 7.", "thePu239_alpha is alpha in ANS-5.1-1979 Table 8.", "thePu239_lamda is lamda in ANS-5.1-1979 Table 8.", "theU238_alpha is alpha in ANS-5.1-1979 Table 9.", "theU238_lamda is lamda in ANS-5.1-1979 Table 9.", "Run a Rockit configuration file and Rails dependency checks\n unless turned off by configuration.", "If the digest of the input is different from the stored key, execute the block.", "If the digest of the file is different from the stored digest, execute the block.", "Execute the given block if the input is different from\n the output .\n\n key - the key to lookup the stored hash value\n new_value - the value to compare with the stored hash value\n block - block to execute if the hash value does not match the stored hash value\n\n return if the block was not executed, false, if it is executed, the return\n         status of the block", "Run system commands and if not successful exit and print out an error\n message. Default behavior is to print output of a command when it does\n not return success.\n\n command - the system command you want to execute\n options - 'error_message' - a message to print when command is not successful\n           'print_command' - displays the command being run\n           'failure_callback' - Proc to execute when the command fails. If a callback returns\n             true then it will avoid\n           'on_success' - Proc to execute when the command is successful\n\n returns only true, will perform exit() when not successful", "Tries to find file with name, if no file could be found or there are multiple files matching the name error is\n raised\n\n @param [String] name  name of the file that should be found\n @param [String] reference_path  path to file from which is loading/finding\n\n @return [String, nil] returns nil when this file should be skipped otherwise absolute path to file", "Compares the object with another metadata object\n Return true if they are for the same table", "Writes Json to file using echo\n file is written to remote server via SSH\n Echo is used for writing the file", "Returns a copy of self with nil-values appended for empty cells that have\n an associated Format.\n This is primarily a helper-function for the writer classes.", "assumes local_path is defined", "assumes remote_path is defined", "don't use this if you don't have to!", "Shortcut method to deliver a single message", "begin listening for all topics in publish.", "Tries to either get rate or calculate the inverse rate from cache.\n\n First looks for an \"usd_eur_25-8-2010\" entry in the cache,\n and if it does not find it, it looks for \"eur_usd_25-8-2010\" and\n inverts it.", "Allows acts_as_list methods to be used within the warning.\n  If closers were the act_as_list object, you could do things like this\n\n       warning.closers.last.move_higher\n\n   However, as closers are used on multiple warnings and they\n   need to be independently sortable within each warning, it is the\n   through table model WarningCloser that acts_as_list. To change\n   position the change must be made in the context of the warning.\n   pass_method_to_warning_closer in combination with method_missing,\n   allows you to pass to a warning the acts_as_list method together with\n   the closer it needs to effect. The equivalent move_higher call then becomes:\n\n       warning.move_higher(warning.closers.last)\n\n   You can also do:\n\n       warning.move_to_top(closer)\n       warning.last?(closer)", "Find a node down the hierarchy with content\n @param [Object,Regexp] content of searched node\n @return [Object, nil] nil if not found", "Returns an array of character sets from this header that match the given\n +charset+, ordered by precedence.", "Given a container uuid, or biblographic uuid, returns a\n list of mods uuids.", "get the item detail from a uuid", "get bibliographic container uuid from an image_id", "get highreslink from an item, matching up the image idi\nsince some bibliographic items may have many maps under them", "Assign attributes from the given hash\n\n @param [Hash<[Symbol, String] => Any>] new_attributes\n @param [Hash] options\n @return [void]", "Find customer by twinfield customer code", "Find customer by name", "The request for getting all elements in a Twinfield dimension", "Express an emotion towards another record\n\n @example\n   user = User.first\n   picture = Picture.first\n   user.express! :happy, picture", "No longer express an emotion towards another record\n\n @example\n   user = User.first\n   picture = Picture.first\n   user.no_longer_express! :happy, picture", "add entry to this catalog\n @private", "Parse the title from a Favstar RSS title.\n\n   title - a Favstar-formatted String (x stars: title here)\n\n This splits on the first colon, and then use everything after that. To\n account for tweets with colons in them, we have to strip the first \": \"\n String we find, and then shift the String back two characters.", "Creates a new SQS queue and returns a Queue object.\n\n @param [String] name\n @param [Hash] attributes\n @return [Queue]\n @raise [AwsActionError]", "Get an SQS queue by name.\n @param [String] name\n @param [Hash] options\n @return [Queue,nil] Returns a Queue object if the queue is found, otherwise nil.\n @raise [AwsActionError]", "Return an array of Queue objects representing the queues found in SQS. An\n optional prefix can be supplied to restrict the queues found. This prefix\n is additional to the client prefix.\n\n @param [String] prefix option prefix to restrict the queues found.\n @return [Array<Queue>] queue objects found.\n @raise [AwsActionError]\n\n @example Delete all the queues\n\n   client.list_queues.each do |queue|\n     queue.delete\n   end", "Put a message on a queue. Takes the queue url and the message body, which\n should be a string. An optional delay seconds argument can be added if\n the message should not become visible immediately.\n\n @param [String] queue_url\n @param [String] message_body\n @param [Fixnum] delay_seconds\n @return nil\n @raise [MessageHasWrongMd5Error]\n @raise [AwsActionError]\n\n @example\n\n   client.send_message(queue.path, \"test message\")", "Returns the external network ip", "Returns the status of the router which is an array of 3 elements.\n Connection status, Last error, Uptime.", "Router connection information", "Total bytes sent from the router to external network", "Total bytes received from the external network.", "Total packets sent from the router to the external network.", "An array of mappings registered on the router", "Get the mapping registered for a specific port and protocol", "Delete the port mapping for specified network port and protocol", "Check that the protocol is a correct value", "Registers a handler.\n\n As a result, when `#route!` is called for that command, the aggregate will be\n loaded from repository, the command will be sent to the object to invoke the\n object's method, and finally the aggregate will be saved.", "Routes a command to the registered target.\n Raises `NotFoundError` if no corresponding target can be found.\n\n Arguments:\n   - command - name of the command\n   - aggregate_id - aggregate id\n   - options - flags:\n     - transactor - transactor instance to replace the default one (`OptimisticTransactor`);\n   See docs for `OptimisticTransactor` for a list of additional supported options.", "Declares persisted attributes.\n All attributes are stored on the Riak hash.\n\n Example:\n   class User\n     include Ork::Document\n\n     attribute :name\n   end\n\n   # It's the same as:\n\n   class User\n     include Ork::Document\n\n     def name\n       @attributes[:name]\n     end\n\n     def name=(name)\n       @attributes[:name] = name\n     end\n   end", "Index any attribute on your model. Once you index an attribute,\n you can use it in `find` statements.", "Returns true if current controller and action names equals to any of passed.\n Asterik as action name matches all controller's action.\n\n Examples:\n   <%= \"we are in PostsController::index\" if action_any_of?(\"posts#index\") %>\n\n   <%= \"we are not in PostsController::index\" unless action_any_of?(\"posts#index\") %>\n\n   <% if action_any_of?(\"posts#index\", \"messages#index\") %>\n     we are in PostsController or in MessagesController\n   <% end %>", "Extracts controller and action names from a string.\n\n Examples:\n\n   extract_controller_and_action(\"posts#index\")       # [\"posts\", \"index\"]\n   extract_controller_and_action(\"admin/posts#index\") # [\"admin/posts\", \"index\"]\n   extract_controller_and_action(\"admin/posts#index\") # raises ArgumentError", "I guess this is toooooo sloooow but anyhow let's play with it", "Replaces Tempfile's +make_tmpname+ with one that honors file extensions.\n Copied from Paperclip", "Initialize with an API key and config options", "This makes an api call to grab the train arrival and departure predictions.\n If more than one line is present at a station, such is concatenated and\n the call is made on all lines.", "Updates an existing template.\n\nAvailable _params_ argument are:\n   * :templateID - The ID of the template to be updated.\n   * :templateName - The name of the template. Maximum of 30 characters (will be truncated to 30 characters if longer).\n   * :htmlPageURL - The URL of the HTML page you have created for the template.\n   * :zipFileURL - Optional URL of a zip file containing any other files required by the template.\n   * :screenshotURL - Optional URL of a screenshot of the template. Must be in jpeg format and at least 218 pixels wide.\n   * :apiKey - optional API key to use to make request. Will use CAMPAIGN_MONITOR_API_KEY if not set.\n*Return*:\n\n*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields\ncontaining a successful message.\n\n*Error*: An Exception containing the cause of the error will be raised.", "stolen from sinatra\n Fixes encoding issues by casting params to Encoding.default_external", "return true if installation succeeded\n return false if either no git repo or hook already present", "Iterates over the AMIs available for the specified distro.\n\n === Parameters\n distro<String>:: Release name of the distro to display.\n\n === Returns\n Hash:: Keys are the AMI type, values are the AMI ID.", "called on tree node at end of the visit i.e. oll subtree are visited", "called when visit leaf node", "The initializer takes an optional text, which is the document to be converted from\n rdoc style to markdown.\n Convert the existing document to markdown.  The result is returned as a String.", "Gets a list of all templates for a client.\n\n*Return*:\n\n*Success*: Upon a successful call, this method will return a collection of Campaigning::Template objects.\n\n*Error*: An Exception containing the cause of the error will be raised.", "Gets a list of all subscriber lists for a client.\n\n*Return*:\n\n*Success*: Upon a successful call, this method will return a collection of Campaigning::List objects.\n\n*Error*: An Exception containing the cause of the error will be raised.", "Gets a list of all campaigns that have been sent for a client.\n\n*Return*:\n\n*Success*: Upon a successful call, this method will return a collection of Campaigning::Campaign objects.\n\n*Error*: An Exception containing the cause of the error will be raised.", "Update the access and billing settings of an existing client, leaving the basic details untouched.\n\nHere's a list of all the parameters you'll need to pass to the Campaigning::Client#update_access_and_billing! method. Only the :+access_level+ parameter\nis required for all calls. The relevance and necessity of the other parameters depends on the chosen AccessLevel (and BillingType),\nand will be fully described along with each parameter.\n\nAvailable _params_ argument are:\n   * :accessLevel - An integer describing the client's ability to access different areas of the application. Influences the significance\n                     and requirements of the following parameters. See http://www.campaignmonitor.com/api/method/client-updateaccessandbilling/#accesslevels\n                     for a full description of available levels.\n   * :username - Client login username. Not required and ignored if AccessLevel is set to 0.\n   * :password - Client login password. Not required and ignored if AccessLevel is set to 0.\n   * :billingType - Client billing type, only required if :accessLevel is set to allow the client to create and send campaigns\n   * :currency - Billing currency for this client, only required if :billingType is set to either ClientPaysAtStandardRate or\n                 ClientPaysWithMarkup. See full details: http://www.campaignmonitor.com/api/method/client-updateaccessandbilling/#currencies.\n   * :deliveryFee - Flat rate delivery fee to be charged to the client for each campaign sent, expressed in the chosen currency's\n                     major unit, but without the currency symbol (for example, sending \"6.5\" means \"$6.50\" if USD is used). Only\n                     required if BillingType is set to ClientPaysWithMarkup, in which case it should be at least equal to the standard rate.\n                     Further detail is available at http://help.campaignmonitor.com/topic.aspx?t=118.\n   * :costPerRecipient - Additional cost added to the campaign for each email address the campaign is sent to, expressed in the chosen\n                           currency's minor unit (for example, sending \"1.5\" means 1.5 cents per email address if USD is used). Only required\n                           if BillingType is set to ClientPaysWithMarkup, in which case it should be at least equal to the standard cost/recipient\n                           rate. Further detail is available at http://help.campaignmonitor.com/topic.aspx?t=118.\n   * :designAndSpamTestFee - Expressed in the chosen currency's major unit (for example, sending \"10\" means \"$10\" if USD is used). Only required\n                                 if BillingType is set to ClientPaysWithMarkup and client has access to design and spam tests, in which case the fee\n                                 should be equal to or higher than the standard rate (identical to the standard DeliveryFee for that currency).\n\n\n\nPlease note that for reasons of security there is no way to set a client's credit card details via the API. It will have to be done in the application.\n\n*Return*:\n\n*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields\ncontaining a successful message.\n\n*Error*: An Exception containing the cause of the error will be raised.", "Updates the basic details of an existing client.\nIf you wish to change only some details, the others must be included as they currently are. Please note that the client's existing\naccess and billing details will remain unchanged by a call to this method.\n\nAvailable _params_ argument are:\n   * :companyName - The client company name.\n   * :contactName - The personal name of the principle contact for this client.\n   * :emailAddress - An email address to which this client will be sent application-related emails.\n   * :country - This client's country.\n   * :timezone - Client timezone for tracking and reporting data. Valid timezone strings are obtainable by means of the\n                  API procedure Campaigning.timezones.\n\n*Return*:\n\n*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields\ncontaining a successful message.\n\n*Error*: An Exception containing the cause of the error will be raised.", "Saves an aggregate to the repository, appending events to the corresponding stream.", "Updates the status of the messages sent to devices and the list of devices that should be retried.\n @param [Array] unsent_reg_ids\n @param [Hash] all_results\n @param [GcmHelper::MulticastResult] multicast_result", "Create a select list based on the field name finding items within Selection.\n\n Example\n   form_for(@ticket) do |f|\n     f.select(\"priority\")\n\n Uses priority_id from the ticket table and creates options list based on items in Selection table with a system_code of\n either priority or ticket_priority\n\n options = {} and html_options = {} suport all the keys as the rails library select_tag does.\n\n options\n * +system_code+ - Overrides the automatic system_code name based on the fieldname and looks up the list of items in Selection", "Build a radio button list based field name finding items within Selection\n\n Example\n   form_for(@ticket) do |f|\n     f.select :priority\n options\n * +system_code+ - Overrides the automatic system_code name based on the fieldname and looks up the list of items in Selection", "Return +true+ if the node is equal to +other+. Normally this means\n +other+ is an instance of the same class or a subclass and has equal\n children and attributes.\n\n @return [Boolean] +true+ if the node is equal to +other+\n Return +true+ if the node has the same value as +other+, i.e. +other+\n is an instance of the same class and has equal children and attributes.\n\n @return [Boolean] +true+ the node has the same value as +other+\n Allow attributes to be accessed as methods.", "Creates methods that allows an +association+ to be monitored.\n\n The +association+ parameter should be a string or symbol representing the name of an association.", "Will add on timestamp according to Relais protocol, encrypt,\n and Base64-encode, all per Relais protocol.", "Gets the current moon phase of the location.\n @param location [String] The place to get the phase for.\n @return [Hash<Symbol, Integer>] A hash of two integers for the moon phase\n   information. The `:age` key in the hash contains the moon's age in days,\n   and the `:illumination` key contains the percentage of how illuminated it\n   is.", "Gets sunrise and sunset information for the current day at the current location.\n @param location [String] The place to get the info for.\n @return [Hash<Symbol, Hash<Symbol, Integer>>] A hash containing two hashes at keys :rise and :set for sunrise\n   and sunset information respectively. They each contain an :hour key and a :minute key which point to the hour\n   and minute that the sun will rise or set.", "Parses the simple forecast information.", "Parses the complex forecast information.", "Attempts to reopen an IO object.", "Get the variant and set it as an instance variable, handling\n overriding by passing in the URL\n\n @param  identifier [String, Hash] Name for the experiment or ID hash\n for the experiment\n @param  ivar_name [String, Symbol] Name for the variable\n\n @example\n\n   def my_action\n     gxapi_get_variant(\"Name\")\n   end\n\n   # OR\n\n   def my_action\n     gxapi_get_variant(id: 'id_from_google')\n   end\n\n @return [Celluloid::Future, Gxapi::Ostruct] Variant value", "Process the request.\n\n @param request [Rack::WebProfiler::Request]\n @param body\n @param status [Integer]\n @param headers [Hash]\n @param exception [Exception, nil]\n\n @return [Rack::Response]", "Perform a search and return an array of Torrent objects", "Return the n page results of a search, assuming it is multipage", "Parse HTML body of a supplied URL", "Search for International Shipping Options\n @param parcel_params [Hash] parcel parameters\n @return [Array] return array of shipping options", "Run the visitor through the directory tree\n\n @overload run\n\n @overload run(dirname)\n   @param [String] dirname\n   @yield define TreeNodeVisitor\n\n @overload run(tree_node_visitor)\n   @param [TreeNodeVisitor]\n   @yield define TreeNodeVisitor\n\n @overload run(dirname, tree_node_visitor)\n   @param [String] dirname\n   @param [TreeNodeVisitor]\n   @yield define TreeNodeVisitor\n\n @return [TreeNodeVisitor] the visitor\n\n @example Print the contents of tmp directory\n   w = DirTreeWalker.new\n   w.run(\"/tmp\") do\n     on_visit_leaf_node { |pathname| puts pathname }\n   end.run", "recurse on other directories", "method for plugins to get the\n cxxproject2rake\n building_blocks\n log", "Wait for all health checks on the host to become healthy.\n\n services - services to perform health checks on (if health checks are\n            defined)", "Blocks forever waiting for updates to the list of available services.", "Blocks forever waiting for updates to service addresses.", "Non-blocking request for service_addresses.", "Returns an array of media types from this header that match the given\n +media_type+, ordered by precedence.", "Returns true if all parameters and values in +match+ are also present in\n +params+.", "Get words by pos name", "Apply a rule by dispatching to the given match method. The result of\n applying the rule is memoized so that the match method is invoked at most\n once at a given parse position.\n\n @param (see RecursiveDescentParser#apply)\n @return (see RecursiveDescentParser#apply)", "Create a new matrix. There are two ways to use this function\n\n <b>pass an array</b>::\n   Constructs a column vector. For example: DoubleMatrix.from_array 1, 2, 3\n <b>pass an array of arrays</b>::\n   Constructs a matrix, inner arrays are rows. For\n   example: DoubleMatrix.from_array [[1,2,3],[4,5,6]]\n\n See also [], JBLAS#mat", "Yields Term AST to the block argument or provides an enumerator of\n Term AST.", "Give the region, service and optionally the AwsCredentials.\n\n @param [String] region the AWS region (ex. us-east-1)\n @param [String] service the AWS service (ex. sqs)\n @param [AwsCredentials] credentials\n\n @example\n   class Sqs\n     include AwsConnection\n\n     def initialize(region)\n       super(region, 'sqs')\n     end\n   end\n\n Perform an HTTP query to the given path using the given method (GET,\n POST, PUT, DELETE). A hash of query params can be specified. A POST or\n PUT body cna be specified as either a string or a hash of form params. A\n hash of HTTP headers can be specified.\n\n @param [String] method HTTP method, should be GET, POST, PUT or DELETE\n @param [String] path\n @param [Hash] query HTTP query params to send. Specify these as a hash, do not append them to the path.\n @param [Hash,#to_s] body HTTP request body. This can be form data as a hash or a String. Only applies to POST and PUT HTTP methods.\n @param [Hash] headers additional HTTP headers to send.\n @return [AwsRequest]", "Call an AWS API with the given name at the given path. An optional hash\n of options can be passed as arguments for the API call.\n\n @note The API call will be automatically retried *once* if the returned status code is\n   in the 500 range.\n\n @param [String] action_name\n @param [String] path\n @param [Hash] options\n @return [AwsResponse]\n @raise [AwsActionError] if the response is not successful. AWS error\n   information can be extracted from the exception.", "check if the resource can perform the action\n\n @raise [Authorizable::Error::NotAuthorized] if configured to raise\n   exception instead of handle the errors\n @return [Boolean] the result of the permission evaluation\n  will halt controller flow", "check if the resource can perform the action and respond\n according to the specefied config\n\n @param [Symbol] action the current controller action\n @param [Hash] config the configuration for what to do with the given action\n @return [Boolean] the result of the permission evaluation", "run the permission\n\n @param [Hash] options the data for the permission\n @return [Boolean] the result of the permission", "Get all file from drive folder", "When SQL sentence is an INSERT query generate the Thrift mutations according\n to the specified query values.", "When SQL sentence is a SELECT query generate the Thrift filters according\n to the specified query values.", "Generate a Thrift QualifierFilter and ValueFilter from key value pair.", "Initializes a file search object.\n\n @param [String] base_path the path of the directory to search within\n @param [String] matching_regex a regex that all localizable files match, optionally including a catch group for the language\n @param [String] exclude_regex a regex to exclude some matches from matching_regex\n Finds all files with corresponding language within a given directory\n matching the specified regexes.\n\n @return [Hash] a hash containing language codes as keys and all found files paths as values (so values are of type Array)", "build service url", "Connect to the server and execute the request", "Issue trade.\n Need api key.", "Issue bid order.\n Need api key.", "Issue ask order.\n Need api key.", "Withdraw funds.\n Need api key.", "Collects fields from model associations\n @return [Array]", "Applies a deep merge while respecting the values from environment\n variables. A deep merge consists of a merge of all the nested elements of\n the two given hashes `config` and `local`. The `config` hash is supposed\n to contain all the accepted keys, and the `local` hash is a subset of it.\n\n Moreover, let's say that we have the following hash: { \"ldap\" => {\n \"enabled\" => true } }. An environment variable that can modify the value\n of the previous hash has to be named `#{prefix}_LDAP_ENABLED`. The `prefix`\n argument specifies how all the environment variables have to start.\n\n Returns the merged hash, where the precedence of the merge is as follows:\n   1. The value of the related environment variable if set.\n   2. The value from the `local` hash.\n   3. The value from the `config` hash.", "Get the typed value of the specified environment variable. If it doesn't\n exist, it will return nil. Otherwise, it will try to cast the fetched\n value into the proper type and return it.", "this is the associated object\n\n evaluate a method on the owner of this node (if present). If an owner is\n not present, then the method is evaluated on this object. In either case\n a check is made to ensure that the object will respond_to? the method call.\n If the owner exists but does not respond to the method, then the method is\n tried on this node object in similar fashion.\n !!! SHOULD THIS JUST OVERRIDE instance_eval ??\n @param [Method] m method to call\n @return [] the result of the method call, or nil if unable to evaluate", "determine whether the parent is valid for this object. See description of\n validate_child for more detail. This method calls validate_child to perform\n the actual validation.\n @param [Taxonomite::Node] parent the parent to validate\n @return [Boolean] whether validation was successful", "Takes two result arrays and using the specified key merges the two\n\n @param [Array] mind_results The results from the API\n @param [Array] database_results The results from the database\n @param [String] key The key of the database_results Hash that should match the mind_results id key\n @return [Hash] An array of merged Hashes", "Generate a unique cryptographically secure secret", "Obfuscate a password using a salt and a cryptographic hash function", "Decode a space delimited string of security scopes and return an array", "Dynamic check of methods\n tab_ops contain the list of allowed method and verbs\n prefix the prefix to add to the method", "Raised on receipt of a message from RabbitMq and uses the appropriate appender", "return a list of all experiments\n\n @return [Array<Gxapi::Ostruct>]", "get a variant for an experiment\n\n @param identifier [String, Hash] Either the experiment name\n as a String or a hash of what to look for\n\n @return [Gxapi::Ostruct]", "List all experiments for our account\n\n @return [Array<Gxapi::Ostruct>] Collection of Experiment data\n retrieved from Google's API", "google api client\n\n @return [Google::APIClient]", "Select a variant from a given experiment\n\n @param  experiment [Ostruct] The experiment to choose for\n\n @return [Ostruct, nil] The selected variant or nil if none is\n selected", "merge a subtree with a prefix and a name", "The control directory used by the SCM.\n\n @return [String]\n   The name of the control directory.", "=> find locations", "=> find connections", "=> find station boards", "Delegate the methods start with \"actor_\" or \"target_\" to\n cached result", "Update the loadbalancer.", "Method for constructing a signature", "Lowercase, and try to get just the last name out of something\n that looks like a cataloging authorized heading.\n\n Try to remove leading 'by' stuff when we're getting a 245c", "Generates a keywords meta tag for use inside HTML header area.\n @return [String] HTML safe keywords meta tag.", "Generates a description meta tag for use inside HTML header area.\n @return [String] HTML safe description meta tag.", "Generates a Last-Modified meta tag for use inside HTML header area.\n @return [String] HTML safe Last-Modified meta tag.", "Generates a canonical link tag for use inside HTML header area.\n @return [String] HTML safe canonical link tag.", "Primitive97 validation of provided number\n\n @example\n   Sjekksum::Primitive97.valid?(235695) #=> true\n\n @param  number [Integer, String] number with included checksum\n\n @return [Boolean]", "Raises an AcceptError if this server is not able to serve an acceptable\n response.", "Calculates Verhoeff checksum\n\n @example\n   Sjekksum::Verhoeff.of(142857) #=> 0\n\n @param  number [Integer, String] number for which the checksum should be calculated\n\n @return [Integer] calculated checksum", "Save configuration into file\n @param [path] path to output file", "Ethon hates on hash with indifferent access for some reason", "Performs HTTP queries while respecting the rate limit.\n @param wait_for_quota [Boolean] whether to wait for quota reset\n        and query again if the rate limit (300 requests/s) is exceeded.\n @return The HTTP response or nil if we're hitting the rate limit and\n         wait_for_quota is false (@see #initialize).", "Returns an array of languages from this header that match the given\n +language+, ordered by precedence.", "Create a new RubyPandoc converter object. The first argument contains the\n input either as string or as an array of filenames.\n\n Any other arguments will be converted to pandoc options.\n\n Usage:\n   new(\"# A String\", :option1 => :value, :option2)\n   new([\"/path/to/file.md\"], :option1 => :value, :option2)\n   new([\"/to/file1.html\", \"/to/file2.html\"], :option1 => :value)\n Run the conversion. The convert method can take any number of arguments,\n which will be converted to pandoc options. If options were already\n specified in an initializer or reader method, they will be combined with\n any that are passed to this method.\n\n Returns a string with the converted content.\n\n Example:\n\n   RubyPandoc.new(\"# text\").convert\n   # => \"<h1 id=\\\"text\\\">text</h1>\\n\"", "Wrapper to run pandoc in a consistent, DRY way", "Builds the option string to be passed to pandoc by iterating over the\n opts passed in. Recursively calls itself in order to handle hash options.", "Takes a flag and optional argument, uses it to set any relevant options\n used by the library, and returns string with the option formatted as a\n command line options. If the option has an argument, it is also included.", "Takes an option and optional argument and uses them to set any flags\n used by RubyPandoc.", "Parse each parser in sequence, and if they all succeed return the result\n of applying the semantic action to the captured results.\n\n @param (see Match#parse)\n\n @return the result of applying the semantic action to the captured\n   results of each parser, or +false", "delete an array or a single card from the deck\n converts a string to a new card, if a string is given", "Using this method instead of resources, adds member routes for pages added in the\n itsf_backend configuration.", "generate_html entry point for on fly document generation", "returns a hash from all sources to the toolchain that should be used for a source", "calcs a map from unique directories to array of sources within this dir", "Formats a value into an Array of arguments.\n\n @param [Hash, Array, String] value\n   The value to format.\n\n @return [Array]\n   The formatted arguments.", "Adds an object to a relation.\n\n @example\n     relations = RelationMap.new\n     relations.add 'self', Link.new('/resource/1')\n     relations['self']\n     # => [#<Halibut::Core::Link:0x007fa0ca5b92b8 @href=\\\"/resource/1\\\",\n          @options=#<Halibut::Core::Link::Options:0x007fa0ca5b9240\n          @templated=nil, @type=nil, @name=nil, @profile=nil,\n          @title=nil, @hreflang=nil>>]\n\n @param [String] relation relation that the object belongs to\n @param [Object] item     the object to add to the relation", "Returns a hash corresponding to the object.\n\n RelationMap doens't just return @relations because it needs to convert\n correctly when a relation only has a single item.\n\n @return [Hash] relation map in hash format", "Perform an HTTP request.", "follow a model\n\n Example:\n => @bonnie.follow(@clyde)", "unfollow a model\n\n Example:\n => @bonnie.unfollow(@clyde)", "Raises a `TypeError` if `value` is not of `@type`.\n @api private", "searches the remaining and completed todos for the first todo with the substring in its content\n\n @param [String] substring substring to look for\n @return [Logan::Todo] the matched todo, or nil if there wasn't one", "create a todo in this todo list via the Basecamp API\n\n @param [Logan::Todo] todo the todo instance to create in this todo lost\n @return [Logan::Todo] the created todo returned from the Basecamp API", "update a todo in this todo list via the Basecamp API\n\n @param [Logan::Todo] todo the todo instance to update in this todo list\n @return [Logan::Todo] the updated todo instance returned from the Basecamp API", "Filter method that does the SafetyCone action\n based on the configuration.", "Fetches a configuration based on current request", "Initializes a new Client.\n\n Returns nothing.\n Run a loop FOREVER until we kill it or we make a selection.\n\n Returns nothing.", "Displays all of the star tables and information we have.\n\n Returns nothing.\n Show more information about a particular post.\n\n id - the Integer id entered by the user, which we map to a Post\n\n Returns nothing (although does delegate to the Post to show #more).", "This does the actual printing of posts.\n\n posts - an Array of Post objects\n\n It loops through the Array of posts and sends them to `terminal-table`.", "gatherer uses the pt row to display loyalty", "Add a previously uploaded file to the Repository.\n @return [Hash] report data as specified in the API.\n FIXME: this should be called file", "List all packages in the repository\n @return [Array<String>] list of packages in the repository", "Edit this repository's attributes as per the parameters.\n @note this possibly mutates the attributes depending on the HTTP response\n @return [self] if the instance data was mutated\n @return [nil] if the instance data was not mutated", "Reformats the data received from the LOC service", "Simple conversion from LoC-based struct to QA hash", "Initializes the remote repository.\n\n @param [Hash] options\n   Options for the remote repository.\n\n @option options [URI::Generic] :uri\n   The URI of the remote repository.\n\n @option options [Symbol, String] :scm\n   The SCM used for the remote repository.\n\n\n The name of the repository.\n\n @return [String]\n   The remote repository name.\n\n @since 0.1.2", "Initialize a Thrift connection to the specified host and port\n and execute the provided ThriftCallGroup object.", "get active todo lists for this project from Basecamp API\n\n @return [Array<Logan::TodoList>] array of active todo lists for this project", "publish this project from Basecamp API\n\n @return <Logan::Project> this project", "get completed todo lists for this project from Basecamp API\n\n @return [Array<Logan::TodoList>] array of completed todo lists for this project", "get an individual todo list for this project from Basecamp API\n\n @param [String] list_id id for the todo list\n @return [Logan::TodoList] todo list instance", "create a todo list in this project via Basecamp API\n\n @param [Logan::TodoList] todo_list todo list instance to be created\n @return [Logan::TodoList] todo list instance from Basecamp API response", "create a message via Basecamp API\n\n @param [String] subject subject for the new message\n @param [String] content content for the new message\n @param [Array] subscribers array of subscriber ids for the new message\n @param [Bool] private should the private flag be set for the new message\n @return [Logan::Message] message instance from Basecamp API response", "Parse using the rule body and on success return the result, on failure\n return a false value.\n\n @param (see Match#parse)\n @return (see Match#parse)", "Helps to enable debug logging when in development mode", "Write data to entry key, or updating existing one if it exists.\n\n @param [String] key\n @param [String] data", "Read a key from the keychain.\n\n @param [String] key\n @return [Array<Hash, String>, nil] tuple of entry info, and text contents, or nil if key does not exist", "Write data with given key to the keychain, or update existing key if it exists.\n\n @note keychain entries are not unique by key, but also by the information\n       provided through options; two entries with same key but different\n       account name (for example), will become two different entries when\n       writing.\n\n @param [String] key\n @param [String] data\n @param [Hash] options\n @option options [#to_s] :type (:note) one of Mellon::TYPES\n @option options [String] :account_name (\"\")\n @option options [String] :service_name (key)\n @option options [String] :label (service_name)\n @raise [CommandError] if writing fails", "Delete the entry matching key and options.\n\n @param [String] key\n @param [Hash] options\n @option (see #write)", "Find a variation in this Family by the Font Variation Description\n @param id [String] Family/Font variation ID/Description (e.g. n4 or i7)", "Autoloads all app-specific files", "Fetches data from ComicVine based on objects api_detail_url and updates self with new values\n\n @return [ComicVine::Resource]\n @since 0.1.2", "In this base implementation we just reset all the query information.\n Features and subclasses must redefine this method if they are interested\n in adding some behaviour.", "In this base implementation we perform the real pluck execution.\n\n The method collects all the attributes and columns to pluck and add it\n to the results array.", "Calculate the signing key for task 3.", "The canonical headers, including the Host.", "Run a command in git.\n\n   git :init\n   git add: \"this.file that.rb\"\n   git add: \"onefile.rb\", rm: \"badfile.cxx\"", "get hash of node update properties", "get all nodes that have updated facts", "get hash of facts for given node name", "get all nodes with all facts", "Execute an EC2 command, expand the input,\n and compact the output\n\n Examples:\n   ec2.call(\"DescribeInstances\")\n   ec2.call(\"TerminateInstances\", \"InstanceId\" => [\"i-1234\", \"i-993j\"]", "Constructs a new pure ruby connector for use with the words wordnet class.\n\n @param [Pathname] data_path Specifies the directory within which constructed datasets can be found (evocations etc...)\n @param [Pathname] wordnet_path Specifies the directory within which the wordnet dictionary can be found.\n @return [PureWordnetConnection] A new wordnet connection.\n @raise [BadWordnetConnector] If an invalid connector type is provided.\n Causes the connection specified within the wordnet object to be reopened if currently closed.\n\n @raise [BadWordnetConnector] If an invalid connector type is provided.", "Locates from a term any relevent homographs and constructs a homographs hash.\n\n @param [String] term The specific term that is desired from within wordnet.\n @param [true, false] use_cache Specify whether to use caching when finding and retreving terms.\n @result [Hash, nil] A hash in the format { 'lemma' => ..., 'tagsense_counts' => ..., 'synset_ids' => ...  }, or nil if no homographs are available.\n @raise [NoWordnetConnection] If there is currently no wordnet connection.", "Locates from a synset_id a specific synset and constructs a synset hash.\n\n @param [String] synset_id The synset id to locate.\n @result [Hash, nil] A hash in the format { \"synset_id\" => ..., \"lexical_filenum\" => ..., \"synset_type\" => ..., \"words\" => ..., \"relations\" => ..., \"gloss\" => ... }, or nil if no synset is available.\n @raise [NoWordnetConnection] If there is currently no wordnet connection.", "Locates from a synset id any relevent evocations and constructs an evocations hash.\n\n @see Synset\n @param [String] senset_id The id number of a specific synset.\n @result [Hash, nil] A hash in the format { 'relations' => ..., 'means' => ..., 'medians' => ... }, or nil if no evocations are available.\n @raise [NoWordnetConnection] If there is currently no wordnet connection.", "Sends a request to create an account using the +accounts+ endpoint.\n Raises a +MissingAPITokenError+ error if an API token\n hasn't been set on the Hey module or Yo instance.\n Accepts an optional hash of additional parameters to\n send with the request.\n\n  Hey::Account.new.create \"worldcup\", \"somepass\", email: \"f@bar.baz\"", "Execute a given block when the batch has finished processing.  If the batch\n has already finished executing, execute immediately.", "Prune dead branches from the repository.\n\n @option options [Time] :age Ignore branches whose HEAD commit is newer than this timestamp\n @option options [Regexp] :except Ignore branches matching this pattern\n @option options [Regexp] :only Consider only branches matching this pattern\n @option options [Boolean] :local Consider only local branches\n @option options [Boolean] :remote Consider only remote branches\n @option options [String] :merged Consider only branches that are fully merged into this branch (e.g. master)", "Build a plain-English description of a prune command based on the\n options given.\n @param [Hash] options", "Ask the user a yes-or-no question", "Given a natural-language English description of a time duration, return a Time in the past,\n that is the same duration from Time.now that is expressed in the string.\n\n @param [String] str an English time duration\n @return [Time] a Time object in the past, as described relative to now by str", "Returns params to create existing authenticated client\n @return [Hash]", "Returns newly created Client\n @note If suppress_errors == false SquashMatrix::Errors::AuthorizationError will be raised if specified credentials are incorrect and squash matrix authentication returns forbidden\n @param [Hash] opts the options to create client\n @return [Client]\n Returns club info.\n @note If suppress_errors == false SquashMatrix Errors will be raised upon HttpNotFound, HttpConflict, Timeout::Error, etc...\n @param id [Fixnum] club id found on squash matrix\n @return [Hash] hash object containing club information", "Returns player results.\n @note If suppress_errors == false SquashMatrix Errors will be raised upon HttpNotFound, HttpConflict, Timeout::Error, etc...\n @param id [Fixnum] played id found on squash matrix\n @return [Array<Hash>] Array of player match results", "Returns get_search_results results\n @note If suppress_errors == false SquashMatrix Errors will be raised upon HttpNotFound, HttpConflict, Timeout::Error, etc...\n @param query [String] get_search_results query\n @return [Hash] hash object containing get_search_results results", "Begin declaring an expectation for this Mock.\n\n == Simple Examples\n Expect the +customer+ to be queried for +account+, and return <tt>\"The\n Account\"</tt>:\n   @customer.expects.account.returns \"The Account\"\n\n Expect the +withdraw+ method to be called, and raise an exception when it\n is (see Expectation#raises for more info):\n   @cash_machine.expects.withdraw(20,:dollars).raises(\"not enough money\")\n\n Expect +customer+ to have its +user_name+ set\n   @customer.expects.user_name = 'Big Boss'\n\n Expect +customer+ to have its +user_name+ set, and raise a RuntimeException when\n that happens:\n   @customer.expects('user_name=', \"Big Boss\").raises \"lost connection\"\n\n Expect +evaluate+ to be passed a block, and when that happens, pass a value\n to the block (see Expectation#yields for more info):\n   @cruncher.expects.evaluate.yields(\"some data\").returns(\"some results\")\n\n\n == Expectation Blocks\n To do special handling of expected method calls when they occur, you\n may pass a block to your expectation, like:\n   @page_scraper.expects.handle_content do |address,request,status|\n     assert_not_nil address, \"Can't abide nil addresses\"\n     assert_equal \"http-get\", request.method, \"Can only handle GET\"\n     assert status > 200 and status < 300, status, \"Failed status\"\n     \"Simulated results #{request.content.downcase}\"\n   end\n In this example, when <tt>page_scraper.handle_content</tt> is called, its\n three arguments are passed to the <i>expectation block</i> and evaluated\n using the above assertions.  The last value in the block will be used\n as the return value for +handle_content+\n\n You may specify arguments to the expected method call, just like any normal\n expectation, and those arguments will be pre-validated before being passed\n to the expectation block.  This is useful when you know all of the\n expected values but still need to do something programmatic.\n\n If the method being invoked on the mock accepts a block, that block will be\n passed to your expectation block as the last (or only) argument.  Eg, the\n convenience method +yields+ can be replaced with the more explicit:\n   @cruncher.expects.evaluate do |block|\n     block.call \"some data\"\n     \"some results\"\n   end\n\n The result value of the expectation block becomes the return value for the\n expected method call. This can be overidden by using the +returns+ method:\n   @cruncher.expects.evaluate do |block|\n     block.call \"some data\"\n     \"some results\"\n   end.returns(\"the actual value\")\n\n <b>Additionally</b>, the resulting value of the expectation block is stored\n in the +block_value+ field on the expectation.  If you've saved a reference\n to your expectation, you may retrieve the block value once the expectation\n has been met.\n\n   evaluation_event = @cruncher.expects.evaluate do |block|\n     block.call \"some data\"\n     \"some results\"\n   end.returns(\"the actual value\")\n\n   result = @cruncher.evaluate do |input|\n     puts input  # => 'some data'\n   end\n   # result is 'the actual value'\n\n   evaluation_event.block_value # => 'some results'", "return a string with a file path where the file will be saved", "start the downloading process", "return an array of error objects\n empty array if all validation passes", "Get label details\n @param label_id [String]\n @return Object of label details", "Connects to the repository.", "Get the range of days to show", "Get the month's day corresponding to a row. Nil is returned if none.", "Get detailed information about this Family Variation from Typekit\n @note This is called lazily when you access any non-loaded attribute\n   and doesn't need to be called manually unless you want to reload the\n   data. This means we can return an array of Variation objects for {Family#variations}\n   without making N+1 requests to the API.\n @param attribute [Symbol] Optionally return a single attribute after data is loaded\n @return Returns @attribute if attribute argument is specified; otherwise returns self", "Endpoint helper. If the method is not defined, then try looking into the available endpoints.", "Execute a helper block if it matches conditions", "Return +true+ if the node has the same value as +other+, i.e. +other+\n is an instance of the same class and has equal children and attributes\n and the children are labeled the same.\n\n @return [Boolean] +true+ the node has the same value as +other+\n Allow labeled children to be accessed as methods.", "Create volume snapshot.\n\n ==== Parameters\n * +options+<Hash>:\n   - +name+<String> - *Optional*, name of the snapshot\n   - +description+<String> - *Optional*, description of the snapshot\n\n ==== Returns\n * +id+<String> - Universally unique identifer of resource\n * +type+<String> - Resource type\n * +href+<String> - Resource URL representation\n * +metadata+<Hash>:\n   - +lastModifiedDate+\n   - +lastModifiedBy+\n   - +createdDate+\n   - +createdBy+\n   - +state+\n   - +etag+\n * +properties+<Hash>:\n   - +name+<Integer>\n   - +description+<Array>\n   - +location+<String>\n   - +cpuHotPlug+<Boolean>\n   - +cpuHotUnPlug+<Boolean>\n   - +ramHotPlug+<Boolean>\n   - +ramHotUnPlug+<Boolean>\n   - +nicHotPlug+<Boolean>\n   - +nicHotUnPlug+<Boolean>\n   - +discVirtioHotPlug+<Boolean>\n   - +discVirtioHotUnPlug+<Boolean>\n   - +discScsiHotPlug+<Boolean>\n   - +discScsiHotUnPlug+<Boolean>\n   - +licenceType+<String>", "Parses a string of media type range parameters into a hash of parameters\n to their respective values.", "Converts 1.0 and 0.0 qvalues to 1 and 0 respectively. Used to maintain\n consistency across qvalue methods.", "Matches a single value against an array of Strings, Symbols, and Regexp's.\n @param [String] data    Any value as a String to compare against any of the Strings, Symbols, or Regexp's in the values argument.\n @param [Array] values   An array of Strings, Symbols, or Regexp's to compare against the data argument.  The array can be a mix of all three possible types.\n @return [Boolean] True if data matches any of the values or expressions in the values argument, otherwise, false.", "Creates a many to one association between two models. Works\n exactly as ActiveRecord's belongs_to, except that it adds\n caching to it.\n\n Usage:\n\n   class Book < ActiveRecord::Base\n     cached_belongs_to :author, :caches => :name\n   end", "Reads the next message", "Search directories for JSON files", "Define a parser with the given grammar and compile it into a parser class\n using the given options\n\n @return [Class] a new parser class", "Specify default sms backend. It must be registered.\n\n @param value [Symbol] Backend key which will be used as default", "Register sms provider backend\n\n @param key [Symbol] Key for acessing backend in any part of AnySMS\n @param classname [Class] Real class implementation of sms backend\n @param params [Hash]\n   Optional params for backend. Useful for passing tokens and options", "Instantiate an object with `default` as the path to the default\n configuration, `local` as the alternate file, and `prefix` as the prefix\n for environment variables. The `prefix` will take \"cconfig\" as the default.\n\n Note: the `local` value will be discarded in favor of the\n `#{prefix}_LOCAL_CONFIG_PATH` environment variable if it was set.\n Returns a hash with the app configuration contained in it.", "Returns a hash with the alternate values that have to override the default\n ones.", "Returns the captcha challenge.\n\n Internally calls the +render_challenge+ method of ValidatesCaptcha#provider.", "Returns an input tag of the \"text\" type tailored for entering the captcha solution.\n\n Internally calls Rails' #text_field helper method, passing the +object_name+ and\n +options+ arguments.", "By default, returns an anchor tag that makes an AJAX request to fetch a new captcha challenge and updates\n the current challenge after the request is complete.\n\n Internally calls +render_regenerate_challenge_link+ method of ValidatesCaptcha#provider.", "Segment keys are placeholders for the values that are plugged into a named route when it is constructed.\n\n The following Rails route has a two segment keys: :id and :format.\n\n     book GET    /books/:id(.:format)   books#show\n\n :id is the row.id of a Book and :format is the extension to be used when constructing a path or url.\n\n     book_path(1)                      #=> /book/1\n     book_path(1, \"html\")              #=> /book/1.html\n     book_path(id: 1, format: \"html\")  #=> /book/1.html\n     book_path(id: 2, format: \"xml\")   #=> /book/2.xml\n\n sitemap_capture_segments attempts to populate a Hash with values associated with the required segment keys.\n\n     row = Book.create(title: \"Duck is a self-proclaimed resident moron...\")\n     puts row.id                                #=> 1\n     row.sitemap_capture_segments(nil, [:id])   #=> {:id => 1}\n\n You have the ability to map attributes of an object to segment keys.  This could be useful for routes\n that do not follow standard convention or cases where you have some deeply nested resources.\n\n     class BooksController < ApplicationController\n       sitemap_segments :show, id: :my_id\n     end\n\n     class Book < ActiveRecord::Base\n       attr_accessible :my_id, :author, :title\n\n       before_save :generate_my_id\n\n       def generate_my_id\n         # do some magic\n         self.my_id = 2\n       end\n\n     end\n\n     row = Book.create(title: \"Please ignore the first title :)\")\n     puts row.id                                #=> 1\n     puts row.my_id                             #=> 2\n     # normally, you would get the attributes via:\n     # controller.sitemap_attributes(\"show\")[:segments]\n     attributes = {id: :my_id}\n     row.sitemap_capture_segments(attributes, [:id])   #=> {:id => 2}\n\n Segment values are obtained in two stages.\n - Stage one asks the current object (controller or model) for attributes from segment_mappings and\n   places those key/values in the returning hash.\n\n - Stage two asks the current object (controller or model) for attributes from segments array\n   that have not already been found via segment_mappings and places those key/values in the returning hash.\n\n @param [Hash] segment_mappings    A Hash containing one-to-one attribute mappings for segment keys to object attributes.\n @param [Array] segments           The segments Array of a Rails Route.\n return [Hash]", "Yields AST results for each line of the IO.\n\n @example Receive AST results in given block.\n   # doctest setup require 'bel_parser' self.class.include AST::Sexp\n\n   # example usage line_io = StringIO.new(\"\\\"AKT1\\\"\\n\") line    =\n   nil ast_res = nil ::BELParser::ASTGenerator.new.each(line_io)\n   { |(line_number, line, results)|\n     # do something\n   }\n\n @example Receive AST results as an enumerator.\n   # doctest setup require 'bel_parser' self.class.include AST::Sexp\n\n   # example usage line_io = StringIO.new(\"\\\"AKT1\\\"\\n\") line,\n   ast_res = ::BELParser::ASTGenerator.new.each(line_io).first.to_a\n\n @param  [IO] io the IO-object to read each line from @yield\n [[Integer, String, Array<AST::Node>]] yields line number, line,\n         and AST results as an {Array}\n @return [IO, #<Enumerator: #<BELParser::ASTGenerator#each>] the {IO}\n         object is returned if a block is given, otherwise an\n         {Enumerator} object is returned that can be iterated with\n         {Enumerator#each}", "Pings over raw Ethernet sockets.\n\n Returns a Number representing the ping latency (in seconds) if the ping\n response matches, an array of [expected, received] strings if it doesn't\n match, and false if the ping times out.", "match against a domain name. the domain must be an instance of DomainName", "Executes passed block for each \"unit\" of time specified, with a new time object for each interval passed to the block.", "Executes passed block for each \"unit\" of time specified, with a new time object set to the beginning of \"unit\" for each interval passed to the block.", "Executes passed block for each \"unit\" of time specified, returning an array with the return values from the passed block.", "Executes passed block for each \"unit\" of time specified, returning an array with the return values from passed block. Additionally the time object passed into the block is set to the beginning of specified \"unit\".", "Build an entry info hash.\n\n @param [String] key\n @param [Hash] options\n @return [Hash]", "Parse entry contents.\n\n @param [String]\n @return [String]", "Split a file with SPLIT_MARKER.\n Returns a Hash of filename key with its content.", "Replay events, building up the state of the aggregate.\n Used by Repository.", "FIXME make this conditional to different types of platforms", "desc \"Build the beta release of the app\"", "runs a pod dry run before tagging", "Generate a percentile for the data set.\n @example\n  snapshot.percentile(95)\n  snapshot.percentile(99.9)", "when rank lands between values, generated a weighted average\n of adjacent values", "Convert this matrix to a string.\n\n This methods takes a few extra arguments to control how the result looks\n like.\n\n +fmt+ is a format as used by sprintf, +coljoin+ is the string used to\n join column, +rowjoin+ is what is used to join rows. For example,\n\n    x.to_s('%.1f', ' ', \"\\n\")\n\n Returns a matrix where columns are separated by spaces, rows by newlines\n and each element is shown with one digit after the comma.", "Returns array of passports.", "Returns ID card information.", "Returns passport information.", "Returns array of addresses.", "Returns array of address nodes.", "Get address info by it's id.", "Get persons array at the given address.", "returns a user by id", "returns a room by id", "Returns all the messages containing the supplied term.", "Toggles the star next to a message", "Get a hash of all options with default values. The list of values is initialized with the result.", "Attempt to read option keys from a YAML file", "For every option we yield the configuration and expect a value back. If the block returns a value we set the\n option to it.", "Add a collector.\n\n @param collector_class [Array, Class]\n\n @raise [ArgumentError] if `collector_class' is not a Class or is not an instance of Rack::WebProfiler::Collector::DSL\n   or a collector with this identifier is already registrered.", "Sort collectors by definition identifier.", "Normalizes a value for the formatted hash values\n TVDB hashes should not contain more hashes\n Sometimes TVDB returns a hash with content inside which needs to be extracted", "Initialize a new system watcher\n\n @param argv [Hash] the command line parameters hash (usually `ARGV`).\n @param env [Hash] the environment variables hash (usually `ENV`).\n Parse the command line options", "Find all installed Pry slugins and store them in an internal array.", "recursive open struct", "define accessors for an attribute", "dynamically define getter and setter when an unknown setter is called", "take a string an convert it from\n camelCase to under_scored", "This function handles making the call when there is more than one call in\n the batch.", "task that will link the given object files to a static lib", "return all ancestors of this node", "move all children to the parent node\n !!! need to perform validations here?", "perform validation on whether this child is an acceptable child or not?\n the base_class must have a method 'validate_child?' to implement domain logic there", "subclasses should overload create_taxonomy_node to create the appropriate Place object and set it up", "checking the status code of the response; if we are not authenticated\n then authenticate the session\n @raise [Calculated::PermissionDenied] if the status code is 403\n @raise [Calculated::SessionExpired] if a we get a 401\n @raise [Calculated::MissingParameter] if we get something strange", "Adds configured fields to attrs", "Adds configured has manys to attrs", "Adds configured has ones to attrs", "Calculates Damm checksum\n\n @example\n   Sjekksum::Damm.of(572) #=> 4\n\n @param  number [Integer, String] number for which the checksum should be calculated\n\n @return [Integer] calculated checksum", "Generates a sitemap at +basedir+\n @param basedir [String] the location where the sitemap should be generated", "This class is for internal usage. No need to initialize this manually,\n instead use controller methods provided.\n\n When being used as automatical way in controller, e.g. as\n after_filter, supply the controller\n\n   ActivityProcessor.new(self)\n\n If cache options needs to be attached, ensure the second argument\n\n   ActivityProcessor.new(self, nil, foo: 'bar')\n\n When being used manually, normally the target would be provided\n\n   ActivityProcessor.new(self, @article, foo: 'bar')\n\n @param controller [Object] The controller object, often self in controller\n\n @param target [Object] The target instance. If nil, it will be found based on\n        controller.\n\n        When supplied manually, target should be free of error, aka,\n        after controller actiton(create, update etc) success\n\n @param reference [Hash] When required, the second arg \"target\" should be\n        there, either object or nil\n\n @return warning\n         If the target object has any error, the fact is it has not\n         passed validation yet. Return a warning in logger.\n\n         If there is any other errors say absence of current_user, warning\n         will also be returned from create_activity\n\n @return Valid activity object from create_activity if everything okay\n\n Return nil at this level, but not at #initialize. The reason is not to\n throw error on `nil.create_activity`, for validation error of\n target is common case. SimpleActivity should let it pass.", "Get HTTP headers.\n\n @return [Hash]", "Get full HTTP request in HTTP format.\n\n @return [String]", "Copies a filter\n @return [Hash]", "Clears a single type of filter.\n @param [Symbol]        section  The section of filter to update. :exclude or :include.\n @param [Symbol]        key      The key of filter to update. :actions, :verbs, :names, :controllers.\n @return [Nil]", "Returns true if there is more than one record.", "Get current status of container\n @return [Hash] hash with :state and :pid attributes", "Wait for container to change status\n @param [String] state name", "Get container cpu usage in seconds\n @return [Float]", "Get container processes\n @return [Array] list of all processes", "Create a new container\n @param [String] path path to container config file or [Hash] options\n @return [Boolean]", "Clone to a new container from self\n @param [String] target name of new container\n @return [LXC::Container] new container instance", "Create a new container from an existing container\n @param [String] source name of existing container\n @return [Boolean]", "Adds a host", "Shows a host", "Shows all hosts", "Create a new extended packrat parser to parse +source+.\n\n @param (see PackratParser#initialize)\n @option (see PackratParser#initialize)\n\n Apply a rule by dispatching to the given match method. The result of\n applying the rule is memoized so that the match method is invoked at most\n once at a given parse position. Left-recursion is detected and parsed\n correctly.\n\n @param (see PackratParser#apply)\n @return (see PackratParser#apply)", "this request will have loaded generic objects for the ready basically\n @param [String] name\n @param [Hash] params\n @return [Calculated::Models::ObjectTemplate]", "this request will have loaded relatable categories for the object template\n @param [String] related_attribute\n @param [String] name\n @param [Hash] params\n @return [Calculated::Models::ObjectTemplate]", "This will filter the results of the generic objects from a simple text search\n   note this is not an expancive text search so limit to 1 word searches for best\n   results\n\n @example\n   generic_objects_for_object_template_with_filter('airport', 'london')\n\n   There is also the usuage of relatable_category_values with the params\n   this will allow further filtering on the search its an AND Filter not an OR filter\n\n @example\n   searching for ford diesel cars for example\n\n   generic_objects_for_object_template_with_filter('car', 'diesel', :relatable_category_values => [\"ford\"])\n\n this request will have loaded relatable categories for the object template\n @param [String] name\n @param [String] filter\n @param [Hash] params\n @return [Calculated::Models::GeneriObject]", "Runs the program under sudo.\n\n @overload sudo(*arguments)\n   Run the program under `sudo` with the given arguments.\n\n   @param [Array] arguments\n     Additional arguments to run the program with.\n\n @overload sudo(*arguments,options)\n   Run the program under `sudo` with the given arguments\n   and options.\n\n   @param [Array] arguments\n     Additional arguments to run the program with.\n\n   @param [Hash] options\n     Additional options to execute the program with.\n\n   @option options [Hash{Symbol => Object}] :sudo\n     Additional `sudo` options.\n\n @return [Boolean]\n   Specifies whether the program exited successfully.\n\n @raise [ProgramNotFound]\n   Indicates that the `sudo` program could not be located.\n\n @since 0.1.8\n\n @see http://rubydoc.info/stdlib/core/1.9.2/Kernel#spawn-instance_method\n   For acceptable options.\n\n @see SudoTask\n   For valid `:sudo` options.", "Runs the program with the arguments from the given task.\n\n @param [Task, #to_a] task\n   The task who's arguments will be used to run the program.\n\n @param [Hash] options\n   Additional options to execute the program with.\n\n @return [true, false]\n   Specifies the exit status of the program.\n\n @see #run", "Runs the program under `sudo` with the arguments from the given task.\n\n @param [Task, #to_a] task\n   The task who's arguments will be used to run the program.\n\n @param [Hash] options\n   Spawn options for the program to be ran.\n\n @yield [sudo]\n   If a block is given, it will be passed the sudo task.\n\n @yieldparam [SudoTask] sudo\n   The sudo tasks.\n\n @return [true, false]\n   Specifies the exit status of the program.\n\n @see #sudo\n\n @since 0.3.0", "Defines a sitemap for a Rails app.\n\n\n You can find a few examples and apps at:\n - (http://www.jeffduckett.com/blog/11/defining-rails-3-x-sitemaps-using-duckmap.html)\n - (http://www.jeffduckett.com/blog/12/multiple-sitemap-definitions.html)\n\n @return [Nil]", "Packs the given data into a string.  The keys of the data\n correspond to the names of the directives.\n\n @param data [Hash<Symbol, Object>] the data.\n @return [String] the packed data.", "Unpacks the given string with the directives.  Returns a hash\n containing the values, with the keys being the names of the\n directives.\n\n @param string [String] the packed string.\n @return [Hash<Symbol, Object>] the unpacked data.", "This unpacks the entire string at once.  It assumes that none of\n the directives will need the values of other directives.  If\n you're not sure what this means, don't use it.\n\n @param string [String] the packed string.\n @return [Hash<Symbol, Object>] the unpacked data.", "Creates a new directive with the given method and arguments.\n\n @return [Directive] the new directive.", "return true if the task need to be executed, false otherwise", "Ensure that all items in the passed Array are allowed", "Ensure that the specific item passed is allowed", "Try each parser in sequence, and if they all succeed return an array of\n captured results, or return +false+ if any parser fails.\n\n @param (see Match#parse)\n\n @return an array of captured results of each parser in sequence, or\n   +false+", "Return the Tag that matches the given class", "Method add a route or method to be managed by safety cone", "Method to generate a key from the options", "Requests the oembeddable resource\n\n @return Faraday::Response", "Creates a new custom field for a list\n\nAvailable _params_ argument are:\n   * :fieldName - The Name for the new Custom Field. This will be used to generate the custom fields Key.\n   * :dataType - The Data Type for the new Custom Field. This must be one of Text, Number, MultiSelectOne, or MultiSelectMany\n   * :options - The available options for a multi-valued custom field. Options should be an Array of Strings, like: %w[Brazil Ireland England].\n                You can't pass this field for Text and Number custom fields\n\n*Return*:\n\n*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields\ncontaining a successful message.\n\n*Error*: An Exception containing the cause of the error will be raised.", "Gets a list of all active subscribers for a list.\n\n*Return*:\n\n*Success*: Upon a successful call, this method will return a collection of Campaigning::Subscriber objects.\n\n*Error*: An Exception containing the cause of the error will be raised.", "Extracts the base url of the API from JSON Schema\n @return [String, nil]\n @example\n   base_url_from_schema #=> \"https://api.example.com/\"", "Read socket and return Relp frame information in hash", "Check if command is one of valid commands if not raise exception", "Call octokit, using memcached response, when available", "Returns true if one of the given controllers match the actual one.\n If actions are set they are taken into account.", "Queries a salesforce webservice", "end_date is 1 week in seconds", "Returns the full path to the current Ruby interpreter's executable file.\n This might not be the actual correct command to use for invoking the Ruby\n interpreter; use ruby_command instead.", "Returns the correct command string for invoking the +name+ executable\n that belongs to the current Ruby interpreter. Returns +nil+ if the\n command is not found.\n\n If the command executable is a Ruby program, then we need to run it\n in the correct Ruby interpreter just in case the command doesn't\n have the correct shebang line; we don't want a totally different\n Ruby than the current one to be invoked.", "Ruby 1.8-2.1 compatible\n Make a string suitable for parsing by Jenkins JUnit display plugin by escaping any non-valid\n Java class name characters as an XML entity. This prevents Jenkins from interpreting \"hi1.2\"\n as a package-and-class name.\n\n @param [String] name\n @return [String] string with all non-alphanumerics replaced with an equivalent XML hex entity", "Strip invalid UTF-8 sequences from a string and entity-escape any character that can't legally\n appear inside XML CDATA. If test output contains weird data, we could end up generating\n invalid JUnit XML which will choke Java. Preserve the purity of essence of our precious XML\n fluids!\n\n @return [String] the input with all invalid UTF-8 replaced by the empty string\n @param [String] untrusted a string (of any encoding) that might contain invalid UTF-8 sequences", "Locate the correct service endpoint for the given resource URL.\n\n @param url [String] a fully-qualified URL to an oembeddable resource\n\n @return the url, or false if no known endpoint.", "Delete all indices matching the specified pattern\n\n @param   [#to_s]          pattern  Regexp pattern used to restrict the selection\n @return  [void]\n\n @note No confirmation is needed, so beware!\n\n @note This method will also output its result on STDOUT if +@verbose+ is\n       true\n\n @example Delete all indices whose name begins with \"test\"\n    Desi::IndexManager.new.delete!('^test') #=> nil\n\n @api  public", "Close all indices matching the specified pattern\n\n @param   [#to_s]          pattern  Regexp pattern used to restrict the selection\n @return  [void]\n\n @note No confirmation is needed, so beware!\n\n @note This method will also output its result on STDOUT if +@verbose+ is\n       true\n\n @example Close all indices whose name begins with \"test\"\n    Desi::IndexManager.new.close!('^test') #=> nil\n\n @api  public", "method returns number of errors", "ensure the configuration is resolved and ready to use", "Initializes the Logan shared client with information required to communicate with Basecamp\n\n @param basecamp_id [String] the Basecamp company ID\n @param auth_hash [Hash] authorization hash consisting of a username and password combination (:username, :password) or an access_token (:access_token)\n @param user_agent [String] the user-agent string to include in header of requests\n Updates authorization information for Logan shared client\n\n @param auth_hash [Hash] authorization hash consisting of a username and password combination (:username, :password) or an access_token (:access_token)", "get project templates from Basecamp API\n\n @return [Array<Logan::ProjectTemplate>] array of {Logan::ProjectTemplate} instances", "get active Todo lists for all projects from Basecamp API\n\n @return [Array<Logan::TodoList>] array of {Logan::TodoList} instances", "Create, flush and delete chains and other iptable chain operations.\n @param [Symbol] cmd the operation to perform (:new, :delete, :flush)\n @param [String] chain name of the chain (e.g. INPUT, CATFLAP-DENY, etc.)\n @param [Hash] p parameters for specific iptables features.\n @return self\n @example\n   Rules.new('nat').chain(:list, 'MY-CHAIN', numeric: true).flush\n   => \"iptables -t nat -n -L MY-CHAIN\"", "Adds an event to the changeset.", "Execute the given API request on the manager\n\n @param [JsonRequest] json_req\n @return [JsonResponse]", "Calculates Luhn checksum\n\n @example\n   Sjekksum::Luhn.of(7992739871) #=> 3\n\n @param  number [Integer, String] number for which the checksum should be calculated\n\n @return [Integer] calculated checksum", "access the appropriate parent entity_types for a particular child or child entity_type\n @param [Taxonomy::Node, String] child the child object or entity_type string\n @return [Array] an array of strings which are the valid parent types for the child", "access the appropriate child entity_types for a particular parent or parent entity_type\n @param [Taxonomy::Node, String] parent the parent object or entity_type string\n @return [Array] an array of strings which are the valid child types for the child", "Walking the description chain looking to see if any of them are serviceable\n\n TODO: see if we can't define a method on the context to observe instead of calling\n action_controller_description? each time", "return a variant value by name or id\n\n @param identifier [String, Hash] The name of the experiment or a hash\n with the id of the experiment\n @param override [String] Override value returned from the experiment\n\n @example\n   variant = @gxapi.get_variant(\"my_experiment\")\n   variant.value =>\n     # Ostruct.new(experiment_id: \"x\", index: 1, name: \"name\")\n\n @example\n   variant = @gxapi.get_variant(id: \"x\")\n   variant.value =>\n     # Ostruct.new(experiment_id: \"x\", index: 1, name: \"name\")\n\n @return [Celluloid::Future]", "protected method to make the actual calls to get values\n from the cache or from Google\n\n @param identifier [ExperimentIdentifier] Experiment to look for\n\n @return [Gxapi::Ostruct] Experiment data", "Don't you just love mr. metaclass?", "Changes the size of the directive to the given size.  It is\n possible for the given value to the a directive; if it is,\n it just uses the name of the directive.\n\n @param new_size [Numeric, Directive]\n @return [self]", "Finalizes the directive.\n\n @return [void]", "The number of bytes this takes up in the resulting packed string.\n\n @param (see #to_s)\n @return [Numeric]", "Modifies the given string if it's needed, according to\n signness and endianness.  This assumes that a signed\n directive should be in lowercase.\n\n @param str [String] the string to modify.\n @param include_endian [Boolean] whether or not to include the\n   endianness.\n @return [String]", "Modifies the given string to account for endianness.  If\n +use_case+ is true, it modifies the case of the given string to\n represent endianness; otherwise, it appends data to the string\n to represent endianness.\n\n @param str [String] the string to modify.\n @param use_case [Boolean]\n @return [String]", "Create a new trash record for the provided record.\n Restore a trashed record into an object. The record will not be saved.", "Attributes of the trashed record as a hash.", "Persist the model attributes and update indices and unique\n indices.\n\n Example:\n\n   class User\n     include Ork::Document\n\n     attribute :name\n   end\n\n   u = User.new(:name => \"John\").save\n   # => #<User:6kS5VHNbaed9h7gFLnVg5lmO4U7 {:name=>\"John\"}>", "Overwrite attributes with the persisted attributes in Riak.", "Build the secondary indices of this object", "Look up into Riak for repeated values on unique attributes", "Constructs a new tokyo ruby connector for use with the words wordnet class.\n\n @param [Pathname] data_path Specifies the directory within which constructed datasets can be found (tokyo index, evocations etc...)\n @param [Pathname] wordnet_path Specifies the directory within which the wordnet dictionary can be found.\n @return [PureWordnetConnection] A new wordnet connection.\n @raise [BadWordnetConnector] If an invalid connector type is provided.\n Causes the connection specified within the wordnet object to be reopened if currently closed.\n\n @raise [BadWordnetConnector] If an invalid connector type is provided.", "Sets a property in the resource.\n\n @example\n     resource = Halibut::Core::Resource.new\n     resource.set_property :name, 'FooBar'\n     resource.property :name\n     # => \"FooBar\"\n\n @param [Object] property the key\n @param [Object] value    the value", "Adds link to relation.\n\n @example\n     resource = Halibut::Core::Resource.new\n     resource.add_link 'next', '/resource/2', name: 'Foo'\n     link = resource.links['next'].first\n     link.href\n     # => \"/resource/2\"\n     link.name\n     # => \"Foo\"\n\n @param [String]      relation  relation\n @param [String]      href      href\n @param [Hash]        opts      options: templated, type, name, profile,\n                                  title, hreflang", "Hash representation of the resource.\n Will ommit links and embedded keys if they're empty\n\n @return [Hash] hash representation of the resource", "Takes a symbol and returns the proper transaction type.\n\n @param [Symbol] Can be :pending, :waiting, :completed or :partially_paid\n @return [String,nil] Returns the corresponding \"PE\", \"WA\", \"CO\" or \"PP\"", "Hits the Bitpagos transaction API, returns a hash with results\n\n @param [String] State (Pending, Waiting, Completed, Partially Paid)\n @param [String] Transaction ID\n @return [Hash]", "returns the first plugin class that supports this module directory\n not sure what to do when we find multiple plugins\n would need additional criteria", "Takes actual block of code that is to be guarded by\n the lock. The +run_loop+ method does the actual work.\n\n If 'daemon?' is true, your code (including +on_load+)\n will execute after a fork.\n\n Make sure you don't open files and sockets in the exiting\n parent process by mistake. Open them in code that is called\n via +on_load+.", "attempts to rebuild the cluster from any of the hosts passed as arguments\n returns the first ip that worked, else nil", "attempts a list-machines action on the given host.\n returns true if successful, else false", "attempts to rebuild the cluster by the specified fleet host, then hosts that it\n has built previously, and finally by using the discovery url", "If the decorated parser matches return the entire matched string,\n otherwise return a false value.\n\n @param (see Match#parse)\n\n @return (see Match#parse)", "Provides transparent access to the options within the option list.\n\n @example\n   opt_list = OptionList.new(:name => 'test')\n   opt_list.name\n   # => \"test\"", "Gets the common data for a page.\n Convenience method that can be used for bulk reading of page data.\n @return [Array<page_title, ressource_count, total_download_size, overall_load_time>] An array with page data\n @example Example of returned Array\n     [\"Software is hard\", \"26\", \"0.36\", \"6.745\"]", "Gets the data for a row for all entries.\n Convenience method that can be used for bulk reading of entry data.\n @return [Array<Array<html_method, ressource_name, status_name, status_code, ressource_size, load_duration>>] An array with row data\n @example Example of returned Array\n     [[\"GET\", \"/prototype.js?ver=1.6.1\", \"200\", \"OK\", \"139.85\", \"1.06\"], ... ]", "Send the HTTP request and get a response. Returns an AwsResponse object.\n The instance is frozen once this method is called and cannot be used\n again.", "Encode the form params if the body is given as a Hash.", "Create the AwsRequestAuthorization object for the request.", "Retrieve a message from the queue. Returns nil if no message is waiting\n in the given poll time. Otherwise it returns a Message.\n\n @param [Fixnum] poll_time\n @return [Message,nil]\n @raise [AwsActionError]", "checks if the permission has already been calculated\n otherwise the permission needs to be evaluated", "checks the cache if we have calculated this permission before\n @return [Boolean|NilClass]", "performs a full evaluation of the permission\n @return [Boolean]", "This method can also be overridden if one desires to have multiple types of\n ownership, such as a collaborator-type relationship\n\n @param [ActiveRecord::Base] object should be the object that is being tested\n   if the user can perform the action on\n @return [Number] true if self owns object", "Spin up a new thread", "This thread watches over the pool and allocated and deallocates threads\n as necessary", "Ensures all values in an Array are of a certain type.  This is meant to be used internally\n by DuckMap modules and classes.\n\n     values = [\"new_book\", \"edit_book\", \"create_book\", \"destroy_book\"]\n     values = obj.convert_to(values, :symbol)\n     puts values #=> [:new_book, :edit_book, :create_book, :destroy_book]\n\n @param [Array]    values The Array to inspect and convert.\n @param [Symbol]   type Valid values are :string and :symbol.\n                        - :string converts all values to a String.\n                        - :symbol converts all values to a Symbol.\n @return [Array]", "Ruby 2.1 feature", "Returns additional params which are required for all requests.\n Depends on request scope.\n\n @return [Hash]", "Performs API call to Odnoklassniki\n\n @example Performs API call in current scope\n   school_friend = SchoolFriend::Session.new\n   school_friend.api_call('widget.getWidgets', wids: 'mobile-header,mobile-footer') # Net::HTTPResponse\n\n @example Force performs API call in session scope\n   school_friend = SchoolFriend::Session.new\n   school_friend.api_call('widget.getWidgets', {wids: 'mobile-header,mobile-footer'}, true) # SchoolFriend::Session::RequireSessionScopeError\n\n\n @param [String] method API method\n @param [Hash] params params which should be sent to portal\n @param [FalseClass, TrueClass] force_session_call says if this call should be performed in session scope\n @return [Net::HTTPResponse]", "Builds URI object\n\n @param [String] method request method\n @param [Hash] params request params\n @return [URI::HTTP]", "only works if deleting of resources occurs by setting\n the deleted_at field", "determines if we want to use the parent class if available or\n if we just use the resource class", "Reads next maximal term. The following input doesn't make the term more complete.\n Respects the priority of operators by comparing it to the given value.", "Nifty generators errors helper code", "Update the current theme for the controller and optionally save\n @param name [String] The name of the new theme\n @param options [Hash] Options hash\n @option options [String] :layout ('application') Default layout for theme\n @option options [Boolean] :dont_save (false) Dont save the update to the theme.yml config\n @return (Theme) the theme for the controller", "Expects the connection to behave like an instance of +Mysql+\n If you need something else, replace +acquire_lock+ with your own code.\n Or define your own lock_function while configuring a new Revenant task.", "Create the ordered options, populate with provided hash and load YAML file\n options.\n @param default_options [Hash] (Hash.new) - Options to populate the theme\n   config with.\n @options default_options [String] :path The path relative to the rails root\n   where templates are installed\n @options default_options [Array(String)] :asset_directories Names of\n   directories containing assets for the theme relative to the 'assets'\n   directory.\n Load the theme.yml file and merge it with the theme configuration", "Save the current state of the theme config to the theme.yml file", "Apply the parse rule of the same name inherited from a super-grammar.\n\n @param (see Match#parse)\n\n @return the result of applying parse rule of the same name inherited from\n   a super-grammar", "Produce BD request hash for exact search of type eg \"ISBN\"\n value can be a singel value, or an array of values. For array,\n BD will \"OR\" them.", "Rig an expected method to raise an exception when the mock is invoked.\n\n Eg,\n   @cash_machine.expects.withdraw(20,:dollars).raises \"Insufficient funds\"\n\n The argument can be:\n * an Exception -- will be used directly\n * a String -- will be used as the message for a RuntimeError\n * nothing -- RuntimeError.new(\"An Error\") will be raised", "Used when an expected method accepts a block at runtime.\n When the expected method is invoked, the block passed to\n that method will be invoked as well.\n\n NOTE: ExpectationError will be thrown upon running the expected method\n if the arguments you set up in +yields+ do not properly match up with\n the actual block that ends up getting passed.\n\n == Examples\n <b>Single invocation</b>: The block passed to +lock_down+ gets invoked\n once with no arguments:\n\n   @safe_zone.expects.lock_down.yields\n\n   # (works on code that looks like:)\n   @safe_zone.lock_down do\n     # ... this block invoked once\n   end\n\n <b>Multi-parameter blocks:</b> The block passed to +each_item+ gets\n invoked twice, with <tt>:item1</tt> the first time, and with\n <tt>:item2</tt> the second time:\n\n   @fruit_basket.expects.each_with_index.yields [:apple,1], [:orange,2]\n\n   # (works on code that looks like:)\n   @fruit_basket.each_with_index do |fruit,index|\n     # ... this block invoked with fruit=:apple, index=1,\n     # ... and then with fruit=:orange, index=2\n   end\n\n <b>Arrays can be passed as arguments too</b>... if the block\n takes a single argument and you want to pass a series of arrays into it,\n that will work as well:\n\n   @list_provider.expects.each_list.yields [1,2,3], [4,5,6]\n\n   # (works on code that looks like:)\n   @list_provider.each_list do |list|\n     # ... list is [1,2,3] the first time\n     # ... list is [4,5,6] the second time\n   end\n\n <b>Return value</b>: You can set the return value for the method that\n accepts the block like so:\n\n   @cruncher.expects.do_things.yields(:bean1,:bean2).returns(\"The Results\")\n\n <b>Raising errors</b>: You can set the raised exception for the method that\n accepts the block. NOTE: the error will be raised _after_ the block has\n been invoked.\n\n   # :bean1 and :bean2 will be passed to the block, then an error is raised:\n   @cruncher.expects.do_things.yields(:bean1,:bean2).raises(\"Too crunchy\")", "Constructs a new wordnet connection object.\n\n @param [Symbol] connector_type Specifies the connector type or mode desired. Current supported connectors are :pure and :tokyo.\n @param [String, Symbol] wordnet_path Specifies the directory within which the wordnet dictionary can be found. It can be set to :search to attempt to locate wordnet automatically.\n @param [String, Symbol] data_path Specifies the directory within which constructed datasets can be found (tokyo index, evocations etc...) It can be set to :default to use the standard location inside the gem directory.\n @return [Wordnet] The wordnet connection object.\n @raise [BadWordnetConnector] If an invalid connector type is provided.\n Locates the set of homographs within wordnet specific to the term entered.\n\n @param [String] term The specific term that is desired from within wordnet. This is caps insensative & we do a small amount of cleanup.\n @return [Homographs] An object encaptulating the homographs of the desired term. If the term cannot be located within wordnet then nil is returned.\n @raise [NoWordnetConnection] If there is currently no wordnet connection.", "`point` is used to calculate the width and height\n    of the new rectangle", "Up vote a +voteable+.\n Raises an AlreadyVotedError if the voter already up voted the voteable.\n Changes a down vote to an up vote if the the voter already down voted the voteable.", "Up votes the +voteable+, but doesn't raise an error if the votelable was already up voted.\n The vote is simply ignored then.", "Down votes the +voteable+, but doesn't raise an error if the votelable was already down voted.\n The vote is simply ignored then.", "Clears an already done vote on a +voteable+.\n Raises a NotVotedError if the voter didn't voted for the voteable.", "Clears an already done vote on a +voteable+, but doesn't raise an error if\n the voteable was not voted. It ignores the unvote then.", "Returns true if the voter down voted the +voteable+.", "=begin rdoc\nSimulate a read of the Mindset device by returning an Array of Packet objects.\nThis assumes it will be called 8 times a second.\n\nAccording to the MDT, Mindset packets are sent at the following intervals:\n  1 packet per second: eSense, ASIC EEG, POOR_SIGNAL\n  512 packets per second: RAW\n\nEach read will therefore return 64 RAW packets. Every eighth read will also \nreturn 1 eSense, ASIC_EEG, and POOR_SIGNAL packet.\n=end", "Verifies the supplied `package.json` file\n @param    [string] package_json\n           Path to `package.json`, relative to current directory\n @return   [void]", "Inspects the supplied `package.json` file and returns problems\n @param    [string] package_json\n           Path to `package.json`, relative to current directory\n @return   [Array<{Symbol => String}>]\n            - `:package`: the offending package name\n            - `:version`: the version as written in `package.json`\n            - `:line`: (probably) the line number.", "Listen for messages. This is asynchronous and returns immediately.\n\n @example\n\n   queue = bisques.find_or_create_queue(\"my queue\")\n   listener = QueuedListener.new(queue)\n   listener.listen do |message|\n     puts \"Received #{message.object}\"\n     message.delete\n   end\n\n   while true; sleep 1; end # Process messages forever\n\n @note Note that the block you give to this method is executed in a new thread.\n @yield [Message] a message received from the {Queue}", "form_for helper for token input with jquery token input plugin\n for has_many and belongs_to association\n\n http://railscasts.com/episodes/258-token-fields\n http://loopj.com/jquery-tokeninput/\n\n helper will render standard text field input with javascript.\n javascript will change standard input to token field input\n\n EXAMPLE\n\n class Category < ActiveRecord::Base\n   attr_accessible :name, :parent_id, :product_ids\n   has_many :products\n\n   # method for converting array of categories to array of hashes in format that token input accepts\n   def to_token\n     {:id => id, :name => name}\n   end\n end\n\n class Product < ActiveRecord::Base\n   attr_accessible :name, :category_id\n\n   belongs_to :category\n end\n\n class CategoriesController < ApplicationController\n\n   # action for autocomplete\n   def token\n     categories = Category.where(\"categories.name like ?\", \"%#{params[:q]}%\")\n\n     respond_to do |format|\n       format.json { render :json => categories.map(&:to_token) }\n     end\n   end\n\n   # rest of the class\n end\n\n then in routes add route for token ajax call\n\n MyApplication::Application.routes.draw do\n   resources :categories do\n     collection do\n       get :token # route for token -> token_categories_path\n     end\n   end\n end\n\n then in view we call token_field\n token_field input will be default expects, that Category model exists\n <%= form_for @product do |f| %>\n   <%= f.token_field :category_id %>\n <% end %>\n\n possible options:\n\n in case the association roles where given like this\n\n class Product < ActiveRecord::Base\n    belongs_to :cat, :class_name => 'Category', :foreign_key => :cat_id\n end\n\n then right model need to be specified\n\n <%= f.token_field :cat_id, :model => :category %>\n\n We can use token_input also for mapping category to products\n we will use ActiveRecord method product_ids which be default return array of ids from association\n <%= form_for @category do |f| %>\n   <%= f.token_field :product_ids %>\n <% end %>\n\n in model we have to change product_ids= method like this\n\n class Category < ActiveRecord::Base\n   has_many :products\n\n   alias_method :product_ids_old=, :product_ids=\n   def product_ids=(ids)\n     ids = ids.split(\",\").map(&:to_i) if ids.is_a?(String)\n     self.product_ids_old=ids\n   end\n\n   # rest of the class...\n end", "recurse on nodes", "res the array with command line arguments that is used as result\n linker the linker hash\n sym the symbol that is used to fish out a value from the linker", "create a task that will link an executable from a set of object files", "Some symbolic links\n ln -s libfoo.so libfoo.1.2.so\n ln -s libfoo.1.so libfoo.1.2.so", "Returns a Hash associated with a key.  The Hash represents all of the attributes for\n a given action name on a controller.\n\n     acts_as_sitemap :index, title: \"my title\"   # index is the key\n     sitemap_attributes(\"index\")                 # index is the key\n\n @return [Hash]", "Return a new matrix which consists of the _self_ and _y_ side by\n side.  In general the hcat method should be used sparingly as it\n creates a new matrix and copies everything on each use. You\n should always ask yourself if an array of vectors or matrices\n doesn't serve you better. That said, you _can_ do funny things\n with +inject+. For example,\n\n   a = mat[1,2,3]\n   [a, 2*a, 3*a].inject {|s,x| s = s.hcat(x)}\n   => 1.0  2.0  3.0\n      2.0  4.0  6.0\n      3.0  6.0  9.0", "Return a new matrix which consists of the _self_ on top of _y_.\n In general the hcat methods should be used sparingly. You\n should always ask yourself if an array of vectors or matrices\n doesn't serve you better. See also hcat.", "Creates a new Option object with. If a block is given it will be\n used for the custom formatting of the option. If a block is not given,\n the option will use the default_format when generating the arguments.\n\n @param [Hash] options\n   Additional options.\n\n @option options [String] :flag\n   The command-line flag to use.\n\n @option options [true, false] :equals (false)\n   Implies the option maybe formated as `--flag=value`.\n\n @option options [true, false] :multiple (false)\n   Specifies the option maybe given an Array of values.\n\n @option options [String] :separator\n   The separator to use for formating multiple arguments into one\n   `String`. Cannot be used with the `:multiple` option.\n\n @option options [true, false] :sub_options (false)\n   Specifies that the option contains sub-options.\n\n @yield [option, value]\n   If a block is given, it will be used to format each value of the\n   option.\n\n @yieldparam [Option] option\n   The option that is being formatted.\n\n @yieldparam [String, Array] value\n   The value to format for the option. May be an Array, if multiple\n   values are allowed with the option.\n\n\n Formats the arguments for the option.\n\n @param [Hash, Array, String] value\n   The arguments to format.\n\n @return [Array]\n   The formatted arguments of the option.", "Closes all sessions.", "mix-in to retreive and parse JSON content from the web", "sets the creator for this todo\n\n @param [Object] creator person hash from API or <Logan::Person> object", "sets the assignee for this todo\n\n @param [Object] assignee person hash from API or <Logan::Person> object\n @return [Logan::Person] the assignee for this todo", "create a create in this todo list via the Basecamp API\n\n @param [Logan::Comment] todo the comment instance to create in this todo lost\n @return [Logan::Comment] the created comment returned from the Basecamp API", "Returns all the messages sent today to a room.", "Returns all the messages sent on a specific date to a room.", "Sends a new message with the currently authenticated user as the sender.\n The XML for the new message is returned on a successful request.\n\n The valid types are:\n\n * TextMessage  (regular chat message)\n * PasteMessage (pre-formatted message, rendered in a fixed-width font)\n * SoundMessage (plays a sound as determined by the message, which can be either \u201crimshot\u201d, \u201ccrickets\u201d, or \u201ctrombone\u201d)\n * TweetMessage (a Twitter status URL to be fetched and inserted into the chat)\n\n If an explicit type is omitted, it will be inferred from the content (e.g.,\n if the message contains new line characters, it will be considered a paste).\n\n :type => \"TextMessage\",  :body => \"Hello\"", "Make sure we're using an allowed emotion name", "Calculates ISBN-10 checksum\n\n @example\n   Sjekksum::ISBN10.of(\"147743025\") #=> 3\n   Sjekksum::ISBN10.of(\"193435600\") #=> \"X\"\n\n @param  number [Integer, String] number for which the checksum should be calculated\n\n @return [Integer, String] calculated checksum", "ISBN-10 validation of provided number\n\n @example\n   Sjekksum::ISBN10.valid?(\"1477430253\") #=> true\n   Sjekksum::ISBN10.valid?(\"193435600X\") #=> true\n\n @param  number [Integer, String] number with included checksum\n\n @return [Boolean]", "Transforms a number by appending the ISBN-10 checksum digit\n\n @example\n   Sjekksum::ISBN10.convert(\"147743025\") #=> \"1477430253\"\n   Sjekksum::ISBN10.convert(\"193435600\") #=> \"193435600X\"\n\n @param  number [Integer, String] number without a checksum\n\n @return [Integer, String] final number including the checksum", "if we caching and we have the same cache lets try and get the\n\u00a0cache; otherwise we will make the request logging if need be", "Split a cron string and extract the LAST interval that appears", "Split string expression into parts", "Succeed or fail like the decorated parser but do not consume any input\n and return +true+ on success.\n\n @param (see Match#parse)\n\n @return [Boolean] +true+ if the decorated parser succeeds", "Some symbolic links\n ln -s foo.dylib foo.A.dylib", "This method is used to retrieve the list of transactions performed within\n the date range by the MSISDN if set. Note that both dates are included\n during the search.\n\n parameters\n ==========\n msisdn\n ------\n The format must be international with or without the \u2018+\u2019 or \u201800\u2019:\n \u201c6012345678\u201d or \u201c+6012345678\u201d or \u201c006012345678\u201d (Malaysia)\n\n destination_msisdn\n ------------------\n The format must be international with or without the \u2018+\u2019 or \u201800\u2019:\n \u201c6012345678\u201d or \u201c+6012345678\u201d or \u201c006012345678\u201d (Malaysia)\n\n code\n ----\n The error_code of the transactions to search for. E.g \u201c0\u201d to search for\n only all successful transactions. If left empty, all transactions will be\n returned(Failed and successful).\n\n start_date\n ----------\n Defines the start date of the search. Format must be YYYY-MM-DD.\n\n stop_date\n ---------\n Defines the end date of the search (included). Format must be YYYY-MM-DD.", "Detach volume from server.", "Determines all of the attributes defined for a controller, then, calls the handler method on the controller\n to generate and return an Array of Hashes representing all of the url nodes to be included in the sitemap\n for the current route being processed.\n @return [Array] An Array of Hashes.", "Create a new command line interface for the given parser class\n\n @param [Class] parser_class the parser class to run the command line\n   interface for\n Run the command line interface", "Loads a patch from the patch_dir\n @param name [#to_s] Name of a patch to load from the patch_dir\n @return [Patch] A patch loaded from the patch_dir\n @raise [ConfigurationError] If patch_dir is nil or is not a valid directory path", "Create a new command-line parser.\n\n @param [Array<String>] args the command-line arguments\n Run the command-line parser.", "Gets the dewpoint highs and lows for the date range.\n @param (see #get_planner_response)\n @return [Hash<Symbol, Hash<Symbol, Hash<Symbol, Integer>>>] Highs and lows minimum, average, and maximum for both\n   metric and imperial systems.\n @return [String] The error if possible.\n @todo Raise an error instead of returning a String.", "Gets the full planner API response.\n @param start_date [DateTime] The date to start at. Only month and day actually matter.\n @param end_date [DateTime] The date to end at. Only month and day actually matter.\n @param location [String] The location to get the planner data for.\n @since 0.5.0\n @return (see Weatheruby#get)", "A utility method that lets you access a nested hash,\n returning nil if any intermediate hashes are unavailable.", "Create a hash of options and their values.", "create a project based on this project template via Basecamp API\n\n @param [String] name name for the new project\n @param [String] description description for the new project\n @return [Logan::Project] project instance from Basecamp API response", "Sets the logging level.\n\n     # sets the logging level to :debug and full stack traces for exceptions.\n     MyApp::Application.routes.draw do\n       log_level :debug, full: true\n     end\n\n @param [Symbol] value The logger level to use.  Valid values are:\n                       - :debug\n                       - :info\n                       - :warn\n                       - :error\n                       - :fatal\n                       - :unknown\n @param [Hash] options Options Hash.\n @option options [Symbol] :full Including full: true will include full stack traces for exceptions.\n                          Otherwise, stack traces are stripped and attempt to only include application traces.", "Generates the command-line arguments for all leading non-options.\n\n @return [Array]\n   The command-line arguments generated from all the leading\n   non-options of the task and it's sub-tasks.", "Generates the command-line arguments from all options.\n\n @return [Array]\n   The command-line arguments generated from all the options of the\n   task and it's sub-tasks.", "Generates the command-line arguments from all tailing non-options.\n\n @return [Array]\n   The command-line arguments generated from all the tailing\n   non-options of the task and it's sub-tasks.", "Generates the command-line arguments from the task.\n\n @return [Array]\n   The command-line arguments compiled from the leading non-options,\n   options and tailing non-options of the task and it's sub-tasks.", "Apply the optimzations to +parser+'s children, then to +parser+, in\n +context+.\n\n @param [Rattler::Parsers::Parser] parser the parser to be optimized\n @param [Rattler::Compiler::Optimizer::OptimizationContext] context\n\n @return [Rattler::Parsers::Parser] the optimized parser", "Try each parser in order until one succeeds and return that result.\n\n @param (see Match#parse)\n\n @return the result of the first parser that matches, or +false+", "Create a new Compress object. Takes a filename as string, and args as\n hash.\n\n args is a hash that contains two values, :type and :compression.\n\n * :type may be :tar or :zip\n * :compression may be :gzip, :bzip2, or nil (no compression)\n\n If the type :zip is selected, no compression will be used. Additionally,\n files in the .zip will all be stored as binary files.\n\n The default set of arguments is\n\n     { :type => :tar, :compression => :gzip }\n\n\n Run the compression. Files are an array of filenames. Optional flag for\n verbosity; if true, will print each file it adds to the archive to\n stdout.\n\n Files must be real files. No symlinks, directories, unix sockets,\n character devices, etc. This method will raise ArgumentError if you\n provide any.", "Initializer to construct a new CfApiServlet object.\n @param [HTTPServer] server a WEBrick HTTP server object.\n @param [Catflap] cf a fully instantiated Catflap object.\n @return void\n Implementation of HTTPServlet::AbstractServlet method to handle GET\n method requests.\n @param [HTTPRequest] req a WEBrick::HTTPRequest object.\n @param [HTTPResponse] resp a WEBrick::HTTPResponse object.\n @return void\n rubocop:disable Style/MethodName", "Updates this snapshot\n @return [self] if the instance data was mutated\n @return [nil] if the instance data was not mutated", "Find differences between this and another snapshot\n @param other_snapshot [Snapshot] to diff against\n @return [Array<Hash>] diff between the two snashots", "ascend from the current dir till I find a .git folder or reach home_dir", "initialize access to mongodb\n\n You might want to adjust the logging level, for example:\n   ::Mongo::Logger.logger.level = logger.level\n\n @param connection        mongodb connection, should already be switched to correct database\n @param nodes             symbol for collection that contains nodes with their facts\n @param node_properties   symbol for collection for nodes with their update timestamps\n @param meta              symbol for collection with update metadata\n get all nodes and their update dates", "get all node names", "get node names that fulfill given mongodb query\n\n @param query mongodb query", "get nodes and their facts that fulfill given mongodb query\n\n @param query mongodb query\n @param facts [Array<String>] get these facts in the result, eg ['fqdn'], empty for all", "get nodes and their facts that fulfill given mongodb query and have at least one\n value for one the given fact names\n\n @param query mongodb query\n @param facts [Array<String>] get these facts in the result, eg ['fqdn'], empty for all", "get nodes and their facts for a pattern\n\n @param query mongodb query\n @param pattern [RegExp] search for\n @param facts [Array<String>] get these facts in the result, eg ['fqdn'], empty for all\n @param facts_found [Array<String>] fact names are added to this array\n @param check_names [Boolean] also search fact names", "get facts for given node name\n\n @param node [String] node name\n @param facts [Array<String>] get these facts in the result, eg ['fqdn'], empty for all", "get meta informations about updates", "update or insert facts for given node name\n\n @param node [String] node name\n @param facts [Hash] facts for the node", "update node properties", "update or insert timestamps for given fact update method", "update or insert timestamps for node_properties_update", "high confident level", "Indicates if the current route requirements segments keys to generate a url.\n @return [Boolean] True if keys are required to generate a url, otherwise, false.", "Get a new ResultSet fetch for the next page", "todo improve speed", "Add a separator or newlines or both in between code generated in the\n given block for each element in +enum+. Newlines, are always added\n after the separator.\n\n @param [Enumerable] enum an enumerable sequence of objects\n\n @option opts [String] :sep (nil) optional separator to use between\n   elements\n @option opts [true, false] :newline (false) separate with a single\n   newline if +true+ (and if :newlines is not specified)\n @option opts [Integer] :newlines (nil) optional number of newlines to\n   use between elements (overrides :newline)\n\n @yield [element] each element in +enum+\n\n @return [self]", "collect track status", "format the string using given format\n if the result is shorter than width, pad space to the left\n if the result is longer than width, truncate the last characters", "Map each element and store the result in the matrix.\n\n Note that the result must be again something\n which can be stored in the matrix. Otherwise you should do an\n to_a first.", "Creates a Router for the given root directory.\n Returns the full file system path of the file corresponding to\n the given URL +path+, or\n\n - +:must_redirect+ if the request must be redirected to +path/+,\n - +:not_found+ if no corresponding file exists.\n\n The return value is found as follows:\n\n 1. a +path/+ with a trailing slash is changed to +path/index.html+,\n 2. then, the method checks for an exactly corresponding file,\n 3. when +path+ does not exist but +path/index.html+ does,\n    a redirect will be indicated,\n 4. finally, when no exactly corresponding file or redirect\n    can be found, +path.html+ is tried.", "Returns the body of the custom 404 page or +nil+ if none exists.", "A convenience method that takes a hash where each key is\n the symbol of a method, and each value is the parameters\n passed to that method.", "Given a category file that's an array, this method finds\n the parent of an item", "Given a category file that's a hash, this method finds\n the parent of an item", "Given a category file that's an array, this method finds\n the children of an item, probably a map topic\n\n toc - the array containing the table of contents\n title - the text title to return the children of\n\n Returns a flattened array of all descendants which could be empty.", "Given a category file that's a hash, this method finds\n the children of an item, probably a map topic\n\n toc - the hash containing the table of contents\n title - the text title to return the children of\n\n Returns a flattened array of all descendants which could be empty.", "add a service to hatt\n\n @param name [String] the name of the service\n @param url [String] an absolute url to the api", "Return domestic address details for a domestic address id\n @param address_id [String]\n @return address detail object", "Return australian address details for a specific international address id\n @param address_id [String]\n @return australian address detail", "Search for an International Address\n @param [String] characters to search for\n @param [Integer] number of search results to return (max 10)\n @param [String] country code for results - listed here: https://developers.google.com/public-data/docs/canonical/countries_csv/\n @return [Array] array of international addresses", "Return international address details for a specific international address id\n @param address_id [String]\n @return international address detail", "Find petition pages matching a given name.\n\n @param [Int] offset The number of records to skip.\n @param [Int] limit  The maximum number of results to return.\n @param [String] name The string to match against name.", "Create a petition page in your ActionKit instance.\n\n @param [String] name          The name of the page.\n @param [String] title         The title of the page.\n @param [URI]    lang          The URI string for the language of this page in the form of /rest/v1/language/{id}\n @param [URL]    canonical_url The canonical URL for this page.", "Creates an action which associates a user with a page.\n\n @param [String] page_name The ActionKit name of the page on which the action is being taken.\n @param [String] email     The email address of the person taking action.", "Creates an action which registers a donation with a user account.\n\n @param [Hash] options The hash of values sent to ActionKit which contain information about this transaction.", "Lists users in your instance.\n\n @param [Int] offset The number of records to skip.\n @param [Int] limit  The maximum number of results to return.", "we should be able to lookup where the user stores the config map\n so the user doesn't have to pass this info each time\n create a blank yaml config file it file does not exist", "Add one or many fields to the csv format.\n\n If options are passed, they apply to all given fields.", "Define a one to one association. This is also aliased as `belongs_to`. Expects a name and a block to\n define the fields on associated record.\n\n For example:\n\n   define_csv_fields do |c|\n     has_many 'publisher' do |p|\n       p.field :id, :name, :_destroy\n     end\n   end", "Define a one to many association. Expect a name and a block to\n define the fields on associated records.\n\n For example:\n\n   define_csv_fields do |c|\n     has_many 'reviews' do |r|\n       r.field :id, :name, :_destroy\n     end\n   end", "Generates a rule based on a parsed expression", "always returns a string, intended for request bodies\n every attempt is made to ensure string is valid json\n but if that is not possible, then its returned as is", "attempts to parse json strings into native ruby objects", "Returns a hash where the keys are the values in the passed array and the\n values are the number of times that value appears in the list.", "Returns the UID for the username on the host.", "Returns GID for the group on the host.", "Makes a GET request to the Podbay servers that are listening for Podbay\n data requests", "update by deleting missing nodes and get a complete map of nodes with facts\n and update or insert facts for each one\n\n mongo: 1597 nodes in 35.31 seconds", "update node update information\n\n mongo: 1602 nodes in 0.42 seconds", "Returns an array of encodings from this header that match the given\n +encoding+, ordered by precedence.", "Helper for belongs_to and accepts all the standard rails options\n\n Example\n   class Thing < ActiveRecord::Base\n     belongs_to_selection :priority\n\n by default adds - class_name: \"Selection\"\n\n This macro also adds a number of methods onto the class if there is a selection\n named as the class underscore name (eg: \"thing_priority\"), then methods are created\n for all of the selection values under that parent. For example:\n\n   thing = Thing.find(x)\n   thing.priority = Selection.thing_priority_high\n   thing.priority_high? #=> true\n   thing.priority_low?  #=> false\n\n thing.priority_high? is equivalent to thing.priority == Selection.thing_priority_high\n except that the id of the selection is cached at the time the class is loaded.\n\n Note that this is only appropriate to use for system selection values that are known\n at development time, and not to values that the users can edit in the live system.", "=begin\n\t\tdef explode!\n\t\t\t@grid.explode!\n\t\t\tsuper\n\t\tend\n=end", "sends a subscription request to the bare entity", "send a subscription stanza to accept an incoming subscription request", "unsubscribes from from the bare entity", "returns a PubSub entity with same bare jid\n accepts an optional node-id", "Generates a MUC entity from this entity.\n If the nick argument is null then the entity is the MUC itself.\n If the nick argument is present, then the entity is the user with\n the corresponding nickname.", "returns Float\n this is wonky because of the wonky way we use historical_rate_by_day", "Get phone number\n\n   Jia::User.new.phone # => '18100000000'", "returns true if time is aligned to the recurrence pattern and matches all the filters", "Find a potential previous date matching the rule as a minimum of previous\n valid dates from all the filters. Subclasses should add a check of\n recurrence pattern match", "Creates a Hash representation of self\n\n @return [Hash]", "Coals assumes that any task lacking a description\n is not meant to be called directly, i.e. a 'subtask'\n This is in line with the list rendered by `rake -T`", "This function check that the post parent exist and has not others post for the same language.", "This function add the post to the default category.", "Calls the given function with the given parameters via the JSON\n interface of Scalaris.", "The command as a string, including arguments and options, plus prefixed\n environment variables.", "This method is invoked when a log event occurs", "remember the domain name and get the cookie to use from the TPB server\n search torrents", "Performs an HTTP POST request", "Performs an HTTP PUT request", "Performs an HTTP DELETE request", "Initialize the option\n\n ==== Parameters\n * <tt>name</tt>  - A valid name for the option\n * <tt>behaviors</tt>  - Behaviors used to for this option\n * <tt>block</tt>   - A proc that should be run against the option value.\n ==== Options\n * <tt>allow</tt>  - The option value must be in this list\n * <tt>boolean</tt>  - The option will accept <tt>true</tt>, <tt>false</tt>, <tt>0</tt>, <tt>1</tt>", "Create the map hash\n @since 0.4.1\n Return an ASCII-formatted string for display in common command line\n terminals\n @since 0.0.1", "detects what changed and updates as needed\n @return [TrueClass || FalseClass] updated?", "this is slightly dangerous, if anything was still pointing to old pointer location\n now its being reclaimed, this will change it\n @return [Integer] hash", "Handles methods corresponding to a tag name, ending with either\n _list or _attr, or starting with add_ .", "Returns a short summary that is at least 140 characters long", "this method with upgrade the RequestToken to an AccessToken\n   note that this will destroy the current RequestToken", "adds the line to the while maintaining the data's sort order\n\n @param [String] line to add to the file, it should not have it's own line ending.\n @return [Nil] always returns nil to match standard #puts method", "Builds an Array of position and length of the current file.\n @return [Array[Array[Fixnum,Fixnum]]] array of position, line length pairs", "remembers current file position, reads everything at the position\n execute the block, and put everything back.\n This routine is really bad for huge files since it could run out of\n memory.", "Prepares the basic @http object with the current values of the module (host, port, ...)\n Prepares the @http_request object with the actual content of the request", "Actually makes the request prepared in @http_request, and sets @http_response", "Finds the group memberships that match the given group, possibly\n constrained by one or more affiliates.\n\n (Note that this method hides the `Enumerable` method `find`.\n You can still use it under its `detect` alias.)\n\n @param [Group,#to_s] group the group in question or its name\n @param [Array<Object>,nil] *affiliate_ids the affiliates to use to\n   constrain the query.\n\n @return [Array<GroupMembership>]", "connect kvs and exec block.\n This function pools the connecting driver.\n\n @example\n   config = {\n     :host           => 'localhost', # host of KVS.\n     :port           => 6379,        # port of KVS.\n     :namespace      => 'Example',   # namespace of avoid a conflict with key\n     :timeout_sec    => 5,           # timeout seconds.\n     :pool_size      => 5,           # connection pool size.\n     :config_key     => :none        # this key is option.(defaults=:none)\n                                     #  when set this key.\n                                     #  will refer to a connection-pool based on config_key,\n                                     #  even if driver setting is the same without this key.\n   }\n   result = Driver.session(config) do |kvs|\n     kvs['example'] = 'abc'\n     kvs['example']\n   end\n\n   puts result  # => 'abc'\n\n @param driver_config [Hash] driver_config.\n @param &block [{|driver_instance| #something... }] exec block.\n @return [Object] status", "get driver connection pool\n if doesn't exist pool, it's made newly.\n\n @param driver_class   [RailsKvsDriver::Base]  driver_class\n @param driver_config  [Hash]                  driver_config\n @return [ConnectionPool] connection pool of driver", "set driver connection pool\n\n @param driver_class   [RailsKvsDriver::Base]  driver_class\n @param driver_config  [Hash]                  driver_config\n @return [ConnectionPool] connection pool of driver", "search driver connection pool\n\n @param driver_class   [RailsKvsDriver::Base]  driver_class\n @param driver_config  [Hash]                  driver_config\n @return [ConnectionPool] connection pool of driver, or nil", "compare driver config.\n\n @param config1 [Hash] driver config\n @param config2 [Hash] driver config", "following methods are used for calling from the function block\n raise an error if argument count got does not match the expected", "Load specified extensions in the order defined by self.extension_include_order.", "Dialog content for a new element", "Create a new element", "Update an existing element", "Move an element", "Replaces the non-interactive authentication modes.\n @param [List<#to_sym>] new_modes the names of the desired modes\n @return [void]", "Loads parameters from the given aker central parameters\n file.\n\n @see Aker::CentralParameters\n @param [String] filename the filename\n @return [void]", "Initializes a new instance of a Core object.\n\n\n  Configures the given", "Executes a given block with an \"anonymous\" temporary file.\n The temporary file is deleted at the end of the block, and its contents\n are returned.", "Create new color from a hex value", "Makes an HTTP request using the provided parameters\n @raise [Plangrade::Error::Unauthorized]\n @param method [string]\n @param path [string]\n @param params [Hash]\n @return [Plangrade::ApiResponse]\n @!visibility private", "returns an Array of the App Servers in the deployment", "The duration of the movie in milliseconds, as an integer.\n\n Example:\n\n   24400         # 24.4 seconds\n\n Note that the precision of the duration is in tenths of a second, not\n thousandths, but milliseconds are a more standard unit of time than\n deciseconds.", "Returns a new instance of Domain\n\n @param domain [String] The domain name.\n\n @example EmailChecker::Domain.new('google.com')\n Checks if the domian exists and has valid MX and A records.\n\n @return [Boolean]", "Check if the domian has valid MX records and it can receive emails.\n The MX server exists and it has valid A records.\n\n @return [Boolean]", "The servers that this domian MX records point at.\n\n @return [Array<Hash>] Array of type { preference: 1, address: '127.0.0.1' }", "Initialize the generator.\n\n @param [BitMagic::Adapters::Magician, Hash] magician_or_field_list a Magician\n   object that contains field_list, bits, and options OR a Hash object of\n   :name => bit index or bit index array, key-value pairs\n @param [Hash] options options and defaults, will override Magician action_options\n   if given\n @option options [Integer] :default a default value, default: 0\n @option options [Proc] :bool_caster a callable Method, Proc or lambda that\n   is used to cast a value into a boolean\n\n @return [BitsGenerator] the resulting object\n Given a field name or list of field names, return their corresponding bits\n Field names are the key values of the field_list hash during initialization\n\n @param [Symbol, Integer] one or more keys for the field name or an integer\n    for a known bit index\n\n @example Get a list of bits\n   gen = BitMagic::BitsGenerator.new(:is_odd => 0, :amount => [1, 2, 3], :is_cool => 4)\n   gen.bits_for(:is_odd) #=> [0]\n   gen.bits_for(:amount) #=> [1, 2, 3]\n   gen.bits_for(:is_odd, :amount) #=> [0, 1, 2, 3]\n   gen.bits_for(:is_cool, 5, 6) #=> [4, 5, 6]\n   gen.bits_for(9, 10) #=> [9, 10]\n\n @return [Array<Integer>] an array of bit indices", "Iterates over the entire combination of all possible values utilizing the\n list of bits we are given.\n\n Warning: Because we are iteration over possible values, the total available\n values grows exponentially with the given number of bits. For example, if\n you use only 8 bits, there are 2*8 = 256 possible values, with 20 bits it\n grows to 2**20 = 1048576. At 32 bits, 2**32 = 4294967296.\n\n Warning 2: We're using combinations to generate each individual number, so\n there's additional overhead causing O(n * 2^(n-1)) time complexity. Carefully\n benchmark when you have large bit lists (more than 16 bits total) and\n check both timing and memory for your use case.\n\n @param [optional, Array<Integer>] each_bits a list of bits used to generate\n   the combination list. default: the list of bits given during initialization\n @param [Proc] block a callable method to yield individual values\n\n @yield num will yield to the given block multiple times, each time with one\n   of the integer values that are possible from the given bits list\n\n @example Iterate over a list of bits\n   gen = BitsGenerator.new(:is_odd => 0, :amount => [1, 2, 3], :is_cool => 4)\n   values = []\n   gen.each_value { |val| values << val } #=> 32\n   values #=> [0, 1, 2, 4, 8, 16, 3, 5, 9, 17, 6, 10, 18, 12, 20, 24, 7, 11, 19, 13, 21, 25, 14, 22, 26, 28, 15, 23, 27, 29, 30, 31]\n   values2 = []\n   gen.each_value([0, 5]) { |val| values2 << val } #=> 4\n   values2 #=> [0, 1, 32, 33]\n\n\n @return [Integer] total number of values yielded", "Gives you an array of all possible integer values based off the bit\n combinations of the bit list.\n\n Note: This will include all possible values from the bit list, but there\n are no guarantees on their order. If you need an ordered list, sort the result.\n\n Warning: Please see the warnings on each_value.\n\n Warning: Memory usage grows exponentially to the number of bits! For example,\n on a 64 bit platform (assuming pointers are 8 bytes) if you have 8 bits,\n this array will have 256 values, taking up 2KB of memory. At 20 bits, it's\n 1048576 values, taking up 8MB. At 32 bits, 4294967296 values take up 34GB!\n\n @param [optional, Array<Integer>] each_bits a list of bits used to generate\n   the combination list. default: the list of bits given during initialization\n @param [Hash] opts additional options\n @option opts [Integer] :warn_threshold will output warning messages if\n   the total number of bits is above this number. false to disable. default: 20\n\n @example Get an array for all values from our bit list\n   gen = BitsGenerator.new(:is_odd => 0, :amount => [1, 2, 3], :is_cool => 4)\n   gen.all_values\n\n @return [Array<Integer>] an array of all possible values from the bit list\n   Order is not guaranteed to be consistent.", "Gives you an array of values where the given field names are exactly\n equal to their given field values.\n\n Possible values are derived from the bits list during initialization.\n\n Note: Order is not guaranteed. All numbers will be present, but there is\n no expectation that the numbers will be in the same order every time. If\n you need an ordered list, you can sort the result.\n\n @param [Hash] one or more field names or an integer for a known bit index\n   as the key, and the value (integer or boolean) for that field as the hash\n   value. Values that have more bits than available will be truncated for\n   comparison. eg. a field with one bit setting value to 2 means field is 0\n\n @example Get different amount values\n   gen = BitsGenerator.new(:is_odd => 0, :amount => [1, 2, 3], :is_cool => 4)\n   gen.equal_to(:amount => 5) #=> [10, 11, 26, 27]\n   gen.equal_to(:amount => 7) #=>  [14, 15, 30, 31]\n   gen.equal_to(:amount => 7, :is_odd => 1, :is_cool => 1) #=> [31]\n\n @return [Array<Integer>] an array of integer values where the bits and values\n   match the given input", "Will return an array of two numbers, the first of which has all bits set\n where the corresponding value bit is 1, and the second has all bits set\n where the corresponding value bit is 0.\n These numbers can be used in advanced bitwise operations to test fields\n for exact equality.\n\n @param [Hash] one or more field names or an integer for a known bit index\n   as the key, and the value (integer or boolean) for that field as the hash\n   value. Values that have more bits than available will be truncated for\n   comparison. eg. a field with one bit setting value to 2 means field is 0\n\n @example Retrieve the representation for various amounts\n   gen = BitsGenerator.new(:is_odd => 0, :amount => [1, 2, 3], :is_cool => 4)\n   gen.equal_to_numbers(:amount => 5) #=> [10, 4]\n   # 5 is 101, 10 is 1010 and 4 is 100. (Note that amount uses bits 1, 2, 3)\n   gen.equal_to_numbers(:amount => 7) #=> [14, 0]\n   gen.equal_to_numbers(:amount => 7, :is_odd => 1) #=> [15, 0]\n\n\n @return [Array<Integer>] an array of two integers, first representing bits\n   of given field bit values as 1 set to 1, and the second representing bits\n   of given field bit values as 0 set to 1. See the example.", "This function return all category children of the current category.", "Get the Lundar date in 'xxxx-xx-xx' fromat", "Return the days in lunar of y year.", "Cache dropdown options for children classes to use\n Meant to be reseted each time an entry is created, updated or destroyed\n So it is only rebuild once required after the list has changed\n Maintaining an array and not rebuilding it all might be faster\n But it will not happen much so that it is fairly acceptable", "crushyfield is crushyinput but with label+error", "Provide a thumbnail for the column", "parsing incoming traffic", "Default callbacks for PING, VERSION, TIME and ISUPPORT processing.", "Write a LookUpTable into Cache", "Reads from a erb file and renders the content with context\n\n @param src String - file path of template\n @param dst String - file path location to save\n @param context Hash - parametized variables to pass to template\n @return Boolean\n\n @example\n     template('examples/my-demo-charm/templates/vhost.conf',\n              '/tmp/nginx-data.conf',\n              public_address: 'localhost',\n              app_path: '/srv/app')", "Reads from a embedded template in the rake task itself.\n\n @param src String - The data found after __END__\n @param dst String - Save location\n @param context Hash - variables to pass into template\n @return Boolean\n\n @example\n     inline_template('vhost.conf',\n                     '/etc/nginx/sites-enabled/default')\n                     server_name: \"example.com\")\n\n     __END__\n     @@ vhost.conf\n     server { name <%= server_name %> }", "Delete +key+ from the container. If the container is on the CDN, the object will\n still be served from the CDN until the TTL expires.", "Returns some metadata about a single object in this container.", "Download the object at key into a local file at filepath.\n\n Returns the number of downloaded bytes.", "Return an array of files in the container.\n\n Supported options\n\n max - the maximum number of items to return\n marker - return items alphabetically after this key. Useful for pagination\n prefix - only return items that start with this string\n details - return extra details for each file - size, md5, etc", "Return some basic stats on the current container.", "Set metadata headers on the container\n\n     headers = { \"X-Container-Meta-Access-Control-Allow-Origin\" => \"*\" }\n     container.set_metadata(headers)\n\n Note: Rackspace requires some headers to begin with 'X-Container-Meta-' or other prefixes, e.g. when setting\n       'Access-Control-Allow-Origin', it needs to be set as 'X-Container-Meta-Access-Control-Allow-Origin'.\n See:  http://docs.rackspace.com/files/api/v1/cf-devguide/content/CORS_Container_Header-d1e1300.html\n       http://docs.rackspace.com/files/api/v1/cf-devguide/content/\n         POST_updateacontainermeta_v1__account___container__containerServicesOperations_d1e000.html", "Return the key details for CDN access to this container. Can be called\n on non CDN enabled containers, but the details won't make much sense.", "use this with caution, it will make EVERY object in the container publicly available\n via the CDN. CDN enabling can be done via the web UI but only with a TTL of 72 hours.\n Using the API it's possible to set a TTL of 50 years.\n\n TTL is defined in seconds, default is 72 hours.", "Generate an expiring URL for downloading a file that is otherwise private.\n Useful for providing temporary access to files.", "Generate a temporary URL for uploading a file to a private container. Anyone\n can perform a PUT request to the URL returned from this method and an object\n will be created in the container.", "build the request path for listing the contents of a container", "Creates a new Temp and initializes it with the current date if no date\n is provided\n Provides the date calculation methods dynamically", "Creates a new person object\n\n @param [Hash] data the data used to create the user\n @return [Person]\n Converts a hash to instance variables\n\n @param [Hash] data the data used to create the instance variables", "Sets all instance variables\n\n @param [String] k the key used to create the instance variables\n @param [String] v the value used to create the instance variables", "Override the aggregate hash conditions behavior to coerce has_enumeration\n attributes that show up in finder options as symbols into instances of\n the aggregate class before hash expansion.", "The new external attribute value\n\n Tells the current transaction to ignore further errors of this kind\n until the attribute value is changed again externally.\n\n @param [Boolean] update_value\n   If set to +true+, the read set entry for this attribute is updated with the\n   new external value. This means that the new value will be visible inside of\n   the transaction until it changes again.\n\n   Otherwise, the exception is completely ignored and will have no impact\n   on the values displayed inside the transaction.", "Tells the transaction to ignore all changes previously done to the current\n attribute in the transaction.", "download a v13 report", "schedule and download a v13 report", "Compute a patch between the given +expected+ output and the +actual+ output\n and return it as a string.", "initialize a polypaperclip model if a configuration hasn't already been loaded", "Dynamically pass unknown messages to the underlying state storage\n\n State fields become accessible through readers, like in an\n {http://ruby-doc.org/stdlib-2.0.0/libdoc/ostruct/rdoc/OpenStruct.html OpenStruct}.\n A single state field can be questioned for existence by having its name\n followed by a question mark - eg. bacon?.\n A single state field can be force-accessed by having its name followed by\n an exclamation mark - eg. bacon!.\n\n This method reeks of :reek:TooManyStatements.\n\n @param name [Symbol|String]\n @param args [Array<Object>]\n @param block [Proc]\n\n @return [Object]\n @raise [NoMethodError]\n @raise [Errors::StateMissing]\n @api private\n @example\n   state = Statefully::State.create(bacon: 'tasty')\n\n   state.bacon\n   => \"tasty\"\n\n   state.bacon?\n   => true\n\n   state.bacon!\n   => \"tasty\"\n\n   state.cabbage\n   NoMethodError: undefined method `cabbage' for #<Statefully::State::Success bacon=\"tasty\">\n           [STACK TRACE]\n\n   state.cabbage?\n   => false\n\n   state.cabbage!\n   Statefully::Errors::StateMissing: field 'cabbage' missing from state\n           [STACK TRACE]", "Companion to `method_missing`\n\n This method reeks of :reek:BooleanParameter.\n\n @param name [Symbol|String]\n @param _include_private [Boolean]\n\n @return [Boolean]\n @api private", "Bumps a version by incrementing one of its terms and reseting the others\n according to semver specification.\n\n @example\n   Versioner.new('1.2.3-alpha.1+build.2').bump(:major)\n     # => '2.0.0'\n   Versioner.new('1.2.3-alpha.1+build.2').bump(:minor)\n     # => '1.3.0'\n   Versioner.new('1.2.3-alpha.1+build.2').bump(:patch)\n     # => '1.2.4'\n   Versioner.new('1.2.3-alpha.1+build.2').bump(:pre)\n     # => '1.2.3-alpha.2'\n   Versioner.new('1.2.3-alpha.1+build.2').bump(:build)\n     # => '1.2.3-alpha.2+build.3'\n\n @param term [Symbol] the term to increment\n @raise [Anvil::Versioner::NotSuportedTerm] When the given term is invalid", "Resets all the terms which need to be reset after a bump\n\n @param term [Symbol] The term which has been bumped\n @return [Anvil::Versioner] A new version with the proper number\n @todo we still need to reset pre-release and builds properly", "Receipient number should be in the format of 04xxxxxxxx where x is a digit.\n Authorization header value should be in the format of \"Bearer xxx\" where xxx\n is the access token returned from a token request.", "Initialize a provider from a tag and object hash.\n\n @param [String] tag the tag which represents the origin on the provider.\n @param [Hash] hash the attributes for the box\n @param hash [String] :name The name of the provider.\n @param hash [String] :url An HTTP URL to the box file. Omit if uploading\n   with Atlas.\n Save the provider.\n\n @return [Hash] Atlas response object.", "Upload a .box file for this provider.\n\n @param [File] file a File object for the file.", "Return true if job is runnable at the given time.\n\n Note we expect an instance of Time.\n ActiveSupport can be used to give us time zones in Time.\n\n Example\n   ok,details = runnable?(Time.now)", "Adds an allow rule for the given actions to the collection.\n\n @example Allow a person that is a member of a team to show\n   allow :person, :who => :is_member, :of => :team, :to => :show\n @example Allow a person that is a member of any of the teams to index.\n   allow :person, :who => :is_member, :of => [:team1, :team2], :to => :index\n @example Allow a person with either of the named roles for a resource to perform any \"write\" operations.\n   allow [:project_admin, :project_manager], :of => :project, :to => :write\n @example Allow a person with the viewer role of either of the projects to show.\n   allow :viewer, :of => [:project1, :project2], :to => :show\n\n @param [Symbol, <Symbol>] roles the role(s) that the rule will apply to.\n @param [Hash] options the options used to build the rule.\n @option options [Symbol] :who the method to call on the target resource.\n @option options [Symbol] :that alias for :who\n @option options [Symbol, nil, :any, <Symbol, nil>] :of the name of the instance variable holding the target\n   resource. If set to +:any+ then the match will apply to a person that has\n   a matching role authorization for any resource. If not given, or set to\n   +nil+, then the match will apply to a person that has a matching role\n   authorization for a nil resource. +:any/nil+ functionality only applies\n   when using named roles. (see Permit::NamedRoles).\n @option options [Symbol, nil, :any, <Symbol, nil>] :on alias for +:of+\n @option options [Symbol, String, Proc] :if code to evaluate at the end of the\n   match if it is still valid. If it returns false, the rule will not\n   match. If a proc if given, it will be passed the current subject and\n   binding. A method will be called without any arguments.\n @option options [Symbol, String, Proc] :unless code to evaluate at the end\n   of the match if it is still valid. If it returns true, the rule will not\n   match. If a proc if given, it will be passed the current subject and\n   binding. A method will be called without any arguments.\n @option options [Symbol, <Symbol>] :to the action(s) to allow access to if this\n   rule matches. +:all+ may be given to indicate that access is given to all\n   actions if the rule matches. Actions will be expanded using the aliases\n   defined in {Permit::Config.action_aliases}. The expansion operation is\n   not recursive.\n @return [PermitRule] the rule that was created for the parameters.\n @raise [PermitConfigurationError] if +:to+ is not valid, or if the rule\n   cannot be created.", "activation method for an AR class", "Intantiate a new class to work with subscriptions\n\n @param [required, Hash] params to create the user\n @option params [required, String] :username username to authenticate with\n @option params [required, String] :password to authenticate with\n @option params [optional, String] :base_uri of an alternative location of SMSified\n @option params [optional, String] :destination_address to use with subscriptions\n @option params [optional, String] :sender_address to use with subscriptions\n @option params [optional, Boolean] :debug to turn on the HTTparty debugging to stdout\n @example\n   subscription = Subscription.new :username => 'user', :password => '123'\n\n Creates an inbound subscription\n\n @param [required, String] destination_address to subscribe to\n @param [required, Hash] params to send an sms\n @option params [optional, String] :notify_url to send callbacks to\n @option params [optional, String] :client_correlator to update\n @option params [optional, String] :callback_data to update\n @return [Object] A Response Object with http and data instance methods\n @param [required, String] notify_url to send callbacks to\n @return [Object] A Response Object with http and data instance methods\n @example\n   subscriptions.create_inbound_subscription('tel:+14155551212', :notify_url => 'http://foobar.com')", "This method should be be called by +before_filter+.\n\n   before_filter :authorize_action", "Find and load config file.", "Find and load JSON config file.", "Find and load YAML config file.", "Reconstruct the new sequence from the diff", "Populates the sourcefile with the given content\n\n @param content [String] - Usually the output of a bash command\n\n @param **options [key value pairs] -\n See https://github.com/piotrmurach/tty-file for TTY::File docs", "implementation of skeletonization algorithm presented in Gonzalez & Woods, p 651-652", "Filter the squares with a hash of attribute and matching values.\n\n @param [Hash] hash\n   attributes to query for.\n\n @return [SquareSet]\n\n ==== Example:\n   # Find all squares where piece is nil\n   square_set.where(piece: nil)", "Find the square with the matching x and y co-ordinates\n\n @param [Fixnum] x\n   the x co-ordinate.\n\n @param [Fixnum] y\n   the y co-ordinate.\n\n @return [Square]\n ==== Example:\n   # Find the square at 4,2\n   square_set.find_by_x_and_y(4, 2)", "Find all squares within distance of square\n\n @param [Square] square\n   the originating square\n\n @param [Fixnum] distance\n   the specified distance from the square\n\n @return [SquareSet]\n ==== Example:\n   # Get all squares within 2 squares of square_a\n   square_set.in_range(square_a, 2)", "Find all squares at distance of square\n\n @param [Square] square\n   the originating square\n\n @param [Fixnum] distance\n   the specified distance from the square\n\n @return [SquareSet]\n ==== Example:\n   # Get all squares at 2 squares from square_a\n   square_set.at_range(square_a, 2)", "Returns destination from the origin that have a clear path\n\n @param [Square] origin\n   the originating square.\n\n @param [SquareSet] square_set\n   the board position.\n\n @return [SquareSet]", "Returns squares between a and b.\n Only squares that are in the same diagonal will return squares.\n\n @param [Square] a\n   a square.\n\n @param [Square] b\n   another square.\n\n @return [SquareSet]\n\n ==== Example:\n   # Get all squares between square_a and square_b\n   square_set.between(square_a, square_b)", "Determines the version of Vagrant based on the output", "Get the full changelog including metadata.\n @param [Boolean] first_parent Optional, if true limits to first parent commits\n @param [String] range Optional, define a specific range of commits\n @param [String] branch Optional, show commits in a branch\n @param [String] from_ancestor_with Optional, from common ancestor with this branch\n @return [String] changelog", "Get log messages for a repository\n @param [Boolean] first_parent Optional, if true limit to first parent commits\n @param [String] range Optional, define a specific range of commits\n @param [String] branch Optional, show commits in a branch\n @param [String] from_ancestor_with Optional, from common ancestor with this branch\n @return [Array<String>] log messages", "Get the header when a range is defined\n @param [String] range Define a specific range of commits\n @return [String] header with a range", "Get the header when a branch is defined\n @param [String] branch Show commits for a branch\n @param [String] ancestor Ancestor or nil\n @return [String] header with a branch", "Checks file node matches the schema.\n\n Checks type of node against expected type and\n checks any children are of the accepted types.", "Checks that the node is of the correct type\n\n If the expected node is a custom node type as defined in the schema\n It will run `match_node` to check that the node schema matches the\n custom type.", "Public function for running cleanup of previous build", "Public function for building sprockets assets and minifying", "Render html from a mustache template", "Conver underscore to camelcase", "Initialize sprockets environment", "Minify assets in format", "Launch all servers in the deployment.", "Checks that monitoring is enabled on all servers in the deployment.  Will raise an error if monitoring is not enabled.", "Add attributes to the instance cache and define the accessor methods", "Add the foreign key for the belongs_to relationships", "Generate the full tag for the given image, concatenating the org,\n project, env, image name, and version.\n\n Pass `version: nil` to exclude the version portion.\n\n @example\n   image_tag(\"app\") # => jutonz/dctl-dev-app:1", "Returns the path to the .dctl.yml file for the current project", "If there are user defined commands in .dctl.yml, dynamically add them to\n the passed thor CLI so they may be executed.", "Ensure the current project's .dctl.yml contains all the requisite keys.", "Accepts a list of pairs and produces option tags.\n\n @example\n\n   select_options([['One', 1], ['Two', 2]])\n   select_options([['One', 1], ['Two', 2]], 1)\n   select_options([['One', 1], ['Two', 2]], 1, '- Choose -')\n\n   # using it with the provided date helpers...\n   select_options year_choices, 2010 # select 2010 as default\n   select_options month_choices, 5 # select May as default\n   select_options day_choices, 25 # select the 25th as default\n\n @param [Array] pairs a collection of label, value tuples.\n @param [Object] current the current value of this select.\n @param [#to_s] prompt a default prompt to place at the beginning\n                of the list.", "Presents errors on your form. Takes the explicit approach and assumes\n that for every form you have, the copy for the errors are important,\n instead of producing canned responses.\n\n Allows you to do the following in your haml view:\n\n @example\n\n   - errors_on @user do |e|\n     - e.on [:email, :not_present], \"We need your email address.\"\n     - e.on [:password, :not_present], \"You must specify a password.\"\n\n   # produces the following:\n   # <div class=\"errors\">\n   #   <ul>\n   #     <li>We need your email address</li>\n   #     <li>You must specify a password.</li>\n   #   </ul>\n   # </div>\n\n @param [#errors] object An object responding to #errors. This validation\n                  also checks for the presence of a #full_messages method\n                  in the errors object for compatibility with ActiveRecord\n                  style objects.\n @param [Hash] options a hash of HTML attributes to place on the\n               containing div.\n @option options [#to_s] :class (defaults to errors) The css class to put\n                                in the div.\n @yield [Sinatra::Helpers::HamlErrorPresenter] an object responding to #on.\n\n @see Sinatra::Helpers::HamlErrorPresenter#on", "Show the percentage representation of a numeric value.\n\n @example\n   percentage(100) == \"100.00%\"\n   percentage(100, 0) == \"100%\"\n\n @param [Numeric] number A numeric value\n @param [Fixnum]  precision (defaults to 2) Number of decimals to show.\n @return [String] the number displayed as a percentage\n @return [nil]    given a nil value or an empty string.", "Get a graph of the historical data for the given buoy.\n\n Inspired by:\n\n https://github.com/thepug/nbdc_graph/blob/master/generate_graphs.py", "Send Email after model save", "create a new server on Rackspace.\n\n server_name is a free text name you want to assign the server.\n\n flavor_name is a string that describes the amount of RAM. If you enter\n an invalid option a list of valid options will be raised.\n\n image_name is a string that describes the OS image to use. If you enter\n an invalid option a list of valid options will be raised. I suggest\n starting with 'Ubuntu 10.04 LTS'\n\n files is an optional Hash of path to blobs. Use it to place a file on the\n disk of the new server.\n\n Use it like this:\n\n     server.create(\"my-server\", 512, \"Ubuntu 10.04 LTS\", \"/root/.ssh/authorised_keys\" => File.read(\"/foo\"))", "Add the given file to this graph. Creates a new entry in the\n graph, the key of which is the relative path to this file and\n the value is the array of relative paths to its dependencies.\n Any dependent files will also be recursively added to this\n graph.", "Parses all of the files in the given glob and adds their\n dependencies to the graph. A file in this glob is not added\n to the graph unless another file in the glob depends on it.", "Parses the file and returns the relative paths to its dependencies.", "Run the loop", "Check the url for each link in view to show it", "Run puppet using `driver_instance` to execute `puppet_codes`\n @param puppet_test Hash of test names <-> puppet code, eg {\"apache\"=>\"include apache\",\"nginx\"=>\"include nginx\"}}", "Extracts all parameters from the operation node, and return as an array.\n\n @param op_options [Hash] The operation options.\n @param node [Nokogiri::XML] The operation node.\n @return [Array] The parsed parameters.", "Serializes the result of an operation as a SOAP Envelope.\n\n @param op_options [Hash] The operation options.\n @param r [Hash,Object] The operation result.\nnoinspection RubyArgCount", "Extracts a field from an object, casts it to the appropriate type, and serializes as XML.\n\n @param builder [Builder::XmlMarkup] The XML builder.\n @param obj [Hash,Object] The resulting object.\n @param field [Symbol,String] The field to extract.\n @param type [Class] The type to convert.", "Serializes an exception as a SOAP Envelope containing a SOAP Fault.\n\n @param ex [Exception] The Exception to serialize.\n @return [String] The SOAP Envelope containing the Fault.\nnoinspection RubyArgCount", "All user defined instance variables for current request.", "This action stores the data submitted by the Javascript.", "Lookup an option from our options set.\n\n Examples:\n\n   # Optional parameter whose default value is nil.\n   do_extra = opt_set.get :do_extra\n\n   # Optional params that defaults to [1,2,3]\n   start_array = opt_set.get :start_array, [1,2,3]\n\n Returns default value when:\n * Key is non-existent in Options Hash.\n * OR when the value of the key in the Options Hash is nil.\n\n Returns nil when:\n * Default is nil and the Options Hash lookup returns a nil.\n   Options Hash returns a nil because of either a\n   non-existent key or a nil value in said hash for said key.", "Use this the option is mandatory.\n\n There are cases where an option may have a default value for a feature,\n but the caller may just want to disable said feature. To do so,\n users of this module should allow for the caller to pass in 'false'\n as an option value instead of nil to disable said feature. The\n implementer will have to do a boolean check of the returned option value\n and disable accordingly.\n\n Examples:\n\n   # Has a default logger, but we can disable logging by passing false.\n   # If caller had passed in nil for :logger, it would have\n   # defaulted to ::Log4r['my_logger'].\n   logger = opt_set.get! :logger, ::Log4r['my_logger']\n\n   # Here we force the end user to pass in a Non-nil option as a\n   # mandatory parameter.\n   max_threads = opt_set.get! :max_threads\n\n Raises error when `get` returns a nil.", "This method performs initialization tasks\n\n\n This method connects to the Solr instance. It looks to see if Blacklight is loaded first for the\n Blacklight.solr_config. If not loaded, it then looks for the Rails.root.to_s/config/solr.yaml file and loads\n it to get the solr url. The configuration strucuture can take both the\n { \"development\" => {\"default\" => { \"url\" => \"http://localhost\"}, \"fulltext\" => { \"url\" => \"http://localhost\"} }}\n or { \"development\"=>{\"url\"=>\"http://localhost\" }}\n Can also take Blacklight.solr_config[\"url\"] and Blacklight.solr_config[:url]\n\n If you want to specify a timeout for solr, provide these keys:\n   :read_timeout=>120, :open_timeout => 120", "This method generates the month and day facets from the date_t in solr_doc", "This method creates a Solr-formatted XML document", "The body content needs to be a json.", "Build the constraint matrix and add it to the model", "Get The Birth Date\n@return [Date]", "Get The death date else nil\n@return [Date]", "Return the Filmography\nfor the moment I can't make subdivision of this, then i take all in an array\n@return [Movie]", "Return all the javascript paths in the spec, included those nested\n inside other objects", "Return all the stylesheet paths in the spec, included those nested\n inside other objects", "This function serializes a complete version of the category.", "This function serializes a basic version of the category.", "Builds a MarkLogic Query from Mongo Style Criteria\n\n @param [Hash] criteria The Criteria to use when searching\n\n @example Build a query from criteria\n\n    # Query on age == 3\n    collection.from_criteria({ 'age' => { '$eq' =>  3  } })\n\n    # Query on age < 3\n    collection.from_criteria({ 'age' => { '$lt' =>  3  } })\n\n    # Query on age <= 3\n    collection.from_criteria({ 'age' => { '$le' =>  3  } })\n\n    # Query on age > 3\n    collection.from_criteria({ 'age' => { '$gt' =>  3  } })\n\n    # Query on age >= 3\n    collection.from_criteria({ 'age' => { '$ge' =>  3  } })\n\n    # Query on age != 3\n    collection.from_criteria({ 'age' => { '$ne' =>  3  } })\n\n @since 0.0.1", "A basic drawing method that iterates through an entire image.  At each coordinate,\n an attached block is evaluated for a boolean response that determines whether that\n coordinate is overwritten with a specified value.  The attached block will be given\n a single parameter, which is the current ImageCoordinate.\n\n @param [WritableImage] im the image being drawn on\n @param [Numeric] draw_value the value to which a pixel will be set if the block\n  evaluates to a true value at that coordinate\n\n @return [void]", "Draws a specified shape into an image.\n\n @param [WritableImage] im the image into which to draw\n @param [Array] location an array containing the coordinates of the shape to draw.\n  The exact meaning of this parameter depends on which shape is being drawn.\n @param [Symbol] shape_name the name of the shape to draw.  This should correspond\n  to one of the methods of this class.\n @param shape_parameters the parameters for drawing the specified shape;\n  the meaning of this parameter depends on the shape.\n\n @return [void]", "Draws a circle into an image.\n\n @param [WritableImage] im the image into which to draw\n @param [Array] center an array containing the x,y coordinates of the circle's center\n @param [Numeric] radius the radius of the circle in pixels\n\n @return [void]", "Draws an ellipse into an image.\n\n @param [WritableImage] im the image into which to draw\n @param [Array] foci an array containing two arrays, each of which contains the x,y\n  coordinates of one focus of the ellipse\n @param [Numeric] radius_inc the extra amount of distance (in pixels) beyond the\n  distance between the foci that the ellipse should be drawn.  (2*radius_inc + dist\n  between foci = major axis length)\n\n @return [void]", "Annotate the named file. Sets and returns rows.", "Annotate the named file, returns HTML document.", "ERB template uses this to obtain our own stylesheet.", "Return `true` if the current page contains the given text or regular expression,\n or `false` if it does not.\n\n @param [String, Regexp] text_or_regexp\n   Text or regular expression to look for\n\n @raise [ArgumentError]\n   If the given argument isn't a String or Regexp\n\n @since 0.2.0", "Verify the presence of content on the page. Passes when all the given items\n are found on the page, and fails if any of them are not found.\n\n @example\n   should_see \"Animaniacs\"\n   should_see [\"Yakko\", \"Wakko\", \"Dot\"]\n   should_see \"Baloney\", :within => \"#slacks\"\n   should_see /(Animaney|Totally Insaney|Pinky and the Brainy)/\n\n @param [String, Regexp, Array] texts\n   Text(s) or regexp(s) to look for\n @param [Hash] scope\n   Scoping keywords as understood by {#in_scope}\n\n @raise [Kelp::Unexpected]\n   If any of the expected text strings are not seen in the given scope", "Verify that all items appear in the same table row. Passes if a `tr`\n element exists containing all the given `texts`, and fails if no such\n `tr` exists. The texts may be in any order in the row.\n\n @example\n   should_see_in_same_row [\"Yakko\", \"Rob Paulsen\"]\n   should_see_in_same_row [\"Wakko\", \"Jess Harnell\"]\n   should_see_in_same_row [\"Dot\", \"Tress MacNeille\"]\n\n @param [Array] texts\n   Array of Strings that should appear in the same row\n @param [Hash] scope\n   Scoping keywords as understood by {#in_scope}\n\n @raise [Kelp::Unexpected]\n   If no row is found containing all strings in `texts`", "take the lineage name, find all snapshots and sleep until none are in the pending state.", "Returns the timestamp of the latest snapshot for testing OPT_DB_RESTORE_TIMESTAMP_OVERRIDE", "Requires the file with the given name, within the namespace root\n directory.\n\n @param [Symbol, String] name\n   The name of the file to require.\n\n @return [true, nil]\n   Returns `true` if the file was successfully loaded, returns `nil`\n   on a `LoadError` exception.\n\n @raise [Gem::LoadError]\n   A dependency needed by the file could not be satisfied by RubyGems.\n\n @since 0.3.0", "Checks if a constant is defined or attempts loading the constant.\n\n @param [String] name\n   The name of the constant.\n\n @param [Boolean] inherit\n   Specifies whether to search the ancestors for the constant.\n\n @return [Boolean]\n   Specifies whether the constant is defined.", "Which todo is due sooner?\n\n @example\n   [todo_one, todo_two].sort # this implicitly calls <=>\n\n @return [Fixnum]\n @api public\n The relative path to the file where this todo was found\n\n @example\n   todo.relative #=> \"spec/spec_helper.rb\"\n\n @return [String]\n @api public", "A tag was referenced, so let's see when that's due\n @return [DueDate]\n @raise [KeyError] if the tag does not reference a due date in the config\n @api private", "Debug-Wrapper", "Rateable flag. If false, result is not rateable. Can only be true if there is an opponent.", "Returns Auth Settings hash for api client.", "Execute the request, optionally passing a block to handle the response\n\n @param [JsonRequest] json_request\n @param [Block] block\n\n @return [JsonResponse] response", "Function to write the last update time to a temporary file.", "To convert xml_time received from the server to integer.", "This method keeps the remote-keys and the local-keys synchronized.\n This method should be called only after initializing the configuration\n object as it uses those configuration values.", "Get the list of input file\n\n @param [Hash<Symbol, Object>] args the input options\n @option args [String] :command the shell command to be used to get list of files\n @return [Array<String>] list of files in the format\n         [\"./Gemfile\", \"./lib/vim_printer/cli.rb\", ..]", "Main entry point to export the code\n\n @param [Hash<Symbol, Object>] options the options argument", "convert multiple files to html", "Render out the template values and return the updated options hash\n @param [String] endpoint\n @param [String] request_type\n @param [Hash] options\n @return [String] rendered_template\n @return [Hash] options", "Copy a source file directly to an output file", "Inspired by Ruby 1.9", "retrieve a cached value from a redis hash.\n\n hashes are accessed using the report title and row title. values within\n the hash are keyed using the column's start/end timestamps", "Used to configure UsingYAML for a class by defining what files\n should be loaded and from where.\n\n   include UsingYAML\n   using_yaml :foo, :bar, :path => \"/some/where\"\n\n +args+ can contain either filenames or a hash which specifices a\n path which contains the corresponding files.\n\n The value of :path must either be a string or Proc (see\n +using_yaml_path+ for more information on overriding paths).", "Returns the URL for the route. If it's templated,\n then we utilize the provided options hash to expand\n the route. Otherwise we return the `path`\n\n @return [String] The templated or base URI", "Decrypt the provided cipher text, and return the plaintext\n Return nil if whitespace", "Extracts the initialization vector, encrypted key, and\n cipher text according to the specified format.\n\n delimited:\n * Expected format: iv::encrypted-key::ciphertext\n\n json:\n * Expected keys: iv, key, message", "title, size = 1\n\n size = 1, &block", "Just like +link_to+, but wrap with li tag and set +class=\"active\"+\n to corresponding page.", "Find other Etd Servers by looking at node attributes or via Chef Search", "Try to grab an etcd connection\n\n @param [String] server  ()  The server to try to connect too", "Check each item in this array, if runnable push it on a queue.\n\n We assume that this item is or simlar to CronJob. We don't call\n cron_job#job. That is the work for another thread esp. if #job\n is a Proc.", "Start cron.\n\n Will wake up every minute and perform #run.", "Gracefully stop the thread.\n\n If block is given, it will be called once the thread has\n stopped.", "An HTML form for logging in.\n\n @param env the Rack environment\n @return a finished Rack response", "it check only for gender field for now", "simple nested set for 2 classes with defined main_fields", "The before_action that implements authenticates_using_http_basic.\n\n If your ApplicationController contains authenticates_using_http_basic, you\n can opt out in individual controllers using skip_before_action.\n\n     skip_before_action :authenticate_using_http_basic", "Define attribute as translatable\n\n   class Thing < ActiveRecord::Base\n     translate :name\n   end", "Executes the command from the `Builder` object.\n If there had been given a block at instantiation it will be\n called after the `popen3` call and after the pipes have been\n attached.", "Called by child pipes when they get unbound.", "Kills the child process.", "Initializes the parser. Pass in options using a hash structure.\n Starts the main loop. This loop runs until the game engine closes the\n console line. During the loop, the parser reads from the game engine,\n sanitizes the input a little bit, and then passes it to a method that\n needs to be overwritten by parsers extending this interface.", "Notice that the method will actually iterate over the enumerator\n @param enumerator [Enumerator]", "Serialize activity to a hash\n\n @note All keys are stringified (ie. there is no Symbol)\n\n @return [Hash] Activity hash", "Bindings for humanization sentence\n\n For each entity, returned hash contains:\n   :<entity_name>       => <entity humanization>\n   :<entity_name>_model => <entity model instance>\n\n All `meta` are merged in returned hash too.\n\n @param options [Hash] Humanization options\n @return [Hash] Humanization bindings", "Humanize that activity\n\n @param options [Hash] Options hash\n @option options [true, false] :html Output HTML (default: `false`)\n @return [String] Humanized activity", "Check if activity is valid\n\n @raise [MissingEntityError] if a mandatory entity is missing\n @api private", "Returns a new hash with +self+ and +other_hash+ merged recursively.\n Modifies the receiver in place.", "Make sure data is optimal", "Convert to BSON ObjectId or make a new one", "Encrypts the given attribute.\n\n Configuration options:\n * <tt>:mode</tt> - The mode of encryption to use.  Default is <tt>:sha</tt>.\n   See EncryptedStrings for other possible modes.\n * <tt>:to</tt> - The attribute to write the encrypted value to. Default\n   is the same attribute being encrypted.\n * <tt>:before</tt> - The callback to invoke every time *before* the\n   attribute is encrypted\n * <tt>:after</tt> - The callback to invoke every time *after* the\n   attribute is encrypted\n * <tt>:on</tt> - The ActiveRecord callback to use when triggering the\n   encryption.  By default, this will encrypt on <tt>before_validation</tt>.\n   See ActiveRecord::Callbacks for a list of possible callbacks.\n * <tt>:if</tt> - Specifies a method, proc or string to call to determine\n   if the encryption should occur. The method, proc or string should return\n   or evaluate to a true or false value.\n * <tt>:unless</tt> - Specifies a method, proc or string to call to\n   determine if the encryption should not occur. The method, proc or string\n   should return or evaluate to a true or false value.\n\n For additional configuration options used during the actual encryption,\n see the individual cipher class for the specified mode.\n\n == Encryption timeline\n\n By default, attributes are encrypted immediately before a record is\n validated.  This means that you can still validate the presence of the\n encrypted attribute, but other things like password length cannot be\n validated without either (a) decrypting the value first or (b) using a\n different encryption target.  For example,\n\n   class User < ActiveRecord::Base\n     encrypts :password, :to => :crypted_password\n\n     validates_presence_of :password, :crypted_password\n     validates_length_of :password, :maximum => 16\n   end\n\n In the above example, the actual encrypted password will be stored in\n the +crypted_password+ attribute.  This means that validations can\n still run against the model for the original password value.\n\n   user = User.new(:password => 'secret')\n   user.password             # => \"secret\"\n   user.crypted_password     # => nil\n   user.valid?               # => true\n   user.crypted_password     # => \"8152bc582f58c854f580cb101d3182813dec4afe\"\n\n   user = User.new(:password => 'longer_than_the_maximum_allowed')\n   user.valid?               # => false\n   user.crypted_password     # => \"e80a709f25798f87d9ca8005a7f64a645964d7c2\"\n   user.errors[:password]    # => \"is too long (maximum is 16 characters)\"\n\n == Encryption mode examples\n\n SHA encryption:\n\n   class User < ActiveRecord::Base\n     encrypts :password\n     # encrypts :password, :salt => 'secret'\n   end\n\n Symmetric encryption:\n\n   class User < ActiveRecord::Base\n     encrypts :password, :mode => :symmetric\n     # encrypts :password, :mode => :symmetric, :key => 'custom'\n   end\n\n Asymmetric encryption:\n\n   class User < ActiveRecord::Base\n     encrypts :password, :mode => :asymmetric\n     # encrypts :password, :mode => :asymmetric, :public_key_file => '/keys/public', :private_key_file => '/keys/private'\n   end\n\n == Dynamic configuration\n\n For better security, the encryption options (such as the salt value)\n can be based on values in each individual record.  In order to\n dynamically configure the encryption options so that individual records\n can be referenced, an optional block can be specified.\n\n For example,\n\n   class User < ActiveRecord::Base\n     encrypts :password, :mode => :sha, :before => :create_salt do |user|\n       {:salt => user.salt}\n     end\n\n     private\n       def create_salt\n         self.salt = \"#{login}-#{Time.now}\"\n       end\n   end\n\n In the above example, the SHA encryption's <tt>salt</tt> is configured\n dynamically based on the user's login and the time at which it was\n encrypted.  This helps improve the security of the user's password.", "Encrypts the given attribute to a target location using the encryption\n options configured for that attribute", "Reads the given attribute from the database, adding contextual\n information about how it was encrypted so that equality comparisons\n can be used", "Creates a new cipher with the given configuration options", "adds the given Iota to this Room\n\n @param [Iota] i the Iota to add\n\n @raise Edoors::Exception if i already has a parent or if a Iota with the same name already exists", "adds the given Link to this Room\n\n @param [Link] l the Link to add\n\n @raise Edoors::Exception if the link source can't be found in this Room", "search for a matching link\n\n @param [Particle] p the Particle searching for a matching link", "route the given Particle\n\n @param [Particle] p the Particle to be routed", "send the given Particle\n\n @param [Particle] p the Particle to send\n @param [Boolean] sys if true send to system Particle fifo", "send the given Particle to application Particle fifo\n\n @param [Particle] p the Particle to send", "send the given Particle to system Particle fifo\n\n @param [Particle] p the Particle to send", "process the given system Particle\n\n @param [Particle] p the Particle to be processed\n\n @note the Particle is automatically released", "save an XML file corresponding to the tree data in the self through the designated IO.\n\n \u81ea\u8eab\u306e\u30c4\u30ea\u30fc\u30c7\u30fc\u30bf\u3092\u3001\u6307\u5b9a\u3055\u308c\u305fIO\u3092\u901a\u3057\u3066\u3001XML\u30d5\u30a1\u30a4\u30eb\u306b\u4fdd\u5b58\u3059\u308b\u3002\n ==== Args\n _indent_(if not nil) :: a saved XML file is formatted with the designaged indent.\n      xyml_tree=Xyml::Document.new({a: [{b: \"ccc\"},{d: [\"eee\"]}]})\n      #-> [{a: [{b: \"ccc\"},{d: [\"eee\"]}]}]\n      xyml_tree.out_XML(File.open(\"aaa.xml\",\"w\"))\n      #-> aaa.xml\n      # <a b=\"ccc\">\n      #   <d>eee</d>\n      # </a>", "load an XYML file through the designated IO and set the tree data in the file to the self.\n\n XYML\u30d5\u30a1\u30a4\u30eb\u3092IO\u3088\u308a\u30ed\u30fc\u30c9\u3057\u3066\u3001\u305d\u306e\u30c4\u30ea\u30fc\u30c7\u30fc\u30bf\u3092\u81ea\u8eab\u306b\u8a2d\u5b9a\u3059\u308b\u3002\n      # aaa.xyml\n      #  - a:\n      #    -b: ccc\n      #    -d:\n      #      - eee\n      xyml_tree=Xyml::Document.new\n      xyml_tree.load_XYML(File.open(\"aaa.xyml\"))\n      #-> [{a: [{b: \"ccc\"},{d: [\"eee\"]}]}]", "save a JSON file corresponding to the tree data in the self through the designated IO.\n Note that a JSON file can be loaded by load_XYML method because JSON is a part of YAML.\n\n \u81ea\u8eab\u306e\u30c4\u30ea\u30fc\u30c7\u30fc\u30bf\u3092\u3001\u6307\u5b9a\u3055\u308c\u305fIO\u3092\u901a\u3057\u3066\u3001JSON\u30d5\u30a1\u30a4\u30eb\u306b\u4fdd\u5b58\u3059\u308b\u3002JSON\u30d5\u30a1\u30a4\u30eb\u306e\u30ed\u30fc\u30c9\u306f\u3001\n _load_XYML_\u30e1\u30bd\u30c3\u30c9\u3067\u5b9f\u65bd\u3067\u304d\u308b\u3053\u3068\u306b\u6ce8\u610f\uff08JSON\u306fYAML\u4ed5\u69d8\u306e\u4e00\u90e8\u5206\u3068\u306a\u3063\u3066\u3044\u308b\u305f\u3081\uff09\u3002\n      xyml_tree=Xyml::Document.new({a: [{b: \"ccc\"},{d: [\"eee\"]}]})\n      #-> [{a: [{b: \"ccc\"},{d: [\"eee\"]}]}]\n      xyml_tree.out_JSON(File.open(\"aaa.json\",\"w\"))\n      #-> aaa.jdon\n      #  [{\"a\":[{\"b\":\"ccc\"},{\"d\":[\"eee\"]}]}]", "Return the public API URL for a particular rackspace service.\n\n Use Account#service_names to see a list of valid service_name's for this.\n\n Check the project README for an updated list of the available regions.\n\n     account = Raca::Account.new(\"username\", \"secret\")\n     puts account.public_endpoint(\"cloudServers\", :syd)\n\n Some service APIs are not regioned. In those cases, the region code can be\n left off:\n\n     account = Raca::Account.new(\"username\", \"secret\")\n     puts account.public_endpoint(\"cloudDNS\")", "Raca classes use this method to occasionally re-authenticate with the rackspace\n servers. You can probably ignore it.", "This method is opaque, but it was the best I could come up with using just\n the standard library. Sorry.\n\n Use this to safely extract values from nested hashes:\n\n     data = {a: {b: {c: 1}}}\n     extract_value(data, :a, :b, :c)\n     => 1\n\n     extract_value(data, :a, :b, :d)\n     => nil\n\n     extract_value(data, :d)\n     => nil", "Generate the payload if stuff was provided", "for backward compatibility", "don't use if you don't know what it is.", "interfaces for SSLSocketWrap.", "uri == nil for generic purpose", "Connect to the server", "Read status block.", "Upload the given path to S3.\n\n @param [String] bucket the bucket where to store the archive in.\n @param [String] key the key where the archive is stored under.\n @param [String] path the path, where the archive is located.\n\n @return [Hash]", "Upload a part for a multipart upload\n\n @param [String] bucket Name of bucket to add part to\n @param [String] key Name of object to add part to\n @param [String] upload_id Id of upload to add part to\n @param [String] part_number Index of part in upload\n @param [String] data Contect of part\n\n @return [String] ETag etag of new object. Will be needed to complete upload", "Complete a multipart upload\n\n @param [String] bucket Name of bucket to complete multipart upload for\n @param [String] key Name of object to complete multipart upload for\n @param [String] upload_id Id of upload to add part to\n @param [String] parts Array of etags for parts\n\n @return [Excon::Response]", "Remove old versions of a backup.\n\n @param [String] bucket the bucket where the archive is stored in.\n @param [String] prefix the prefix where to look for outdated versions.\n @param [Integer] versions number of versions to keep.\n\n @return [nil]", "Format a tweet all pretty like", "Issues a write operation to Scalaris and adds it to the current\n transaction.", "Issues a add_del_on_list operation to scalaris and adds it to the\n current transaction.\n Changes the list stored at the given key, i.e. first adds all items in\n to_add then removes all items in to_remove.\n Both, to_add and to_remove, must be lists.\n Assumes en empty list if no value exists at key.", "Issues a add_on_nr operation to scalaris and adds it to the\n current transaction.\n Changes the number stored at the given key, i.e. adds some value.\n Assumes 0 if no value exists at key.", "creates a new Simulator which will return the desired outcomes with the given probability\n @param outcome_to_probability [Hash<Symbol, Number>] hash of outcomes to their probability (represented as\n   numbers between zero and one)\n @note raises errors if there is only one possible outcome (why bother using this if there's only one\n   outcome?), if the probabilities don't total one (use Rationals if this proves problematic with rounding) or\n   if any of the outcomes are impossible (why include them if they can never happen?)\n generate an outcome with the initialised probabilities\n @return [Symbol] symbol for outcome", "Add a new route to the Routes collection\n\n @return [Array] Routes collection", "Raise an exception if the route is invalid or already exists", "Retrieve a route by it's link relationship name\n\n @return [Route, nil] Instance of the route by name or nil", "Raise an exception of the route's not found", "Auditing creates audit objects for a record.\n\n @examples\n   class School < ActiveRecord::Base\n      audit_enabled\n   end\n   class School < ActiveRecord::Base\n     audit_enabled :fields => [:name, :established_on]\n   end", "Dynamically sets attr_readers for elements", "Tells users that we respond to missing methods\n if they are instance variables.", "initializes a point object using latitude and longitude\n returns true if point is in bounding_box, false otherwise", "returns relative x and y for point in bounding_box", "grow bounding box by percentage", "This function syncronizes the config post fields with the post\n fields on database.", "This function syncronizes the config post fields with the post fields\n on database for a single post object.", "This function syncronizes a single post field of a specific post with database.", "This function syncronizes a single post field of a specific post with config file.", "This function update an existing post field on database with new content.", "Return the JSON data on this record as a hash", "Check that the x_MD5_Hash value matches our expectations\n\n The formula for the hash differs for subscription vs regular transactions. Regular transactions\n will be associated with the gateway ID that was used in the originating API call. Subscriptions\n however are ran on the server at later date, and therefore will not be associated to a gateway ID.\n\n * Subscriptions: MD5 Digest(AUTH_NET_HASH_VAL + TRANSACTION_ID + TRANSACTION_AMOUNT)\n * Other Transactions: MD5 Digest(AUTH_NET_HASH_VAL + GATEWAY_LOGIN + TRANSACTION_ID + TRANSACTION_AMOUNT)", "Simple override of initializer in order to add in the dojo_props attribute\n Creates a button\n\n overrides simple_form's button method\n\n dojo_form_for @user do |f|\n   f.button :submit, :value => 'Save Me'\n end\n\n To use dojox/form/BusyButton, pass :busy => true\n dojo_form_for @uswer do |f|\n   f.button :submit, :busy => true, :value => 'Save Me'\n end\n\n If :value doesn't exist, tries to determine the\n the value based on the current object", "Basically the same as rails submit_default_value", "after configuring a connection with .new - send commands via ssh to open directory\n @command [Symbol] - required -- to choose the action wanted\n @params [Hash] - required -- necessary information to accomplish action\n @output [String] - optional -- 'xml' or 'plist' will return responses using xml format\n response [Hash] - { response: results, status: status, command: command, attributes: params, dscl_cmds: ssh_clean }", "Does the counting from DB. Unlike the other counter that uses Redis. Hence\n   the name local_count\n @param [Time] duration A time/time range object\n @param [Fixnum] type The type of counter to look for", "Takes an absolute path", "Reblog a Post\n\n @see http://www.tumblr.com/docs/en/api/v2#reblogging\n @requires_authentication Yes\n\n @param id [Integer] The ID of the reblogged post on tumblelog\n @param reblog_key [Integer] The reblog key for the reblogged post \u2013 get the reblog key with a /posts request\n @param options [Hash] A customizable set of options\n @option options [String] :comment A comment added to the reblogged post", "Creates the table used to hold file blobs.\n\n @param [Symbol] table_name the name of the table used to hold file data\n @param [Hash<Symbol, Object>] options\n @option options [Integer] blob_limit the maximum file size that can be\n     stored in the table; defaults to 1 megabyte", "Scale an image down and crop away any extra to achieve a certain size.\n This is handy for creating thumbnails of the same dimensions without\n changing the aspect ratio.", "clean up this module later.\n Build a megam api client\n\n === Parameters\n api:: The Megam::API client", "Attribute macros\n Defines an attribute\n\n @param [String] name The name of the attribute\n @param [Symbol] type The type of the attribute\n @param [Hash{Symbol => Object}] metadata The metadata for the attribute", "Defines a string attribute\n\n @param [Symbol] attr The name of the attribute\n @param [Hash{Symbol => Object}] metadata The metadata for the attribute", "Defines a boolean attribute\n\n @param [Symbol] attr The name of the attribute\n @param [Hash{Symbol => Object}] metadata The metadata for the attribute", "Defines a integer attribute\n\n @param [Symbol] attr The name of the attribute\n @param [Hash{Symbol => Object}] metadata The metadata for the attribute", "Defines a float attribute\n\n @param [Symbol] attr The name of the attribute\n @param [Hash{Symbol => Object}] metadata The metadata for the attribute", "Defines a decimal attribute\n\n @param [Symbol] attr The name of the attribute\n @param [Hash{Symbol => Object}] metadata The metadata for the attribute", "Defines a date attribute\n\n @param [Symbol] attr The name of the attribute\n @param [Hash{Symbol => Object}] metadata The metadata for the attribute", "Defines an array attribute\n\n @param [Symbol] attr The name of the attribute\n @param [Hash{Symbol => Object}] metadata The metadata for the attribute", "Defines an association\n\n @param [String] name The name of the association\n @param [Symbol] type The type of the association\n @param [Hash{Symbol => Object}] metadata The metadata for the association", "Defines an association that is a reference to an Array of another Attribution class.\n\n @param [Symbol] association_name The name of the association\n @param [Hash] metadata Extra information about the association.\n @option metadata [String] :class_name Class of the association,\n   defaults to a class name based on the association name", "for lazy load", "Convert to a hash. Also flattens some of the data into new fields.", "Specifies a list of arguments of a given type to be parsed.\n @param type [Symbol] the type of the arguments\n @param sym [Symbol] the name of the argument in {results}\n @param count [Integer] the number of arguments in the list", "Perform the actual parsing.\n @return [Result] this instance\n @api private", "Check whether the expected arguments absorb all supplied arguments.\n @raise [AbsoptionError] if absorption fails and {strict?} is not true\n @api private", "Count the number of arguments expected to be supplied.\n @raise [Integer, nil] the number of expected arguments, or nil if a list\n  of indeterminate size is specified\n @api private", "Parse a one or more expected arguments of a given type and add them to\n  the results.\n @param type [Symbol] the type of the individual elements of the list\n @param sym [Symbol] the key to store the results under in {results}\n @param count [Integer, nil] the size of the list, or nil if the list\n  absorbs all following arguments\n @api private", "Book a Reservation", "Request Alternate Properties", "This action renders the frame for the statistics tool", "This action renderes the overview of some data in the statistics tool", "lookup collection value by a key", "lookup collection key by a value", "Create the bindings for the computed properties and observers", "Add an entry to the feed", "Convenience method for creating a new Machined environment", "Returns a fresh context, that can be used to test helpers.", "Runs the CLI with the given args.", "Modifies the given file", "verify the partial, init and return the key\n  otherwise ArgumentError it up", "verify the template, init the key set, and return the key string\n  otherwise ArgumentError it up", "Encodes output as utf8 - Not for binary http responses", "Makes a request to Plangrade server that will swap your authorization code for an access\n token\n\n @see http://docs.plangrade.com/#finish-authorization\n\n @opts [Hash] may include redirect uri and other query parameters\n\n >> client = PlangradeClient.new(config)\n >> client.exchange_auth_code_for_token({\n      :code => '123456789'\n      :redirect_uri => 'http://localhost:3000/auth/plangrade/callback',\n    })\n\n POST /oauth/token HTTP/1.1\n Host: www.plangrade.com\n Content-Type: application/x-www-form-urlencoded\n  client_id={client_id}&code=G3Y6jU3a&grant_type=authorization_code&\n  redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Fauth%2Fplangrade%2Fcallback&client_secret={client_secret}", "set the options for the dumping soap message\n\n @param [Hash] options\n @option options [String] :directory\n @option options [String] :file\n @option options [String] :format\n @option options [String] :interceptor", "The real Rack call interface.\n This is the common behavior for both the verbose and summary logging\n middlewares. It sets rack's logger, times the response and returns it as is.", "This the real Rack call interface. It adds logging before and after\n super-ing to the common logging behavior.", "This the real Rack call interface. It adds logging after super-ing to the\n common logging behavior.", "one convenient method to pass jq_upload the necessary information", "Attempts to set self as the claimant of the given task.  If not authorized\n to claim the task, raises exception.  Also bubbles exception from Task\n when task is already claimed by a different claimant.", "If we are the current claimant of the given task, release the task. Does\n nothing if the task is not claimed, but raises exception if the task is\n currently claimed by someone else.", "Validates all three CSS files", "occurrences in [t1, t2)", "Destroys the given crate object.\n\n @return [CrateDestroyError, nil] if there is an issue destroying the crate, an error will be raised with the message explaining why.", "Renamed the given crate object.\n\n @return [CrateRenameError, nil] if there is an issue with renaming the crate, an error will be raised with the message explaining why.", "Add a file to the given crate object.\n\n @param [String] This is the path to the file that you wish to upload.\n @return [CrateFileAlreadyExistsError, nil] if there is an issue uploading the file to the crate, an error will be raised with the message explaining why.", "Return the logical modification time for the element.", "Replace variables with values. This will occur recursively upto a limited\n depth if the resolved values themselves contain variables.", "This will merge partitions from multiple appliances.", "Copy the contents of the logfile to another file. Truncate the logfile\n to zero length. This method will set the roll flag so that all the\n current logfiles will be rolled along with the copied file.", "Inserts string formating characters around the section of a string\n that differs internally from another line so that the Line class\n can insert the desired formating", "Return the value of the interpolation kernel for the separation between the two given vectors. If linear was chosen this will just be the normalised distance between the two points.", "Return the interpolated value for the given parameters.", "Evaluate the function,", "Create a GraphKit object of the contours.", "Initialize the CSF object with data\n The method_missing override checks to see if the called method\n can be evaluated to a key, then stores it and calls it if it can.\n For example, .itemType or .authors.", "Sets credentials on a request object.\n\n If creds is a hash containing :username and :password keys, HTTP basic\n authorization is used.  If creds is a string, the string is added as a\n cookie.", "Wait for a single fork to finish.\n\n If a fork successfully finishes, it's return value from the *process*\n block is stored into the main result set.\n\n @return [Array<pid, status, data>] An array containing the pid,\n   status and data returned from the process block.  If wait2() fails nil\n   is returned.", "Signals all forks.\n\n @return [Integer] The number of processes signaled.", "Register a callable by key.\n\n The callable should be given in a block which will be lazily evaluated\n when the action is needed.\n\n If an action by the given name already exists then it will be\n overwritten.", "Get an action by the given key.\n\n This will evaluate the block given to `register` and return the resulting\n action stack.", "Go through the specification checking that files that are pointed to\n actually exist", "Use this method to setup your request's payload and headers.\n\n Example:\n\n   request.set :headers do |h|\n     h.content_type = 'application/ufo'\n   end\n\n   request.set :params do |p|\n     p.sessionid = '12323'\n     p.api_key   = '13123\n   end", "Send http request to Viddler API.", "Check that the master password is correct. This is done to prevent opening an existing but blank locker with the wrong password.", "Return the value stored under key", "Store entry or value under key", "Delete the value that is stored under key and return it", "Return all entries as array", "Change the master password to +new_master_password+. Note that we don't take a password confirmation here.\n This is up to a UI layer.", "Pulls object from remote service\n @param [Integer] Remote ID of object.\n @return [Boolean] Result of pulling", "Pushes local object to remote services.\n Er, I mean, its attributes.\n Like not object itself. Just attributes.\n @param [Object] Local object", "Pulls whole remote collection. If it cannot find\n matching local object, it will create one.\n This method is slow, useful for initial import, not\n for regular updates. For regular updates, only\n changed remote objects should be updates using pull_object\n @see pull_object", "Build xml into Builder\n\n @param [Builder::XmlMarkup]", "instantiate an BiddableAdGroupCriterion but it is called 'keyword' for convenience\n\n http://code.google.com/apis/adwords/v2009/docs/reference/AdGroupCriterionService.BiddableAdGroupCriterion.html", "ad param management", "Builds a bookmark with given attributes and add it.", "Builds a folder with given attributes and add it.", "Builds an alias with given attributes and add it.", "end to end tests", "def new_artifact_content name, type, content=nil, &block", "Actually perform the message unpacking", "Get the constant GLPK uses to represent our variable types", "Returns the API usage per day for this application.\n @accessibility: public key, secret key\n @methods: GET\n @format: json, jsonp\n @authenticated: true\n @limited: false\n @return [Hashie::Rash] API usage per day for this application.\n @param application [Integer] Defaults to null\n @param days [Integer] Defaults to 30, Maximum length of 30\n @example Returns the API usage per day for this application.\n   Disqussion::Client.applications.listUsage\n @see http://disqus.com/api/3.0/applications/listUsage.json", "Login to SmugMug using a specific user account.\n\n @param [String] email The username ( Nickname ) for the SmugMug account\n @param [String] password The password for the SmugMug account\n\n @return [Smile::SmugMug.new] An Smug object that has been authenticated", "Tries to find chapter in this course by chapter slug.", "Creates an SDL parser on the specified +IO+.\n\n   IO.open(\"path/to/sdl_file\") { |io|\n     parser = SDL4R::Parser.new(io)\n     tags = parser.parse()\n   }\n\n Parses the underlying +IO+ and returns an +Array+ of +Tag+.\n\n ==Errors\n [IOError] If a problem is encountered with the IO\n [SdlParseError] If the document is malformed", "Parses the children tags of +parent+ until an end of block is found.", "Combines a simple Date with a TimeSpanWithZone to create a DateTime", "Close the reader and throw a SdlParseError using the format\n Was expecting X but got Y.", "Builds the complementary word.\n\n  ComplementBuilder.new(Word.new('fizeste')).build\n  # => #<Tracinho::Word:0x007f8a9b0ba928 @text=\"fize-te\">\n\n  ComplementBuilder.new(Word.new('passa-mos')).build\n  # => #<Tracinho::Word:0x007f8a9b10f270 @text=\"passamos\">", "Entity constructor from a Hash\n\n @param [Hash] hsh hash of values\n\n @example\n   class Person\n     include StronglyTyped::Model\n\n     attribute :id, Integer\n     attribute :slug, String\n   end\n\n   Person.new(id: 1, slug: 'elgalu')\n   #=> #<Person:0x00c98 @id=1, @slug=\"elgalu\">\n   leo.id   #=> 1\n   leo.slug #=> \"elgalu\"\n\n @raise [NameError] if tries to assign a non-existing member\n\n @private", "Entity constructor from ordered params\n\n @param [Array] values ordered values\n\n @example\n   class Person\n     include StronglyTyped::Model\n\n     attribute :id, Integer\n     attribute :slug, String\n   end\n\n   Person.new(1, 'elgalu')\n   #=> #<Person:0x00c99 @id=1, @slug=\"elgalu\">\n   leo.id   #=> 1\n   leo.slug #=> \"elgalu\"\n\n @raise [ArgumentError] if the arity doesn't match\n\n @private", "A new instance of Server.\n @param [Proc, #call] request_handler proc which implements the pingback registration and takes the source_uri and the target_uri\n     as params. Use the exceptions defined in Pingback to indicate errors.", "Set the duration\n @param [String] duration as time", "Prompt user to provide input", "Set or update env var", "Build a catalog from a directory", "Load catalog from a file", "Save serialized catalog to file\n @param [String,File] file", "simple report with essential information about this catalog\n @return [String] report", "return ruby script to eliminate duplicated\n @return [String] ruby script", "Creates a new registry.\n Registers a new client for that channel. Migrates client to new channel\n if client already exists.\n @param [String] channel ID\n @param [String] client ID", "Removes client from +@clients+, and decrements channel's client count. If\n channel has no clients, it is removed.\n @param [String] client ID", "Runs given commands using mixlib-shellout", "work method receives message payload in raw format\n in our case it is JSON encoded string\n which we can pass to RecentPosts service without\n changes", "Public because the old tests depend on it", "Forward all method calls to the proxied object, reload if necessary", "This will return related items that are tagged to the same mainstream\n browse page as the main content item.", "This will return related items whose parents are tagged to the same mainstream\n browse page as the main content item's parent.", "This will return related links that are tagged to mainstream browse\n pages unrelated to the main content item.", "Render an ERB template with the given name, and cache the result for\n subsequent calls.\n\n @param template [String] the name of a template\n @param context [Hash] key/value pairs of variables to bind the template\n @return [String] the ERB render result", "check that we have the Nagios server details", "Appends the elements in other_array to self, as standardized URL Hashes", "Replaces the contents of self with the contents of other_array, truncating or expanding if necessary. The contents of other_array\n is converted standardized URL Hashes.", "Calls URL API\n @see LinkShrink::Shrinkers::Base#api_url\n @see LinkShrink::Shrinkers::Base#body_parameters", "Used to find a suitable implementation\n @api public\n @param [*selectors] zero or more selectors to use for finding an\n   implementation of this interface. If none is given, :auto is assumed.\n @return [Implementation::Registry::Finder]", "Cleanup some crap", "Returns an array of possible namespaces based on splitting the key at\n every underscore.", "Returns the rest of the key for a given namespace", "Initialize the attribute.\n\n @param name [Symbol] The name of the attribute.\n @param list [AttributeList] The attribute list this attribute is\n   a part of.\n @param options [Hash] The optiosn for the attribute.\n Update the attribute with the given value.  It runs the value\n through the callbacks, and returns a new value given by the\n callbacks.\n\n @param value [Object] The new value.\n @return [Object] The new new value.", "Dynamically execute shell commands, instead of Ruby.\n\n @param [String] input\n   The input from the console.", "Format a specific section.\n\n section_changes ... changes in the format of { section_1: [changes...], section_2: [changes...]}\n header ... header of the section\n entry_style ... is called for styling each item of a section\n header_style ... optional, since styled header can be passed directly; is called for styling the header of the section", "Render the Changelog with Slack Formatting", "Grow the pool by one if we have more jobs than idle workers", "Handles method calls for our configuration keys.", "Write the string to a file in the export path.", "Creates a new page, restarting the vertical position of the pointer.\nPrint the whole header for the current groups and the columns of the report.", "Convert to symbol all hash keys, recursively.", "Convert the structure of the rules to facilitate the generating proccess.", "Create a structure to calculate the footer values for all groups. Appends the footer body to total values too.", "Print the footers according to the groups and source specified", "releases the given Particle\n\n @parama [Particle] p the Particle to be released\n\n @note the Particle is stored into Hash @pool to be reused as soon as needed\n\n @see Particle#reset! the Particle is reseted before beeing stored", "requires a Particle of the given Class\n\n @param [Class] p_kls the desired Class of Particle\n\n @note if there is no Particle of the given Class, one is created", "process the given particle\n\n @param [Particle] p the Particle to be processed", "starts the system mainloop\n\n first Iota#start! is called on each children unless the system is resuming from hibernation\n then while there is Particle in the fifo, first process all system Particle then 1 application Particle\n after all Iota#stop! is called on each children, unless the system is going into hibernation", "sends the system into hibernation\n\n @param [String] path the path to the hibernation file\n\n the system is serialized into JSON data and flushed to disk", "collapses all types encountered in a file's column into a single type", "get all remote link on page", "fill Page instant with data for report", "get page with open-uri, then parse it with Nokogiri. Get site domain and path from URI", "true if title and h1 have no duplicates", "true if metadescription less then 200 symbols", "true if code of page less then text on it", "check meta and title tags duplicates", "return hash with all titles, h1 and h2", "get all a tags", "This will be included in every request once you have logged in", "Call either the secure or the base web url", "This converts a hash that has mixed case\n into all lower case", "Matches both the subject and action, not necessarily the conditions", "In short, this is the XML string that makes the report.\n\n @return [String] XML report", "Writes the report to the specified file\n also returns the new XML report content\n\n @return [String] final XML report content", "Helper method to return errors or desired response data as appropriate.\n\n Added just for convenience to avoid having to traverse farther down the response just to get to returned data.", "Set the bounds of a variable in the model", "Construct a new model object", "Build a constraint matrix for the currently existing variables", "Store all data for the model", "Store the bounds for a given constraint", "Set the properties of a variable in the model", "renders a calendar table\n\n Example with elements that span more than 1 day:\n\n     = month_calendar @date, @reservations, start_date_method: :start_at, end_date_method: :end_at\n\n Example of using a lamda as display method:\n\n     = month_calendar(display_method: ->(context, resource) { context.link_to(resource.booker.human, resource.booker) })", "Send a command to the current buffer.\n\n Note: If the given command does not start with a slash, one will be added.\n\n @param [Array<String>] *parts All parts of the command to send\n @return [String] The whole command as sent to the buffer\n @example\n   my_buffer.command(\"/whois\", \"dominikh\")", "Send a text to the buffer. If the buffer represents a channel, the text\n will be send as a message to the channel.\n\n Note: this method will automatically escape a leading slash, if present.\n\n @param [Array<String>] *text All parts of the text to send\n @return [String] The whole string as sent to the buffer", "Returns an array with all lines of the buffer.\n\n @param [Boolean] strip_colors Whether to strip out all color codes\n @return [Array<Line>] The lines\n @see #text", "Bind keys to a command.\n\n @param [Array<String>] keys An array of keys which will be used to build a keychain\n @param [String, Command] command The command to execute when the keys are being pressed\n @return [String] The keychain\n @see #unbind_keys", "A really important part of this class. The headers are injected here,\n and the body is transformed into a JSON'd string when necessary.\n We do exponential back-off for error responses, and return a parsed\n response body if present, the full Response object if not.", "Build a resumable upload request that then makes POST and PUT requests with the correct\n headers for each request.\n\n The initial POST request initiates the upload process, passing the metadata for the file.\n The response from the API includes a Location header telling us where to actually send the\n media we want uploaded. The subsequent PUT request sends the media itself to the API.", "Put together the full URL we will send a request to.\n First we join the API's base URL with the current method's path, forming the main URL.\n\n If the method is mediaUpload-enabled (like uploading a file to Google Drive), then we want\n to take the path from the resumable upload protocol.\n\n If not, then, we are going to iterate through each of the parameters for the current method.\n When the parameter's location is within the path, we first check that we have had that\n option passed, and if so, substitute it in the correct place.\n When the parameter's location is a query, we add it to our query parameters hash, provided it is present.\n Before returning the URL and remaining options, we have to build the query parameters hash\n into a string and append it to the end of the URL.", "Adapted from Rails language_select. Just uses language codes instead of full names.", "Sends a file blob to the browser.\n\n This method uses HTTP's strong etag feature to facilitate serving the files\n from a cache whenever possible.\n\n @param [FileBlobs::FileBlobProxy] proxy a proxy for a collection of\n     attributes generated by has_file_blob\n @param [Hash<Symbol, Object>] options tweaks the options passed to the\n     underlying send_data call; this method sets the  :filename and :type\n     options, but their values can be overridden by the options hash\n @see ActionController::DataStreaming#send_data", "Ensures that all configuration parameters are of an expected type.\n\n @raise [Diversion::Error::ConfigurationError] Error is raised when\n   supplied configuration is not of expected type", "Returns a Code128 barcode instance.\n\n opts:\n :subset - specify the Code128 subset to use ('A', 'B', or 'C').", "Writes a barcode PNG image.\n\n opts:\n :subset - specify the Code128 subset to use ('A', 'B', or 'C').\n remaining options passed through to PNGOutputter.", "Get the classification leaderboard for a given campaign\n\n param [Integer] campaign_id The ID of the campaign to fetch the leaderboard for.", "select \"count characters\"", "select \"count\" words", "select \"count\" paragraphs, wrap in p-tags", "Calls the block given to this method with this database as an argument, and closes the\n database when done.\n\n @param [String, nil] user the application login user\n @param [String, nil] password the application login password\n @yield [database] the operation to perform on the database\n @yieldparam [Database] database self", "Releases database resources. This method should be called when database interaction\n is completed.", "Performs the operation given by the given op symbol on obj by calling the block given to this method.\n Lazy loading is suspended during the operation.\n\n @param [:find, :query, :create, :update, :delete] op the database operation type\n @param [Resource] obj the domain object on which the operation is performed\n @param opts (#see Operation#initialize)\n @yield the database operation block\n @return the result of calling the operation block", "Initializes the default application service.", "Returns the current database operation stack as a String.", "Connects to the database.", "Retrieve whatever data is stored in at `key`, and return it!", "setup an oktokit client with auto_pagination turned on so we get all the repos\n returned even in large organizations\n\n @param token [String] the github access token\n @return [Octokit::Client] the oktokit client object", "Retrieves a Set containing all the plugins from the output", "Parses a single line of the output into a Plugin object", "Rewrite the algorithm, much much more better.", "post JSON data.\n @param [String] path The parts of the URL that comes after the core\n @param [Hash,Array] object_to_post The data to post as json\n @return [Hash] the parsed-out response", "Get from solr, and return a Response object of some sort\n @return [SimpleSolrClient::Response, response_type]", "Post an object as JSON and return a Response object\n @return [SimpleSolrClient::Response, response_type]", "Get a client specific to the given core2\n @param [String] corename The name of the core (which must already exist!)\n @return [SimpleSolrClient::Core]", "Create a new, temporary core\nnoinspection RubyWrongHash", "Set up files for a temp core", "Overwritten send_single_request method, so it now adds header with the user agent\n @return [Array] collection of responses", "Overwritten send_batch_request method, so it now adds header with the user agent\n @return [Array] collection of responses", "Overwritten send_batch method, so it now returns collection of responses\n @return [Array] collection of responses", "Camelcases the options", "Builds the necessary query string", "Serialize model into a string\n\n @param [Hash] options\n @option options [String] :format name of the serializer to use,\n @option options [String] :mime_type MIME type of the syntax, if applicable,\n @option options [String, URI] :type_uri URI of syntax, if applicable,\n @option options [String, URI] :base_uri base URI,\n   to be applied to the nodes with relative URIs.\n @raise [RedlandError] if it fails to create a serializer", "Starts the Djinn in the background.", "Starts the Djinn in the foreground, which is often useful for\n testing or other noble pursuits.", "Initialize the BitField with an optional value. Default is 0\n\n @param [Integer] value the integer that contains the bit fields\n Read the specified bit indices into a hash with bit index as key\n\n @param [Integer] bits one or more bit indices to read.\n\n @example Read a list of bits into a hash\n   bit_field = BitField.new(5)\n   bit_field.read_bits(0, 1, 2)\n   #=> {0=>1, 1=>0, 2=>1}\n   # because 5 is 101 in binary\n\n @return [Hash] a hash with the bit index as key and bit (1 or 0) as value", "Read the specified bit indices as a group, in the order given\n\n @param [Integer] bits one or more bit indices to read. Order matters!\n\n @example Read bits or a list of bits into an integer\n   bit_field = BitField.new(101) # 1100101 in binary, lsb on the right\n   bit_field.read_field(0, 1, 2) #=> 5 # or 101\n   bit_field.read_field(0) #= 1\n   bit_field.read_field( (2..6).to_a ) #=> 25 # or 11001\n\n @return [Integer] the value of the bits read together into an integer", "Parses given params or file and returns Hash including the given key.", "Loads a specified file and returns Hash including the given key.", "Return the bundle url. In production, the single bundled result is produced; otherwise, each individual\n asset_url is returned.", "end of class methods", "BUILD sub structures", "get forward lines\n\n args\n   size ... number of lines\n\n returner\n   String object as lines", "Make sure that the value of the `role` attribute is a valid role\n for the commentable.\n\n If the commentable doesn't have any comment roles, we make sure\n that the value is blank.", "Route an activity\n\n @param activity [Activity] Activity to route\n @return [Integer] The number of resolved recipients that will handle activity", "Find recipients for given activity in given timeline\n\n @api private\n\n @param timeline_class [Class]    Timeline class\n @param activity       [Activity] Activity instance\n @return [Hash{Object=>Timeline::Route}] Recipients with corresponding Routes", "Retrieves and merges all dojo_props", "Initialize a client to a SAM node hosted at a specific url\n\n @param [Hash] optional hash with user, password, host and port of the SAM node\n @return [Client] the object itself\n @example\n   nsisam = NSISam::Client.new user: 'username' password: 'pass',\n                               host: 'localhost', port: '8888'\n Store a given data in SAM\n\n @param [String] data the desired data to store\n @return [Hash] response with the data key and checksum\n   * \"key\" [String] the key to access the stored data\n   * \"checksum\" [String] the sha512 checksum of the stored data\n\n @raise [NSISam::Errors::Client::AuthenticationError] when user and password doesn't match\n\n @example\n   nsisam.store(\"something\")", "Store a file in SAM. If the file will be used by other NSI's service\n you should pass an additional 'type' parameter.\n\n @param [Object] file_content json serializable object\n @param [Symbol] type of the file to be stored. Can be either :doc and :video.\n @return [Response] object with access to the key and the sha512 checkum of the stored data\n\n @raise [NSISam::Errors::Client::AuthenticationError] when user and password doesn't match\n\n @example\n   nsisam.store_file(File.read(\"foo.txt\"))\n   nsisam.store_file(File.read(\"foo.txt\"), :video)", "Delete data at a given SAM key\n\n @param [Sring] key of the value to delete\n @return [Hash] response\n   * \"deleted\" [Boolean] true if the key was successfully deleted\n\n @raise [NSISam::Errors::Client::KeyNotFoundError] when the key doesn't exists\n @raise [NSISam::Errors::Client::AuthenticationError] when user and password doesn't match\n\n @example Deleting an existing key\n   nsisam.delete(\"some key\")", "Recover data stored at a given SAM key\n\n @param [String] key of the value to acess\n @return [Response] response object holding the file and some metadata\n\n @raise [NSISam::Errors::Client::KeyNotFoundError] when the key doesn't exists\n @raise [NSISam::Errors::Client::AuthenticationError] when user and password doesn't match\n\n @example\n   nsisam.get(\"some key\")", "Recover a file stored at a given SAM key\n\n @param [String] key of the file to access\n @param [Symbol] type of the file to be recovered. Can be either :doc and :video.\n @return [Response] response object holding the file and some metadata\n\n @raise [NSISam::Errors::Client::KeyNotFoundError] when the key doesn't exists\n @raise [NSISam::Errors::Client::AuthenticationError] when user and password doesn't match\n\n @note Use of wrong \"type\" parameter can generate errors.\n\n @example\n   nsisam.get_file(\"some key\")\n   nsisam.store_file(\"test\", :doc) # stored at key 'test_key'\n   nsisam.get_file(\"test_key\", :doc)", "Update data stored at a given SAM key\n\n @param [String] key of the data to update\n @param [String, Hash, Array] data to be stored at the key\n @return [Response] response object holding the file and some metadata\n\n @raise [NSISam::Errors::Client::KeyNotFoundError] when the key doesn't exists\n @raise [NSISam::Errors::Client::AuthenticationError] when user and password doesn't match\n\n @example\n   nsisam.update(\"my key\", \"my value\")", "Update file stored at a given SAM key\n\n @param [String] key of the file to update\n @param [Symbol] type of the file to be recovered. Can be either :doc and :video.\n @param [String] new_content content of the new file\n @return [Response] response object holding the file and some metadata\n\n @raise [NSISam::Errors::Client::KeyNotFoundError] when the key doesn't exists\n @raise [NSISam::Errors::Client::AuthenticationError] when user and password doesn't match\n\n @example\n   nsisam.update_file(\"my key\", \"my value\")\n   nsisam.update_file(\"my key\", \"my value\", :video)\n   nsisam.update_file(\"my key\", \"my value\", :doc)", "Set and view configuration options\n\n # editor [-e --editor]\n ruby-edit configure --editor\n => vim\n ruby-edit configure --editor emacs\n => emacs\n\n # grep options [-o --grep_options]\n ruby-edit configure --grep_options\n => irn\n ruby-edit configure --grep_options h\n => Hn", "The real Rack call interface.\n if an asset file is being requested, this is an endpoint - otherwise, call\n on up to the app as normal", "Finds all versions of the short path name in the paths in the path\n sets.  If no block is given, it returns an enumerable; otherwise, if\n a block is given, it yields the joined path if it exists.\n\n @raise NoFileError If no file could be found.\n @param short [::String, ::Pathname] The \"short\" path to resolve.\n @param options [{::Symbol => ::Object}] The options for finding.\n @option options [Boolean] :allow_absolute (false)\n @option options [Boolean] :file (true) Whether or not the full path\n   must be a file for it to be considered existant.  This should be set\n   to true, because in most cases, it's the desired behavior.\n @yield [path] For every file that exists.\n @yieldparam path [::Pathname] The path to the file.  This is guarenteed\n   to exist.\n @return [void]", "Given a path, run it through tilt and return the compiled version.\n If there's no known engine for it, just return the content verbatim.\n If we know the type buy are missing the gem, raise an exception.", "Copy all the files from a directory to the output, compiling\n them if they are familiar to us. Does not do any sprocketing.", "Process all the files in the directory through sprockets before writing\n them to the output directory", "Generate the manifest from the spec and write it to disk", "Set up the sprockets environment for munging all the things", "Send a message to jabber user jid.\n\n Valid message types are:\n\n   * :normal (default): a normal message.\n   * :chat: a one-to-one chat message.\n   * :groupchat: a group-chat message.\n   * :headline: a \"headline\" message.\n   * :error: an error message.\n\n If the recipient is not in your contacts list, the message will be queued\n for later delivery, and the Contact will be automatically asked for\n authorization (see Jabber::Simple#add).\n\n message should be a string or a valid Jabber::Message object. In either case,\n the message recipient will be set to jid.", "Set your presence, with a message.\n\n Available values for presence are:\n\n   * nil: online.\n   * :chat: free for chat.\n   * :away: away from the computer.\n   * :dnd: do not disturb.\n   * :xa: extended away.\n\n It's not possible to set an offline status - to do that, disconnect! :-)", "Send a Jabber stanza over-the-wire.", "Queue messages for delivery once a user has accepted our authorization\n request. Works in conjunction with the deferred delivery thread.\n\n You can use this method if you want to manually add friends and still\n have the message queued for later delivery.", "This thread facilitates the delivery of messages to users who haven't yet\n accepted an invitation from us. When we attempt to deliver a message, if\n the user hasn't subscribed, we place the message in a queue for later\n delivery. Once a user has accepted our authorization request, we deliver\n any messages that have been queued up in the meantime.", "Creates a new key on the local client\n\n @param options [Hash] fields to send to ssh key pair generation\n @return [String] success or failure message", "Sends a post request with json from the command line key\n\n @param options [Hash] fields from fenton command line\n @return [Object] true or false\n @return [String] message on success or failure", "Generates the SSH key pair\n\n @param options [Hash] fields from fenton command line\n @return [String] ssh key pair object created from the options hash", "Return metadata on all containers", "Initialize context object\n Sets options on a context.\n\n It is recommended to use the default for +io_threads+\n (which is 1) since most programs will not saturate I/O.\n\n The rule of thumb is to make io_threads equal to the number\n of gigabits per second that the application will produce.\n\n The io_threads number specifies the size of the thread pool\n allocated by Crossroads for processing incoming/outgoing messages.\n\n The +max_sockets+ number specifies the number of concurrent\n sockets that can be used in the context. The default is 512.\n\n Context options take effect only if set with **setctxopt()** prior to\n creating the first socket in a given context with **socket()**.\n\n @param [Constant] name\n   One of @XS::IO_THREADS@ or @XS::MAX_SOCKETS@.\n @param [Integer] value\n\n @return 0 when the operation completed successfully.\n @return -1 when this operation fails.\n\n @example Set io_threads context option\n   rc = context.setctxopt(XS::IO_THREADS, 10)\n   unless XS::Util.resultcode_ok?(rc)\n     XS::raise_error('xs_setctxopt', rc)\n   end", "Allocates a socket for context\n\n @param [Constant] type\n   One of @XS::REQ@, @XS::REP@, @XS::PUB@, @XS::SUB@, @XS::PAIR@,\n          @XS::PULL@, @XS::PUSH@, @XS::DEALER@, or @XS::ROUTER@\n\n @return [Socket] when the allocation succeeds\n @return nil when call fails", "Creates an Instance\n @param ip [String] Optionally override the IP of the server\n @param port [Fixnum, Numeric] Optionally specify the port of the server\n Publishes this server and starts the {#heartbeat}", "Creates an object using a factory_girl factory and creates a Given step that reads like\n \"Given a gi_joe with a name of 'Blowtorch' and habit of 'swearing'\"\n @param factory_name A Symbol or String for the name of the factory_girl factory to use\n @param args Arguments to supply to the *factory_name* factory_girl factory", "Setup the notification categories for the enterprise", "Setup the intelligent segments for the enterprise", "assign them a random one and mail it to them, asking them to change it", "Filter keys out of a Hash.\n\n   { :a => 1, :b => 2, :c => 3 }.except(:a)\n   => { :b => 2, :c => 3 }", "Returns a Hash with only the pairs identified by +keys+.\n\n   { :a => 1, :b => 2, :c => 3 }.only(:a)\n   => { :a => 1 }", "Given a set of forms to build, it yields blocks that can be called to\n build a form.\n\n @param which [::Symbol, <::Symbol>] If this is `:all`, all of the forms\n   available are built; otherwise, it only builds the forms whose names\n   are listed.\n @yield [build] Yields for each form that can be built.\n @yieldparam build [::Proc<void>] A block that can be called to build\n   a form.\n @return [void]", "A cache for all of the root nodes.  This is a regular hash; however, upon\n attempt to access an item that isn't already in the hash, it first\n parses the file at that item, and stores the result in the hash, returning\n the root node in the file.  This is to cache files so that they do not\n get reparsed multiple times.\n\n @return [{::Pathname => Parser::Root}]", "Parses a file.  This bypasses the filename cache.\n\n @param path [::Pathname] The path to the actual file.  This should\n   respond to `#read`.  If this isn't a pathname, the short should be\n   provided.\n @param short [::String] The short name of the file.  This is used for\n   location information.\n @return [Parser::Root]", "Initialize a new Statement wrapping the given StatementExecutor.\n\n @param [Object] executor\n   any object that responds to #execute, #connection and #command\n Execute the command using the given bind values.\n\n @param [Object...] args\n   bind parameters to use in place of '?'", "Returns a hash of all the attributes with their names as keys and the values of the attributes as values.", "true if can use for hash-key", "pass if occured the error is just a own instance\n @param [Class] exception_klass", "Processes queued item of type push", "Processes queued item of type pull", "Create attribute accesors for the included class\n   Also validations and coercions for the type specified\n\n @param [Symbol] name the accessor name\n @param [Class] type the class type to use for validations and coercions\n\n @example\n   class Person\n     include StronglyTyped::Model\n\n     attribute :id, Integer\n     attribute :slug, String\n   end\n\n   Person.new(id: 1, slug: 'elgalu')\n   #=> #<Person:0x00c98 @id=1, @slug=\"elgalu\">\n   leo.id   #=> 1\n   leo.slug #=> \"elgalu\"", "Add new attribute for the tiny object modeled\n\n @param [Symbol] name the attribute name\n @param [Class] type the class type\n\n @private", "Define attr_writer method for the new attribute\n   with the added feature of validations and coercions.\n\n @param [Symbol] name the attribute name\n @param [Class] type the class type\n\n @raise [TypeError] if unable to coerce the value\n\n @private", "Initializes a new VirtualMachine for a connection and name\n\n   * connection: The +Derelict::Connection+ to use to manipulate\n                 the VirtualMachine instance\n   * name:       The name of the virtual machine, used when\n                 communicating with the connection)\n Validates the data used for this connection\n\n Raises exceptions on failure:\n\n   * +Derelict::VirtualMachine::NotFound+ if the connection\n     doesn't know about a virtual machine with the requested\n     name", "Executes a command on the connection for this VM\n\n   * command: The command to execute (as a symbol)\n   * options: A Hash of options, with the following optional keys:\n       * log:      Logs the output of the command if true\n                   (defaults to false)\n       * log_mode: Controls how commands are logged (one of\n                   either :chars or :lines, defaults to :lines)\n       * color:    Uses color in the log output (defaults to\n                   false, only relevant if log is true)\n       * provider: The Vagrant provider to use, one of\n                   \"virtualbox\" or \"vmware_fusion\" (defaults to\n                   \"virtualbox\")", "Gives a real number between 0 and 1 indicating how many lines have been\n executed.\n\n @return [Float] lines executed as a fraction", "Gives a real number between 0 and 1 indicating how many lines of code have\n been executed. It ignores all lines that can not be executed such as\n comments.\n\n @return [Float] lines of code executed as a fraction", "Make an array at the key, while providing a seamless upgrade to existing flashes\n\n Initial set to Array\n\n Principle of least surprise\n flash[:notice] = ['message1','message2']\n flash[:notice] # => ['message1','message2']\n\n Initial set to String\n\n Principle of least surprise\n flash[:notice] = 'original'\n flash[:notice] # => ['original']\n\n Overwrite!\n\n Principle of least surprise\n flash[:notice] = 'original'\n flash[:notice] = 'altered'\n flash[:notice] # => ['altered']\n\n The same line of code does all of the above.\n Leave existing behavior in place, but send the full array as the value so it doesn't get killed.", "We need to overload the add method. Basibally it is the same as the\n original one, but we add our own log format to it.", "Load the next chuck of data from GMail into the cache.\n\n @param [GData::Client::Contacts] client Connection to GMail.\n @param [Integer] idx Index of next piece of data to read from\n                      <tt>client</tt>.\n @param [Bitsa::ContacstCache] cache Cache to be updated from GMail.\n @param [Datetime] orig_last_modified Time that <tt>cache</tt> was last\n                                      modified before we started our update\n\n @return [Integer] Number of records read.", "Process a Gmail contact, updating the cache appropriately.\n\n @param [Bitsa::ContacstCache] cache Cache to be updated from GMail.\n @param [REXML::Element] entry GMail data for a contact.", "Generate the URL to retrieve the next chunk of data from GMail.\n\n @param [Integer] idx Index of next piece of data to read from\n   <tt>client</tt>.\n @param [Datetime] cache_last_modified modification time of last contact\n   read from GMail", "works like each, but recursive\n\n @param mode [:pre, :post, :leaves]", "Connect to the server\n OpenSSL verify callback used by initialize when optional callback argument isn't set.", "Sends the login packet with specific token.\n Read the result with `read`.", "Transmit a packet over the connection", "Read a packet from the connection", "Call create store api\n @param store_data", "Call order api\n @param order_data", "Call store lookup api\n @param url", "Take corresponding results array values and compare them", "if the first is a md_ial, it is used as such", "i steal this from rails", "module_eval <<-EOV", "Search for a private channel with user", "Search for the recipient in a private channel.\n If the channel isn't private, it returns the first user it can find\n that has a special mode in that channel.\n So you should probably make sure it's private first.", "Sets up the circuit breaker for making requests to the service.\n\n Any exception raised by the `_request` method will count as a failure for\n the circuit breaker.  Once the threshold for errors has been reached, the\n circuit opens and all subsequent requests will raise a CircuitOpenError.\n\n When the circuit is opened or closed, a message is sent to the logger for\n the client.", "Add a correlation ID to the header and send the request to the adapter", "Parses tests.\n @return   [success]", "Puts the given document content at the specified URI\n\n @param document_uri [String] the URI at wich to store the document.\n relative to the collection specified on initialization otherwise '/db'.\n @return [HTTParty::Response] the response object", "Deletes the document at the specified URI from the store\n\n @param document_uri [String] the URI of the document to delete.\n relative to the collection specified on initialization otherwise '/db'.\n @return [HTTParty::Response] the response object", "Runs the given XQuery against the store and returns the results\n\n @param query [String] XQuery to run against the store\n @param opts [Hash] options for the query request.\n @option opts :start [Integer] Index of first item to be returned.\n @option opts :max [Integer] The maximum number of items to be returned.\n @return [String] the query results", "Stores the given query at the specified URI\n\n @param query_uri [String] the URI of the query to run\n @param query [String] the query body\n @return [HTTParty::Response] the response object", "Stores a document at the specified URI and with the specified content type\n\n @param uri [String] the URI under which to store the document\n @param document [String] the document body\n @param content_type [String] the MIME Type of the document\n @return [HTTParty::Response] the response object", "Creates a new Institution object from the given code, name and hash.\n\n The optional +hash+, if given, will generate additional attributes and values.\n\n\n For example:\n\n   require 'institutions'\n   hash = { \"attribute1\" => \"My first attribute.\", :array_attribute => [1, 2] }\n   institution = Institutions::Institution.new(\"my_inst\", \"My Institution\", hash)\n\n   p institution        # -> <Institutions::Institution @code=:my_inst @name=\"My Institution\" @attribute1=My first attribute.\" @array_attribute=[1, 2] @default=false>\n\n\n Sets the required attributes.\n Raises an ArgumentError specifying the missing arguments if they are nil.", "Uses the Row controller to build up the table body.", "Renders individual rows for the table.", "Generates the body for a grouping. Iterates through the groups and\n renders them using the group controller.", "Get a list of all users for the authenticating client.\n\n @param [Hash]  options\n @option options Integer :limit - The maximum number of records to return.", "Create a user in the checkd.in system tied to the authenticating client.\n\n @param [Hash]  options\n @option options String :identifier            - REQUIRED, The authenticating client's internal identifier for this user.\n @option options String :email                 - REQUIRED, A valid email for the user\n @option options String :referral_token        - OPTIONAL, the referral token of the user that referred the user being created.\n @option options String :first_name            - OPTIONAL\n @option options String :last_name             - OPTIONAL\n @option options String :gender                - OPTIONAL, format of male or female\n @option options String :birth_date            - OPTIONAL, YYYY-MM-DD format\n @option options String :username              - OPTIONAL\n @option options String :mobile_number         - OPTIONAL, XXXYYYZZZZ format\n @option options String :postal_code_text      - OPTIONAL, XXXXX format\n @option options String :classification        - OPTIONAL, the internal group or classification a user belongs to\n @option options Boolean :delivery_email       - OPTIONAL, whether a user should receive email notifications\n @option options Boolean :delivery_sms         - OPTIONAL, whether a user should receive sms notifications\n @option options Integer :campaign_id          - OPTIONAL, automatically join a user to this campaign, rewarding existing known actions", "Create an authentication for a user\n\n param [Integer] id The ID of the user\n @param [Hash]  options\n @option options String :provider - The name of the provider for the authentication (twitter, facebook, foursquare, linkedin, instagram)\n @option options String :uid - The user's id for the provider (on the provider's service, not your internal identifier)\n @option options String :oauth_token - The user's oauth token or access token that can be used to retrieve data on their behalf on the service.\n @option options String :oauth_token_secret - The user's oauth token secret or access token secret that is used in combination with the oauth token (required for twitter)\n @option options String :nickname - The user's nickname on the provider's service.", "Get a list of all blacklisted users for the authenticating client.\n\n @param [Hash]  options\n @option options Integer :limit - The maximum number of records to return.", "View a full user's description\n\n param [Integer] id The ID of the user", "+temp_object+ should respond to +data+ and +meta+", "Updates a repository, syncing in all packages which have not already been\n downloaded and caches them locally.\n\n == Parameters:\n ignore_cksum::\n   Ignore checksum mismatches\n ignore_sigs::\n   Ignore author signature mismatches", "Delete a key", "Return a Hash of terminating nodes to Integer counts for a given String data,\n i.e. Find the count of instances of each String in the tree in the given data.", "Find a node by its key", "Creates a new Migrator with the given options.\n\n The migration configuration must provide sufficient information to build a well-formed migration\n target object. For example, if the target object is a new +CaTissue::SpecimenCollectionGroup+,\n then the migrator must build that SCG's required +CollectionProtocolRegistration+. The CPR in\n turn must either exist in the database or the migrator must build the required CPR\n +participant+ and +collection_protocol+.\n\n @option (see Jinx::Migrator#initialize)\n @option opts [Database] :database the target application database\n @see #migrate_to_database\n Imports this migrator's file into the database with the given connect options.\n This method creates or updates the domain objects mapped from the migration source.\n If a block is given to this method, then the block is called on each migrated\n target object.\n\n The target object is saved in the database. Every referenced migrated object is created,\n if necessary. Finally, a migration target owner object is created, if necessary.\n\n For example, suppose a migration configuration specifies the following:\n * the target is a +CaTissue::SpecimenCollectionGroup+\n * the field mapping specifies a +Participant+ MRN,\n * the defaults specify a +CollectionProtocol+ title and a +Site+ name\n\n The migrator attempts to fetch the protocol and site from the database. If they do not\n exist, then they are created. In order to create the protocol and site, the migration\n configuration must specify sufficient information to validate the objects before creation,\n as described in {#initialize}. Finally, the SCG +CollectionProtocolRegistration+ owner\n is created. This CPR references the migration protocol and site.\n\n If the +:create+ option is set, then an input record for a target object which already\n exists in the database is noted in a debug log message and ignored rather than updated.\n\n @yield [target, row] operates on the migration target\n @yieldparam [Resource] target the migrated target domain object\n @yieldparam [{Symbol => Object}] row the migration source record", "temp method, for prototyping", "temp method, for prototyping\n save as above, except the keys are Time objects", "Add a child page. You will seldom need to call this directly.\n Instead use add_blog or add_article", "Compares a plain-text password against the password hash in this credential.\n\n Returns +true+ for a match, +false+ otherwise.", "Password virtual attribute.", "Ensure that the model has markup. Accepts all the same options that has_markup does.\n\n   should_have_markup :content", "Initialize and return a new Client instance. Optionally, configure\n options for the instance by passing a Configuration object. If no\n custom configuration is provided, the configuration options from\n Orchestrate.config will be used.\n\n Creates the Request object and sends it via the perform method,\n which generates and returns the Response object.", "Builds the URL for each HTTP request to the orchestrate.io api.", "add variables. doesn't check for uniqueness, does not overwrite existing", "Use to set the value for a variety of variables", "Calculate precipitation in self defined units and aproximated real world units", "Create or update a customer with given id\n @return [Customer] if successfully created or updated\n @raise [Httparty::Error] for all sorts of HTTP statuses.", "Parses the IndexList", "Sets the key to expire after ttl seconds\n @param [#to_f] ttl the time to live in seconds (where 0.001 = 1ms)\n @return [Boolean] true if expired, false otherwise", "Sets the key to expire at the given timestamp.\n @param [#to_f] time time or unix timestamp at which the key should expire; once converted to float, assumes 1.0 is one second, 0.001 is 1 ms\n @return [Boolean] true if expired, false otherwise", "Restores the struct to its serialized value as given\n @param [String] serialized serialized representation of the value\n @param [#to_f] ttl the time to live (in seconds) for the struct; defaults to 0 (meaning no expiry)\n @raise [Redis::CommandError] raised if the serialized value is incompatible or the key already exists\n @return [Boolean] true if restored, false otherwise", "Parse arguments and setup attributes.\n\n It also handles showing the Help and Version information.\n\n @example parse command line arguments\n   cli = Bitsa::CLI.new\n   cli.parse(ARGV)\n   cli.cmd # => # => \"reload\"\n\n @param args [String[]] Cmd line arguments.\n\n @return [nil]\n\n @raise [TrollopException] If invalid data is passed", "The field with a specific identifier", "Load all Collections that are related to the current one through AssociationFields", "returns true if it was created by given user or if given user is an admin", "returns an array of participants for the discussion", "Count operates using three different approaches.\n\n * Count all: By not passing any parameters to count, it will return a count of all the rows for the model.\n * Count using column: By passing a column name to count, it will return a count of all the\n   rows for the model with supplied column present.\n * Count using options will find the row count matched by the options used.\n\n The third approach, count using options, accepts an option hash as the only parameter. The options are:\n\n * <tt>:conditions</tt>: An SQL fragment like \"administrator = 1\" or [ \"user_name = ?\", username ].\n   See conditions in the intro to ActiveRecord::Base.\n * <tt>:joins</tt>: Either an SQL fragment for additional joins like \"LEFT JOIN comments ON comments.post_id = id\"\n   (rarely needed) or named associations in the same form used for the <tt>:include</tt> option, which will\n   perform an INNER JOIN on the associated table(s). If the value is a string, then the records\n   will be returned read-only since they will have attributes that do not correspond to the table's columns.\n   Pass <tt>:readonly => false</tt> to override.\n * <tt>:include</tt>: Named associations that should be loaded alongside using LEFT OUTER JOINs.\n   The symbols named refer to already defined associations. When using named associations, count\n   returns the number of DISTINCT items for the model you're counting.\n   See eager loading under Associations.\n * <tt>:order</tt>: An SQL fragment like \"created_at DESC, name\" (really only used with GROUP BY calculations).\n * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.\n * <tt>:select</tt>: By default, this is * as in SELECT * FROM, but can be changed if you, for example,\n   want to do a join but not include the joined columns.\n * <tt>:distinct</tt>: Set this to true to make this a distinct calculation, such as\n   SELECT COUNT(DISTINCT posts.id) ...\n * <tt>:from</tt> - By default, this is the table name of the class, but can be changed to an\n   alternate table name (or even the name of a database view).\n\n Examples for counting all:\n   Person.count         # returns the total count of all people\n\n Examples for counting by column:\n   Person.count(:age)  # returns the total count of all people whose age is present in database\n\n Examples for count with options:\n   Person.count(:conditions => \"age > 26\")\n\n   # because of the named association, it finds the DISTINCT count using LEFT OUTER JOIN.\n   Person.count(:conditions => \"age > 26 AND job.salary > 60000\", :include => :job)\n\n   # finds the number of rows matching the conditions and joins.\n   Person.count(:conditions => \"age > 26 AND job.salary > 60000\",\n                :joins => \"LEFT JOIN jobs on jobs.person_id = person.id\")\n\n   Person.count('id', :conditions => \"age > 26\") # Performs a COUNT(id)\n   Person.count(:all, :conditions => \"age > 26\") # Performs a COUNT(*) (:all is an alias for '*')\n\n Note: <tt>Person.count(:all)</tt> will not work because it will use <tt>:all</tt> as the condition.\n Use Person.count instead.", "Calculates the sum of values on a given column. The value is returned\n with the same data type of the column, 0 if there's no row. See\n +calculate+ for examples with options.\n\n   Person.sum('age') # => 4562", "Replaces any existing order defined on the relation with the specified order.\n\n   User.order('email DESC').reorder('id ASC') # generated SQL has 'ORDER BY id ASC'\n\n Subsequent calls to order on the same relation will be appended. For example:\n\n   User.order('email DESC').reorder('id ASC').order('name ASC')\n\n generates a query with 'ORDER BY id ASC, name ASC'.", "Creates a new PermitRule.\n\n +:if+ and +:unless+ conditions may be evaluated for static, dynamic, and\n named authorizations. They are evaluated after the other rule checks are\n applied, and only if the rule still matches. The conditionals may make a\n matching rule not match, but will not make an unmatched rule match. If\n both +:if+ and +:unless+ are given the +:if+ condition is run first, and\n if the rule still matches the +:unless+ will be run.\n\n @param [:person, :guest, :everyone, Symbol, <Symbol>] roles the role(s) to\n   test against.\n   - :person - +current_person.guest? == false+ This person should be\n     authenticated. This indicates a dynamic authorization.\n   - :guest - +current_person.guest? == true+ This is a person that is not\n     authenticated. This is a static authorization.\n   - :everyone - Any user of the system. This is a static authorization.\n   - Symbol/<Symbol> - This is the key or keys of any of the role(s) to\n     match against in the database. This indicates a named authorization.\n @param [Hash] options the options to use to configure the authorization.\n @option options [Symbol] :who Indicates that a method should be checked on\n   the target object to authorize. Checks a variety of possibilities,\n   taking the first variation that the target responds to.\n\n   When the symbol is prefixed with 'is_' then multiple methods will be\n   tried passing the person in. The methods tried for +:is_owner+ would be\n   +is_owner()+, +is_owner?()+, +owner()+, +owner+, +owners.exist?()+. If\n   this option is given +:of+/+:on+ must also be given.\n @option options [Symbol] :that alias for +:who+\n @option options [Symbol, nil, :any, <Symbol, nil>] :of The name of the\n   instance variable(s) to use as the target resource(s).\n\n   In a dynamic authorization this is the object that will be tested using\n   the value of +:who+/+:that+.\n\n   In a named authorization this is the resource the person must be\n   authorized on for one or more of the roles. +:any+ may be given to\n   indicate a match if the person has one of the roles for any resource. If\n   not given, or set to +nil+, then the match will apply to a person that\n   has a matching role authorization for a nil resource.\n @option options [Symbol, nil, :any, <Symbol, nil>] :on alias for +:of+\n @option options [Symbol, String, Proc] :if code to evaluate at the end of the\n   match if it is still valid. If it returns false, the rule will not\n   match. If a proc if given, it will be passed the current subject and\n   binding. A method will be called without any arguments.\n @option options [Symbol, String, Proc] :unless code to evaluate at the end of\n   the match if it is still valid. If it returns true, the rule will not\n   match. If a proc if given, it will be passed the current subject and\n   binding. A method will be called without any arguments.\n\n @raise [PermitConfigurationError] if the rule options are invalid.\n Determine if the passed in person matches this rule.\n\n @param [permit_person] person the person to evaluate for authorization\n @param [Binding] context_binding the binding to use to locate the resource\n   and/or evaluate the if/unless conditions.\n @return [Boolean] true if the person matches the rule, otherwise\n   false.\n @raise [PermitEvaluationError] if there is a problem evaluating the rule.", "Return the first available dependency from the\n list of constant names.", "Configures the arguments for the command\n @param opts [OptionParser]", "Parses the command-line arguments and runs the executable\n @return [String] The short url or argument passed", "Logs an exception and then raises it.\n\n @see Base.log_and_raise\n\n @param [Exception] exception The exception class to raise.\n @param [String] message The message to display with the exception.\n @param [Integer] shift (2) How many places to shift the caller stack in\n   the log statement.", "Direct logging method.\n\n This method provides direct writing of data to the current log device.\n This is mainly used for pushing STDOUT and STDERR into the log file in\n ZTK::SSH and ZTK::Command, but could easily be used by other classes.\n\n The value returned in the block is passed down to the logger specified in\n the classes configuration.\n\n @param [Symbol] log_level This should be any one of [:debug, :info, :warn, :error, :fatal].\n @yield No value is passed to the block.\n @yieldreturn [String] The message to log.", "Load settings from the configuration file hash.\n\n @param  [Hash] config_file_hash <tt>Hash</tt> of settings loaded from\n                                 configuration file.", "Load settings from the command line hash. Load a setting only if it was\n passed.\n\n @param  [Hash] options <tt>Hash</tt> of settings passed on command line.", "Responsible for handling errors sent from the browser, parsing the data,\n and sending the email with the information about the error.", "Query the list of field for a report type\n @param [ReportDefinition::ReportTypes] a value of", "Delete a report definition\n\n @param[ReportDefinition, Number]", "Prints on stdout the list of report definition contained into account\n @param [bool] true if the list must be refreshed\n @return self", "Adds users to this collection only if the collection does not already\n include the specified users.  The users RightScale API href is used\n as the unique identifier for deduplication\n\n @param [Array<RightApi::ResourceDetail>] users An array of RightAPI::ResourceDetail for the resource type \"user\"", "Creates a new Subscriber socket.\n\n @note The default behaviour is to output and messages received to STDOUT.\n\n @param [:bind, :connect] mode (:connect) a mode for the socket.\n @param [Hash] options optional parameters.\n @option options [String] topic a topic to subscribe to.\n @see EZMQ::Socket EZMQ::Socket for optional parameters.\n\n @return [Publisher] a new instance of Publisher.\n\n Receive a message from the socket.\n\n @note This method blocks until a message arrives.\n\n @param [Hash] options optional parameters.\n @option options [lambda] decode how to decode the message.\n\n @yield [message, topic] passes the message body and topic to the block.\n @yieldparam [Object] message the message received (decoded).\n @yieldparam [String] topic the topic of the message.\n\n @return [Object] the message received (decoded).", "Renders a template.\n @param tmpl [String] file name or path to template, relative to /views in\n        project dir\n @example Rendering html erb file\n   render('index.html.erb')\n @todo Layouts.", "GET the JSON API\n @param [String] path\n @return [Hash] response body", "POST the JSON API\n @param [String] path\n @param [Hash] data\n @return [Hash] response body", "POST the non-JSON API\n @param [String] path\n @param [Hash] data\n @return [String] response body", "Generate tokens for a given text\n\n Example:\n\n   >> analyzer = FreelingClient::Analyzer.new\n   >> analyzer.token(:morfo, \"Este texto est\u00e1 en espa\u00f1ol.\")\n\n Arguments:\n   cmd: (Symbol)\n   text: (String)", "Find a workspace according to the given params.", "Instantiates an exception and fills in a response.\n\n klass    - the exception class\n response - the response object that caused the error", "Verify that the given checkbox is checked.\n\n @param [String] checkbox\n   Capybara locator for the checkbox\n @param [Hash] scope\n   Scoping keywords as understood by {#in_scope}\n\n @raise [Kelp::Unexpected]\n   If the given checkbox is not checked\n\n @since 0.1.2", "This parses email headers. Returns an hash.\n\n +hash['data']+ is the message.\n\n Keys are downcased, space becomes underscore, converted to symbols.\n\n     My key: true\n\n becomes:\n\n     {:my_key => true}", "Keys are downcased, space becomes underscore, converted to symbols.", "Returns the number of leading spaces, considering that\n a tab counts as `TabSize` spaces.", "This returns the position of the first real char in a list item\n\n For example:\n     '*Hello' # => 1\n     '* Hello' # => 2\n     ' * Hello' # => 3\n     ' *   Hello' # => 5\n     '1.Hello' # => 2\n     ' 1.  Hello' # => 5", "Strips initial and final hashes", "toglie al massimo n caratteri", "Dump humanization of last timeline entries\n\n @param options [Hash] Options hash\n @option options (see Activr::Timeline::Entry#humanize)\n @option options [Integer] :nb Number of timeline entries to dump (default: 100)\n @return [Array<String>] Array of humanized sentences", "Remove old timeline entries", "This method will fetch content related to content_item, and tagged to taxon. This is a\n temporary method that uses search to achieve this. This behaviour is to be moved into\n\u00a0the content store", "Format a player's record as it would appear in an SP text export file.", "Format a player's result as it would appear in an SP text export file.", "Finds baseline value of an object\n @param [Fixnum] baseline_type One of the valid Baseline Types defined\n @param [Object] obj The object for whom baseline value is to be found\n @param [Time] ts The timestamp at which baseline is to be found", "Does an aggregation of type for a timestamp\n @param [Fixnum] type The counter type for which aggregation\n   has to be done\n @param [Time] ts The time at which aggregation should happen", "Aggregates the baseline for a minute", "Stores the baseline for an enterprise, and type\n @param [String] enterprise_id The enterprise ID of enterprise\n @param [Fixnum] type The Counter type as baseline type\n @param [Time] ts The time stamp of storage\n @param [Hash{String => Float}] baseline A hash representing baseline", "Calculates the baseline from counters", "Calculates the baseline score from an array of scores\n @param [Array<Float>] counts The counts array\n @return [Float] The baseline score for counters", "Given the options for a locale_dating call, set the defaults for the naming convention to use.", "escape symbol-font strings", "A tag helper version for a FormBuilder class. Will create the select and the needed modal that contains the given\n form for the target model to create.\n\n A multiple select will generate a button to trigger the modal.\n\n @param [Symbol] method See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select.\n @param [Array] choices The list of choices for the select, shoudl be in [[val, display],...] format\n @param [Hash] options the options to create a message with.\n @option options [Boolean] :include_blank Include a blank option (Forced to <tt>true</tt> when <tt>choices.count</tt> == 0)\n @option options [String] :new_option_text Text to display as the <tt>option</tt> that will trigger the new modal (Default \"-- Add new --\", will be ignored if <tt>html_options[:multiple]</tt> is set to <tt>true</tt>)\n @option options [Symbol] :value_key The attribute of the model that will be used as the <tt>option</tt> value from the JSON return when a new record is created\n @option options [Symbol] :text_key The attribute of the model that will be used as the <tt>option</tt> display content from the JSON return when a new record is created\n @option options [Symbol] :new_key The JSON key that will contain the value of the record that was created with the modal\n @option options [String] :modal_title The title of the modal (Default to \"Add new <model.class.name>\")\n @option options [String] :partial The form partial for the modal body\n @param [Hash] html_options See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select.", "Notify checkd.in of a custom activity ocurring\n\n @param [Hash]  options\n @option options Integer :custom_activity_node_id - The ID of the custom activity node that has ocurred, available in checkd.in admin. Required.\n @option options Integer :user_id - The ID of the user that has performed the custom activity - either this or email is required.\n @option options String  :email - The email address of the user that has performed the custom activity - either this or user_id is required.", "Used internally\n List Domains. If domain name is passed return detailed information, otherwise return a list of all domains.", "Add a response to the list\n\n @param [Kanpachi::Response] response The response to add.\n @return [Hash<Kanpachi::Response>] All the added responses.\n @raise DuplicateResponse If a response is being duplicated.\n @api public", "Whack the draft data onto the real object.\n\n @return [Draftable] the draftable object populated with the draft attrs.", "Attach draft files to the real object.\n\n @return [Draftable] the draftable object where CarrierWave uploads\n   on the object have been replaced with their draft equivalents.", "Includes controller and action name as data attributes.\n\n @example\n  body_tag()  #=> <body data-action='index' data-controller='home'>\n\n  body_tag(id: 'my-id', class: 'my-class')  #=> <body class=\"my-class\" data-action=\"index\" data-controller=\"home\" id=\"my-id\">\n @param options [Hash] become attributes of the BODY tag\n @return [String]", "Searches the record for any errors and returns them\n\n @return [ActiveModel::Errors] the error object for the current record\n\n @raise [AttributeNotFound] when the attribute is not found in the record", "Returns the code needed to embed a KDPv3 player.\n\n @param [String] entry_id Kaltura entry_id\n @param [Hash] options the embed code options.\n @option options [String] :div_id ('kplayer') The div element that the flash object will be inserted into.\n @option options [Array] :size ([]) The [width,wight] of the player.\n @option options [Boolean] :use_url (false) flag to determine whether entry_id is an entry or a URL of a flash file.\n @option options [String] :player_conf_id (KalturaFu.config(:player_conf_id)) A UI Conf ID to override the player with.\n\n @return [String] returns a string representation of the html/javascript necessary to play a Kaltura entry.", "Creates a link_to tag that seeks to a certain time on a KDPv3 player.\n\n @param [String] content The text in the link tag.\n @param [Integer] seek_time The time in seconds to seek the player to.\n @param [Hash] options\n\n @option options [String] :div_id ('kplayer') The div of the KDP player.", "generic operator implementation", "Follow a link on the page.\n\n @example\n   follow \"Login\"\n   follow \"Contact Us\", :within => \"#footer\"\n\n @param [String] link\n   Capybara locator expression (id, name, or link text)\n @param [Hash] scope\n   Scoping keywords as understood by {#in_scope}", "Press a button on the page.\n\n @example\n   press \"Cancel\"\n   press \"Submit\", :within => \"#survey\"\n\n @param [String] button\n   Capybara locator expression (id, name, or button text)\n @param [Hash] scope\n   Scoping keywords as understood by {#in_scope}", "Click a link in a table row containing the given text.\n\n @example\n   click_link_in_row \"Edit\", \"Pinky\"\n\n @param [String] link\n   Content of the link to click\n @param [String] text\n   Other content that must be in the same row", "Verify that the current page matches the path of `page_name_or_path`. The\n cucumber-generated `path_to` function will be used, if it's defined, to\n translate human-readable names into URL paths. Otherwise, assume a raw,\n absolute path string.\n\n @example\n   should_be_on_page 'home page'\n   should_be_on_page '/admin/login'\n\n @param [String] page_name_or_path\n   Human-readable page name (mapped to a pathname by your `path_to` function),\n   or an absolute path beginning with `/`.\n\n @raise [Kelp::Unexpected]\n   If actual page path doesn't match the expected path\n\n @since 0.1.9", "Verify that the current page has the given query parameters.\n\n @param [Hash] params\n   Key => value parameters, as they would appear in the URL\n\n @raise [Kelp::Unexpected]\n   If actual query parameters don't match expected parameters\n\n @since 0.1.9", "Creates a new instance, which will compile\n the assets to the given +output_path+.\n Loop through and compile each available\n asset to the appropriate output path.", "Writes the asset to its destination, also\n writing a gzipped version if necessary.", "Gets the full output path for the given asset.\n If it's supposed to include a digest, it will return the\n digest_path.", "Creates a new RouteHandler wrapping a handler block.\n @param path_params [Hash] named parameters from paths similar to\n        /users/:id\n @param block [Proc] the actual route handler\n Invokes the handler as a normal Rack application.\n @param env [Hash] Rack environment\n @return [Array] Rack response array", "Generates a join table name from two provided table names.\n The names in the join table names end up in lexicographic order.\n\n   join_table_name(\"members\", \"clubs\")         # => \"clubs_members\"\n   join_table_name(\"members\", \"special_clubs\") # => \"members_special_clubs\"", "Returns an array with an element for each column containing the number of\n rows for that column", "model must be loaded after the connection is established", "Retrieve a comprehensive list of all the unique identifiers in Fedora and\n solrize each object's full-text and facets into the search index\n\n @example Suppress errors using :suppress_errors option\n   solrizer.solrize_objects( :suppress_errors=>true )", "Generate from templates in scaffold", "Hook to serve behavior to ActiveRecord-Descendants", "Defines a new private reader instance method for a context mate role, delegating it to the context object.", "rendering images with rails slider effects", "Configure the structure of Gricer's admin menu\n\n Default value see source\n @return [Array]", "Runs through the list of fields under this type and creates the appropriate objects", "check if the helper exist", "If auto explain is enabled, this method triggers EXPLAIN logging for the\n queries triggered by the block if it takes more than the threshold as a\n whole. That is, the threshold is not checked against each individual\n query, but against the duration of the entire block. This approach is\n convenient for relations.\n\n The available_queries_for_explain thread variable collects the queries\n to be explained. If the value is nil, it means queries are not being\n currently collected. A false value indicates collecting is turned\n off. Otherwise it is an array of queries.", "Silences automatic EXPLAIN logging for the duration of the block.\n\n This has high priority, no EXPLAINs will be run even if downwards\n the threshold is set to 0.\n\n As the name of the method suggests this only applies to automatic\n EXPLAINs, manual calls to +ActiveRecord::Relation#explain+ run.", "Make sure that the SPKI data we were passed is legit.", "Allocates a socket of type +type+ for sending and receiving data.\n\n To avoid rescuing exceptions, use the factory method #create for\n all socket creation.\n\n By default, this class uses XS::Message for manual\n memory management. For automatic garbage collection of received messages,\n it is possible to override the :receiver_class to use XS::ManagedMessage.\n\n @example Socket creation\n   sock = Socket.new(Context.new, XS::REQ, :receiver_class => XS::ManagedMessage)\n\n Advanced users may want to replace the receiver class with their\n own custom class. The custom class must conform to the same public API\n as XS::Message.\n\n Creation of a new Socket object can raise an exception. This occurs when the\n +context_ptr+ is null or when the allocation of the Crossroads socket within the\n context fails.\n\n @example\n   begin\n     socket = Socket.new(context.pointer, XS::REQ)\n   rescue ContextError => e\n     # error handling\n   end\n\n @param pointer\n @param [Constant] type\n   One of @XS::REQ@, @XS::REP@, @XS::PUB@, @XS::SUB@, @XS::PAIR@,\n          @XS::PULL@, @XS::PUSH@, @XS::XREQ@, @XS::REP@,\n          @XS::DEALER@ or @XS::ROUTER@\n @param [Hash] options\n\n @return [Socket] when successful\n @return nil when unsuccessful\n Set the queue options on this socket\n\n @param [Constant] name numeric values\n   One of @XS::AFFINITY@, @XS::RATE@, @XS::RECOVERY_IVL@,\n          @XS::LINGER@, @XS::RECONNECT_IVL@, @XS::BACKLOG@,\n          @XS::RECONNECT_IVL_MAX@, @XS::MAXMSGSIZE@, @XS::SNDHWM@,\n          @XS::RCVHWM@, @XS::MULTICAST_HOPS@, @XS::RCVTIMEO@,\n          @XS::SNDTIMEO@, @XS::IPV4ONLY@, @XS::KEEPALIVE@,\n          @XS::SUBSCRIBE@, @XS::UNSUBSCRIBE@, @XS::IDENTITY@,\n          @XS::SNDBUF@, @XS::RCVBUF@\n @param [Constant] name string values\n   One of @XS::IDENTITY@, @XS::SUBSCRIBE@ or @XS::UNSUBSCRIBE@\n @param value\n\n @return 0 when the operation completed successfully\n @return -1 when this operation fails\n\n With a -1 return code, the user must check XS.errno to determine the\n cause.\n\n @example\n   rc = socket.setsockopt(XS::LINGER, 1_000)\n   XS::Util.resultcode_ok?(rc) ? puts(\"succeeded\") : puts(\"failed\")", "Convenience method for checking on additional message parts.\n\n Equivalent to calling Socket#getsockopt with XS::RCVMORE.\n\n Warning: if the call to #getsockopt fails, this method will return\n false and swallow the error.\n\n @example\n   message_parts = []\n   message = Message.new\n   rc = socket.recvmsg(message)\n   if XS::Util.resultcode_ok?(rc)\n     message_parts << message\n     while more_parts?\n       message = Message.new\n       rc = socket.recvmsg(message)\n       message_parts.push(message) if resultcode_ok?(rc)\n     end\n   end\n\n @return true if more message parts\n @return false if not", "Send a sequence of strings as a multipart message out of the +parts+\n passed in for transmission. Every element of +parts+ should be\n a String.\n\n @param [Array] parts\n @param flag\n   One of @0 (default)@ and @XS::NonBlocking@\n\n @return 0 when the messages were successfully enqueued\n @return -1 under two conditions\n   1. A message could not be enqueued\n   2. When +flag+ is set with XS::NonBlocking and the socket returned EAGAIN.\n\n With a -1 return code, the user must check XS.errno to determine the\n cause.", "Sends a message. This will automatically close the +message+ for both successful\n and failed sends.\n\n @param message\n @param flag\n   One of @0 (default)@ and @XS::NonBlocking\n\n @return 0 when the message was successfully enqueued\n @return -1 under two conditions\n   1. The message could not be enqueued\n   2. When +flag+ is set with XS::NonBlocking and the socket returned EAGAIN.\n\n With a -1 return code, the user must check XS.errno to determine the\n cause.", "Receive a multipart message as a list of strings.\n\n @param [Array] list\n @param flag\n   One of @0 (default)@ and @XS::NonBlocking@. Any other flag will be\n   removed.\n\n @return 0 if successful\n @return -1 if unsuccessful", "Should only be used for XREQ, XREP, DEALER and ROUTER type sockets. Takes\n a +list+ for receiving the message body parts and a +routing_envelope+\n for receiving the message parts comprising the 0mq routing information.\n\n @param [Array] list\n @param routing_envelope\n @param flag\n   One of @0 (default)@ and @XS::NonBlocking@\n\n @return 0 if successful\n @return -1 if unsuccessful", "Calls to xs_getsockopt require us to pass in some pointers. We can cache and save those buffers\n for subsequent calls. This is a big perf win for calling RCVMORE which happens quite often.\n Cannot save the buffer for the IDENTITY.\n\n @param option_type\n @return cached number or string", "Get the options set on this socket.\n\n @param name\n   One of @XS::RCVMORE@, @XS::SNDHWM@, @XS::AFFINITY@, @XS::IDENTITY@,\n          @XS::RATE@, @XS::RECOVERY_IVL@, @XS::SNDBUF@,\n          @XS::RCVBUF@, @XS::FD@, @XS::EVENTS@, @XS::LINGER@,\n          @XS::RECONNECT_IVL@, @XS::BACKLOG@, XS::RECONNECT_IVL_MAX@,\n          @XS::RCVTIMEO@, @XS::SNDTIMEO@, @XS::IPV4ONLY@, @XS::TYPE@,\n          @XS::RCVHWM@, @XS::MAXMSGSIZE@, @XS::MULTICAST_HOPS@,\n          @XS::KEEPALIVE@\n @param array should be an empty array; a result of the proper type\n   (numeric, string, boolean) will be inserted into\n   the first position.\n\n @return 0 when the operation completed successfully\n @return -1 when this operation failed\n\n With a -1 return code, the user must check XS.errno to determine the\n cause.\n\n @example Retrieve send high water mark\n   array = []\n   rc = socket.getsockopt(XS::SNDHWM, array)\n   sndhwm = array.first if XS::Util.resultcode_ok?(rc)", "set a single role", "add a single role", "remove a single role", "V8 context with Handlerbars code compiled\n @yield [context] V8::Context compiled Handlerbars source code in V8 context", "Compile a Handlerbars template for client-side use with JST\n @param [String, File] template Handlerbars template file or text to compile\n @return [String] Handlerbars template compiled into Javascript and wrapped inside an anonymous function for JST", "Compile and evaluate a Handlerbars template for server-side rendering\n @param [String] template Handlerbars template text to render\n @param [Hash] vars controller instance variables passed to the template\n @return [String] HTML output of compiled Handlerbars template", "divide yaml file\n @param src_file [String]\n @param dst_dir  [String]\n @return [Array<String>] divided yaml filenames", "Disassociates every role from the playing object.", "The test suite calls this method directly\n to bypass the Listen gem for certain tests.", "Returns all the account's events from brownpapersticker", "This method get an event from brownpapersticker.\n The event should belong to the account.\n @param [String] envent_id this is id of the event I want to find", "Separate out initialization for testing purposes", "This will go away once we get the correct signals in the DB", "Render a given relative content path to Markdown.", "`sudo!` executes sudo command and provides password input.", "defines actions for each request in yaml file.", "Save the event to Mongo via mongo_handle", "Specialized logging.  Logs messages in the same format, except has the\n option to shift the caller_at position to exposed the proper calling\n method.\n\n Very useful in situations of class inheritence, for example, where you\n might have logging statements in a base class, which are inherited by\n another class.  When calling the base class method via the inherited class\n the log messages will indicate the base class as the caller.  While this\n is technically true it is not always what we want to see in the logs\n because it is ambigious and does not show us where the call truly\n originated from.", "Writes a log message if the current log level is at or below the supplied\n severity.\n\n @param [Constant] severity Log level severity.\n @param [String] message Optional message to prefix the log entry with.\n @param [String] progname Optional name of the program to prefix the log\n   entry with.\n @yieldreturn [String] The block should return the desired log message.", "Sets the log level.\n\n @param [String] level Log level to use.", "Pops an item from the list, optionally blocking to wait until the list is non-empty\n @param [Integer] timeout the amount of time to wait in seconds; if 0, waits indefinitely\n @return [nil, String] nil if the list was empty, otherwise the item", "Shifts an item from the list, optionally blocking to wait until the list is non-empty\n @param [Integer] timeout the amount of time to wait in seconds; if 0, waits indefinitely\n @return [nil, String] nil if the list was empty, otherwise the item", "Pops an element from this list and shifts it onto the given list.\n @param [Redstruct::List] list the list to shift the element onto\n @param [#to_i] timeout optional timeout to wait for in seconds\n @return [String] the element that was popped from the list and pushed onto the other", "Connects the socket to the given address.\n\n @note This method can be called as #bind, in which case it binds to the\n   specified address instead.\n\n @param [Symbol] transport (:tcp) transport for transport.\n @param [String] address ('127.0.0.1') address for endpoint.\n @note Binding to 'localhost' is not consistent on all platforms.\n   Prefer '127.0.0.1' instead.\n @param [Fixnum] port (5555) port for endpoint.\n @note port is ignored unless transport is one of :tcp, :pgm or :epgm\n\n @return [Boolean] was connection successful?", "Retrieves data from the queue.  If the queue is empty, the calling thread is\n suspended until data is pushed onto the queue.  If +non_block+ is true, the\n thread isn't suspended, and an exception is raised.", "Retrieves data from the queue and returns array of contents.\n If +num_to_pop+ are available in the queue then multiple elements are returned in array response\n If the queue is empty, the calling thread is\n suspended until data is pushed onto the queue.  If +non_block+ is true, the\n thread isn't suspended, and an exception is raised.", "Internal method to get an option.\n If value is callable without arguments\n it will be called and result will be returned.", "Method to set an option.\n If there is an option accessor defined then it will be used.\n In other cases +raw_set+ will be used.", "Checks if option is set.\n Works similar to set if value passed but sets only uninitialized options.", "Find page part by key or build new record", "Get movie poster address\n @return [String]", "Get movie title\n @return [String]", "Get Director Person class\n @return [Person]", "Setup stubbing for all endpoints", "This function cleans all old post parents without any child.", "This function returns an object with the list of posts with some filters.", "This function returns a single post searched by id or permalink.", "message is not used.", "Convert params to query string\n\n @param [Hash] params\n   API call arguments\n @return [String]", "Handle http requests\n @param [URI::HTTPS] uri\n   API uri\n @param [Object] request\n   request object\n @return [Net::HTTPResponse]", "Returns the next n events from the moment specified in the second\n optional argument.\n\n === Parameters\n\n [n = 10] how many coming events should be returned\n [start_time] only events hapenning after this time will be considered\n\n === Returns\n\n A list of hashes, sorted by event start time, each hash having\n two keys:\n\n [:time] start time of the event\n [:feed] feed describing the event", "Returns all events starting after the time specified by the first\n parameter and before the time specified by the second parameter,\n which accept regular Time objects.\n\n === Parameters\n\n [start_time] will return only events starting after this moment\n [end_time] will return only events starting before this moment\n\n === Returns\n\n A list of hashes, sorted by event start time, each hash having\n two keys:\n\n [:time] start time of the event\n [:feed] feed describing the event", "Check access to route and we expected the existing of current_user helper", "Begin fetching.\n Will run synchronous fetches first and async fetches afterwards.\n Updates progress when each module finishes its fetch.", "Array of instantiated fetch modules.", "Updates progress with a percentage calculated from +total+ and +done+.", "Generates a Kaltura ks and adds it to the KalturaFu client object.\n\n @return [String] a Kaltura KS.", "Creates a new instance of Attr to be used as a template for converting\n XML to objects and from objects to XML\n @param [Symbol,String] name Sets the accessor methods for this attr.\n   It is also used to guess defaults for :from and :as.\n   For example if it ends with '?' and :as isn't set\n   it will treat it as a boolean.\n @param [Hash] o the options for the new attr definition\n @option o [Symbol,String] :from (tag_proc.call(name))\n   Tells OxMlk what the name of the XML attribute is.\n   It defaults to name processed by the tag_proc.\n @option o [Symbol,String,Proc,Array<Symbol,String,Proc>] :as\n   Tells OxMlk how to translate the XML.\n   The argument is coerced into a Proc and applied to the string found in the XML attribute.\n   If an Array is passed each Proc is applied in order with the results\n   of the first being passed to the second and so on. If it isn't set\n   and name ends in '?' it processes it as if :bool was passed otherwise\n   it treats it as a string with no processing.\n   Includes the following named Procs: Integer, Float, String, Symbol and :bool.\n @option o [Proc] :tag_proc (proc {|x| x}) Proc used to guess :from.\n   The Proc is applied to name and the results used to find the XML attribute\n   if :from isn't set.\n @yield [String] Adds anothe Proc that is applied to the value.\n Finds @tag in data and applies procs.", "merge takes in a set of values and overwrites the previous values.\n mash does this in reverse.", "Walks the tree based on a url and returns the requested page\n Will return nil if the page does not exist", "Get a list of all won rewards for the authenticating client.\n\n @param [Hash]  options\n @option options Integer :campaign_id - Only return won rewards for this campaign.\n @option options Integer :user_id - Only return won rewards for this user.\n @option options Integer :promotion_id - Only return won rewards for this promotion.\n @option options Integer :limit - The maximum number of records to return.", "Check or Generate client password", "Perform Kong Operations after creating client", "pass thru namespace methods to the proxied NAMESPACE handler", "for everything else, send to the proxied NAMESPACE handler\n at this point it really just enables dynamic options writers", "Add or merge environment configuration\n\n Params:\n - env {Symbol} Environment to set (optional, default: :default)\n\n Yields: block with key-value definitions\n\n Returns: {Sequoia::Builder} builder instance", "Build configuration object\n\n Params:\n - env {Symbol} Environment to build\n\n Returns: {Sequoia::Entity} builded configuration object", "The absolute name of the source file\n initialise the \"page object\", which is the object that \"owns\" the defined instance variables,\n and the object in whose context the Ruby components are evaluated\n Three special instance variable values are set - @fileName, @baseDir, @baseFileName,\n so that they can be accessed, if necessary, by Ruby code in the Ruby code components.\n (if this is called a second time, it overrides whatever was set the first time)\n Notes on special instance variables -\n  @fileName and @baseDir are the absolute paths of the source file and it's containing directory.\n  They would be used in Ruby code that looked for other files with names or locations relative to these two.\n  They would generally not be expected to appear in the output content.\n  @baseFileName is the name of the file without any directory path components. In some cases it might be\n  used within output content.", "Add a newly started page component to this page\n Also process the start comment, unless it was a static HTML component, in which case there is\n not start comment.", "Write the output of the page components to the output file (optionally checking that\n there are no differences between the new output and the existing output.", "Read in and parse lines from source file", "Regenerate from the source file into the output file", "Execute the Ruby components which consist of Ruby code to be evaluated in the context of the page object", "Method to render an ERB template file in the context of this object", "extract track data from gpx data\n\n it's not necessary to call this directly", "infer a location from track data and a time\n\n @param [Time,String,Fixnum] time\n @return [Hash]\n @see Track#at", "Removes all permissions for the user in the specified rightscale account using the supplied client\n\n @param [String] account_href The RightScale API href of the account\n @param [RightApi::Client] client An active RightApi::Client instance for the account referenced in account_href\n @param [Hash] options Optional parameters\n @option options [Bool] :dry_run If true, no API calls will be made, but the return value will contain the actions which would have been taken\n\n @raise [RightApi::ApiError] If an unrecoverable API error has occurred.\n\n @return [Hash] A hash where the keys are the permission hrefs destroyed, and the keys are the role_title of those permissions", "Removes and adds permissions as appropriate so that the users current permissions reflect\n the desired set passed in as \"permissions\"\n\n @param [Array<String>] permissions The list of desired permissions for the user in the specified account\n @param [String] account_href The RightScale API href of the account\n @param [RightApi::Client] client An active RightApi::Client instance for the account referenced in account_href\n @param [Hash] options Optional parameters\n @option options [Bool] :dry_run If true, no API calls will be made, but the return value will contain the actions which would have been taken\n\n @raise [RightApi::ApiError] If an unrecoverable API error has occurred.\n\n @return [Hash,Hash] A tuple where two hashes are returned.  The keys of the hashes are the href of the permission, and the values are the role_title of the permission.  The first hash is the permissions removed, and the second hash is the permissions added", "Return a hash after verifying everything was set correctly", "runs all handlers, calls the remover method if a handler should be removed", "update all of the parameter-related values in the current request's environment", "make sure the request came from a whitelisted ip, or uses a publically accessible request method", "updates the options", "adds csrf info to non-GET requests of whitelisted IPs", "Call methods on the object that's being presented and create a flat\n hash for these mofos.", "Update the attrs on zie model.", "Proxy the writer to zie object.", "Return a hash of rows to be inserted. The key is the table, the value is\n a list of rows to insert to that table.", "Use the given module", "Requires all files that match the glob.", "This method validates if the user object is valid. A user is valid if\n username and password exist OR oauth integration exists.", "This method will generate a reset token that lasts for an hour.", "Grab the scripts we plan to excersize", "This is really just a PHP server check. relocate?", "Checks if the record has a `guise` record identified by on the specified\n `value`.\n\n @param [String, Class, Symbol] value `guise` to check\n @return [true, false]", "Create a class instance for a rule entry", "Tries to find favicon urls from the html content of query_url", "Follow redirects from the query url to get to the last url", "Create a context for route nesting.\n\n   @param path [String, Regexp, Matcher] any path specification which can\n          be consumed by {Matcher.compile}\n   @param block the route handler\n   @yield to the given block\n\n @example A simple context\n   context '/foo' do\n     get '/bar' do\n     end\n   end", "Tries to match against a Rack environment.\n @param env [Hash] Rack environment\n @return [Route] matching route. Can be nil if no match found.", "Insert a new Timeline Item in the user's glass.\n\n @param [Google::APIClient::API] client\n   Authorized client instance.\n @return Array[Google::APIClient::Schema::Mirror::V1::TimelineItem]\n   Timeline item instance if successful, nil otherwise.", "Based on the ATTRS the args are returned that are included in the ATTRS.\n args with nil values are omitted", "Export a forum\n @accessibility: public key, secret key\n @methods: POST\n @format: json, jsonp\n @authenticated: true\n @limited: false\n @param forum [String] Forum short name (aka forum id).\n @return [Hashie::Rash] Export infos\n @param options [Hash] A customizable set of options.\n @option options [String] :format. Defaults to \"xml\". Choices: xml, xml-old\n @example Export forum \"the88\"\n   Disqussion::Client.exports.exportForum(\"the88\")\n @see: http://disqus.com/api/3.0/exports/exportForum.json", "Updates a single attribute of an object, without calling save.\n\n * Validation is skipped.\n * Callbacks are skipped.\n * updated_at/updated_on column is not updated if that column is available.\n\n Raises an +ActiveRecordError+ when called on new objects, or when the +name+\n attribute is marked as readonly.", "Return absolute path to Markdown file on this machine.", "Sets the default action to update a resource. If the resource is\n singular, updates the parent's associated resource. Otherwise, updates the\n resource directly.", "Deserialize the response to the given return type.\n\n @param [Response] response HTTP response\n @param [String] return_type some examples: \"User\", \"Array[User]\", \"Hash[String,Integer]\"", "Lists all sessions that belong to the specified or authenticated user.", "This action is essentially the login action. Note that get_user is not\n triggered for this action because we will look at username first. That\n would be the \"normal\" way to login. The alternative would be with the\n token based authentication. If the latter doesn't make sense, just use\n the username and password approach.\n\n A ApplicationController::UNAUTHORIZED_ERROR is thrown if user is not\n verified.", "Get the specified or current session.\n\n A Repia::Errors::NotFound is raised if the session does not\n exist (or deleted due to expiration).\n\n A ApplicationController::UNAUTHORIZED_ERROR is raised if the\n authenticated user does not have authorization for the specified\n session.", "Declares an enumerated attribute called +enumeration+ consisting of\n the symbols defined in +mapping+.\n\n When the database representation of the attribute is a string, +mapping+\n can be an array of symbols. The string representation of the symbol\n will be stored in the databased.  E.g.:\n\n   has_enumeration :color, [:red, :green, :blue]\n\n When the database representation of the attribute is not a string, or\n if its values do not match up with the string versions of its symbols,\n an hash mapping symbols to their underlying values may be used:\n\n   has_enumeration :color, :red => 1, :green => 2, :blue => 3\n\n By default, has_enumeration assumes that the column in the database\n has the same name as the enumeration.  If this is not the case, the\n column can be specified with the :attribute option:\n\n   has_enumeration :color, [:red, :green, :blue], :attribute => :hue", "helper for recursion into descendents", "Execute requests. By default, will block until complete and return results.\n\n @param [Boolean] async      If true, will not wait for requests to finish.\n                             (Default=false)\n\n @param [Block] block        If passed, responses will be passed into the callback\n                             instead of being returned directly\n\n @yield [Request, String]    Passes to the block the request and the response body\n\n @return [Hash<Key, String>] Hash of responses, if no block given. Returns true otherwise", "Create ordered array from hash of results", "Return an XPath for any table row containing all strings in `texts`,\n within the current context.", "if the response.content_type has not been set (if it has, then responthere are responses for the current action, then respond_to them\n\n we rescue the case where there were no responses, so that the default_render\n action will be performed", "load divided yaml files\n @param src_dir [String] divided yaml dir\n @return [Hash] merged yaml hash", "Provide the locale which is currently in use with the object or the current global locale.\n If the default is in use, always return nil.", "Provide a translation object based on the parent and the translation_locale\n current value.", "Override the default mass assignment method so that the locale variable is always\n given preference.", "Run validations on the associated parent resources\n\n @api semipublic", "Run validations on the associated child resources\n\n @api semipublic", "Handle all other Hash methods", "Make sure the key is valid", "checks if requirements are met from the requires params\n creates an instance of the interaction\n calls run on the instance", "runs interaction raises if any error or returns the interaction result", "Checks the given option-parameters for incompatibilities and registers a\n   new option.", "Returns an option registered under `name`.", "Sets a base_uri and default_params for requests.\n @raise [Error::MissingCredentials] if endpoint not set.", "Returns the closest matching word in the dictionary", "Returns the number of matching bigrams between the two sets of bigrams", "Returns a value from 0 to 1 for how likely these two words are to be a\n match", "For each word, adjust it's score by usage\n\n v = s * (1 - a) + u * a\n Where v is the new value\n a is @alpha\n s is the bigram score (0..1)\n u is the usage score (0..1)", "Receives the rack environment in case of a failure and renders a\n response based on the interactiveness of the request and the\n nature of the configured modes.\n\n @param [Hash] env a rack environment\n\n @return [Array] a rack response", "Shuffles the playlist by selecting randomly among the tracks as\n grouped by the given field\n\n shuffle_by is intended to change between different\n artists/albums/genres more frequently than if all tracks were\n shuffled based on a uniform distribution. In particular, it works\n well at preventing one very large group of songs (like A. R.\n Rahman's full discography) from dominating your playlist, but\n leaves many such entries at the end of the playlist.", "returns a hash of the passed in fields\n with the first-found values for the fields", "Checks the scope of the `Change` and the change out if the scope does not match.", "get all vms in all datacenters", "does this artist represents various artists?\n@return [Boolean]", "low level Callback method used for commands", "low level Callback used for running commands", "low level Timer callback", "low level buffer input callback", "low level bar build callback", "low level info callback", "low level print callback", "low level callback for signal hooks", "low level config callback", "low level process callback", "low level modifier hook callback", "Initializes the connection to Basecamp using httparty.\n\n @param basecamp_id [String] the Basecamp company ID\n @param authorization [Hash] authorization hash consisting of a username and password combination (:username, :password) or an access_token (:access_token)\n @param user_agent [String] the user-agent string to include in header of requests\n Sets the authorization information.\n Need to\n\n @param authorization [Hash] authorization hash consisting of a username and password combination (:username, :password) or an access_token (:access_token)", "Removes all users from the UserList that don't share channels with the\n Thaum.", "Convert attributes array back to attributes lines representation to be put into file", "Update attribudes array to the current database state", "Convert attributes lines into meaniningful array", "default value could be a multiple lines string, which would ruin annotations,\n so we truncate it and display inspect of that string", "Human readable description of given column type", "Run application.\n\n @example run the application\n   args = Bitsa::CLI.new\n   args.parse(ARGV)\n   app = Bitsa::BitsaApp.new\n   app.run(args.global_opts, args.cmd, args.search_data)\n\n @param global_opts [Hash] Application arguments\n @param cmd [String] The command requested.\n @param search_data [String] Data to search for from cmd line.\n\n @return [nil] ignored", "Load settings, combining arguments from cmd lien and the settings file.\n @param global_opts [Hash] Application arguments\n @return [Settings] Object representing the settings for this run of the\n                    app.", "Search the cache for the requested search_data and write the results to\n std output.\n @param cache [ContactsCache] Cache of contacts to be searched.\n @param search_data [String] Data to search cache for.", "Where to look for HTML and CSS assets.\n\n This is currently hardcoded as `(aker gem root)/assets/aker/form`.\n\n @return [String] a directory path", "Provides the HTML for the login form.\n\n This method expects to find a `login.html.erb` ERB template in\n {#asset_root}.  The ERB template is evaluated in an environment where\n a local variable named `script_name` is bound to the value of the\n `SCRIPT_NAME` Rack environment variable, which is useful for CSS and\n form action URL generation.\n\n @param env [Rack environment] a Rack environment\n @param [Hash] options rendering options\n @option options [Boolean] :login_failed If true, will render a failure message\n @option options [Boolean] :logged_out If true, will render a logout notification\n @option options [String] :username Text for the username field\n @option options [String] :url A URL to redirect to upon successful login\n @return [String] HTML data", "Test whether this set of results passed or not\n @return true if tests were executed and passed, nil if no tests were\n   executed, false if tests were exectued and there were failures", "gets BASIC auth info", "Parse YAML job configuration.\n\n @param [String] jobfile the path of the job configuration file.\n\n @return [Hash]", "Schedule the jobs to be executed in the given interval.\n\n This method will block and keep running until it gets interrupted.\n\n @param [Array] jobs the list of jobs to be scheduled.\n\n @return [nil]", "Add a resource to the list\n\n @param [Kanpachi::Resource] The resource to add.\n @return [Hash<Kanpachi::Resource>] All the added resources.\n @raise DuplicateResource If a resource is being duplicated.\n @api public", "Returns a resource based on its name\n\n @param [String] name The name of the resource you are looking for.\n @raise [UnknownResource] if a resource with the passed name isn't found.\n @return [Kanpachi::Resource] The found resource.\n\n @api public", "Return true if the certificate is signed by a CA certificate in the\n store. If the certificate can be trusted, it's added to the store so\n it can be used to trust other certs.", "Return the trusted root CA certificates installed in the @cert_directory. These\n certificates are used to start the trust chain needed to validate certs\n we receive from clients and servers.", "Returns the URL of an Image or the URL of a version if a string or symbol is passed", "Use for sort_if_enabled which requires the attribute name", "Use this method if you have a taxonomy code and need to lookup the\n information about that code", "Add a error to the list\n\n @param [Kanpachi::Error] error The error to add.\n @return [Hash<Kanpachi::Error>] All the added errors.\n @raise DuplicateError If a error is being duplicated.\n @api public", "Returns a set of drawn numbers", "Returns the basket with numbers", "Get a list of all activities for the authenticating client.\n\n @param [Hash]  options\n @option options Integer :campaign_id - Only return won rewards for this campaign.\n @option options String  :classification - Only return activities for users in this classification.\n @option options Integer :user_id - Only return won rewards for this user.\n @option options Integer :since - Only fetch updates since this time (UNIX timestamp)\n @option options Integer :limit - The maximum number of records to return.", "Initialize the notification.\n\n @param params [Hash] The request parameters from Digistore24.\n @return [Notification]\n Calculate SHA512 signature for payload.\n\n @return [String] The signature.", "process the given particle then forward it to user code\n\n @param [Particle] p the Particle to be processed", "Tokenizes the source of the block as determined by the `method_source` gem\n and determines the beginning and end of the block.\n\n In both cases the entire line is checked to ensure there's no unexpected\n ambiguity as to the start or end of the block. See the test file for this\n class for examples of ambiguous situations.\n\n @param [Proc] block The proc for which the starting offset of its source\n code should be determined.\n @param [String] source The source code of the provided block.\n @raise [AmbiguousSourceError] Raised when the source of the block cannot\n   be determined unambiguously.\n @return [Array<Integer>] The start and end offsets of the block's source\n   code as 2-element Array.", "Use the undefined method as a column", "Meta functions \n Return the correct method used to transform the column value the correct Ruby class", "Get all default values", "Get a list of point account entries.\n\n @param [Hash]  options\n @option options Integer :user_id - Return entries only for this user\n @option options Integer :campaign_id - Return entries only for this campaign\n @option options Integer :point_account_id - Return entries only for this point account.\n @option options Integer :limit - The maximum number of records to return.", "Runs the process callback. If it fails with an exception, it will send\n the exception to the error callback.", "Retrieves list of supported QR-Code type names.\n\n @return [Array<(QRCodeCollection, Fixnum, Hash)>]\n QRCodeCollection data, response status code and response headers", "Verify the Document.\n\n @param request PostVerificationCollectionRequest\n @return [Array<(VerifiedDocumentResponse, Fixnum, Hash)>]\n VerifiedDocumentResponse data, response status code and response headers", "Sets description of node.", "Sets addition date.", "Parses an array of tweets\n\n Returns a dict of things", "Sends the request and returns the response with the body parsed from JSON.\n @return [Net::HTTPResponse] if the request succeeds.\n @raise [Fb::HTTPError] if the request fails.", "Read a field or bit from its bit index or name\n\n @param [Symbol, Integer] name either the name of the bit (a key in field_list)\n   or a integer bit position\n @param [BitField optional] field a specific BitField to read from.\n   default: return value of #field\n\n @example Read bit values\n   # The struct is just an example, normally you would define a new class\n   Example = Struct.new('Example', :flags)\n   exo = Example.new(9)\n   bits = Bits.new(exo, {:is_odd => 0, :amount => [1, 2, 3], :is_cool => 4})\n   bits.read(:is_odd) #=> 1\n   bits.read(:amount) #=> 4\n   bits.read(:is_cool) #=> 0\n   bits.read(:amount, BitField.new(78)) #=> 7\n   # Bonus: aliased as []\n   bits[:is_odd] #=> 1\n\n @return [Integer] a value of the bit (0 or 1) or bits (number from 0 to\n   (2**bit_length) - 1) or nil if the field name is not in the list", "Write a field or bit from its field name or index\n\n Note: only the total bits of the field is used from the given value, so\n any additional bits are ignored. eg: writing a field with one bit as value\n of 4 will set the bit to 0, writing 5 sets it to 1.\n\n @param [Symbol, Integer, Array<Integer>] name a field name, or bit position,\n   or array of bit positions\n @param [Integer, Array<Integer>] target_value the target value for the field\n   (note: technically, this can be anything that responds to :[](index), but\n   usage in that type of context is discouraged without adapter support)\n\n @example Write values to bit fields\n   # The struct is just an example, normally you would define a new class\n   Example = Struct.new('Example', :flags)\n   exo = Example.new(0)\n   bits = Bits.new(exo, {:is_odd => 0, :amount => [1, 2, 3], :is_cool => 4})\n   bits.write(:is_odd, 1) #=> 1\n   bits.write(:amount, 5) #=> 11\n   exo.flags #=> 11\n   # Bonus, aliased as :[]=, but note in this mode, the return value is same as given value\n   bits[:is_cool] = 1 #=> 1\n   exo.flags #=> 27\n\n @return the return value of the updater Proc, usually is equal to the final\n   master value (with all the bits) after writing this bit", "Returns a hash representing the shooting.\n @return [Hash{String => Object}]", "prune away nodes that don't meet the configured score threshold", "Returns true if self.headers == other.headers and self.string == other.string.\n Modifies the headers in the set, using the given _hash_, which has the form\n\n     { some_header: { raw: a, key: b }, another_header: ..., ... }\n\n Change the header with key :some_header such that its new raw name is _a_ and its new key name\n is _b_. Returns a HeaderSet object containing the changed Header objects.", "Dynamically write value", "Add a +Directory+ named +name+ to this entity's list of children. The\n +name+ may simply be the name of the directory, or may be a path to the\n directory.\n\n In the case of the latter, +dir+ will create the +Directory+ tree\n specified by the path. The block parameter yielded in this case will be\n the innermost directory.\n\n @example\n   archive = Directory.new\n   archive.dir('app') do |app|\n     app.name == 'app'\n     app.path == './app'\n   end\n\n @example\n   archive.dir('app/controllers/concerns') do |concerns|\n     concerns.name == 'concerns'\n     concerns.path == './app/controllers/concerns'\n   end\n\n @param name [String] the directory name\n @param mode [Fixnum] the directory mode\n\n @yieldparam directory [AndFeathers::Directory] the newly-created\n   +Directory+", "Add a +File+ named +name+ to this entity's list of children. The +name+\n may simply be the name of the file or may be a path to the file.\n\n In the case of the latter, +file+ will create the +Directory+ tree\n which contains the +File+ specified by the path.\n\n Either way, the +File+'s contents will be set to the result of the\n given block, or to a blank string if no block is given\n\n @example\n   archive = Directory.new\n   archive.file('README') do\n     \"Cool\"\n   end\n\n @example\n   archive = Directory.new\n   archive.file('app/models/user.rb') do\n     \"class User < ActiveRecord::Base\\nend\"\n   end\n\n @param name [String] the file name\n @param mode [Fixnum] the file mode\n\n @yieldreturn [String] the file contents", "Generates xml suitable for an XML POST request to Tropo\n\n Example:\n   tropo_message = Tropo::Message.new\n   tropo_message.to = \"44122782474\"\n   tropo_message.text = \"Hi John, how r u today?\"\n   tropo_message.token = \"1234512345\"\n\n   tropo_message.request_xml # =>\n   # <sessions>\n   #   <token>1234512345</token>\n   #   <var name=\"to\" value=\"44122782474\"/>\n   #   <var name=\"text\" value=\"Hi+John%2C+how+r+u+today%3F\"/>\n   # </sessions>\"", "Project the current state of the object to a hash of attributes that can\n be used to restore the attribute object at a later time.\n\n @param [Array, Regex] only include matching attributes\n @param [Array, Regex] except matching attributes\n @return [Hash] of attributes", "compact all attribute QNames to Strings", "returns the namespace uri for a prefix, if declared in the stack", "figure out which explicit namespaces need declaring\n\n +ns_stack+ is the stack of namespace bindings\n +ns_explicit+ is the explicit refs for a element", "produce a Hash of namespace declaration attributes with exploded\n QNames, from\n a Hash of namespace prefix bindings", "produces a Hash of compact namespace attributes from a\n Hash of namespace bindings", "merges two sets of namespace bindings, raising error on clash", "Creates a process to run a command. Handles connecting pipes to stardard\n streams, launching the process and returning a pid for it.\n @return [pid, host_stdout, host_stderr] the process id and streams\n   associated with the child process", "Run the command, wait for termination, and collect the results.\n Returns an instance of CommandRunResult that contains the output\n and exit code of the command.", "Completely replace the running process with a command. Good for setting\n up a command and then running it, without worrying about what happens\n after that. Uses `exec` under the hood.\n @macro normalized\n @example Using replace_us\n   # The last thing we'll ever do:\n   shell.run_as_replacement('echo', \"Everything is okay\")\n   # don't worry, we never get here.\n   shell.run(\"sudo\", \"shutdown -h now\")", "Run the command in the background.  The command can survive the caller.\n Works, for instance, to kick off some long running processes that we\n don't care about. Note that this isn't quite full daemonization - we\n don't close the streams of the other process, or scrub its environment or\n anything.\n @macro normalized", "Checks if this holder can perform some action on an object by checking the Holder's policies\n @param action [String] What the user is trying to do to obj\n @param obj [Object] The receiver of the action\n @return [Boolean] Whether or not holder can action to object. We define a full abstainment as a failure to perform the action.", "Returns the sections that this section references.\n If 'recursive = true' is given, searches recursively for sections referenced by the referenced sections.\n Otherwise, simply returns the sections that are referenced by this section.", "Renders this section, i.e. returns the HTML for this section.", "Extracts options and sets all the parameters.\n\n\n Builds a new value for the option.\n It automatically applies transformations and filters and validates the\n resulting value, raising an exception if the value is not valid.", "Looks through the parameters and returns the non-nil values as a hash", "Returns the block if nothing else if given and blocks are allowed to be\n   values.", "Reverses the auto-cast to Array that is applied at `new_value`.", "Applies a transformation to the given value.\n\n @param [Object] value\n   The new value to be transformed\n\n If a `transform` was set up for the given option, it is used\n as `to_proc` target when iterating over the value.\n The value is always treated as a collection during this phase.", "Takes in a locale code and returns the string for that language", "Core parsing method for non-streams\n\n @note\n   If a block is given, the extracted statements will be yielded into\n   the block and inserted into the model depending on the output\n   of the block (if true, the statement will be added,\n   if false, the statement will not be added).\n\n @param [String, URI] content\n   - Can be a String,\n     causing the statements to be extracted\n     directly from it, or\n   - URI\n     causing the content to be first pulled\n     from the specified URI (or a local file,\n     if URI schema == \"file:\")\n @param [Hash] options\n @option options [String] :format name of the parser to use,\n @option options [String] :mime_type MIME type of the syntax, if applicable,\n @option options [String, URI] :type_uri URI of syntax, if applicable,\n @option options [String, URI] :base_uri base URI,\n   to be applied to the nodes with relative URIs.\n @yieldparam [Statement]\n @raise [RedlandError] if it fails to create a parser or stream\n @return [Model]", "Determine the model to use depending on the request. If a sub-resource\n was requested, use the parent model to get the association. Otherwise, use\n all the resource's model's records.", "Determine the default action to use depending on the request. If the\n `page` param was passed and the action allows paging, page the results.\n Otherwise, set the request body to all records.", "evaluate the equation in the passed context", "Returns all the docs in the current database.\n\n   c = Rufus::Jig::Couch.new('http://127.0.0.1:5984, 'my_db')\n\n   docs = c.all\n   docs = c.all(:include_docs => false)\n   docs = c.all(:include_design_docs => false)\n\n   docs = c.all(:skip => 10, :limit => 10)\n\n It understands (passes) all the options for CouchDB view API :\n\n   http://wiki.apache.org/couchdb/HTTP_view_API#Querying_Options", "Attaches a file to a couch document.\n\n   couch.attach(\n     doc['_id'], doc['_rev'], 'my_picture', data,\n     :content_type => 'image/jpeg')\n\n or\n\n   couch.attach(\n     doc, 'my_picture', data,\n     :content_type => 'image/jpeg')", "Detaches a file from a couch document.\n\n   couch.detach(doc['_id'], doc['_rev'], 'my_picture')\n\n or\n\n   couch.detach(doc, 'my_picture')", "Watches the database for changes.\n\n   db.on_change do |doc_id, deleted|\n     puts \"doc #{doc_id} has been #{deleted ? 'deleted' : 'changed'}\"\n   end\n\n   db.on_change do |doc_id, deleted, doc|\n     puts \"doc #{doc_id} has been #{deleted ? 'deleted' : 'changed'}\"\n     p doc\n   end\n\n This is a blocking method. One might want to wrap it inside of a Thread.\n\n Note : doc inclusion (third parameter to the block) only works with\n CouchDB >= 0.11.", "A development method. Removes all the design documents in this couch\n database.\n\n Used in tests setup or teardown, when views are subject to frequent\n changes (rufus-doric and co).", "Queries a view.\n\n   res = couch.query('_design/my_test/_view/my_view')\n     \n     #   [ {\"id\"=>\"c3\", \"key\"=>\"capuccino\", \"value\"=>nil},\n     #     {\"id\"=>\"c0\", \"key\"=>\"espresso\", \"value\"=>nil},\n     #     {\"id\"=>\"c2\", \"key\"=>\"macchiato\", \"value\"=>nil},\n     #     {\"id\"=>\"c4\", \"key\"=>\"macchiato\", \"value\"=>nil},\n     #     {\"id\"=>\"c1\", \"key\"=>\"ristretto\", \"value\"=>nil} ]\n\n   # or simply :\n\n   res = couch.query('my_test:my_view')\n\n Accepts the usual couch parameters : limit, skip, descending, keys,\n startkey, endkey, ...", "A shortcut for\n\n   query(path, :include_docs => true).collect { |row| row['doc'] }", "sends appreciation to another User\n raises BalanceError if insufficient funds exist", "define the parent ns using the given block", "Calculate the extension's ID from the key\n Core concepts from supercollider.dk", "Generate a key with OpenSSL and write it to the key path", "pre-order traversal of the Nokogiri Nodes, calling methods on\n the visitor with each Node", "Creates the configuration file\n\n @param options [Hash] fields from fenton command line\n @return [Object] true or false\n @return [String] message on success or failure", "Generates the configuration file content\n\n @param options [Hash] fields from fenton command line\n @return [String] true or false", "Add a bang to an error message", "format some data into a table to then be displayed to the user", "Clear the cache of performed strategies so far. Warden runs each\n strategy just once during the request lifecycle. You can clear the\n strategies cache if you want to allow a strategy to be run more than\n once.\n\n This method has the same API as authenticate, allowing you to clear\n specific strategies for given scope:\n\n Parameters:\n   args - a list of symbols (labels) that name the strategies to attempt\n   opts - an options hash that contains the :scope of the user to check\n\n Example:\n   # Clear all strategies for the configured default_scope\n   env['warden'].clear_strategies_cache!\n\n   # Clear all strategies for the :admin scope\n   env['warden'].clear_strategies_cache!(:scope => :admin)\n\n   # Clear password strategy for the :admin scope\n   env['warden'].clear_strategies_cache!(:password, :scope => :admin)\n\n :api: public", "Manually set the user into the session and auth proxy\n\n Parameters:\n   user - An object that has been setup to serialize into and out of the session.\n   opts - An options hash.  Use the :scope option to set the scope of the user, set the :store option to false to skip serializing into the session, set the :run_callbacks to false to skip running the callbacks (the default is true).\n\n :api: public", "Do not use the Setting class to load the profile because it can cause an\n infinite loop then if we decide to use Lono.env from within settings class.", "Specifies keys that must exist", "Datatype URI for the literal node, or nil", "Value of the literal node as a Ruby object instance.\n\n Returns an instance of URI for resource nodes,\n \"blank identifier\" for blank nodes.\n\n @return [URI, Any]", "Remove a record from the underlying DAO whose slug matches the passed-in\n identifier.\n @param identifier [String] [Slug](http://en.wikipedia.org/wiki/Semantic_URL#Slug)\n                   for record to be deleted.\n @return [Repository::Support::StoreResult] An object containing\n     information about the success or failure of an action.\n @since 0.0.5", "Renders the \"x - y of z\" text", "This appears to be from more \"reputable\" sources?", "List links that match the attributes", "Merge links based on the provided attribue to one link by combining the\n values. The first link will be updated and the obsolete links are deleted\n and will be returned", "Groups the links on the provided attribute. If no links array is provided\n the links from self are used", "Create multiple Links based on the attribute provided. The specified\n spearator will splitt the attribute value in distinct values and for each\n different value a Link will be created", "List all attributes of the links", "Run in endless loop", "api detail info, include request url & arguments\n @param api_method, string, default output information of all api\n @return an array of match api info string, format: api_name, REQUEST url, arguments symbol array", "Custom counter cache.  Does not include the first post of a discussion.", "Returns the requested attribute of the user if it exists, or post's attribute", "Writes the file.", "Checks the current template and the common fields for any field with the same name", "Finds all fields with the same name and ensures they know there is another field with the same name\n thus allowing us to have them a prefix that lets us identify them in a query string", "Routes from routes.rb", "Get your BCA Bisnis account statement for a period up to 31 days.", "Get your BCA Bisnis account balance information", "raise ResponseError exception on error", "if geocoding fails, then look for lat,lng string in address", "Finds a database object by name. Objects are tables, views, or\n sequences.", "Deletes all keys created by the factory. By defaults will iterate at most of 500 million keys\n @param [Hash] options accepts the options as given in each\n @see Redstruct::Factory#each", "Creates using this factory's connection\n @see Redstruct::Script#new\n @return [Redstruct::Script] script sharing the factory connection", "Performs cropping with focuspoint", "Print a table with a title and a top border of matching width.", "capture table in order to determine its width", "Returns this +Archive+ as a package of the given +package_type+\n\n @example\n   require 'and_feathers/gzipped_tarball'\n\n   format = AndFeathers::GzippedTarball\n   AndFeathers::Archive.new('test', 16877).to_io(format)\n\n @see https://github.com/bcobb/and_feathers-gzipped_tarball\n @see https://github.com/bcobb/and_feathers-zip\n\n @param package_type [.open,#add_file,#add_directory]\n\n @return [StringIO]", "Escapes string to readable Czech HTML entities.\n\n @param input [String] Text input.\n @return [String] Text with HTML entities.", "Initializes the client\n\n Example:\n\n   >> client = FreelingClient::Client.new\n\n Arguments:\n   server: (String)\n   port: (String)\n   timeout: (Integer)\n\n Calls the server with a given text\n\n Example:\n\n   >> client = FreelingClient::Client.new\n   >> client.call(\"Este texto est\u00e1 en espa\u00f1ol.\")\n\n Arguments:\n   text: (String)", "Whether an action is defined on a resource on the version.\n @param resource [Symbol] The resource's name\n @param action [Symbol] The action's name\n @return [Boolean]", "Get a new coverter\n Given a marc4j record, return a rubymarc record", "Given a rubymarc record, return a marc4j record", "Try to get the specified jarfile, or the bundled one if nothing is specified", "Create a temporary directory.\n\n @param option [Hash]\n @option option [Integer] :mode\n   mode for the directory permission\n @option option [String] :basename\n   prefix of directory name\n @option option [Pathname] :basedir\n   pathname of base directory", "Create a empty file.\n\n @param option [Hash]\n @option option [Integer] :mode\n   mode for the file permission\n @option option [String] :basename\n   prefix of filename\n @option option [Pathname] :basedir\n   pathname of base directory", "Up vote any \"votable\" object.\n Raises an AlreadyVotedError if the voter already voted on the object.", "Up vote any \"votable\" object without raising an error. Vote is ignored.", "Down vote a \"votable\" object without raising an error. Vote is ignored.", "Returns true if the voter up voted the \"votable\".", "Checks that the given hash has the valid types for each value, if they\n exist.\n @raise [ManifestError] if a bad type is encountered.", "Returns 0 or 1.", "WIP\n ATM mapper serialises issue to JSON\n We might consider using objects", "This +Directory+'s path\n\n @return [String]", "Computes the union of this +Directory+ with another +Directory+. If the\n two directories have a file path in common, the file in the +other+\n +Directory+ takes precedence. If the two directories have a sub-directory\n path in common, the union's sub-directory path will be the union of those\n two sub-directories.\n\n @raise [ArgumentError] if the +other+ parameter is not a +Directory+\n\n @param other [Directory]\n\n @return [Directory]", "Iterates through this +Directory+'s children depth-first\n\n @yieldparam child [File, Directory]", "I need this because otherwise it will try to do self.class.new on subclasses\n which would get \"0 for 1\" arguments error with Snapshot, among other things", "Allows the job to behave as the return value of the block.\n\n Accessing any method on the job will cause code to block\n until the job is completed.", "Indicates that this class is an enumeration.\n\n The default attribute used to enumerate the class is +name+.  You can\n override this by specifying a custom attribute that will be used to\n *uniquely* reference a record.\n\n *Note* that a presence and uniqueness validation is automatically\n defined for the given attribute since all records must have this value\n in order to be properly enumerated.\n\n Configuration options:\n * <tt>:cache</tt> - Whether to cache all finder queries for this\n   enumeration.  Default is true.\n\n == Defining enumerators\n\n The enumerators of the class uniquely identify each record in the\n table.  The enumerator value is based on the attribute described above.\n In scenarios where the records are managed in code (like colors,\n countries, states, etc.), records can be automatically synchronized\n via #bootstrap.\n\n == Accessing records\n\n The actual records for an enumeration can be accessed via shortcut\n helpers like so:\n\n   Color['red']    # => #<Color id: 1, name: \"red\">\n   Color['green']  # => #<Color id: 2, name: \"green\">\n\n When caching is enabled, these lookup queries are cached so that there\n is no performance hit.\n\n == Associations\n\n When using enumerations together with +belongs_to+ associations, the\n enumerator value can be used as a shortcut for assigning the association.\n\n In addition, the enumerator value is automatically used during\n serialization (xml and json) of the associated record instead of the\n foreign key for the association.\n\n For more information about how to use enumerations with associations,\n see EnumerateBy::Extensions::Associations and EnumerateBy::Extensions::Serializer.\n\n === Finders\n\n In order to be consistent by always using enumerators to reference\n records, a set of finder extensions are added to allow searching\n for records like so:\n\n   class Car < ActiveRecord::Base\n     belongs_to :color\n   end\n\n   Car.find_by_color('red')\n   Car.all(:conditions => {:color => 'red'})\n\n For more information about finders, see EnumerateBy::Extensions::BaseConditions.", "Typecasts the given enumerator to its actual value stored in the\n database.  This will only convert symbols to strings.  All other values\n will remain in the same type.", "Return the elements on a yield container. Includes shared elemenents from siblings or parents", "Find the child pages", "Return the logical modification time for the page, suitable for http caching, generational cache keys, etc.", "Only option is \"expires\" and it's a boolean", "checks if the square matches the attributes passed.\n\n @param [Symbol] attribute\n   the square's attribute.\n\n @param [Object,Hash] value\n   a value to match on. Can be a hash of attribute/value pairs for deep matching\n\n ==== Example:\n   # Check if square has a piece owned by player 1\n   square.attribute_match?(:piece, player_number: 1)", "Add some methods to a class which includes Dio module.", "Intantiate a new class to work with OneAPI\n\n @param [required, Hash] params to create the user\n @option params [required, String] :username username to authenticate with\n @option params [required, String] :password to authenticate with\n @option params [optional, String] :base_uri of an alternative location of SMSified\n @option params [optional, String] :destination_address to use with subscriptions\n @option params [optional, String] :sender_address to use with subscriptions\n @option params [optional, Boolean] :debug to turn on the HTTparty debugging to stdout\n @raise [ArgumentError] if :username is not passed as an option\n @raise [ArgumentError] if :password is not passed as an option\n @example\n   one_api = OneAPI.new :username => 'user', :password => '123'\n\n Send an SMS to one or more addresses\n\n @param [required, Hash] params to send an sms\n @option params [required, String] :address to send the SMS to\n @option params [required, String] :message to send with the SMS\n @option params [optional, String] :sender_address to use with subscriptions, required if not provided on initialization of OneAPI\n @option params [optional, String] :notify_url to send callbacks to\n @return [Object] A Response Object with http and data instance methods\n @raise [ArgumentError] if :sender_address is not passed as an option when not passed on object creation\n @raise [ArgumentError] if :address is not provided as an option\n @raise [ArgumentError] if :message is not provided as an option\n @example\n   one_api.send_sms :address => '14155551212', :message => 'Hi there!', :sender_address => '13035551212'\n   one_api.send_sms :address => ['14155551212', '13035551212'], :message => 'Hi there!', :sender_address => '13035551212'", "Dispatches method calls to other objects for subscriptions and reporting", "Adds the configured portal to the user if necessary.\n\n @return [Aker::User]", "Decode all string fragments", "Creates a domain through specialization by constraint\n\n @param [Class] super_domain\n   the super_domain of the factored domain\n @param [Proc] pred\n   the domain predicate\n\n @return [Class]\n   the created domain as a ruby Class\n\n @api public", "Retrieve a value from the store. If it doesn't exist and a block is\n supplied, create and return it; otherwise, raise a KeyError.\n\n A synchronized version of:\n\n   store[key] ||= value", "This method authorizes @contribution, checks if the contribution can be transitioned to the desired state, calls Contribution#update_state_on_gateway!, transition the contribution's state, and return the proper JSON for Unlock's AJAX calls", "Returns the options needed for setting up the Rack server.", "Returns a mutable options hash with symbolized keys.\n Optionally, returns only the keys given.", "== Defining LookUpTables\n\n   # Sample class:\n   Foobar(id: integer, foo: string, bar: integer)\n\n === Simplest way to define a LookUpTable:\n   look_up_table :id\n   look_up_table :foo\n   look_up_table :bar\n\n === Add some options to your LookUpTable:\n   look_up_table :foo, :batch_size => 5000, :where => \"id > 10000\"\n\n === Pass a block to define the LUT manually\n   look_up_table :foo do |lut, foobar|\n     lut[foobar.foo] = foobar.id\n   end\n\n === Turn off AutoFinder and completly define the whole LUT yourself:\n   look_up_table :foo, :sql_mode => false do |lut|\n     Foobar.where(\"id > 10000\").each do |foobar|\n       lut[foobar.foo] = foobar.id\n     end\n   end", "== Calling LookUpTables\n\n === Call without any params\n * Returns: All LUTs defined within Foobar\n     Foobar.lut\n     =>\n       {\n         :foo    => { :a => 1 },\n         :bar    => { :b => 2 },\n         :foobar => { :c => 3, :d => 4, :e => 5 }\n       }\n\n === Call with :lut_key:\n * Returns: Hash representing LUT defined by :lut_key\n     Foobar.lut :foo\n     => { :a => 1 }\n\n === Call with array of :lut_keys\n * Returns: Hash representing LUT defined with :lut_key in given Array\n     Foobar.lut [:foo, :bar]\n     =>\n       {\n         :foo => { :a => 1 },\n         :bar => { :b => 2 }\n       }\n\n === Call with Call with :lut_key and :lut_item_key\n * Returns: Value in LUT defined by :lut_key and :lut_item_key\n     Foobar.lut :foo, \"foobar\"\n     => 1\n     # So we've got a Foobar with :foo => \"foobar\", its ID is '1'\n\n === Call with Call with :lut_key and :lut_item_key as Array\n * Returns: Hash representing LUT defined by :lut_key with\n   :lut_item_keys in Array\n     Foobar.lut :foobar, [\"foo\", \"bar\", \"oof\"]\n     =>\n       {\n         \"foo\" => 3,\n         \"bar\" => 4,\n         \"oof\" => nil\n       }\n     # So we got Foobars with ID '3' and '4'\n     # and no Foobar defined by :foobar => :oof\n\n === Call with :lut_key as a Hash\n * Returns: Hash representing LUTs given by keys of passed Hash.\n   - If given value of Hash-Item is nil, will get whole LUT.\n   - If given value is String or Symbol, will get value of LUT.\n   - If given value is Array, will get values of entries.\n * Example:\n    Foobar.lut { :foo => :a, :bar => nil, :foobar => [:c, :d] }\n    =>\n      {\n        :foo    => 1,\n        :bar    => { :b => 2 },\n        :foobar => { :c => 3, :d => 4 }\n      }", "Reading LUT and writing cache again", "Reads a single lut", "Fields that should be synchronized on types specified\n in argument\n @param [Array<Symbol>] Types\n @return [Array<Symbol>] Fields", "Format the measurement and return as a string.\n This will format using the base unit if no unit\n is specified.\n\n Example:\n\n   Length.new(1.8034).to_s(:feet) => 6'\n\n Multiple units can be specified allowing for a\n more naturally formatted measurement. For example:\n\n   Length.new(1.8034).to_s(:feet_and_inches) => 5' 11\"\n\n Naturally formatted measurements can be returned using\n shorthand functions:\n\n   Length.new(1.8034).in_feet_and_inches => 5' 11\"\n\n The unit group can also be specified to get a similar effect:\n\n   Length.new(1.8034).to_s(:metric) => '1m 80cm 3mm'\n\n A precision can be specified, otherwise the measurement\n is rounded to the nearest integer.", "Initializes the list.\n\n @param capacity [Integer] The maximum number of matches this list can hold\n Pushes a match into the list.\n The list is re-sorted and any matches that don\u2019t fit are rejected.\n\n @param match [MatchyMatchy::Match]\n @return [MatchyMatchy::MatchList] Self", "Returns the class or module where method is defined", "Parse the config file for all pools", "Reads config sections from a inifile", "Merges config sections form all inifiles", "Hashes configs to detect changes", "bitmap\n anchor anchorPos\n height pixels\n width pixels\n window pathName\n    def window args, key_args\n      x, y = args\n\n    end\n An embedded window that shows a list of key-value pairs.\n    def proplist args, key_args\n    end\n just a very simple example!", "Delete all statements from the model,\n matching the given pattern\n\n @param [Statement, Hash] pattern (see {#find})\n @return [Boolean]", "Find statements satisfying the given criteria.\n\n @param [:first, :all] scope find just one or all matches\n @param [Hash, Statement] pattern matching pattern made of:\n   - Hash with :subject, :predicate or :object nodes, or\n   - \"patternized\" Statement (nil nodes are matching anything).\n @return [Statement, Array, nil]", "Calculates the location of a cached checkout", "Adds syntactic suger for reading attributes.\n\n @example\n   page.title == page.attributes[\"title\"]\n\n @param [Symbol] method_name\n @param [Array] args\n @param [Proc] block\n @raise [NoMethodError] Raised when there is no method name key in attributes\n @return [Object] Value of the method name attribute", "loads an image and caches it for further use\n if an image has been loaded it is just being returned", "Override this in your subclass if you want to do fun things like\n reading templates from a database. It will be rendered by the\n context, so all you need to do is return a string.", "Provides a simple DSL to defines price instance method on the receiver.\n\n @param [Hash] options the options for creating price method.\n @option options [Symbol] :attribute (:price) Name of the price method.\n @option options [Boolean] :free (false) Set `:free => true` to use null object pattern.\n\n @yield The yielded block provides method `item` for declaring price entries,\n   and method `group` for declaring price groups.\n\n @example Normal usage\n   class Product < ActiveRecord::Base\n     has_price do\n       item base_price, \"base\"\n       item discount, \"discount\"\n\n       group \"taxes\" do\n         item federal_tax, \"federal tax\"\n         item state_tax, \"state tax\"\n       end\n\n       group \"shipment\" do\n         # Notice that delivery_method is an instance method.\n         # You can call instance methods anywhere in has_price block.\n         item delivery_price, delivery_method\n       end\n     end\n   end\n\n @example Null object pattern\n   class Product < ActiveRecord::Base\n     # Creates method #price which returns empty Price.\n     has_price :free => true\n   end\n\n @see PriceBuilder#item\n @see PriceBuilder#group", "Setup the schedules for counters.", "Specify symbols that will later be reified into attributes", "Helpful method to define constraints", "Check if a given name-value pair is valid given the constraints", "Either specify the port and serial parameters\n\n   xbee = XBeeRuby::Xbee.new port: '/dev/ttyUSB0', rate: 9600\n\n or pass in a SerialPort like object\n\n   xbee = XBeeRuby::XBee.new serial: some_serial_mockup_for_testing", "Copy validators on inheritance.", "Numerate this section and its children", "Designates an attribute on this model to indicate \"featuredness,\" where\n only one record within a given scope may be featured at a time.\n\n Pass in the name of the attribute and an options hash:\n\n * <tt>:scope</tt> - If given, designates the scope in which this model is featured. This would typically be a <tt>belongs_to</tt> association.\n * <tt>:create_scope</tt> - If <tt>true</tt>, creates a named scope using the name of the attribute given here. If it's a symbol, creates a named scope using that symbol.\n\n    class Project < ActiveRecord::Base\n      # no two Projects will ever have their @featured attributes set simultaneously\n      acts_as_featured :featured\n    end\n\n    class Photo < ActiveRecord::Base\n      # each account gets a favorite photo\n      belongs_to :account\n      acts_as_featured :favorite, :scope => :account\n    end\n\n    class Article < ActiveRecord::Base\n      # creates a named scope called Article.featured to return the featured article\n      acts_as_featured :main, :create_scope => :featured\n    end", "What is the problem with this todo?\n\n @return [String] if there's a problem\n @return [NilClass] if no charge needed\n @api private", "Have shift operator load the datapoint into the datastream's datapoints array", "Converts a measurement to a Datapoint", "Send the queued datapoints array to Xively", "Performs a put request.\n\n @param [String] url\n @param [String] payload\n @param [Block] block\n @return [String] the payload of the response as string", "Performs a delete request.\n\n @param [String] url\n @param [Hash] options\n @param [Block] block\n @return [String] the payload of the response as string", "Copy allegations on inheritance.", "Returns a string with the export data", "Returns a csv string with the export data", "Returns a class based on a path array", "Produces a Hash containing the differences between the calling object\n and the object passed in as a parameter", "Fetches the attributes of the calling object, exluding the +id+ field\n and any fields specified passed as an array of symbols via the +excluded+\n parameter", "Uses reflection to fetch the eligible associated objects for the current\n object, excluding parent objects and child objects that do not include\n the Diffable mixin", "crea o carga un plan en un cliente de payu\n se utiliza el current_user, el payu_id del cliente y el plan_code del plan", "crear tarjeta de credito en payu\n utiliza los params recibidos", "busca la info de una tarjeta de payu", "Limit results.\n\n @param [Hash] options\n @return [Collection]", "Limit results by page.\n\n @param [Integer, Hash] page\n @param [Hash] options\n @return [Collection]", "Calculate total records\n\n @param [Hash] query\n @return [Integer]", "Extends this scheduled program with another program of the same type.", "This method is executed before any call to a public method.\n @param [Object] key the key associated with the value currently filteres in the filtered datas.\n @param [Hash]   options the options applied to the initial value.", "Tries to store the associated key in the filtered key, transforming it with the given process.\n @param [Object] key the key associated with the value to store in the filtered datas.\n @param [Proc]   process a process (lambda) to execute on the initial value. Must contain strictly one argument.\n @param [Hash]   options the options applied to the initial value.", "Raises a type error with a generic message.\n @param [Object] key the key associated from the value triggering the error.\n @param [Class]  type the expected type, not respected by the initial value.\n @raise [ArgumentError] the chosen type error.", "Checks if a required key is present in provided datas.\n @param [Object] key the key of which check the presence.\n @raise [ArgumentError] if the key is not present.", "Checks if a dependency is respected. A dependency is a key openly needed by another key.\n @param [Object] key the key needing another key to properly work.\n @param [Object] dependency the key needed by another key for it to properly work.\n @raise [ArgumentError] if the required dependency is not present.", "Check if the value associated with the given key is typed with the given type, or with a type inheriting from it.\n @param [Object]   key the key of the value to check the type from.\n @param [Class]    type the type with which check the initial value.\n @return [Boolean] true if the initial value is from the right type, false if not.", "Checks if the value associated with the given key is included in the given array of values.\n @param [Object] key the key associated with the value to check.\n @param [Array]  values the values in which the initial value should be contained.\n @raise [ArgumentError] if the initial value is not included in the given possible values.", "Checks if the value associated with the given key is equal to the given value.\n @param [Object] key the key associated with the value to check.\n @param [Object] value the values with which the initial value should be compared.\n @raise [ArgumentError] if the initial value is not equal to the given value.", "Check if the value associated with the given key matches the given regular expression.\n @param [Object]   key the key of the value to compare with the given regexp.\n @param [Regexp]   regex the regex with which match the initial value.\n @return [Boolean] true if the initial value matches the regex, false if not.", "Checks if the value associated with the given key has the given required values.\n @param [Object] key the key associated with the value to check.\n @param [Array]  required_values the values that the initial Enumerable typed value should contain.\n @raise [ArgumentError] if the initial value has not each and every one of the given values.", "Checks if the value associated with the given key has the given required keys.\n @param [Object] key the key associated with the value to check.\n @param [Array]  required_keys the keys that the initial Hash typed value should contain.\n @raise [ArgumentError] if the initial value has not each and every one of the given keys.", "This function cleans all old tag parents without any child.", "This function returns an object with the list of tags with some filters.", "This function returns a single category searched by id or permalink.", "Returns random items from the set\n @param [Integer] count the number of items to return\n @return [String, Set] if count is one, then return the item; otherwise returns a set", "Computes the difference of the two sets and stores the result in `dest`. If no destination provided, computes\n the results in memory.\n @param [Redstruct::Set] other set the set to subtract\n @param [Redstruct::Set, String] dest if nil, results are computed in memory. if a string, a new Redstruct::Set is\n constructed with the string as the key, and results are stored there. if already a Redstruct::Set, results are stored there.\n @return [::Set, Integer] if dest was provided, returns the number of elements in the destination; otherwise a standard Ruby set containing the difference", "Computes the interesection of the two sets and stores the result in `dest`. If no destination provided, computes\n the results in memory.\n @param [Redstruct::Set] other set the set to intersect\n @param [Redstruct::Set, String] dest if nil, results are computed in memory. if a string, a new Redstruct::Set is\n constructed with the string as the key, and results are stored there. if already a Redstruct::Set, results are stored there.\n @return [::Set, Integer] if dest was provided, returns the number of elements in the destination; otherwise a standard Ruby set containing the intersection", "Computes the union of the two sets and stores the result in `dest`. If no destination provided, computes\n the results in memory.\n @param [Redstruct::Set] other set the set to add\n @param [Redstruct::Set, String] dest if nil, results are computed in memory. if a string, a new Redstruct::Set is\n  constructed with the string as the key, and results are stored there. if already a Redstruct::Set, results are stored there.\n @return [::Set, Integer] if dest was provided, returns the number of elements in the destination; otherwise a standard Ruby set containing the union", "Execute a block in the manipulated environment.\n\n Additional arguments will be passed to the block.\n\n Returns the return value of the block", "accepts nokogiri doc's only atm", "Initializes a Connection for use in a particular directory\n\n   * instance: The Derelict::Instance to use to control Vagrant\n   * path:     The project path, which contains the Vagrantfile\n Validates the data used for this connection\n\n Raises exceptions on failure:\n\n   * +Derelict::Connection::NotFound+ if the path is not found", "Receives the reference to the model class to seed.\n Seeds only when there are no records in the table\n or if the +force+ option is set to true.\n Also optionally it can receive the +file_name+ to use.", "Receives the class reference and csv file and creates all thre records\n inside one transaction", "adds destinations to the destination list\n\n @param [Array] dsts destinations to add\n\n @raise Edoors::Exception if a destination is not acceptable\n\n The parameters are checked before beeing added.\n they must not be empty or be '?' or start with '/'\n or contain '/?' or '//' or '\\s+'", "sets the current destination\n\n @param [String] a the action\n @param [String Iota] d the destination", "applies the effects of the given Link\n\n @param [Link] lnk the link to apply effects\n\n updates @src with Link @src, clears the destination list\n adds the Link destinations to @dsts, sets the @link_keys", "sets the links keys\n\n @param [Array] args list of keys to set\n\n \\@link_value attribute will be updated", "tries to link the Particle with the given Link\n\n @param [Link] link the link to try to link with\n\n returns true if the value of the Link is nil\n otherwise checks if the extracted key values pairs from the Particle\n payload using the Link value keys as selectors, equals the Link value\n\n @return [Boolean] true if the Link links with the Particle", "recursively clears the merged Particle list\n\n @param [Boolean] r releases the cleared Particle if true", "Retrieve a player's current competitive season ranking.\n Returns -1 if player did not complete placements.", "Retrieve player's main Quick Play hero, in lowercase form.", "Retrieve player's main Competitive hero, in lowercase form.\n You should check if the sr is -1 before attempting to call this.", "parse body from hash to xml format", "add command line option", "Convert back to \"normal\" time", "Intantiate a new class to work with reporting\n\n @param [required, Hash] params to create the Reporting object with\n @option params [required, String] :username username to authenticate with\n @option params [required, String] :password to authenticate with\n @option params [optional, String] :base_uri of an alternative location of SMSified\n @option params [optional, String] :destination_address to use with subscriptions\n @option params [optional, String] :sender_address to use with subscriptions\n @option params [optional, Boolean] :debug to turn on the HTTparty debugging to stdout\n @example\n   subscription = Subscription.new :username => 'user', :password => '123'\n\n Get the delivery status of an outstanding SMS request\n\n @param [required, Hash] params to get the delivery status\n @option params [required, String] :request_id to fetch the status for\n @option params [optional, String] :sender_address used to send the SMS, required if not provided on initialization of OneAPI\n @return [Object] A Response Object with http and data instance methods\n @raise [ArgumentError] of :sender_address is not passed here when not passed on instantiating the object\n @example\n   one_api.delivery_status :request_id => 'f359193765f6a3149ca76a4508e21234', :sender_address => '14155551212'", "Returns a list of threads sorted by the date created.\n @accessibility: public key, secret key\n @methods: GET\n @format: json, jsonp, rss\n @authenticated: false\n @limited: false\n @return [Hashie::Rash] List of threads.\n @param options [Hash] A customizable set of options.\n @option options [Integer] :category. Defaults to null\n @option options [String] :forum. Defaults to null. Looks up a forum by ID (aka short name)\n @option options [Integer] :thread. Defaults to null. Looks up a thread by ID. You may pass use the 'ident' or 'link' query types instead of an ID by including 'forum'.\n @option options [Integer, String] :author. Defaults to null. You may look up a user by username using the 'username' query type.\n @option options [Datetime, Timestamp] :since. Unix timestamp (or ISO datetime standard). Defaults to null\n @option options [String, Array] :related allows multiple. Defaults to []. You may specify relations to include with your response. Choices: forum, author, category\n @option options [Integer] :cursor. Defaults to null\n @option options [Integer] :limit. Defaults to 25. Maximum length of 100\n @option options [String, Array] :include allows multiple. Defaults to [\"open\", \"close\"]. Choices: open, closed, killed.\n @option options [String] :order. Defaults to \"asc\". Choices: asc, desc\n @example Return extended information for forum 'myforum'\n   Disqussion::Client.threads.list(:forum => \"the88\")\n @see: http://disqus.com/api/3.0/threads/list.json", "Returns a list of posts within a thread.\n @accessibility: public key, secret key\n @methods: GET\n @format: json, jsonp, rss\n @authenticated: false\n @limited: false\n @return [Hashie::Rash] List of threads post.\n @param thread [Integer] Looks up a thread by ID. You must be a moderator on the selected thread's forum. You may pass use the 'ident' or 'link' query types instead of an ID by including 'forum'.\n @param options [Hash] A customizable set of options.\n @option options [String] :forum. Defaults to null. Looks up a forum by ID (aka short name)\n @option options [Datetime, Timestamp] :since. Unix timestamp (or ISO datetime standard). Defaults to null\n @option options [String, Array] :related allows multiple. Defaults to []. You may specify relations to include with your response. Choices: forum\n @option options [Integer] :cursor. Defaults to null\n @option options [Integer] :limit. Defaults to 25. Maximum length of 100\n @option options [Integer] :query. Defaults to null.\n @option options [String, Array] :include allows multiple. Defaults to [\"approved\"]. Choices: unapproved, approved, spam, deleted, flagged\n @option options [String] :order. Defaults to \"desc\". Choices: asc, desc\n @example Return extended information for forum 'myforum'\n   Disqussion::Client.threads.list()\n @see: http://disqus.com/api/3.0/threads/listPosts.json", "Removes a thread\n @accessibility: public key, secret key\n @methods: POST\n @format: json, jsonp\n @authenticated: true\n @limited: false\n @param thread [Array, Integer] allows multiple. Looks up a thread by ID. You must be a moderator on the selected thread's forum. You may pass use the 'ident' or 'link' query types instead of an ID by including 'forum'.\n @return [Hashie::Rash] ID of the deleted thread.\n @option options [String] :forum. Defaults to null. Looks up a forum by ID (aka short name). You must be a moderator on the selected forum.\n @example Removes thread 12345678\n   Disqussion::Client.threads.remove(12345678)\n @see: http://disqus.com/api/3.0/threads/remove.json", "Returns a String containing a representation of the current content of\n in this storage.", "Select a value from a dropdown or listbox, or fill in a text field,\n depending on what kind of form field is available. If `field` is a\n dropdown or listbox, select `value` from that; otherwise, assume\n `field` is a text box.\n\n @param [String] field\n   Capybara locator for the field (name, id, or label text)\n @param [String] value\n   Text to select from a dropdown or enter in a text box\n\n @raise [Kelp::AmbiguousField]\n   If more than one field matching `field` is found\n @raise [Kelp::FieldNotFound]\n   If no field matching `field` is found\n @raise [Kelp::OptionNotFound]\n   If a dropdown matching `field` is found, but it has no\n   option matching `value`\n\n @since 0.1.9", "Verify that the given field is empty or nil.\n\n @param [String] field\n   Capybara locator for the field (name, id, or label text)\n @param [Hash] scope\n   Scoping keywords as understood by {#in_scope}\n\n @raise [Kelp::Unexpected]\n   If the given field is not empty or nil", "Return the string value found in the given field.\n If the field is `nil`, return the empty string.\n\n @param [String] field\n   Capybara locator for the field (name, id, or label text)\n\n @return [String]\n   The value found in the given field\n\n @since 0.2.1", "Verify the values of multiple fields given as a Hash.\n\n @param [Hash] field_values\n   \"field\" => \"value\" for each field you want to verify\n @param [Hash] scope\n   Scoping keywords as understood by {#in_scope}\n\n @raise [Kelp::Unexpected]\n   If any field does not contain the expected value", "Figure out whether the field locator matches a single select\n or fillable field.\n\n @param [String] field\n   Capybara locator for the field (name, id, or label text)\n\n @raise [Kelp::AmbiguousField]\n   If more than one field matching `field` is found\n @raise [Kelp::FieldNotFound]\n   If no field matching `field` is found\n\n @return [Symbol]\n   `:select` or `:fillable_field` depending on the type of element", "Creates a new message.\n @param [Hash] message The message hash to be produced", "after create hook to create a corresponding +Referee+", "Initialize Docker Client", "Configure the levels that will trigger an immediate flush of the\n logging buffer. When a log event of the given level is seen, the\n buffer will be flushed immediately. Only the levels explicitly given\n in this assignment will flush the buffer; if an \"error\" message is\n configured to immediately flush the buffer, a \"fatal\" message will not\n even though it is a higher level. Both must be explicitly passed to\n this assignment.\n\n You can pass in a single level name or number, an array of level\n names or numbers, or a string containing a comma separated list of level\n names or numbers.\n\n   immediate_at = :error\n   immediate_at = [:error, :fatal]\n   immediate_at = \"warn, error\"", "Add terms from the other expression to this one", "Produce a string representing the expression", "if reading a lazy_proc, call the proc and return its coerced return val\n otherwise, just return the stored value", "The workhorse, finds the node matching meth.\n\n Rough flow guide:\n   If a block is given then yield to it each for each instance\n     of the element found in the current node.\n   If no block given then get the first element found\n     If the node has only one text element check if the\n       method called has a ? suffix then return true if node content\n       looks like a boolean. Otherwise return text content\n     Otherwise return a new Node instance", "Writes this mapped object as a pretty-printed XML string.\n\n @param options [Hash] the options to be passed to\n   [XML::Mapping#save_to_xml](http://multi-io.github.io/xml-mapping/XML/Mapping.html#method-i-save_to_xml)\n @return [String] the XML form of the object, as a compact, pretty-printed string.", "Attempts to munge a string into a valid X509 certificate\n\n @param raw_cert [String] The string of text you wish to parse into a cert\n @return [OpenSSL::X509::Certificate]", "Creates a temporary cert and orchestrates certificate body reformatting\n\n @param raw_cert [String] The string of text you wish to parse into a cert\n @return [String] reformatted and (hopefully) parseable certificate string", "Attempts to reformat multi-line certificate bodies\n\n @param raw_cert [String] The string of text you wish to parse into a cert\n @return [String] reformatted certificate body", "Appends GET parameters to a URI instance. Duplicate parameters will\n be replaced with the new value.\n @param [URI] base_uri The original URI to work with (will not be modified)\n @param [Hash] added_params To GET params to add.\n @return [URI] The URI with appended GET parameters", "Returns a persistent connection to the server, reusing a connection of it was\n previously established.\n\n This method is mainly used for internal use but can be used to do advanced\n HTTP connectivity with the Tender API server.\n\n @return [Net::HTTP] The net/http connection instance.", "Iterates over a collection, issuing multiple requests to get all the paged results.\n\n @option options [Date] :since Only include records updated since the provided date.\n   Caution: not supported by all resources.\n @option options [Integer] :start_page The initial page number to request.\n @option options [Integer] :end_page The final page number to request.", "nasty hack until I can get an answer on the official way to remove the instance root keys in a list", "Assumes the existance of a User model", "Converse with speech recognition.\n\n Currently a \"poorman's\" DSL to utilize applescript and\n the MacOS speech recognition server.\n\n === Examples\n\n   case converse 'What is the best food?', :cookies => 'Cookies', :unknown => 'Nothing'\n   when :cookies\n     speak 'o.m.g. you are awesome!'\n   else\n     case converse 'That is lame, shall I convince you cookies are the best?', :yes => 'Ok', :no => 'No', :maybe => 'Maybe another time'\n     when :yes\n       speak 'Well you see, cookies are just fantastic.'\n     else\n       speak 'Ok then, bye.'\n     end\n   end\n\n === Notes\n\n * MacOS only", "Determines if the user is authorized for the object. The user must be\n either the creator of the object or must be an admin or above.", "Attempts to retrieve the payload encoded in the token. It checks if\n the token is \"valid\" according to JWT definition and not expired.\n\n A UNAUTHORIZED_ERROR is raised if token cannot be decoded.", "Truly verifies the token and its payload. It ensures the user and\n session specified in the token payload are indeed valid. The\n required role is also checked.\n\n A UNAUTHORIZED_ERROR is thrown for all cases where token is\n invalid.", "Attempt to get a token for the session. Token must be specified in\n query string or part of the JSON object.\n\n Raises a UNAUTHORIZED_ERROR if cached session has less role\n than what's required.", "Get API key from the request.\n\n Raises a UNAUTHORIZED_ERROR if API key is not valid (or not\n provided).", "Get auth data from the request. The token takes the precedence.", "Returns reaction details\n @accessibility: public key, secret key\n @methods: GET\n @format: json, jsonp\n @authenticated: false\n @limited: false\n @param reaction [Integer] Looks up a reaction by ID.\n @param forum [String] Looks up a forum by ID (aka shortname).\n @return [Hashie::Rash] Reaction of the forum.\n @example Message for post ID 12345678\n   Disqussion::Client.reactions.detail(12345678,\"Hello\")\n @see: http://disqus.com/api/3.0/reactions/details.json", "Custom attributes for lograge logging", "Prints the process pid, so it can be grabbed by the supervisor process, inits tranport fifos\n and requires requested libraries.\n Installs the require-spying code and starts requiring", "Find isn't fuzzy for Special Content. It looks for full\n uri or the uri's basename, optionally tacking on @ext", "Create a new JsonRequest\n\n @param [String] operation  Name of operation\n @param [Array] params  Array of parameters; must ve valid JSON types\n Stringify, useful for debugging\n\n @param [Boolean] include_params         whether or not to include params in the output (default: true)\n\n @return [String]", "Validates the params by type.  Could add in additional validations in\n this method depending on requirements.  Raises exception with invalid\n types with early return or returns true if params are valid", "Initializes a new AuditLog\n\n @param [Hash] options A hash of options that impact the audit log filename.\n @option options [String] :timestamp The timestamp to append to the filename\n @option options [Bool] :dry_run A boolean indicating if this is a dry run\n @option options [String] :audit_dir The directory where the audit log should be created\n Adds a new entry to the audit log\n\n @param [String] email The email address of the user impacted by the change\n @param [String] account The account name impacted by the change\n @param [String] action The action performed.  Expected options are ['update_permissions', 'created', 'deleted']\n @param [String] changes A free form description of the changes", "Send the message!", "Ensure all nested attributes for common fields get saved as common fields, and not as template fields", "The seconds since epoch that the request for this document started", "The number of bytes downloaded for a particular resource type. If the\n resource was gzipped during transfer then the gzipped size is reported.\n\n The HTTP headers for the response are included in the byte count.\n\n Possible resource types: 'Document','Script', 'Image', 'Stylesheet',\n 'Other'.", "The number of bytes downloaded for a particular resource type. If the\n resource was gzipped during transfer then the uncompressed size is\n reported.\n\n The HTTP headers for the response are NOT included in the byte count.\n\n Possible resource types: 'Document','Script', 'Image', 'Stylesheet',\n 'Other'.", "the number of network requests of a particular resource\n type that were required to load this document\n\n Possible resource types: 'Document', 'Script', 'Image', 'Stylesheet',\n 'Other'.", "Searches for sources in Google Books.\n\n ==== Attributes\n\n * +query+ - The search term.\n Return as hash.", "Handle when connection gets closed", "Declares a reference to a certain xml attribute.\n\n == Sym Option\n [sym] Symbol representing the name of the accessor\n\n === Default naming\n This is what it will use to lookup the attribute if a name isn't defined in :from. For example:\n\n  ox_attr :bob\n  ox_attr :pony\n\n are equivalent to:\n\n  ox_attr :bob, :from => 'bob'\n  ox_attr :pony, :from => 'pony'\n\n === Boolean attributes\n If the name ends in a ?, OxMlk will attempt to coerce the value to true or false,\n with true, yes, t and 1 mapping to true and false, no, f and 0 mapping\n to false, as shown below:\n\n  ox_elem :desirable?\n  ox_attr :bizzare?, :from => 'BIZZARE'\n\n  x = #from_xml(%{\n    <object BIZZARE=\"1\">\n      <desirable>False</desirable>\n    </object>\n  })\n\n  x.desirable?\n  => false\n  x.bizzare?\n  => true\n\n When a block is provided the value will be passed to the block\n where unexpected values can be handled. If no block is provided\n the unexpected value will be returned.\n\n  #from_xml(%{\n    <object BIZZARE=\"Dunno\"\\>\n  }).desirable?\n  => \"Dunno\"\n\n  ox_attr :bizzare? do |val|\n    val.upcase\n  end\n\n  #from_xml(%{\n    <object BIZZARE=\"Dunno\"\\>\n  }).strange?\n  => \"DUNNO\"\n\n == Blocks\n You may also pass a block which manipulates the associated parsed value.\n\n  class Muffins\n    include OxMlk\n\n    ox_attr(:count, :from => 'bakers_dozens') {|val| val.to_i * 13 }\n  end\n\n Blocks are always passed the value after being manipulated by the :as option\n and are the last thing to manipulate the XML. This is different than the\n ox_elem annotation that is passed an Array.\n\n == Options\n === :as\n ==== Basic Types\n Allows you to specify one of several basic types to return the value as. For example\n\n  ox_elem :count, :as => Integer\n\n is equivalent to:\n\n  ox_elem(:count) {|val| Integer(val) unless val.empty?}\n\n Such block shorthands for Integer, Float, String, Symbol and Time\n are currently available.\n\n If an Array is passed each Type in the array will be applied to the value in order.\n\n === :from\n The name by which the xml value will be found in XML. Default is sym.", "Declares a reference to a certain xml element or a typed collection of elements.\n\n == Sym Option\n [sym] Symbol representing the name of the accessor.\n\n === Default naming\n This name will be the default node searched for, if no other is declared. For example:\n\n  ox_elem :bob\n  ox_elem :pony\n\n are equivalent to:\n\n  ox_elem :bob, :from => 'bob'\n  ox_elem :pony, :from => 'pony'\n\n === Boolean attributes\n If the name ends in a ?, OxMlk will attempt to coerce the value to true or false,\n with true, yes, t and 1 mapping to true and false, no, f and 0 mapping\n to false, as shown below:\n\n  ox_elem :desirable?\n  ox_attr :bizzare?, :from => 'BIZZARE'\n\n  x = #from_xml(%{\n    <object BIZZARE=\"1\">\n      <desirable>False</desirable>\n    </object>\n  })\n\n  x.desirable?\n  => false\n  x.bizzare?\n  => true\n\n When a block is provided the value will be passed to the block\n where unexpected values can be handled. If no block is provided\n the unexpected value will be returned.\n\n  #from_xml(%{\n    <object>\n      <desirable>Dunno</desirable>\n    </object>\n  }).desirable?\n  => \"Dunno\"\n\n  ox_elem :strange? do |val|\n    val.upcase\n  end\n\n  #from_xml(%{\n    <object>\n      <strange>Dunno</strange>\n    </object>\n  }).strange?\n  => \"DUNNO\"\n\n == Blocks\n You may also pass a block which manipulates the associated parsed value.\n\n  class Muffins\n    include OxMlk\n\n    ox_elem(:count, :from => 'bakers_dozens') {|val| val.first.to_i * 13 }\n  end\n\n Blocks are always passed an Array and are the last thing to manipulate the XML.\n The array will include all elements already manipulated by anything passed to\n the :as option. If the :as option is an Array and no block is passed then the\n Array is returned unmodified. If the :as option is nil or is not an Array then\n only the first element is\n\n == Options\n === :as\n ==== Basic Types\n Allows you to specify one of several basic types to return the value as. For example\n\n  ox_elem :count, :as => Integer\n\n is equivalent to:\n\n  ox_elem(:count) {|val| Integer(val.first) unless val.first.empty?}\n\n Such block shorthands for Integer, Float, String, Symbol and Time\n are currently available.\n\n To reference many elements, put the desired type in a literal array. e.g.:\n\n   ox_elem :counts, :as => [Integer]\n\n Even an array of text nodes can be specified with :as => []\n\n   ox_elem :quotes, :as => []\n\n === Other OxMlk Classes\n Declares an accessor that represents another OxMlk class as child XML element\n (one-to-one or composition) or array of child elements (one-to-many or\n aggregation) of this type. Default is one-to-one. For one-to-many, simply pass the class\n as the only element in an array. You can also put several OxMlk classes in an Array that\n will act like a polymorphic one-to-many association.\n\n Composition example:\n  <book>\n   <publisher>\n     <name>Pragmatic Bookshelf</name>\n   </publisher>\n  </book>\n\n Can be mapped using the following code:\n   class Book\n     include OxMlk\n     ox_elem :publisher, :as => Publisher\n   end\n\n Aggregation example:\n  <library>\n   <books>\n    <book/>\n    <book/>\n   </books>\n  </library>\n\n Can be mapped using the following code:\n   class Library\n     include OxMlk\n     ox_elem :books, :as => [Book], :in => 'books'\n   end\n\n If you don't have the <books> tag to wrap around the list of <book> tags:\n   <library>\n     <name>Ruby books</name>\n     <book/>\n     <book/>\n   </library>\n\n You can skip the wrapper argument:\n    ox_elem :books, :as => [Book]\n\n ==== Hash\n Unlike ROXML, OxMlk doesn't do anything special for hashes. However OxMlk\n applies :as to each element and the block once to the Array of elements.\n This means OxMlk can support setting hashes but it is more of a manual process.\n I am looking for a easier method but for now here are a few examples:\n\n ===== Hash of element contents\n For xml such as this:\n\n    <dictionary>\n      <definition>\n        <word/>\n        <meaning/>\n      </definition>\n      <definition>\n        <word/>\n        <meaning/>\n      </definition>\n    </dictionary>\n\n This is actually one of the more complex ones. It uses the :raw keyword to pass the block an array of LibXML::XML::Nodes\n   ox_elem(:definitions, :from => 'definition', :as => [:raw]) do |vals|\n     Hash[*vals.map {}|val| [val.search('word').content,val.search('meaning').content]}.flatten]\n   end\n\n ===== Hash of :content\n For xml such as this:\n\n   <dictionary>\n     <definition word=\"quaquaversally\">adjective: (of a geological formation) sloping downward from the center in all directions.</definition>\n     <definition word=\"tergiversate\">To use evasions or ambiguities; equivocate.</definition>\n   </dictionary>\n\n This one can also be accomplished with the :raw keyword and a fancy block.\n   ox_elem(:definitions, :from => 'definition', :as => [:raw]) {|x| Hash[*x.map {|val| [val['word'],val.content] }.flatten]}\n\n ===== Hash of :name\n For xml such as this:\n\n    <dictionary>\n      <quaquaversally>adjective: (of a geological formation) sloping downward from the center in all directions.</quaquaversally>\n      <tergiversate>To use evasions or ambiguities; equivocate.</tergiversate>\n    </dictionary>\n\n This one requires some fancy xpath in :from to grab all the elements\n    ox_elem(:definitions, :from => './*', :as => [:raw]) {|x| Hash[*x.map {|val| [val.name,val.content] }.flatten]}\n\n === :from\n The name by which the xml value will be found in XML. Default is sym.\n\n This value may also include XPath notation.\n\n ==== :from => :content\n When :from is set to :content, this refers to the content of the current node,\n rather than a sub-node. It is equivalent to :from => '.'\n\n Example:\n  class Contributor\n    ox_elem :name, :from => :content\n    ox_attr :role\n  end\n\n To map:\n  <contributor role=\"editor\">James Wick</contributor>\n\n === :in\n An optional name of a wrapping tag for this XML accessor.\n This can include other xpath values, which will be joined with :from with a '/'", "Sets the name of the XML element that represents this class. Use this\n to override the default camelcase class name.\n\n Example:\n  class BookWithPublisher\n   ox_tag 'book'\n  end\n\n Without the ox_tag annotation, the XML mapped tag would have been 'BookWithPublisher'.\n\n Most xml documents have a consistent naming convention, for example, the node and\n and attribute names might appear in CamelCase. ox_tag enables you to adapt\n the oxmlk default names for this object to suit this convention.  For example,\n if I had a document like so:\n\n  <XmlDoc>\n    <MyPreciousData />\n    <MoreToSee />\n  </XmlDoc>\n\n Then I could access it's contents by defining the following class:\n\n  class XmlDoc\n    include OxMlk\n\n    ox_tag :camelcase\n    ox_elem :my_precious_data\n    ox_elem :more_to_see\n  end\n\n You may supply a block or any #to_proc-able object as the argument,\n and it will be called against the default node and attribute names before searching\n the document. Here are some example declaration:\n\n  ox_tag :upcase\n  ox_tag &:camelcase\n  ox_tag {|val| val.gsub('_', '').downcase }\n\n See ActiveSupport::CoreExtensions::String::Inflections for more prepackaged formats", "Returns a new instance from XML\n @param [XML::Document,XML::Node,File,Pathname,URI,String] data\n   The xml data used to create a new instance.\n @return New instance generated from xml data passed in.\n   Attr and Elem definitions are used to translate the xml to new object.", "Returns XML generated from an instance based on Attr & Elem definitions.\n @param [Object] data An instance used to populate XML\n @return [XML::Node] Generated XML::Node", "randomly pick a key-value with respect to its probability\n in given distribution", "computes variance given that keys in distribution\n are numeric", "Transform must be used inside an `emit` block.\n It can be used to alter named keys within the item set\n\n Usage:\n     emit do\n       transform :name, :description do |name|\n         name.gsub(/\\302/, \"\")\n       end\n     end\n\n In quasi-english: The result of the block is returned and set to each\n of the :name and :description keys in the result set.", "Used to store or retreive variables that are used to query services.\n\n Usage:\n   Smoke.twitter.username(\"benschwarz\").output\n\n As you can see, the method is chainable, many properties can be\n set at once, although it may be cleaner to use the method argument method:\n\n Demo:\n   Smoke.twitter(:username => \"benschwarz\").output", "Re-sort items by a particular key\n Sort must be used inside an `emit` block.", "Keep items that match the regex\n\n Usage (block, during initialization):\n     Smoke.yql(:ruby) do\n       ...\n       emit do\n         keep(:title, /tuesday/i)\n       end\n     end\n Keep must be used inside an `emit` block.", "Discard items that do not match the regex\n\n Usage (block, during initialization):\n     Smoke.yql(:ruby) do\n       ...\n       emit do\n         discard(:title, /tuesday/i)\n       end\n     end\n Discard must be used inside an `emit` block.", "Creates a new Context object.\n\n @param app the context's application\n Initializes the attributes based on an environment.\n\n @param env the environment to use", "Generate the payload for slack attachments", "Use a fancy border around console", "Callback from observed memory", "Add a storage adapter to the set of possible adapters.  Takes an object\n that responds to `driver`, `use?`, `storage_class`, and `display_name`.", "If storage_adapter is not explicitly set, find first registered adapter that\n can use Bumbleworks.storage.", "If the user explicitly declared a path, raises an exception if the\n path was not found.  Missing default paths do not raise an exception\n since no paths are required.", "given an argument hash and a description of acceptable keyword args and\n their default values, checks validity of the arguments and raises any\n errors, otherwise returns a new hash containing all arg values with\n defaults filled in as needed.\n\n args = hash.keyword_args(:a, :b, :c,        # these are all optional args\n                          :d => :optional,   # same as listing it the arg up front\n                          :e => :required,   # raises an error if arg not provided\n                          :f => \"hello\"      # default value\n                          :g => [:x,:y,:z]   # valid values\n                          :h => Integer      # valid type\n                          :i => :enumerable  # expect/coerce an enumerable, check all items, default is []\n                          :j => { :valid => Integer, :allow_nil => true}   # Integer or nil\n                          :j => { :valid => [:x,:y,:z], :default => :x, :required => true }   # combo\n                          )\n\n by default this will raise an error if the hash contains any keys not\n listed.  however, if :OTHERS is specified as a keyword arg, that test\n will be disabled and any other key/value pairs will be passed through.\n\n Returns a Struct whose values are the", "pages that numbers are displayed", "Pure function to create correct filename", "Non blocking get url", "All valid documents", "Prepare and queue a multi request\n\n @return [#run]", "Gets a block image by its ID and Metadata. Unfortunately it uses the old\n   block IDs rather than the new ones, so you have to memorize those\n   pesky integers.\n @param id [Integer] The (outdated) block ID number.\n @param metadata [Integer] The metadata, if any, for the block.\n @param size [Fixnum] The size of the image to get.\n @return [ChunkyPNG::Image] The ChunkyPNG instance of that block image.\n @raise see #get", "Gets the monster image by its ID.\n @param id [Any] The string ID. It will automatically prefix it with \"m\" if\n   that is omitted. It doesn't matter what type it is: String or Fixnum,\n   because it will automatically convert it to a String.\n @param three [Boolean] Whether to get a three-dimensional monster image.\n   The three-dimensional image is of the full monster, while the\n   two-dimensional image is just its head.\n @param size [Integer] The size of the image (width) to get. For 3D images\n   this will not be perfect just by nature of the API.\n @return [ChunkyPNG::Image] The ChunkyPNG instance of that monster image.\n @raise see #get", "Initialize with the directory to zip and the location of the output archive.\n Zip the input directory.", "Computes the ID assigned to a blob.\n\n @param [String] path the path of the file whose contents is used in the\n   fixture, relative to the Rails application's test/fixtures directory\n @return [String] the ID used to represent the blob contents", "The contents of a blob, in a YAML-friendly format.\n\n @param [String] path the path of the file whose contents is used in the\n   fixture, relative to the Rails application's test/fixtures directory\n @param [Hash] options optionally specify the current indentation level\n @option options [Integer] indent the number of spaces that the current line\n   in the YAML fixture file is indented by\n @return [String] the base64-encoded blob contents", "The number of bytes in a file.\n\n @param [String] path the path of the file whose contents is used in the\n   fixture, relative to the Rails application's test/fixtures directory\n @return [Integer] the nubmer of bytes in the file", "Sets the filename, content_type and data attributes from a local filename so that a File can be uploaded through the API", "Download the file to the local disk", "Format a player's record as it would appear in an SP export file.", "variance of an array of numbers", "Sets default options, to be overwritten by option parser down the road\n @param args [Array<String>] runs the analyzer with parsed args taken as options\n @return [void]", "initializes the tracker\n start the tracker", "load the YAML file that is specified in the params", "decide if the status is retweetable", "Defaults to empty string which produces no encoding.", "Amount should be a decimal between 0 and 1. Lower means darker", "Amount should be a decimal between 0 and 1. Higher means lighter", "like reverse merge, only assigns attributes which have not yet been assigned", "Returns a hash filled with Pages", "Maps original query to results", "add a point to the track\n\n @param [Float] lat latitude\n @param [Float] lon longitude\n @param [Float] elevation elevation\n @param [Time] time time at the given location", "is the supplied time covered by this track?\n\n @param time [Time]\n @return Boolean", "return the interpolated location for the given time\n or nil if time is outside the track's start..end\n\n @example\n  track.at(time) => {lat:48, lon:98, elevation: 2100}\n @param time [String,Time,Fixnum]\n @return [Hash,nil]", "Executes a string or an array of strings in a shell in the given directory", "Creates or recreates automatically defined indices", "Creates a new index according to IndexDefinition", "Permanently deletes _object_ from the database and deconnects all connected\n Persistables", "Permanently deletes the index named _index_name_", "Returns the next valid odba_id", "Find objects in an index", "Store a Persistable _object_ in the database", "Show the number of translation missing with colorization", "Read html to string, remove namespace if any,\n set the new namespace, and update the test file.\n adds namespace to BP classes in a html file", "Returns the list of values for this enumeration", "This function create the default category if it not exists.", "This function cleans all old category parents without any child.", "This function returns an object with the list of categories with some filters.", "Fetch the config from the file", "Default configuration options for Rails and non Rails applications", "Iterate to the next element in the path\n\n Algorithm:\n 1. Get the last element of the key path\n 2. Try to find it in the scoped config\n 3. If not present raise an error\n 4. If present and is a hash we are not in a config leaf, so the scoped\n    config is reset to this new value and self is returned\n 5. If present and is a value then return the value", "Establish attributes to proxy along with an alternative proc of how\n the attribute should be loaded\n\n @example Load method using uppercase\n   class GithubUser\n     include ClassProxy\n\n     fallback_fetch { |args| Octokit.user(args[:login]) }\n     after_fallback_fetch { |obj| self.name = obj.name; self.login = obj.login }\n\n     attr_accessor :name, :followers :login\n\n     proxy_methods :name, :followers, uppercase_login: lambda { login.upcase }\n   end\n\n   user = GithubUser.find(login: 'heelhook')\n   user.login           # -> 'heelhook'\n   user.uppercase_login # -> 'HEELHOOK'", "Method to find a record using a hash as the criteria\n\n @example\n   class GithubUser\n     include MongoMapper::Document\n     include ClassProxy\n\n     primary_fetch  { |args| where(args).first or (raise NotFound) }\n     fallback_fetch { |args| Octokit.user(args[:login]) }\n   end\n\n   GithubUser.fetch(login: 'heelhook') # -> Uses primary_fetch\n                                       # -> and, if NotFound, fallback_fetch\n\n @param [ Hash ] args The criteria to use\n @options options [ true, false] :skip_fallback Don't use fallback methods", "Unloads the plugin.\n\n @param [Boolean] force If the plugin to be unloaded is \"ruby\",\n   +force+ has to be true.\n @return [Boolean] true if we attempted to unload the plugin", "Returns an array of all scripts loaded by this plugin.\n\n @return [Array<Script>]", "Unlike the ping method for other Ping subclasses, this version returns\n a PingStatus struct which contains various bits of information about\n the results of the ping itself, such as response time.\n\n In addition, this version allows you to pass certain options that are\n then passed on to the underlying WQL query. See the MSDN documentation\n on Win32_PingStatus for details.\n\n Examples:\n\n  # Ping with no options\n  Ping::WMI.ping('www.perl.com')\n\n  # Ping with options\n  Ping::WMI.ping('www.perl.com', :BufferSize => 64, :NoFragmentation => true)\n--\n The PingStatus struct is a wrapper for the Win32_PingStatus WMI class.", "Runs the given query.\n\n @param [String] sql the SQL to execute\n @param [Array] args the SQL bindings\n @yield [row] operate on the result\n @yield [Array] the result row\n @return [Array] the query result", "Runs the given SQL or block in a transaction. If SQL is provided, then that\n SQL is executed. Otherwise, the block is called.\n\n @quirk RDBI RDBI converts nil args to 12. Work-around this bug by embedding\n   +NULL+ in the SQL instead.\n\n @param [String] sql the SQL to execute\n @param [Array] args the SQL bindings\n @yield [dbh] the transaction statements\n @yieldparam [RDBI::Database] dbh the database handle", "Replaces nil arguments with a +NULL+ literal in the given SQL.\n\n @param (see #transact)\n @return [Array] the (possibly modified) SQL followed by the non-nil arguments", "Reding from the 'Conditions at..as of..' table", "get all vms and their facts as hash with vm.name as key", "pre-order traverse through this node and all of its descendants\n\n @param &block [block] code to execute for each yielded node", "If method is missing, try to pass through to underlying data hash.", "Initialize an instance for a particular directory\n\n   * path: The path to the Vagrant installation folder (optional,\n           defaults to DEFAULT_PATH)\n Validates the data used for this instance\n\n Raises exceptions on failure:\n\n   * +Derelict::Instance::NotFound+ if the instance is not found\n   * +Derelict::Instance::NonDirectory+ if the path is a file,\n     instead of a directory as expected\n   * +Derelict::Instance::MissingBinary+ if the \"vagrant\" binary\n     isn't in the expected location or is not executable", "Determines the version of this Vagrant instance", "Executes a Vagrant subcommand using this instance\n\n   * subcommand: Vagrant subcommand to run (:up, :status, etc.)\n   * arguments:  Arguments to pass to the subcommand (optional)\n   * options:    If the last argument is a Hash, it will be used\n                 as a hash of options. A list of valid options is\n                 below. Any options provided that aren't in the\n                 list of valid options will get passed through to\n                 Derelict::Executer.execute.\n                 Valid option keys:\n      * sudo:    Whether to run the command as root, or not\n                 (defaults to false)\n   * block:      Passed through to Derelict::Executer.execute", "Constructs the command to execute a Vagrant subcommand\n\n   * subcommand: Vagrant subcommand to run (:up, :status, etc.)\n   * arguments:  Arguments to pass to the subcommand (optional)", "The real Rack call interface.", "Authenicate user and set cookies.\n This will be called automatically on endpoint request.", "Makes a copy of +len+ bytes from the ruby string +bytes+. Library\n handles deallocation of the native memory buffer.\n\n Can only be initialized via #copy_in_string or #copy_in_bytes once.\n\n @param bytes\n @param length", "check items have a value. Will raise Undefined error if a required item\n has no value.", "simple option checking, with value constraints and sub-hash checking", "Returns the max of 4 integers", "Get a complex graph\n\n @param [String] path\n @return [Hash] the graph property\n @example\n {\"number\"=>0,\n  \"complex\"=>true,\n  \"created_at\"=>\"2013/05/20 15:08:28\",\n  \"service_name\"=>\"app name\",\n  \"section_name\"=>\"host name\",\n  \"id\"=>18,\n  \"graph_name\"=>\"complex graph test\",\n  \"data\"=>\n   [{\"gmode\"=>\"gauge\", \"stack\"=>false, \"type\"=>\"AREA\", \"graph_id\"=>218},\n    {\"gmode\"=>\"gauge\", \"stack\"=>true, \"type\"=>\"AREA\", \"graph_id\"=>217}],\n  \"sumup\"=>false,\n  \"description\"=>\"complex graph test\",\n  \"sort\"=>10,\n  \"updated_at\"=>\"2013/05/20 15:08:28\"}", "Delete a complex graph\n\n @param [String] path\n @return [Hash]  error response\n @example\n {\"error\"=>0} #=> Success\n {\"error\"=>1} #=> Error", "Sends a post request with json from the command line certificate\n\n @param global_options [Hash] global command line options\n @param options [Hash] json fields to send to fenton server\n @return [Fixnum] http status code\n @return [String] message back from fenton server", "set_relations\n add relation on medium if not exists\n Also check if a class has a duplicate context\n\n @param [String] context\n @param [String] relation type, one of :has_many, :has_one", "this is where the fun begins...", "Saves the current modifications to the provided path.", "Check if any changelog were modified. When the helper receives nothing,\n changelogs defined by the config are used.\n\n @return [Bool] True\n         If any changelogs were modified in this commit", "Return true if any source files are in the git modified files list.\n\n @return [Bool]", "Truncate the string received.\n\n @param  [String] input\n         The string to truncate\n @param  [Number] max (Default: 30)\n         The max size of the truncated string\n @return [String]", "Resolves symbolic references and returns the final reference.\n\n @return [MultGit::Ref]", "Shorthand method to directly create a commit and update the given ref.\n\n @example\n  # setup:\n  dir = `mktemp -d`\n  repository = MultiGit.open(dir, init: true)\n  # insert a commit:\n  repository.head.commit do\n    tree['a_file'] = 'some_content'\n  end\n  # check result:\n  repository.head['a_file'].content #=> eql 'some_content'\n  # teardown:\n  `rm -rf #{dir}`\n\n @option options :lock [:optimistic, :pessimistic] How to lock during the commit.\n @yield\n @return [Ref]", "Sets up the session so that it will authenticate the given user.", "The before_action that implements authenticates_using_session.\n\n If your ApplicationController contains authenticates_using_session, you\n can opt out in individual controllers using skip_before_action.\n\n     skip_before_action :authenticate_using_session", "Not \"delete\"! That already exists in tk.", "Add debian packages to a repo\n\n == Parameters:\n path::\n   The path to the file or directory source\n remove_files::\n   When true, deletes source after import", "Imports package resources from existing mirrors\n\n == Parameters:\n from_mirror::\n   The name of the mirror to import from\n packages::\n   A list of debian pkg_spec strings (e.g. \"libc6 (>= 2.7-1)\")\n deps::\n   When true, follows package dependencies and adds them", "Copy package resources from one repository to another\n\n == Parameters:\n from_repo::\n   The source repository name\n to_repo::\n   The destination repository name\n packages::\n   A list of debian pkg_spec strings\n deps::\n   When true, follow deps and copy them", "Classic oauth 2 login\n\n   login() -> return autorization url\n   login(code) -> try login, return true false", "Automaticaly open autorization url a waiting for callback.\n Launchy gem is required\n\n Parameters:\n   server:: server will be on this addres, its alson address for oatuh 2 callback\n   port:: listening port for server\n   port=0:: server will be on first free port\n\n Steps:\n 1) create server\n 2) launch browser and redirect to google api\n 3) confirm and google api redirect to localhost\n 4) server get code and start session\n 5) close server - you are login", "def define_tasks\n Image namespace", "List all folders containing Dockerfiles", "List all images", "This method overrides the rails built in form helper's action setting code\n to inject a return path", "Assuming the provided app has already been uploaded,\n update this environment to the app's version\n Optionally pass in a bunch of settings to override", "Assuming the archive has already been uploaded,\n create a new environment with the app deployed onto the provided stack.\n Attempts to use the first available cname in the cnames array.", "if a mostly utf8 has some mixed in latin1 characters, replace the\ninvalid characters", "assume ruby>=1.9 here", "spies don't leave any track\n simulate dispatching before passing to mock to verify", "Check if a feature branch have more than one commit.\n\n @param  [Symbol] level (Default: :fail)\n         The report level (:fail, :warn, :message) if the check fails [report](#report)\n @return [void]", "Check if a feature branch contains a single JIRA issue number matching the jira project key.\n\n @param  [Symbol] level (Default: :fail)\n         The report level (:fail, :warn, :message) if the check fails [report](#report)\n @return [void]", "Check if all fix branch commit's message contains any JIRA issue number matching the jira project key.\n\n @param  [Symbol] level (Default: :warn)\n         The report level (:fail, :warn, :message) if the check fails [report](#report)\n @return [void]", "Check if it's a feature branch and if the PR body contains acceptance criteria.\n\n @param  [Symbol] level (Default: :warn)\n         The report level (:fail, :warn, :message) if the check fails [report](#report)\n @return [void]", "Check if the PR has at least one label added to it.\n\n @param  [Symbol] level (Default: :fail)\n         The report level (:fail, :warn, :message) if the check fails [report](#report)\n @return [void]", "Send report to danger depending on the level.\n\n @param  [Symbol] level\n         The report level sent to Danger :\n           :message  > Comment a message to the table\n           :warn     > Declares a CI warning\n           :fail     > Declares a CI blocking error\n @param  [String] content\n         The message of the report sent to Danger\n @return [void]", "Check if the commit's message contains any JIRA issue number matching the jira project key.\n\n @param  [Commit] commit\n         The git commit to check\n @param  [Symbol] level (Default: :warn)\n         The report level (:fail, :warn, :message) if the check fails [report](#report)\n @return [void]", "Wait for the background process to finish.\n\n If a process successfully finished, it's return value from the *process*\n block is stored into the result set.\n\n It's advisable to use something like the *at_exit* hook to ensure you don't\n leave orphaned processes.  For example, in the *at_exit* hook you could\n call *wait* to block until the child process finishes up.\n\n @return [Array<pid, status, data>] An array containing the pid,\n   status and data returned from the process block.  If wait2() fails nil\n   is returned.", "Extracts the columns to display in the table based on the header column\n names", "Determines max column widths for each column based on the data and header\n columns.", "Prints a horizontal line below the header", "Prints columns in a table format", "get ALL records at path by paging through record set\n can pass block to act on each page of results", "create blob record by external url", "parsed record and map to get restructured object", "Experimental, no tests so far.", "at returns the first one only, but search returns all", "Get the file path to output the html based on the file being\n built.  The output path is relative to where guard is being run.\n\n @param file [String] path to file being built\n @return [String] path to file where output should be written", "Returns a slice or partial selection of the set.\n @see Redstruct::SortedSet::Slice#initialize\n @return [Redstruct::SortedSet::Slice] a newly created slice for this set", "Use redis-rb zscan_each method to iterate over particular keys\n @return [Enumerator] base enumerator to iterate of the namespaced keys", "Create a new object using the given connection.\n Tries to delete the value at the given key.\n\n WARNING: This function can lead to inconsistent data (e.g. deleted items\n can re-appear). Also when re-creating an item the version before the\n delete can re-appear.\n\n returns the number of successfully deleted items\n use get_last_delete_result() to get more details", "Take the result of `split` and apply Markdown formatting to comments", "Allow to test for a specific role or similar like Role.accountant?", "Flushes cache if record is saved", "Recursively searches for the blob identified by `blob_name`\n in all subdirectories in the repository. A blob is usually either\n a file or a directory.\n\n @param blob_name [String] the blob name\n @param current_tree [Rugged::Tree] the git directory tree in which to look for the blob.\n   Defaults to the root tree (see `#root_tree`).\n\n @yield [Rugged::Blob] Yields the found blob to an optional block.\n   If the block returns `true` it means that the file is found and\n   recursion is stopped. If the return value is `false`, the resursion continues.\n\n @return [Rugged::Blob] The blob blob or nil if it cannot be found.", "Validates that the conditions Hash follows an expected format", "Registers a path as a data directory.\n\n @param [String] path\n   The path to add to {DataPaths.paths}.\n\n @return [String]\n   The fully qualified form of the specified path.\n\n @example\n   register_data_dir File.join(File.dirname(__FILE__),'..','..','..','data')\n\n @raise [RuntimeError]\n   The specified path is not a directory.\n\n @since 0.3.0", "Unregisters any matching data directories.\n\n @param [String] path\n   The path to unregister.\n\n @return [String]\n   The unregistered data path.\n\n @since 0.3.0", "Unregisters all previously registered data directories.\n\n @return [true]\n   Specifies all data paths were successfully unregistered.\n\n @since 0.3.0", "Reinitialize an Identity Map model object from +coder+.\n +coder+ must contain the attributes necessary for initializing an empty\n model object.", "ensures user must login", "Return user followers\n\n   Example:\n\n   # Search user\n   user = Meme::Info.find('jtadeulopes')\n\n   # Default\n   followers = user.followers\n   followers.count\n   => 10\n\n   # Specify a count\n   followers = user.followers(100)\n   followers.count\n   => 100\n\n   # All followers\n   followers = user.followers(:all)\n   followers.count\n\n   follower = followers.first\n   follower.name\n   => \"zigotto\"\n   follower.url\n   => \"http://meme.yahoo.com/zigotto/\"", "Retrieves all posts of an user", "Reads arguments from a CSV file and creates links accordingly. The links\n are added to the websie", "Export links to specified format", "Updates links read from a file", "Deletes one or more links from the website. Returns the deleted links.\n Expects the links provided in an array", "Deletes links based on URLs that are provided in a file. Each URL has to\n be in one line", "Saves the website to the specified directory with the downcased name of\n the website and the extension 'website'. The website is save as YAML", "Deletes the website if it already exists", "returns a hash of all CSS data passed\n\n ==== Options\n * <tt>data</tt> -- CSS string; defaults to string passed into the constructor", "Loads the environment from the given configuration file.\n @api private", "Yields to each element of specified node_type\n All elements if e_node_type is nil.", "Apply passed block to each String in the hierarchy.", "Will call the given block with all the actual arguments every time\n the method is called", "Will call the given block with it's result every time the method\n returns", "Allows the fields to store an Infinity value.\n\n Overrides the setter and getter of those fields in order to capture\n and return Infinity when appropiate.\n\n Then you can use it as any other value and get the desired result, like\n decrementing, incrementing, comparing with <, >, ==, etc.\n\n Example:\n    class LibrarySubscription < ActiveRecord::Base\n      acts_as_integer_infinitable [:available_books]\n\n      def rent_book\n        # Do other things...\n        self.available_books -= 1\n        save\n      end\n    end\n\n    > simple_subscription = LibrarySubscription.new(available_books: 5)\n    > simple_subscription.available_books\n    => 5\n    > simple_subscription.rent_book\n    > simple_subscription.available_books\n    => 4\n\n    > complete_subscription = LibrarySubscription.new(available_books: Float::INFINITY)\n    > long_subscription.available_books\n    => Infinity\n    > long_subscription.rent_book\n    > long_subscription.available_books\n    => Infinity\n\n == Parameters\n * +fields+ - An Array with the fields that will be infinitable. They have\n   to be integers in the database.\n\n == Options\n * +:infinity_value+ - The value that will be converted to Infinity.\n   Default: -1. Another popular value is `nil`.", "Creates a new PersistenceService with the specified application service name and options.\n\n @param [String] the caBIG application service name\n @param [{Symbol => Object}] opts the options\n @option opts [String] :host the service host (default +localhost+)\n @option opts [String] :version the caTissue version identifier\n Database access methods \n Returns an array of objects fetched from the database which match the given template_or_hql.\n\n If template_or_hql is a String, then the HQL is submitted to the service.\n\n Otherwise, the template_or_hql is a query template domain\n object following the given attribute path. The query condition is determined by the values set in the\n template. Every non-nil attribute in the template is used as a select condition.\n\n @quirk caCORE this method returns the direct result of calling the +caCORE+ application service\n   search method. Calling reference attributes of this result is broken by +caCORE+ design.", "Dispatches the given HQL to the application service.\n\n @quirk caCORE query target parameter is necessary for caCORE 3.x but deprecated in caCORE 4+.\n\n @param [String] hql the HQL to submit", "Returns an array of domain objects associated with obj through the specified attribute.\n This method uses the +caCORE+ v. 4+ getAssociation application service method.\n\n *Note*: this method is only available for caBIG application services which implement +getAssociation+.\n Currently, this includes +caCORE+ v. 4.0 and above.\n This method raises a DatabaseError if the application service does not implement +getAssociation+.\n\n Raises DatabaseError if the attribute is not an a domain attribute or the associated objects were not fetched.", "Runs yardstick on a partial set of paths passed in by guard\n\n @api private\n @return [Void]", "Runs yardstick and outputs results to STDOUT\n\n @api private\n @return [Void]", "Merge further options with yardstick config file.\n\n @api private\n @return [Hash] Hash of options for yardstick measurement", "Raises a type error for `args`.\n\n @param [Array] args\n   arguments passed to `new` or another factory method\n @raise TypeError\n\n @api protected", "Used to build the authenticated parameters for logging in an end-user on\n checkd.in via a redirect.\n\n options              - a hash with a the following values defined:\n   :client_identifier - REQUIRED, the same client identifier used when accessing the regular\n                        API methods.\n   :bridge_secret     - REQUIRED, previously agreed upon shared secret for the user bridge.\n                        This is NOT the shared secret used for accessing the backend API,\n                        please do not confuse the two.\n   :checkdin_landing_url - OPTIONAL, the value will default to CHECKDIN_DEFAULT_LANDING\n                           if not given. Please set this value as directed by Checkd In.\n\n Examples\n\n   bridge = Checkdin::UserBridge.new(:client_identifier => 'YOUR_ASSIGNED_CLIENT_IDENTIFIER',\n                                     :bridge_secret     => 'YOUR_ASSIGNED_BRIDGE_SECRET')\n   redirect_to bridge.login_url(:email           => 'bob@example.com',\n                                :user_identifier => '112-fixed-user-identifier')\n\n Public: Build a full signed url for logging a specific user into checkd.in. Notice:\n you MUST NOT reuse the result of this method, as it expires automatically based on time.\n\n options                 - a hash with the following values defined:\n   email                 - REQUIRED, email address of the user, MAY have different values for a given\n                           user over time.\n   user_identifier       - REQUIRED, your unique identifier for the user, MUST NOT change over time.\n   authentication_action - OPTIONAL, the given action will be performed immediately,\n                           and the user redirected back to your site afterwards.\n   referral_token        - OPTIONAL, the referral token of the user that referred the user being created.\n   first_name            - OPTIONAL\n   last_name             - OPTIONAL\n   gender                - OPTIONAL, format of male or female\n   birth_date            - OPTIONAL, YYYY-MM-DD format\n   username              - OPTIONAL\n   mobile_number         - OPTIONAL, XXXYYYZZZZ format\n   postal_code_text      - OPTIONAL, XXXXX format\n   classification        - OPTIONAL, the internal group or classification a user belongs to\n   delivery_email        - OPTIONAL, whether a user should receive email notifications\n   delivery_sms          - OPTIONAL, whether a user should receive sms notifications\n   campaign_id           - OPTIONAL, automatically join a user to this campaign, rewarding existing known actions\n\n Returns a URL you can use for redirecting a user. Notice this will expire, so it should\n be generated and used only when a user actually wants to log into checkd.in.", "Creating new object\n\n @param\n   account_type [String] it could be :starter\n   main_path [String] it could be :city, :province\n   params [Hash] it could be { id: id city / id province, province: id province }\n\n @example\n   MeserOngkir::Api.new(account_type, main_path, params)", "Method Missing that returns Predicate for the respective sym word\n Search the translate be word in the languages.yml for the rspec-i18n try\n to comunicate with the Rspec", "Generate a tblRefs string.", "Generate tblPubs SQL", "Generate tblPeople string.", "Generate tblRefAuthors string.", "Generate tblCites string.", "Generate tblTypeSpecies string.", "Must be called post tblGenusNames and tblSpeciesNames.\n Some records are not used but can be cleaned by SF", "Return true if row contains no data", "Truncates a decimal to 3 decimal places if numeric\n and remove trailing zeros, if more than one decimal place.\n returns a string", "If the result is n.000... Remove the unecessary zeros.", "Initializes with a root command object\n\n When nothing is given we default to the script name otherwise you choose\n the name of the root command or the command itself\n\n Delegates all parsing responsiblities to a series of handlers, returning\n a structured hash needed to execute a command. The command being executed\n is determined by the CmdArgsStrategy unless you override it, it extracts\n all args upto the first option or ignore. The RootCommand is used to find\n the command using the extracted args, it accounts for sub commands. The\n parser Parser::ParsingStategy handles processing opts, args and ignored\n args\n\n @param raw_args [Array] cli args usually from ARGV\n @return [Hash] structured context for executing a command", "Executes the callable object in a command. All command callable object\n expect to be called the the options hash, arg hash and shell object.\n\n @param context [Hash]\n @return [Integer]", "get the access token", "get the initial access token", "pre-order traversal of the sexp, calling methods on\n the visitor with each node", "A blank page with just the layout and flash message, which can be redirected to when\n all else fails.", "Set the error flash and attempt to redirect back. If RedirectBackError is raised,\n redirect to error_path instead.", "Yields once for each result set, until there is no next token.", "Sets the token value for the current session.", "Reset configuration options to default values", "Loops through the helpers added to the Machined\n environment and adds them to the Context. Supports\n blocks and Modules.", "start the shell", "Responsible for going through the list of available gems and loading\n any plugins requested.  It keeps track of what it's loaded already\n and won't load them again.\n\n It accepts one parameter which is a hash of gem depends that should include\n or exclude a gem from being loaded.  A gem must depend on zergrush to be\n considered, but then each system has to add it's own INCLUDE to make sure\n that only plugins related to it are loaded.\n\n An example again comes from Mongrel.  In order to load all Mongrel plugins:\n\n  GemPlugin::Manager.instance.load \"mongrel\" => GemPlugin::INCLUDE\n\n Which will load all plugins that depend on mongrel AND zergrush.  Now, one\n extra thing we do is we delay loading Rails Mongrel plugins until after rails\n is configured.  Do do this the mongrel_rails script has:\n\n GemPlugin::Manager.instance.load \"mongrel\" => GemPlugin::INCLUDE, \"rails\" => GemPlugin::EXCLUDE\n The only thing to remember is that this is saying \"include a plugin if it\n depends on zergrush, mongrel, but NOT rails\".  If a plugin also depends on other\n stuff then it's loaded just fine.  Only zergrush, mongrel, and rails are\n ever used to determine if it should be included.\n\n NOTE: Currently RubyGems will run autorequire on gems that get required AND\n on their dependencies.  This really messes with people running edge rails\n since activerecord or other stuff gets loaded for just touching a gem plugin.\n To prevent this load requires the full path to the \"init.rb\" file, which\n avoids the RubyGems autorequire magic.", "Creates a new 'cloche'.\n\n There are 2 options :\n\n * :dir : to specify the directory into which the cloche data is store\n * :nolock : when set to true, no flock is used\n\n On the Windows platform, :nolock is set to true automatically.\n\n Puts a document (Hash) under the cloche.\n\n If the document is brand new, it will be given a revision number '_rev'\n of 0.\n\n If the document already exists in the cloche and the version to put\n has an older (different) revision number than the one currently stored,\n put will fail and return the current version of the doc.\n\n If the put is successful, nil is returned.", "Given a type, this method will return an array of all the documents for\n that type.\n\n A optional second parameter may be used to select, based on a regular\n expression, which documents to include (match on the key '_id').\n\n Will return an empty Hash if there is no documents for a given type.\n\n == opts\n\n :skip and :limit are understood (pagination).\n\n If :count => true, the query will simply return the number of documents\n that matched.", "Mehtod that generates datepicker input field inside a form", "This is deliberately not abstracted (it could be easily accessed from\n withing the method_missing method, but that will just lead to nastiness\n later when I implement colors, for example.", "Queues object for push\n @param [Object] Object", "Queues object for pull\n @param [Class] Class of object\n @param [String] Remote ID for object", "initialize elements items", "Create a new POEntry\n\n @param [Hash] attrs\n @option attrs [String] :msgid the id of the string (the string that needs\n   to be translated). Can include a context, separated from the id by\n   {NS_SEPARATOR} or by the specified :separator.\n @option attrs [String] :msgid_plural the pluralized id of the string (the\n   pluralized string that needs to be translated).\n @option attrs [String] :msgctxt the context of the string.\n @option attrs [Array<String>] :msgstr the translated strings.\n @option attrs [Array<String>] :references a list of files with line\n   numbers, pointing to where the string was found.\n @option attrs [Array<String>] :flags a list of flags for this entry.\n @option attrs [String] :separator the separator of context from id in\n   :msgid.\n Convert the entry to a string representation, to be written to a .po file\n @return [String] a string representation of the entry.", "Gives information about the raffle.\n\n @example\n   r = Raffle.new('kstzcbd')\n   r.info #=>\n   {:link_snippet=>\"kstzcbd\",\n    :title=>\"Just one refined [1 hour]\",\n    :description=>\"Plain and simple.\",\n    :start_time=>2012-10-29 09:51:45 -0400,\n    :end_time=>2012-10-29 09:53:01 -0400,\n    :win_chance=>0.1,\n    :current_entries=>10,\n    :max_entries=>10,\n    :is_done=>true}\n\n @param page [Mechanize::Page] the raffle page.\n @return [Hash] a representation of the raffle.\n   * :link_snippet (+String+) \u2014 the \"raffle id\" in the URL.\n   * :title (+String+) \u2014 the raffle's title.\n   * :description (+String+) \u2014 the raffle's \"message\".\n   * :start_time (+Time+) \u2014 the creation time of the raffle.\n   * :end_time (+Time+) \u2014 the projects/observed end time for the raffle.\n   * :win_chance (+Float+) \u2014 a participant's chance to win the raffle.\n     Rounded to 5 digits.\n   * :current_entries (+Fixnum+) \u2014 the current number of participants.\n   * :max_entries (+Fixnum+) \u2014 the maximum number of particpants allowed.\n   * :is_done (+Boolean+) \u2014\u00a0whether new users can enter the raffle.", "Asynchronously makes network connections to TF2R to query its API and\n scrape the raffle page.", "Converts the representation of participants by TF2R's API into our own\n standard representation.", "Post data with the associated tags_in to this's spot's plan's method spot with name name\n and hint that the caller requested the spot activation to be executed on track tack\n\n @param [Track] track requested target track\n @param [Any] data any data event\n @param [Hash] tags to be passed along\n\n @return [self]", "Sends a post request with json from the command line organization\n\n @param global_options [Hash] global command line options\n @param options [Hash] json fields to send to fenton server\n @return [Fixnum] http status code\n @return [String] message back from fenton server", "Build and save the draft when told to do so.", "Loop through and create DraftUpload objects for any Carrierwave\n uploaders mounted on this draftable object.\n\n @param [Hash] attrs the attributes to loop through\n @return [Array<DraftUpload>] an array of unsaved DraftUpload objects.", "Get a reference to the CarrierWave uploader mounted on the\n current draftable object, grab the file in it, and shove\n that file into a new DraftUpload.\n\n @param [String] key the attribute where the CarrierWave uploader\n   is mounted.\n @return [DraftUpload] containing the file in the uploader.", "Finds the root node that this node descends from\n\n @param [Boolean] force_reload forces the root node to be reloaded\n @return [ActiveRecord::Base] node the root node this descends from", "Returns the ids of the node and all nodes that descend from it.\n\n @return [Array[Integer]]", "Rebuild this node's childrens boundaries", "number\n   The telephone number\n url\n   The URL to content. Usually a image, tone or application\n message\n   Information text before downloading content", "Add telephone numbers into the massive send list.\n It is recommended not to send more than 50 in each call\n\n Return TRUE if ok\n   - see accepted in *last_addressees_accepted*\n   - see rejected in *last_addressees_rejected*", "Set the message for the massive send list", "Email a single participant within a discussion - refer to post observer", "Validates each record and returns error count if record is invalid", "snippet based on oauth gem", "Get all registered timeline entries\n\n @return [Hash{String=>Hash{String=>Class}}] A hash of `<timeline kind> => { <route kind> => <timeline entry class>, ... }`", "Get class for timeline entry corresponding to given route in given timeline\n\n @param timeline_kind [String] Timeline kind\n @param route_kind    [String] Route kind\n @return [Class] Timeline entry class", "Register an entity\n\n @param entity_name    [Symbol] Entity name\n @param entity_options [Hash]   Entity options\n @param activity_klass [Class]  Activity class that uses that entity", "Get all entities names for given model class", "Get all entities names by timelines that can have a reference to given model class\n\n @param model_class [Class] Model class\n @return [Hash{Class=>Array<Symbol>}] Lists of entities names indexed by timeline class", "Find all classes in given directory\n\n @api private\n\n @param dir_path [String] Directory path\n @return [Hash{String=>Class}] Hash of `<kind> => <Class>`", "Reads the links from the Internet Explorer's bookmarks directory", "hold original multiply processing", "This function check if current permalink is valid. If it is not valid it\n generate a new from the post title.", "This function check that the category parent exist and has not others tags for the same language.", "Sort the params consistently", "Destroy or Update the Enum Items\ndef clear_optional_items\n\nend\n Infrastructure for the Enumerable", "rails root directory must be set before calling this.", "Updates the properties of an user.", "don't override this method without calling super!", "Used by advanced permission forms which group permissions by their associated component\n or using a single check box per permission.", "Returns true if the object has all the permissions specified by +levels+", "Adds readers for component permission groups and single permissions\n\n Used by advanced permission forms to determine how which options to select\n in the various fields. (eg. which option of f.select :labels_permissions to choose)", "Verifies that all the access levels are valid for the attached permissible\n Makes sure no permissions are duplicated\n Enforces the order of access levels in the access attribute using the order of the permissions array", "Verifies that the result of the block is the same as the approved\n version.", "The approval filename", "Aggregates and creates trends for all the enterprises for a specific\n   trend type at a specific timestamp\n @param [Fixnum] oftype The type of trend to be calculated\n @param [Time] ts The time at which trend needs to be calculated", "Override the aggregate! defined in counter class as the calculations\n   for trending are a little different", "Performs the actual trend calculation\n @param [String] enterprise_id The enterprise ID for whom trend needs to be found\n @param [Fixnum] trend_type The trend type to be calculates\n @param [Time] ts The Timestamp at which trend needs to be calculated.", "Gets the trend of a type at a time\n @param [String] enterprise_id The ID of enterprise for whom trend to fetch\n @param [Fixnum] type The type of trend to fetch\n @param [Hash] opts The options to be provided for finding trends", "Converts a couunter into a trend\n @param [Object] counter A counter object. This object must belong\n   to one of the counter types defined in models.\n @return [Object] Returns a trend instance corresponding to the counter\n   instance", "Builds a new formatter for outputting Uninhibited features.\n\n @api rspec\n @param [IO] output the output stream\n Adds the pending example to skipped examples array if it was skipped,\n otherwise it delegates to super.\n\n @api rspec", "Generates a colorized summary line based on the supplied arguments.\n\n   formatter.summary_line(1, 0, 0)\n   # => 1 example (0 failures)\n\n   formatter.summary_line(2, 1, 1)\n   # => 2 examples (1 failure, 1 pending)\n\n   formatter.skipped_count += 1\n   formatter.summary_line(2, 0, 0)\n   # => 2 examples (1 failure, 1 skipped)\n\n @param [Integer] example_count the total examples run\n @param [Integer] failure_count the failed examples\n @param [Integer] pending_count the pending examples\n\n @return [String] the formatted summary line\n\n @api rspec", "metodo principal de esta clase\n al estar en un 'rescue' evitamos que el proyecto saque error 500 cuando algo sale mal\n INTERCEPTAMOS el error y lo enviamos al controller para que trabaje con el\n\n de la variable @context, obtenemos los params y el current_user\n en los params se encuentran datos del plan , tarjeta de cr\u00e9dito seleccionada o datos de nueva tarjeta\n\n se ejecuta el metodo 'call' del SubscriptionService", "Coalesce the statistics from the _other_ sampler into this one. The\n _other_ sampler is not modified by this method.\n\n Coalescing the same two samplers multiple times should only be done if\n one of the samplers is reset between calls to this method. Otherwise\n statistics will be counted multiple times.", "Adds a sampling to the calculations.", "Calculates the standard deviation of the data so far.", "Create a new Tracker instance. An optional boolean can be passed in to\n change the \"threadsafe\" value of the tracker. By default all trackers\n are created to be threadsafe.\n\n Coalesce the samplers from the _other_ tracker into this one. The\n _other_ tracker is not modified by this method.\n\n Coalescing the same two trackers multiple times should only be done if\n one of the trackers is reset between calls to this method. Otherwise\n statistics will be counted multiple times.\n\n Only this tracker is locked when the coalescing is happening. It is\n left to the user to lock the other tracker if that is the desired\n behavior. This is a deliberate choice in order to prevent deadlock\n situations where two threads are contending on the same mutex.", "Time the execution of the given block and store the results in the\n named _event_ sampler. The sampler will be created if it does not\n exist.", "Periodically execute the given _block_ at the given _period_. The\n tracker will be locked while the block is executing.\n\n This method is useful for logging statistics at given interval.\n\n Example\n\n    periodically_run( 300 ) {\n      logger = Logsly::Logging182::Logger['stats']\n      tracker.each {|sampler| logger << sampler.to_s}\n      tracker.reset\n    }", "Write a target asset to file with a hashed name.\n @param target [String] logical path to asset\n @param gzip [Boolean] if the asset should be gzipped\n @param hash [Boolean] if the asset name should include the hash\n @return [String, nil] the relative path to the written asset or `nil` if no such asset", "Computes the path of the breadcrumb under the given context.\n\n @return [String, Hash]", "Computes the name of the breadcrumb under the given context.\n\n @return [String]", "Reads the links from the Firefox database places.sqlite", "Returns row values in Arrays", "Export source_data as a 16x16 png", "Extract repository files at a particular reference to directory.", "Creates a buffer, and iterates over every breadcrumb, yielding\n the breadcrumb to the block given on initialization.\n\n @return [String]", "Renders the breadcrumbs in HTML tags.  If no options were\n provided on initialization, it uses defaults.\n\n @option @options [String] :outer (\"ol\") The outer tag element\n   to use.\n @option @options [String] :inner (\"li\") The inner tag element\n   to use.\n @option @options [Hash] :outer_options (nil) The outer tag\n   element attributes to use.  Things like `class=\"some-class\"`\n   are best placed here.\n @option @options [Hash] :inner_options (nil) The inner tag\n   element attributes to use.  Things like `class=\"some-class\"`\n   are best placed here.\n @return [String]", "Acquire a lock on a connection and assign it to executing fiber\n - if connection is available, pass it back to the calling block\n - if pool is full, yield the current fiber until connection is available", "Allow the pool to behave as the underlying connection", "Creates a connection to the NXT brick.\n\n Sends a packed string of bits.\n\n Example:\n\n     # Causes the brick to beep\n     conn.transmit [0x80, 0x03, 0xf4, 0x01, 0xf4, 0x01].pack('C*')'\n\n @see The LEGO MINDSTORMS NXT Communications Protocol (Appendex 1 of the Bluetooth Development Kit)\n\n @param {String} bits This must be a binary string. Use `Array#pack('C*')` to generate the string.\n @return [Boolean] Returns true if all the data was sent and received by the NXT.", "Sends a packet string of bits and then receives a result.\n\n Example:\n\n     # Causes the brick to beep\n     conn.transceive [0x80, 0x03, 0xf4, 0x01, 0xf4, 0x01].pack('C*')'\n\n @see The LEGO MINDSTORMS NXT Communications Protocol (Appendex 1 of the Bluetooth Development Kit)\n\n @param {String} bits This must be a binary string. Use `Array#pack('C*')` to generate the string.\n @raise {LegoNXT::TransmitError} Raised if the {#transmit} fails.\n @return [String] A packed string of the response bits. Use `String#unpack('C*')`.", "Opens the connection\n\n This is triggered automatically by intantiating the object.\n\n @return [nil]", "Handle special fields", "Only valid if this is a reference. Also works for attributes, this was a crappy name", "Creates PriceBuilder on a target object.\n\n @param [Object] object the target object on which price is being built.\n Adds price item to the current nesting level of price definition.\n\n @param [#to_hash, #to_i] price an integer representing amount for this price item.\n   Alternatively, anything that responds to #to_hash can be used,\n   and will be treated as a group named with item_name.\n @param [#to_s] item_name name for the provided price item or group.\n\n @see #group", "Adds price group to the current nesting level of price definition.\n Groups are useful for price breakdown categorization and easy subtotal values.\n\n @example Using group subtotals\n   class Product\n     include HasPrice\n\n     def base_price; 100 end\n     def federal_tax; 15 end\n     def state_tax; 10 end\n\n     has_price do\n       item base_price, \"base\"\n       group \"tax\" do\n         item federal_tax, \"federal\"\n         item state_tax, \"state\"\n       end\n     end\n   end\n\n   @product = Product.new\n   @product.price.total # => 125\n   @product.price.tax.total # => 25\n\n @param [#to_s] group_name a name for the price group\n @yield The yielded block is executed within the group, such that all groups and items\n   declared within the block appear nested under this group. This behavior is recursive.\n\n @see #item", "Change the search term, triggering a query rebuild and clearing past results.\n\n Raises ArgumentError if search_term is not a String, Symbol or Array", "Change search options with a hash, triggering a query string rebuild and\n clearing past results.\n\n Raises ArgumentError if options is not a Hash", "Clear out the query and rebuild it from the various stored options. Also clears out the\n results set and sets pages back to -1", "Fetch a list of values from the results set given by name", "A display-friendly name for this user.  Uses `first_name` and\n `last_name` if available, otherwise it just uses the username.\n\n @return [String]", "Used to create nice templated \"tags\" while keeping the html out of\n our helpers.  Additionally, this can be invoked implicitly by\n invoking the partial as a method with \"_\" prepended to the name.\n\n Invoking the method:\n\n   <% concat_partial \"my_partial\", { :var => \"value\" } do %>\n     <strong>Contents stored as a \"body\" local</strong>\n   <% end %>\n\n Or invoking implicitly:\n\n   <% _my_partial :var => \"value\" do %>\n     <strong>Contents stored as a \"body\" local</strong>\n   <% end %>\n\n Note that with the implicit partials the partial will first be\n searched for locally within the current view directory, and then\n additional directories defined by the controller level\n 'additional_partials' method, and finally within the views/shared\n directory.", "AUTHORITY API IMPLEMENTATION\n\n Verifies the credentials against the set provided by calls to\n {#valid_credentials!} and {#load!}.  Supports all kinds.\n\n @return [Aker::User, nil]", "Loads a YAML doc and uses its contents to initialize the\n authority's authentication and authorization data.\n\n Sample doc:\n\n     users:\n       wakibbe:               # username\n         password: ekibder    # password for :user auth (optional)\n         first_name: Warren   # any attributes from Aker::User may\n         last_name: Kibbe     #   be set here\n         identifiers:         # identifiers will be loaded with\n           employee_id: 4     # symbolized keys\n         portals:             # portal & group auth info (optional)\n           - SQLSubmit        # A groupless portal\n           - ENU:             # A portal with simple groups\n             - User\n           - NOTIS:           # A portal with affiliated groups\n             - Manager: [23]\n             - User           # you can mix affiliated and simple\n\n     groups:                  # groups for hierarchical portals\n       NOTIS:                 # (these aren't real NOTIS groups)\n         - Admin:\n           - Manager:\n             - User\n           - Auditor\n\n @param [#read] io a readable handle (something that can be passed to\n   `YAML.load`)\n\n @return [Static] self", "Creates a new reaction client.\n @param [Faye::Client] client    bayeux client\n @param [String]       salt      secret salt, used to generate access\n                                 tokens\n Publishes message to zero or more channels.\n @param [String] name    controller name\n @param [String] message message to send\n @option opts :to        can be a regular expression or an array, defaults\n                         to all.\n @option opts :except    can be a regular expression or an array, defaults\n                         to none.", "to customise the actions for a resource define a list of actions\n\n example:\n   action_links  :posts, :tickets, ->(resource) {link_to \"#{resource.name}\"}\n\n @param  scope [type] [description]\n @param  link_data [type] [description]\n\n @return [type] [description]", "Mixes in useful methods for handling addresses.\n\n === Options\n\n * <tt>fields:</tt> array of fields (default: [:street1, :street2, [:city, [:state, :zip]], :country])\n * <tt>namespace:</tt> prefixes fields names with this, great for use with composed_of in ActiveRecord.", "Use dynamic programming to find all the Hamiltonian cycles in this graph", "THESE METHODS ARE TEMPORARY UNTIL IRONIC-DISCOVERD IS ADDED TO\n OPENSTACK AND KEYSTONE", "add pages for scan array, also add bad pages to bad_pages array", "create Page and add to to site", "get all titles on site and return array of them", "get all meta description tags content and return it as array", "get all h2 tags and return array of it", "get all a tags and return array of it", "check url and try to convert it to valid, remove .jpg links, add scheme to url", "Reads keypresses from the user including 2 and 3 escape character sequences.", "How many spaces before the carets should there be?\n @return [Fixnum]\n @api private", "Create one or more.\n\n @example Record.\n   user = User.new(name: 'Apply Arthurton', age: 32)\n   Swift.db.create(User, user)\n   #=> Swift::Record\n @example Coerce hash to record.\n   Swif.db.create(User, name: 'Apple Arthurton', age: 32)\n   #=> Swift::Record\n @example Multiple resources.\n   apple = User.new(name: 'Apple Arthurton', age: 32)\n   benny = User.new(name: 'Benny Arthurton', age: 30)\n   Swift.db.create(User, [apple, benny])\n   #=> Array<Swift::Record>\n @example Coerce multiple resources.\n   Swift.db.create(User, [{name: 'Apple Arthurton', age: 32}, {name: 'Benny Arthurton', age: 30}])\n   #=> Array<Swift::Record>\n\n @param  [Swift::Record]                                   record    Concrete record subclass to load.\n @param  [Swift::Record, Hash, Array<Swift::Record, Hash>] resources The resources to be saved.\n @return [Swift::Record, Array<Swift::Record>]\n @note   Hashes will be coerced into a Swift::Record resource via Swift::Record#new\n @note   Passing a scalar will result in a scalar.\n @see    Swift::Record.create", "Update one or more.\n\n @example Record.\n   user      = Swift.db.create(User, name: 'Apply Arthurton', age: 32)\n   user.name = 'Arthur Appleton'\n   Swift.db.update(User, user)\n   #=> Swift::Record\n @example Coerce hash to record.\n   user      = Swift.db.create(User, name: 'Apply Arthurton', age: 32)\n   user.name = 'Arthur Appleton'\n   Swif.db.update(User, user.tuple)\n   #=> Swift::Record\n @example Multiple resources.\n   apple = Swift.db.create(User, name: 'Apple Arthurton', age: 32)\n   benny = Swift.db.create(User, name: 'Benny Arthurton', age: 30)\n   Swift.db.update(User, [apple, benny])\n   #=> Array<Swift::Record>\n @example Coerce multiple resources.\n   apple = Swift.db.create(User, name: 'Apple Arthurton', age: 32)\n   benny = Swift.db.create(User, name: 'Benny Arthurton', age: 30)\n   Swift.db.update(User, [apple.tuple, benny.tuple])\n   #=> Array<Swift::Record>\n\n @param  [Swift::Record]                                   record    Concrete record subclass to load.\n @param  [Swift::Record, Hash, Array<Swift::Record, Hash>] resources The resources to be updated.\n @return [Swift::Record, Swift::Result]\n @note   Hashes will be coerced into a Swift::Record resource via Swift::Record#new\n @note   Passing a scalar will result in a scalar.\n @see    Swift::Record#update", "Delete one or more.\n\n @example Record.\n   user      = Swift.db.create(User, name: 'Apply Arthurton', age: 32)\n   user.name = 'Arthur Appleton'\n   Swift.db.delete(User, user)\n @example Coerce hash to record.\n   user      = Swift.db.create(User, name: 'Apply Arthurton', age: 32)\n   user.name = 'Arthur Appleton'\n   Swif.db.delete(User, user.tuple)\n @example Multiple resources.\n   apple = Swift.db.create(User, name: 'Apple Arthurton', age: 32)\n   benny = Swift.db.create(User, name: 'Benny Arthurton', age: 30)\n   Swift.db.delete(User, [apple, benny])\n @example Coerce multiple resources.\n   apple = Swift.db.create(User, name: 'Apple Arthurton', age: 32)\n   benny = Swift.db.create(User, name: 'Benny Arthurton', age: 30)\n   Swift.db.delete(User, [apple.tuple, benny.tuple])\n\n @param  [Swift::Record]                                   record    Concrete record subclass to load.\n @param  [Swift::Record, Hash, Array<Swift::Record, Hash>] resources The resources to be deleteed.\n @return [Swift::Record, Array<Swift::Record>]\n @note   Hashes will be coerced into a Swift::Record resource via Swift::Record#new\n @note   Passing a scalar will result in a scalar.\n @see    Swift::Record#delete", "Create a server side prepared statement\n\n @example\n   finder = Swift.db.prepare(User, \"select * from users where id > ?\")\n   user   = finder.execute(1).first\n   user.id\n\n @overload prepare(record, command)\n   @param  [Swift::Record]       record    Concrete record subclass to load.\n   @param  [String]              command   Command to be prepared by the underlying concrete adapter.\n @overload prepare(command)\n   @param  [String]              command   Command to be prepared by the underlying concrete adapter.\n\n @return [Swift::Statement, Swift::DB::Mysql::Statement, Swift::DB::Sqlite3::Statement, ...]", "Execute a command using the underlying concrete adapter.\n\n @example\n   Swift.db.execute(\"select * from users\")\n @example\n   Swift.db.execute(User, \"select * from users where id = ?\", 1)\n\n @overload execute(record, command, *bind)\n   @param  [Swift::Record]       record    Concrete record subclass to load.\n   @param  [String]              command   Command to be executed by the adapter.\n   @param  [*Object]             bind      Bind values.\n @overload execute(command, *bind)\n   @param  [String]              command   Command to be executed by the adapter.\n   @param  [*Object]             bind      Bind values.\n\n @return [Swift::Result, Swift::DB::Mysql::Result, Swift::DB::Sqlite3::Result, ...]", "Initialize a new page, which can be simply rendered or\n persisted to the filesystem.", "Render the current page.", "Save current page to the specified path.", "remove the thread local maps for threads that are no longer active.\n likely to be painful if many threads are running.\n\n must be called manually; otherwise this object may accumulate lots of garbage\n if it is used from many different threads.", "Returns the property value for the key. If there is no key entry but there is an\n alternate key entry, then alternate key entry is set.", "Loads the specified properties file, replacing any existing properties.\n\n If a key is included in this Properties merge_properties array, then the\n old value for that key will be merged with the new value for that key\n rather than replaced.\n\n This method reloads a property file that has already been loaded.\n\n Raises ConfigurationError if file doesn't exist or couldn't be parsed.", "Copies a file to a target directory", "Loads the configuration from a file", "Return _date_or_datetime_ converted to _format_.\n\n Reminder:\n * you can add formats (e.g. in an initializer)\n * this gem has monkey-patched +NilClass+ so you can just do this: +datetime.to_s(:short)+ without worrying if +datetime+ is +nil+.\n\n @example\n   datetime_to_s(record.created_at, :long)\n   datetime_to_s(Date.today, :short)\n @param date_or_datetime [Date, Datetime] the date/time to convert to string\n @param format [Symbol] one of +Date::DATE_FORMATS+ or +Time::DATE_FORMATS+\n @return [String]", "The before_action that implements authenticates_using_http_token.\n\n If your ApplicationController contains authenticates_using_http_token, you\n can opt out in individual controllers using skip_before_action.\n\n     skip_before_action :authenticate_using_http_token", "Format as a XML document.\n\n @return [REXML::Document]\n   XML document\n @raise FormatError\n   format error when the document is not formattable", "Execute a request using pre, post, and reject middleware.\n\n method - The HTTP method.\n ...    - Arguments to forward to execute.\n\n Returns a promise.", "rendering image with thumbnail effect applied", "Calculates distance between two points on the Earth.\n @param other the place on the Earth to calculate distance to\n @return [Float] the distance between two places on the Earth", "Get a list of all promotions for the authenticating client.\n\n @param [Hash]  options\n @option options Integer :campaign_id - Only return promotions for this campaign.\n @option options String :active - Return either active or inactive promotions, use true or false value.\n @option options Integer :limit - The maximum number of records to return.", "Get a list of activities for a promotion ordered by the number of votes they have received\n\n param [Integer] id The ID of the promotion\n @param [Hash]  options\n @option options Integer :limit - The maximum number of records to return.\n @option options Integer :page - The page of results to return.", "Gets the player image for the type.\n @param username [String] See #get_player_head.\n @param type [String] The type of image to get. Can be 'helm', 'player', or\n   'skin' as defined by the Fishbans Player Skins API.\n @param size [Integer] See #get_player_head.\n @return [ChunkyPNG::Image] The ChunkyPNG::Image instance for the params.\n @raise see #get", "Opens the file provided and writes the relation to it as a CSV.\n\n Example\n\n     User.where(unsubscribed: false).write_to_csv(\"unsubscribed_users.csv\")\n\n Returns nil", "This action generates a JSON for a process statistics.", "This action generates a JSON for a spread statistics.", "Guess for which time range to display statistics", "Write the contents of this file to the specified IO object.\n @param [IO] io the IO object to write the contents of the file to.", "Clears the non-sticky class caches.", "Tries to find module in this chapter by module slug.", "process ipn request\n POST is sent from paypal and will create transaction\n GET is a redirect from paypal and will redirect back to return_path", "returns current payment instance from session", "reads the first line of the CSV file\n returns the columns indices as an array", "Loops through the available Tilt templates\n and registers them as processor engines for\n Sprockets. By default, Sprockets cherry picks\n templates that work for web assets. We need to\n allow use of Haml, Markdown, etc.", "Run specific callbacks.\n\n   run_callbacks_for(:before_fetch)\n   run_callbacks_for(:progress, 12) # 12 percent done", "Determines the file path of the ruby code defining the subscription.\n It's important that this is called from within the initializer to get the\n desired effect.", "Generates a unique identifier for this subscription which will be used to\n \"serialize\" it.\n\n The goal here is to generate a identifier that is the same across different\n processes and servers and that ideally changes infrequently between\n application versions, but when it does change, it should do so predictably.", "Evaluate an integer as a priority.", "Evaluate a symbol as a priority.", "Evaluate nil as a priority.", "returns encrypted request variables", "load YAML file.", "Adds leading and trailing slashes if none are present", "Get a list of all votes for the authenticating client.\n\n @param [Hash]  options\n @option options Integer :user_id - Only return votes for this user.\n @option options Integer :limit - The maximum number of records to return.", "Creates a new client on fenton server by sending a post\n request with json from the command line to create the client\n\n @param global_options [Hash] global command line options\n @param options [Hash] json fields to send to fenton server\n @return [String] success or failure message", "Calls create new client then creates an organization for that client\n via a post request with json from the command line\n\n @param global_options [Hash] global command line options\n @param options [Hash] json fields to send to fenton server\n @return [String] success or failure message", "Formulates the client json for the post request\n\n @param options [Hash] fields from fenton command line\n @return [String] json created from the options hash", "Runs the given caTissue operation block with the given caTissue credentials.\n\n @yield (see #protect!)\n @return [String, nil] the status message", "Publishes the value to the channel\n @param channel [String] The channel to publish to\n @param value [Object] The value to publish\n @yield Allows an optional block to use the Redis connection\n @yieldparam redis [Redis] The Redis connection", "Converts published values to JSON if possible\n @api private", "Check custom validations defined into provider", "Decodes the JWT with the signed secret", "class level\n finds a hook by that name and runs it\n @param  hook_name the hook to find\n @param  [Array] args arguments to be passed to the hook\n @param  [Proc] block Proc to be passed to the hook\n @return [Hook]", "Only valid for vocabularies\n Returns a list of possible values for that vocabulary", "Fetch an entity based on its uri. Each entity containing a valid uri will be retrievable through this method", "Call with Packer, nil, or IO. If +pk+ is nil, returns string. If +pk+ is\n a Packer, returns the Packer, which will need to be flushed. If +pk+ is\n IO, returns nil.", "Return all attributes as a hash\n @return [Hash]", "Removes all connections to another persistable. This method is called\n by the Cache server when _remove_object_ is deleted from the database", "Recursively stores all connected Persistables.", "Creates a new Citation from the given attributes.\n\n ==== Attributes\n\n * +options+ - The attributes of the Citation.\n\n ==== Options\n\n * +:type+ - Not optional. The type of source you are citing.\n * +:contributors+ - An array of hashes of contributors.\n\n ==== Examples\n\n   citation = Scholar::Citation.new({\n     :type => :book,\n     :title => \"Foobar\",\n     :contributors => [\n       {\n         :role => :author,\n         :first => \"John\",\n         :last => \"Sample\"\n       }\n     ]\n   })\n\n Obviously, you'd include more than that, but you need to see the\n specific sources for more documentation.\n Returns the Citation object in Hash form.", "Alert the user that the method they've called is not supported\n @since 0.4.1", "Accepts multiple arguments, an array, or string of SQL and composes them\n @example String\n   \"name='foo''bar' and group_id='4'\" #=>  \"name='foo''bar' and group_id='4'\"\n @example Array\n   [\"name='%s' and group_id='%s'\", \"foo'bar\", 4]  #=>  \"name='foo''bar' and group_id='4'\"\n @param [Array,String]", "Accepts an array of conditions.  The array has each value\n sanitized and interpolated into the SQL statement.\n @param [Array] ary\n @example Array\n   [\"name='%s' and group_id='%s'\", \"foo'bar\", 4]  #=>  \"name='foo''bar' and group_id='4'\"\n @private", "This function serializes a complete version of the tag.", "Deletes a file's associated destination file, if any.", "Delete this object from the bucket\n\n @since 0.0.1\n\n @note This method will reset +id+ attribute\n\n @param [Hash] options options for operation, see\n   {{Couchbase::Bucket#delete}}\n @return [Couchbase::Model] Returns a reference of itself.\n\n @example Delete the Post model\n   p = Post.find('hello-world')\n   p.delete", "Reload all the model attributes from the bucket\n\n @since 0.0.1\n\n @return [Model] the latest model state\n\n @raise [Error::MissingId] for records without +id+\n   attribute", "Sets the universal attributes from the params; any additional\n attributes are set from the block.\n\n Sends the HTTP request and returns a Response object.", "Aggregates to find the sum of all counters for an enterprise\n   at a time\n @param [Hash] aggr The aggregated hash\n @return [Hash] The summed up hash", "Add the item to the end of the list", "This function render the partial used to render post fields for a\n specific post.", "This function render a single post field.", "Read in fixture file instead of url", "Renumber the player according to the supplied hash. Return self.", "Loose equality test. Passes if the names match and the federations are not different.\n Strict equality test. Passes if the playes are loosly equal and also if their IDs, rating, gender and title are not different.\n Merge in some of the details of another player.", "Starts serving the app.\n @param port [Fixnum] port number to bind to", "Initializes a new RunExecutable\n\n @param [RightApi::Client] right_api_client An instantiated and authenticated\n   RightApi::Client instance which will be used for making the request(s)\n Runs a RightScript or Chef Recipe on all instances which have all of the\n specified tags.\n\n @param [String|Array<String>] tags An array of tags.  If a string is\n   supplied it will be converted to an array of Strings.\n @param [String] executable RightScript name or href, or the name of a\n   recipe.  This method will attempt to auto detect which it is, or you\n   can be friendly and provide a hint using the executable_type option.\n @param [Hash] options A list of options where the possible values are\n   - executable_type [String] One of [\"auto\",\"right_script_name\",\"right_script_href\",\"recipe_name\"].  When set\n       to \"auto\" we will attempt to determine if an executable is a recipe,\n       a RightScript name, or a RightScript href. Defaults to \"auto\"\n   - right_script_revision [String] When a RightScript name or href is specified,\n       this can be used to declare the revision to use.  Can be a specific\n       revision number or \"latest\".  Defaults to \"latest\"\n   - tag_match_strategy [String] If multiple tags are specified, this will\n       determine how they are matched.  When set to \"all\" instances with all\n       tags will be matched.  When set to \"any\" instances with any of the\n       provided tags will be matched.  Defaults to \"all\"\n   - inputs [Hash] A hash where the keys are the name of an input and the\n       value is the desired value for that input.  Uses Inputs 2.0[http://reference.rightscale.com/api1.5/resources/ResourceInputs.html#multi_update]\n       semantics.\n   - update_inputs [Array<String>] An array of values indicating which\n       objects should be updated with the inputs supplied.  Can be empty in\n       which case the inputs will be used only for this execution.  Acceptable\n       values are [\"current_instance\",\"next_instance\",\"deployment\"]\n @raise [RightScriptNotFound] If the specified RightScript lineage does\n   not exist, or the specified revision is not available.", "Gets the specified revision of a RightScript from it's lineage\n\n @param [Array<RightApi::Resource>] An array of RightApi::Resource objects\n   of media type RightScript[http://reference.rightscale.com/api1.5/media_types/MediaTypeRightScript.html]\n @param [String] An optional parameter for the desired lineage.  When set\n   to \"latest\" it will get the highest number committed revision. Specify\n   0 for the head revision.\n @raise [RightScriptNotFound] If the specified revision is not in the lineage", "Iterate over all resources with pagination", "Extracts article data through Diffbot API", "find's an available handler\n @param  [Hash] opts\n @option opts [Array<Regexp || String, Array<String> || String>] :platform_defaults [os_pattern, gem_name],\n         the default gem for os_pattern, if os_pattern matches this os\n         and there are mulitple handlers available, install this gem_name\n         and raises ArgumentError when the default matches more than one Stat\n @param  [Proc] block\n @raise  ArgumentError, when the platform default matches more than one Stat\n @return [Stat || NilClass]", "Tasks and dependencies", "Creates new Query object\n and sets the maximum number of issues returned by Query\n @param max_results [Integer] maximum number of issues returned by query\n Handles a JQL Request and returns JiraIssueavigator for that query\n @param query [String]\n @return [JiraIssueNavigator] with those requests", "Initialize a ne Filesystem object.\n\n @return [Filesytem]\n Compress the dump to an tar.bz2 archive.\n\n @param [String] path the path, where the dump is located.\n\n @return [String]", "Remove dump from tmp path.\n\n @param [String] path the path, where the dump/archive is located.\n\n @return [nil]", "Remove all the bzip parts\n\n @param [Array] file_parts an array of paths\n\n @return [nill]", "Validate valid redemption codes", "Define a request level for this class\n Takes a name, and a block which defined the request level", "Find a single element and load it at the given request level", "Find a given level by name and return the request level", "Uses an external reaction server.\n\n @example Using an external reaction server at +localhost:9292/reaction+.\n   use_reaction :at => 'http://localhost:9292/reaction'\n\n @option opts [String] :at     URL of external reaction server.\n @option opts [String] :key    secret token, used for signing messages\n                               published from app server; defaults to\n                               +Rails.application.config.secret_token+\n @raise [RuntimeError] if the reaction client has already been initialized.\n @return [Reaction::Client] client", "Upload all new files to the bucket", "Uploads a file to the bucket. Sets expires header to one year. If a\n gzipped version of the file exists and is a smaller file size", "Source handling methods\n call this to render template source\n use this method in layouts to insert a layout's content source", "Applies a new set of options. Options that are currently unset or nil will not be modified.", "Runs the autocomplete method from the line processor, then reformats its result to be an array.", "Perform the specified action with the provided workitem. Invokes the method specified by the action parameter.", "Fire supplied exception handlers if supplied, otherwise do nothing", "Set a value in the context output", "Read a value from the context output", "control\n Sets the current task as waiting", "Send the \"cancel\" message to the server", "Send the \"not needed\" message to the server.", "end control\n persistence", "end persistence\n Get a field from workitem, supporting default value", "Adds a link to be displayed in the Maestro UI.", "Field Utility methods\n Return numeric version of value", "Return boolean version of a value", "AlgoService.new.parse", "Define a thread local variable for the current instance with name _name_.\n If the value _value_ is given, it is used to initialize the variable.", "Define a thread global variable for the current instance with name\n _name_. If the value _value_ is given, it is used to initialize the\n variable.", "Start deflecting method calls named _id_ to the _from_ class using the\n Deflector instance deflector.", "Start deflecting method calls named _id_ to the _from_ class using the\n Deflector instance deflector. After that yield to the given block and\n stop deflecting again.", "Stop deflection method calls named _id_ to class _from_.", "Delegates all missing method calls to _method_missing_delegator_ if this\n attribute has been set. Otherwise it will call super.", "Create an RDF statement.\n\n @param [Hash] source\n @option source [Node, String, URI, nil] :subject\n @option source [Node, String, URI, nil] :predicate\n @option source [Node, String, URI, nil] :object\n @raise [NotImplementedError] if cannot create a Statement from the given source.\n @raise [RedlandError] if it fails to create a Statement.\n Subject of the statment.\n\n @return [Node, nil]", "Predicate of the statement.\n\n @return [Node, nil]", "Object of the statement.\n\n @return [Node, nil]", "Create a Node from the source\n and get its rdf_node, or return nil\n @api private", "run the instruction", "output benchmark results", "tweak & consume one row", "process rows in parallel", "build and close consumers", "Get a list of all campaigns for the authenticating client.\n\n @param [Hash]  options\n @option options Integer :limit - The maximum number of records to return.", "Get user's alias and confirm", "Get, validate, and confirm user's email address", "Get and confirm user's password", "Get, validate, and confirm the recipient's email address. This data does not persist.", "Open SMTP connection, pass user info as arguments, send message and close connection", "Assuming type is json", "Invokes the specified method with the specified arguments on all\n the authorities which will respond to it.", "Main entry point for apps using this library.\n Will default to environment for host and port settings, if not passed.\n Note that a missing callback_handler will result in a default handler\n being assigned if the FluentLogger is used.", "Execute npolar-api command\n @return [nil]", "enumerate over the callbacks\n @param  [Array] args\n @param  [Proc] block\n @return", "adds image_path and metadata to our list, returns a full path where the\n Engine should put the screenshot in", "Get a response from the AudioVision API.\n Returns a Faraday Response object.\n\n Example:\n   client.get(\"posts/1\")", "Parses the config file and loads the options\n @api public\n @example ConfigFile.new.read_config_file('.todo-lint.yml')\n @return [Hash] parsed file-options", "Adds the exclude file options to the config_options hash\n @api private\n @return [Hash]", "Load the tags from the configuration file as DueDates\n\n @return is irrelevant\n @api private", "Returns a list of columns for the given table.\n\n If a matching Automodel::SchemaInspector registration is found for the connection's adapter,\n and that registration specified a `:columns` Proc, the Proc is called. Otherwise, the\n standard connection `#columns` is returned.\n\n\n @param table_name [String]\n   The table whose columns should be fetched.\n\n\n @return [Array<ActiveRecord::ConnectionAdapters::Column>]", "Returns the primary key for the given table.\n\n If a matching Automodel::SchemaInspector registration is found for the connection's adapter,\n and that registration specified a `:primary_key` Proc, the Proc is called. Otherwise, the\n standard connection `#primary_key` is returned.\n\n\n @param table_name [String]\n   The table whose primary key should be fetched.\n\n\n @return [String, Array<String>]", "Returns a list of foreign keys for the given table.\n\n If a matching Automodel::SchemaInspector registration is found for the connection's adapter,\n and that registration specified a `:foreign_keys` Proc, the Proc is called. Otherwise, the\n standard connection `#foreign_keys` is attempted. If that call to ``#foreign_keys` raises a\n ::NoMethodError or ::NotImplementedError, a best-effort attempt is made to build a list of\n foreign keys based on table and column names.\n\n\n @param table_name [String]\n   The table whose foreign keys should be fetched.\n\n\n @return [Array<ActiveRecord::ConnectionAdapters::ForeignKeyDefinition>]", "Collect objects from the array excluding named objects which have the\n name in the set.\n\n @param array [Array]\n   target of value extraction\n\n @example\n   Naming::NameSet(:A, :B).values([\n     Naming.A(1),\n     Naming.B(2),\n     \"abc\",\n     Naming.A(3),\n     123,\n     nil\n   ]) #=> [\"abc\", 123, nil]", "Return the JSON representation of the specification", "Return the manifest representation of a page or browser action", "Return the manifest representation of a packaged app", "Return the manifest representation of the content scripts, if any", "Return the manifest representation of handled web intents, if any", "This method is called by the buffering code when messages need to be\n sent out as an email.", "The following methods are utility methods for SeleniumStandaloneDsl-DSL.\n You can easily handle driver with this DSL.", "For images that haven't been uploaded yet, they get a random image id\n with 'upload' infront of it.  We replace those with their new image\n id", "Returns an array of incomplete tasks. This array is sorted first by\n percentage incomplete, then by total number of minutes incomplete.", "Finds all unique category ids in a log or a schedule\n @param entries [Hash] A parsed log or schedule\n @return [Array, String] Unique category ids", "Group changes by their old index.\n\n The structure is as follows:\n\n   {\n     <line_number_on_ancestor> => [\n       [ <change>, ... ], # The changes in the first file\n       [ <change>, ... ]  # The changes in the second file\n     ]\n   }", "Returns the values of all the children with the given +name+. If the child has\n more than one value, all the values will be added as an array. If the child\n has no value, +nil+ will be added. The search is not recursive.\n\n _name_:: if nil, all children are considered (nil by default).", "Enumerates the children +Tag+s of this Tag and calls the given block\n providing it the child as parameter.\n\n _recursive_:: if true, enumerate grand-children, etc, recursively\n _namespace_:: if not nil, indicates the namespace of the children to enumerate\n _name_:: if not nil, indicates the name of the children to enumerate", "Removes the first occurence of the specified value from this Tag.\n\n _v_:: The value to remove\n\n Returns true If the value exists and is removed", "Indicates whether there is at least an attribute in this Tag.\n   has_attribute?\n\n Indicates whether there is the specified attribute exists in this Tag.\n   has_attribute?(key)\n   has_attribute?(namespace, key)", "Enumerates the attributes for the specified +namespace+.\n Enumerates all the attributes by default.", "The namespace to set. +nil+ will be coerced to the empty string.\n\n Raises +ArgumentError+ if the namespace is non-blank and is not\n a legal SDL identifier (see SDL4R#validate_identifier)", "Adds all the tags specified in the given IO, String, Pathname or URI to this Tag.\n\n Returns this Tag after adding all the children read from +input+.", "Reads and parses the +io+ returned by the specified block and closes this +io+ if +close_io+\n is true.", "Returns a string representation of the children tags.\n\n _linePrefix_:: A prefix to insert before every line.\n _s_:: a String that receives the string representation\n\n TODO: break up long lines using the backslash", "yields valid occurrences, return false from the block to stop", "Add a team member referenced by any integer.", "Renumber the players according to the supplied hash. Return self.", "Define the package name and an optional version constraint for a distribution release\n @param distro[Symbol] The distribution name like :ubuntu, :debian ...\n @param release[Symbol] The distribution release like :precise for ubuntu 12.04\n @param name[String] A package name\n @param version[String, nil] A version constraint", "Set HTTParty params that we need to set after initialize is called\nThese params come from @options within initialize and include the following:\n:ssl_ca_file - SSL CA File for SSL connections\n:format - 'json', 'xml', 'html', etc. || Defaults to 'xml'\n:format_header - :format Header string || Defaults to 'application/xml'\n:pem_cert - /path/to/a/pem_formatted_certificate.pem for SSL connections\n:pem_cert_pass - plaintext password, not recommended!", "Send a document be granulated by a nsi.cloudooo node\n\n @param [Hash] options used to send a document to be graulated\n @option options [String] file the base64 encoded file to be granulated\n @option options [String] filename the filename of the document\n @note the filename is very importante, the cloudooo node will convert the document based on its filename, if necessary\n @option options [String] doc_link link to the document that'll be granulated\n @note if provided both doc_link and file options, file will be ignored and the client will download the document instead\n @option options [String] callback a callback url to the file granulation\n @option options [String] verb the callback request verb, when not provided, nsi.cloudooo default to POST\n\n @example A simple granulation\n   doc = Base64.encode64(File.new('document.odt', 'r').read)\n   nsicloudooo.granulate(:file => doc, :filename => 'document.odt')\n @example Downloading and granulating from web\n   nsicloudooo.granulate(:doc_link => 'http://google.com/document.odt')\n @example Sending a callback url\n   doc = Base64.encode64(File.new('document.odt', 'r').read)\n   nsicloudooo.granulate(:file => doc, :filename => 'document.odt', :callback => 'http://google.com')\n   nsicloudooo.granulate(:doc_link => 'http://google.com/document.odt', :callback => 'http://google.com')\n @example Using a custom verb to the callback\n   doc = Base64.encode64(File.new('document.odt', 'r').read)\n   nsicloudooo.granulate(:file => doc, :filename => 'document.odt', :callback => 'http://google.com', :verb => \"PUT\")\n   nsicloudooo.granulate(:doc_link => 'http://google.com/document.odt', :callback => 'http://google.com', :verb => \"PUT\")\n\n @return [Hash] response\n   * \"key\" [String] the key to access the granulated document if the sam node it was stored", "Adds a write operation to the request list.", "Adds a add_del_on_list operation to the request list.", "Don't allow unauthorized or blacklisted foreign IP addresses to hit\n what we assume is the session controller for the franchisee.", "Copy the contents of the working directory.\n @param destination [String] path to copy environment's files to\n @param mirror [Boolean] remove any non-excluded paths from destination\n @return [Environment] the current environment instance", "Extracts the site's files from repository to the working directory.\n @return [Environment] the current environment instance", "Checks the config file for invalid settings.\n @todo Refactor this.\n - Checks that paths are not absolute or use `../` or `~/`.", "Returns data points from within a given time range.\n @param [Hash] options\n @option options [Time] :before optional upper bound to select events (inclusive)\n @option options [Time] :after optional lower bound to select events (inclusive)\n @option options [Range<Time>] :in optional range of time to select events (has priority over after/before)\n @option options [Integer] :limit maximum number of events to return\n @option options [Integer] :offset offset in the list (use in conjunction with limit for pagination)", "Record that an action has occurred.", "the maximum length of all the actions known to the logger.", "find the current browser name", "Loads a YAML file, parses it and returns a hash with symbolized keys.", "Loads a YAML file, parses it and checks if all values are given.  If a\n value is missing, it will be set with the default value.", "Displays the 10 most recently added problems.", "Displays the problem numbers and titles for an individual page of the\n archive.", "Displays the details of an individual problem.\n\n * +id+ - ID of the problem to be displayed", "Take the oauth2 request token and turn it into an access token\n which can be used to access private data", "Includes devise_for method for routes. This method is responsible to\n generate all needed routes for devise, based on what modules you have\n defined in your model.\n\n ==== Examples\n\n Let's say you have an User model configured to use authenticatable,\n confirmable and recoverable modules. After creating this inside your routes:\n\n   devise_for :users\n\n This method is going to look inside your User model and create the\n needed routes:\n\n  # Session routes for Authenticatable (default)\n       new_user_session GET    /users/sign_in                    {:controller=>\"devise/sessions\", :action=>\"new\"}\n           user_session POST   /users/sign_in                    {:controller=>\"devise/sessions\", :action=>\"create\"}\n   destroy_user_session DELETE /users/sign_out                   {:controller=>\"devise/sessions\", :action=>\"destroy\"}\n\n  # Password routes for Recoverable, if User model has :recoverable configured\n      new_user_password GET    /users/password/new(.:format)     {:controller=>\"devise/passwords\", :action=>\"new\"}\n     edit_user_password GET    /users/password/edit(.:format)    {:controller=>\"devise/passwords\", :action=>\"edit\"}\n          user_password PUT    /users/password(.:format)         {:controller=>\"devise/passwords\", :action=>\"update\"}\n                        POST   /users/password(.:format)         {:controller=>\"devise/passwords\", :action=>\"create\"}\n\n  # Confirmation routes for Confirmable, if User model has :confirmable configured\n  new_user_confirmation GET    /users/confirmation/new(.:format) {:controller=>\"devise/confirmations\", :action=>\"new\"}\n      user_confirmation GET    /users/confirmation(.:format)     {:controller=>\"devise/confirmations\", :action=>\"show\"}\n                        POST   /users/confirmation(.:format)     {:controller=>\"devise/confirmations\", :action=>\"create\"}\n\n ==== Options\n\n You can configure your routes with some options:\n\n  * :class_name => setup a different class to be looked up by devise, if it cannot be\n    properly found by the route name.\n\n      devise_for :users, :class_name => 'Account'\n\n  * :path => allows you to setup path name that will be used, as rails routes does.\n    The following route configuration would setup your route as /accounts instead of /users:\n\n      devise_for :users, :path => 'accounts'\n\n  * :singular => setup the singular name for the given resource. This is used as the instance variable\n    name in controller, as the name in routes and the scope given to warden.\n\n      devise_for :users, :singular => :user\n\n  * :path_names => configure different path names to overwrite defaults :sign_in, :sign_out, :sign_up,\n    :password, :confirmation, :unlock.\n\n      devise_for :users, :path_names => { :sign_in => 'login', :sign_out => 'logout', :password => 'secret', :confirmation => 'verification' }\n\n  * :controllers => the controller which should be used. All routes by default points to Devise controllers.\n    However, if you want them to point to custom controller, you should do:\n\n      devise_for :users, :controllers => { :sessions => \"users/sessions\" }\n\n  * :failure_app => a rack app which is invoked whenever there is a failure. Strings representing a given\n    are also allowed as parameter.\n\n  * :sign_out_via => the HTTP method(s) accepted for the :sign_out action (default: :get),\n    if you wish to restrict this to accept only :post or :delete requests you should do:\n\n      devise_for :users, :sign_out_via => [ :post, :delete ]\n\n    You need to make sure that your sign_out controls trigger a request with a matching HTTP method.\n\n  * :module => the namespace to find controllers (default: \"devise\", thus\n    accessing devise/sessions, devise/registrations, and so on). If you want\n    to namespace all at once, use module:\n\n      devise_for :users, :module => \"users\"\n\n    Notice that whenever you use namespace in the router DSL, it automatically sets the module.\n    So the following setup:\n\n      namespace :publisher do\n        devise_for :account\n      end\n\n    Will use publisher/sessions controller instead of devise/sessions controller. You can revert\n    this by providing the :module option to devise_for.\n\n    Also pay attention that when you use a namespace it will affect all the helpers and methods for controllers\n    and views. For example, using the above setup you'll end with following methods:\n    current_publisher_account, authenticate_publisher_account!, publisher_account_signed_in, etc.\n\n  * :skip => tell which controller you want to skip routes from being created:\n\n      devise_for :users, :skip => :sessions\n\n  * :only => the opposite of :skip, tell which controllers only to generate routes to:\n\n      devise_for :users, :only => :sessions\n\n  * :skip_helpers => skip generating Devise url helpers like new_session_path(@user).\n    This is useful to avoid conflicts with previous routes and is false by default.\n    It accepts true as option, meaning it will skip all the helpers for the controllers\n    given in :skip but it also accepts specific helpers to be skipped:\n\n      devise_for :users, :skip => [:registrations, :confirmations], :skip_helpers => true\n      devise_for :users, :skip_helpers => [:registrations, :confirmations]\n\n  * :format => include \"(.:format)\" in the generated routes? true by default, set to false to disable:\n\n      devise_for :users, :format => false\n\n  * :constraints => works the same as Rails' constraints\n\n  * :defaults => works the same as Rails' defaults\n\n ==== Scoping\n\n Following Rails 3 routes DSL, you can nest devise_for calls inside a scope:\n\n   scope \"/my\" do\n     devise_for :users\n   end\n\n However, since Devise uses the request path to retrieve the current user,\n this has one caveat: If you are using a dynamic segment, like so ...\n\n   scope \":locale\" do\n     devise_for :users\n   end\n\n you are required to configure default_url_options in your\n ApplicationController class, so Devise can pick it:\n\n   class ApplicationController < ActionController::Base\n     def self.default_url_options\n       { :locale => I18n.locale }\n     end\n   end\n\n ==== Adding custom actions to override controllers\n\n You can pass a block to devise_for that will add any routes defined in the block to Devise's\n list of known actions.  This is important if you add a custom action to a controller that\n overrides an out of the box Devise controller.\n For example:\n\n    class RegistrationsController < Devise::RegistrationsController\n      def update\n         # do something different here\n      end\n\n      def deactivate\n        # not a standard action\n        # deactivate code here\n      end\n    end\n\n In order to get Devise to recognize the deactivate action, your devise_scope entry should look like this:\n\n     devise_scope :owner do\n       post \"deactivate\", :to => \"registrations#deactivate\", :as => \"deactivate_registration\"\n     end", "Removes a Channel from the ChannelList.", "Removes a User from all Channels from the ChannelList.\n Returning a Set of Channels in which the User was.", "Returns a Set of all Users that are in one of the Channels from the\n ChannelList.", "send an pingback request to the targets associated pingback server.\n\n @param [String] source_uri the address of the site containing the link.\n @param [String] target_uri the target of the link on the source site.\n @raise [Pingback::InvalidTargetException] raised if the target is not a pingback-enabled resource\n @raise [XMLRPC::FaultException] raised if the server responds with a faultcode\n @return [String] message indicating that the request was successful", "Wind parameters in meters per second", "Calculate wind parameters, some metar string has multiple winds recorded", "Init\n Add a source to registry\n\n @param source [Fwissr::Source] Concrete source instance", "Get a registry key value\n\n @param key [String] Key\n @return [Object] Value", "Pass in the instance of the object that is using the errors object.\n\n   class Person\n     def initialize\n       @errors = ActiveModel::Errors.new(self)\n     end\n   end", "The most generic form of select.\n It calls to_s on the statement object to facilitate the use of sql builder objects.", "Simple convenience wrapper around the generic select call.\n Throws an exception unless the result set is a single row.\n Returns the row selected.", "Simple convenience wrapper around the generic select call.\n Throws an exception unless the result set is empty or a single row.\n Returns nil if the result set is empty, or the row selected.", "Rows in the result set must have 2 or more fields.\n If there are 2 fields, returns a hash where each key is the first field in the result set, and the value is the second field.\n If there are more than 2 fields, returns a hash where each key is the first field in the result set,\n and the value is the row itself, as a Hash, and without the field used as a key.", "Returns the value at key\n @param [Array<#to_s>] keys a list of keys to fetch; can be only one\n @return [Hash<String, String>] if only one key was passed, then return the value for it; otherwise returns a Ruby hash\n                                where each key in the `keys` is mapped to the value returned by redis", "Sets or updates the value at key\n @param [#to_s] key the hash key\n @param [#to_s] value the new value to set\n @return [Boolean] true if the field was set (not updated!), false otherwise", "Increments the value at the given key\n @param [#to_s] key the hash key\n @param [Integer, Float] by defaults to 1\n @return [Integer, Float] returns the incremented value", "override default url_for method. Add ability to set default params.\n\n Example:\n  'auctions_path' return '/auctions' by default\n  if you set @hash_of_additional_params = {:test => 1, my_param => 2} 'auctions_path' will return '/auctions?test=1&my_param=2'\n\nYou can use before_filer to do this stuff automatically.\n Example:\n  in HomeController:\n   before_filter { @hash_of_additional_params = {:test => '1'} } #this will add test param to all urls in home views", "Creates a new group with the given name.  You can add children\n using `<<`.\n\n @param [#to_s] name the desired name\n @param [Array,nil] args additional arguments.  Included for\n   marshalling compatibility with the base class.\n\n Determines whether this group or any of its children matches the\n given parameter for authorization purposes.\n\n @param [#to_s,Group] other the thing to compare this\n   group to\n @return [Boolean] true if the name of this group or any of its\n   children is a case-insensitive match for the other.", "Copy-pasted from parent in order to use appropriate class when\n deserializing children.\n\n @private", "Reads the content of the Google Chrome bookmarks file", "Extracts the children from the JSON file", "Evaluate the template. Compiles the template for JST\n @return [String] JST-compliant compiled version of the Handlebars template being rendered", "Run the commmand line tool puttext.\n @param [Array<String>] args the command line arguments.", "Applies changes to the document and returns stream of document with the result of comparison\n\n @param request put_changes_document_stream_request\n @return [Array<(File, Fixnum, Hash)>]\n File data, response status code and response headers", "Applies changes to the document and returns images of document with the result of comparison\n\n @param request put_changes_images_request\n @return [Array<(Array<Link>, Fixnum, Hash)>]\n Array<Link> data, response status code and response headers", "Reads definition provided as string. This string can be a YAML document. In this case\n definition is parsed and an ApplianceConfig object is returned. In other cases it tries to search\n for a file with provided name.", "Authenticates incoming requests using Warden.\n\n Additionally, this class exposes the `aker.check` environment\n variable to downstream middleware and the app.  It is an\n instance of {Aker::Rack::Facade} permitting authentication and\n authorization queries about the current user (if any).", "Determine locale from the request URL and return it as a string, it it\n is matching any of provided locales\n If locale matching failed an empty String will be returned.\n\n Examples:\n\n   #http://www.example.com/se\n   locale_from_url # => 'se'\n\n   #http://www.example.com/de/posts\n   locale_from_url # => 'se'\n\n   #http://www.example.com/ursers\n   locale_from_url # => ''", "Provides access to price items and groups using magic methods and chaining.\n\n @example\n   class Product\n     has_price do\n       item 400, \"base\"\n       group \"tax\" do\n         item 100, \"federal\"\n         item 50, \"state\"\n       end\n     end\n   end\n\n   product = Product.new\n   product.price # => Full Price object\n   product.price.base # => 400\n   product.price.tax # => Price object on group tax\n   product.price.tax.federal # => 100\n   product.price.tax.total # => 150\n\n @return [Price, Fixnum] Price object if method matches a group, Fixnum if method matches an item.", "Initialize api client\n\n @param [String] api_url\n @param [Hash] default_headers\n Get request\n\n @param [String] path\n @param [Hash,NilClass] params\n @return [Hash]", "pattern        - An Array of patterns to match tokens against.\n handler_method - A Symbole representing the method to be invoked\n   when patterns are matched.\n tokens - An Array of tokens to process.\n definitions - A Hash of definitions to check against.\n\n Returns true if a match is found.", "Register the given block to be called when the events of type +type+ will be emitted.\n if +once+, the block will be called once", "Unregister the given block. It won't be call then went an event is emitted.", "Emit an event of type +type+ and call all the registered listeners to this event.\n The +sender+ param will help the listener to identify who is emitting the event.\n You can pass then every additional arguments you'll need", "Checks services.  If all services pass muster, enters a read loop.\n\n The database parameter may be either a URL-as-string or a\n Analysand::Database.\n\n If overriding the initializer, you MUST call super.\n The URI of the changes feed.  This URI incorporates any changes\n made by customize_query.", "Returns an object that can be used to block a thread until a document\n with the given ID has been processed.\n\n Intended for testing.", "Gets called when the Guard should reload itself.\n\n @raise [:task_has_failed] when run_on_change has failed", "Resets one or more counter caches to their correct value using an SQL\n count query. This is useful when adding new counter caches, or if the\n counter has been corrupted or modified directly by SQL.\n\n ==== Parameters\n\n * +id+ - The id of the object you wish to reset a counter on.\n * +counters+ - One or more counter names to reset\n\n ==== Examples\n\n   # For Post with id #1 records reset the comments_count\n   Post.reset_counters(1, :comments)", "Search redemption codes", "Creates a new Mango application at the specified path\n @param [String] path", "A Hash of various matadata about the server", "Add a new crate.\n\n @param [String] name of the crate to add.\n @return [nil] no output from this method is expected if everything goes right.", "Create an new Client object.\n\n @param connection:\n pass in a subclass of connection which implements the `request` method\n with whichever HTTP client library you prefer.  Default is Net::HTTP.\n Authenticate to the API using a email and password.\n\n @param email\n @param credentials\n   A hash with either the `with_password` or `with_api_secret` key.", "Request a price estimate\n\n @param width  In thousands of an Inch\n @param height In thousands of an Inch\n @param layers\n @param quantity Optional Defaults to the minimum quantity", "Add a Project to an Order\n\n @param id\n @param project_id\n @param quantity", "Sign a string with a secret\n\n Sign a string with a secret and get the signature\n\n * *Args*    :\n   - +string+ -> the string to sign\n   - +secret+ -> the secret to use\n * *Returns* :\n   - the signature\n * *Raises* :\n   - +ArgumentError+ -> if no algorithm passed and algorithm could not be derived from the string", "Authenticate an authorization header\n\n Authenticates that an authorization header sent by Jive is valid given an apps secret\n\n * *Args*    :\n   - +authorization_header+ -> the entire Authorization header sent by Jive\n   - +client_secret+ -> the client secret to authenticate the header with\n * *Returns* :\n   - the signature\n * *Raises* :\n   - +ArgumentError+ -> if the authorization_header does not contain JiveEXTN\n   - +ArgumentError+ -> if the heauthorization_header does not contain all the required parameters\n   - +ArgumentError+ -> if the heauthorization_header has expired (more than 5 minutes old)", "Validates an app registration\n\n Validates an app registration came from where it claims via jiveSignatureURL\n\n * *Args*    :\n   - +validationBlock+ -> the request body of the registration\n   - +args+ -> additional arguments\n * *Returns* :\n   - boolean", "Override api key methods with proxy object", "Loads grid.css.erb file, binds it to current instance, and returns output", "Output an easily styleable key-value pair", "Build an HTML table\n For collection, pass an array of arrays\n For headers, pass an array of label strings for the top of the table\n All other options will be passed along to the table content_tag", "Pass in an ActiveRecord object, get back edit and delete links inside a TD tag", "This works just like link_to, but with one difference..\n If the link is to the current page, a class of 'active' is added", "Generate a list of column name-value pairs for an AR object", "Wrap the migration in a transaction only if supported by the adapter.", "Add the given String str and value vertically to this node, by adding or finding each character\n horizontally, then stepping down and repeating with the next character and so on, writing the\n value to the last node.", "Find the given String str vertically by finding each character horizontally, then stepping down\n and repeating with the next character and so on. Return the last node if found, or nil if any\n horizontal search fails.\n Optionally, set the offset into the string and its length", "Recursively balance this node in its own tree, and every node in all four directions,\n and return the new root node.", "Walk the tree from this node, yielding all strings and values where the\n value is not nil. Optionally, use the given prefix String str.", "Return the complete string from the tree root up to and including this node\n i.e. The total string key for this node from root.", "Return an Array of Strings of all possible partial string from this node.\n Optionally, use the given prefix String str.", "Prune the tree back from this node onward so that all leaves have values.", "Probably unneccassary - may be removed later", "Dialog content for a new page", "Update an existing page", "Move a page", "Render a given page\n\n When a \"webpath\" parameter is given it will render the page with that name.\n This is what happens when you call a page with it's pretty URL.\n\n When no \"name\" is given and an \"id\" parameter is given it will render the\n page with the given id.\n\n When no \"name\" nor \"id\" parameter is given it will render the root page.", "Render the sitemap.xml for robots", "This functions update all post fields child visibility with the current\n post field visibility.", "Register a vote for a post.\n @accessibility: public key, secret key\n @methods: POST\n @format: json, jsonp\n @authenticated: true\n @limited: false\n @param vote [Integer] Choices: -1, 0, 1\n @param post [Integer] Looks up a post by ID.\n @return [Hashie::Rash] Details on the post.\n @example Vote for post ID 12345678\n   Disqussion::Client.posts.vote(1, 12345678)\n @see: http://disqus.com/api/3.0/posts/vote.json", "Accepts the path of the YAML file to be parsed into\n commands - will throw a CommandException should it have\n invalid parameters\n\n @param filePath [String] Path for YAML file", "Remove an option.\n\n @example remove.\n  require \"pony-express\"\n  mail = PonyExpress::Mail.new\n  mail.add to: \"burns@plant.local\", cc: \"smithers@plant.local\"\n  mail.remove :cc", "Returns the Ambience config as a Hash.", "Returns a Hash generated from a JVM +property+ and its +value+.\n\n ==== Example:\n\n   hash_from_property \"webservice.auth.address\", \"http://auth.example.com\"\n   # => { \"webservice\" => { \"auth\" => { \"address\" => \"http://auth.example.com\" } } }", "Initializes word_list instance variable, precomputed_list\n assigning it a hash whose default values is an empty array.\n\n Precomputes word_list in underneath the hood. (i.e A in-process\n thread that AsyncConsumer offers. )\n\n\n Used for benchmarking", "attempts to load output settings from settings.yml", "Initializes an Executer instance with particular options\n\n   * options: A hash of options, with the following (symbol) keys:\n      * :mode:      Controls how the process' output is given to\n                    the block, one of :chars (pass each character\n                    one by one, retrieved with getc), or :lines\n                    (pass only whole lines, retrieved with gets).\n                    (optional, defaults to :lines)\n      * :no_buffer: If true, the process' stdout and stderr won't\n                    be collected in the stdout and stderr\n                    properties, and will only be passed to the\n                    block (optional, defaults to false)\n Executes <tt>command</tt> and returns after execution\n\n   * command: A string containing the command to run\n   * block:   Gets passed stdout and stderr every time the process\n              outputs to each stream (first parameter is stdout,\n              second parameter is stderr; only one will contain\n              data, the other will be nil)", "Forward signals to a process while running the given block\n\n   * pid:     The process ID to forward signals to\n   * signals: The names of the signals to handle (optional,\n              defaults to SIGINT only)", "Resets the handlers for particular signals to the default\n\n   * signals: An array of signal names to reset the handlers for", "Manages reading from the stdout and stderr streams\n\n   * stdout_stream: The process' stdout stream\n   * stderr_stream: The process' stderr stream\n   * block:         The block to pass output to (optional)", "Outputs data to the block\n\n   * data:        The data that needs to be passed to the block\n   * stream_name: The stream data came from (:stdout or :stderr)\n   * block:       The block to pass the data to", "Create a new command object from a data source\n @param datasource [CommandDataSource] The data source to use to initialize\n command object\n Begins executing the command by starting the monitor specified in\n the data source - will return immediately", "Checks whether the uri is reachable. If so it returns '200' otherwise\n 'Error'. uri has to have a host, that is uri.host should not be nil", "Register the +sock+ for +events+. This method is idempotent meaning\n it can be called multiple times with the same data and the socket\n will only get registered at most once. Calling multiple times with\n different values for +events+ will OR the event information together.\n\n @param socket\n @param events\n   One of @XS::POLLIN@ and @XS::POLLOUT@\n\n @return true if successful\n @return false if not", "Deregister the +sock+ for +events+. When there are no events left,\n this also deletes the socket from the poll items.\n\n @param socket\n @param events\n   One of @XS::POLLIN@ and @XS::POLLOUT@\n\n @return true if successful\n @return false if not", "Deletes the +sock+ for all subscribed events. Called internally\n when a socket has been deregistered and has no more events\n registered anywhere.\n\n Can also be called directly to remove the socket from the polling\n array.\n\n @param socket\n\n @return true if successful\n @return false if not", "Update readables and writeables", "declare needed overloaded methods here", "Return a Tempfile containing our ZipStream", "Creates a new Client socket.\n\n @param [:bind, :connect] mode (:connect) a mode for the socket.\n @param [Hash] options optional parameters.\n @see EZMQ::Socket EZMQ::Socket for optional parameters.\n\n @return [Client] a new instance of Client.\n\n Sends a message and waits to receive a response.\n\n @param [String] message the message to send.\n @param [Hash] options optional parameters.\n @option options [lambda] encode how to encode the message.\n @option options [lambda] decode how to decode the message.\n\n @return [void] the decoded response message.", "returns String with all the private dns of the Front End servers\n used for setting the LB_HOSTNAME input.", "Return a configuration hash for a given environment\n @param [Symbol] environment Environment for which to load the client configs\n @return [Hash]", "parse an response", "Provides a common set of address fields such as, street_address_1, street_address_2, city, state, zip_code and country as String fields.", "Merges the other domain object non-domain attribute values into this domain object's snapshot,\n An existing snapshot value is replaced by the corresponding other attribute value.\n\n @param [Jinx::Resource] other the source domain object\n @raise [ValidationError] if this domain object does not have a snapshot", "Lazy loads the attributes. If a block is given to this method, then the attributes are determined\n by calling the block with this Persistable as a parameter. Otherwise, the default attributes\n are the unfetched domain attributes.\n\n Each of the attributes which does not already hold a non-nil or non-empty value\n will be loaded from the database on demand.\n This method injects attribute value initialization into each loadable attribute reader.\n The initializer is given by either the loader Proc argument.\n The loader takes two arguments, the target object and the attribute to load.\n If this Persistable already has a lazy loader, then this method is a no-op.\n\n Lazy loading is disabled on an attribute after it is invoked on that attribute or when the\n attribute setter method is called.\n\n @param loader [LazyLoader] the lazy loader to add", "Disables lazy loading of the specified attribute. Lazy loaded is disabled for all attributes\n if no attribute is specified. This method is a no-op if this Persistable does not have a lazy\n loader.\n\n @param [Symbol] the attribute to remove from the load list, or nil if to remove all attributes", "Returns whether this domain object must be fetched to reflect the database state.\n This default implementation returns whether this domain object was created and\n there are any autogenerated attributes. Subclasses can override to relax or restrict\n the condition.\n\n @quirk caCORE The auto-generated criterion is a necessary but not sufficient condition\n   to determine whether a save caCORE result reflects the database state. Example:\n   * caTissue SCG event parameters are not auto-generated on SCG create if the SCG collection\n     status is Pending, but are auto-generated on SCG update if the SCG status is changed\n     to Complete. By contrast, the SCG specimens are auto-generated on SCG create, even if\n     the status is +Pending+.\n\n   The caBIG application can override this method in a Database subclass to fine-tune the\n   fetch criteria. Adding a more restrictive {#fetch_saved?} condition will will improve\n   performance but not change functionality.\n\n @quirk caCORE A saved attribute which is cascaded but not fetched must be fetched in\n   order to reflect the database identifier in the saved object.\n\n TODO - this method is no longeer used. Should it be? If not, remove here and in catissue\n subclasses.\n\n @return [Boolean] whether this domain object must be fetched to reflect the database state", "Adds this Persistable lazy loader to the given attribute unless the attribute already holds a\n fetched reference.\n\n @param [Symbol] attribute the attribute to mod\n @return [Boolean] whether a loader was added to the attribute", "Loads the reference attribute database value into this Persistable.\n\n @param [Symbol] attribute the attribute to load\n @return the attribute value merged from the database value", "Disables the given singleton attribute accessor method.\n\n @param [String, Symbol] name_or_sym the accessor method to disable", "renders sass files", "renders scss files", "Defines and runs the command line interface.\n\n @see #program_information\n @see #configure_global_option\n @see #directory_global_option\n @see InitializeCommand.define\n @see BenchCommand.define\n @see BuildCommand.define\n @see ServeCommand.define\n @return [void]", "The program information.  This is for use with Commander.\n\n @return [void]", "Creates a progress bar on the terminal based off of the given array.\n This mostly passes everything on to the `progress` method provided by\n Commander, but with a few options added.\n\n @param array [::Array] The array of items that are being processed.\n @yield [item] Once for every item in the array.  Once the block ends,\n   the progress bar increments.\n @yieldparam item [::Object] One of the items in the array.\n @return [void]", "Fills the matrix with the alignment map.", "fill\n Traces backward, finding the alignment.\n @yield [i,j,step]\n @yieldparam i [Integer] The location in sequence one\n @yieldparam j [Integer] The location in sequence two\n @yieldparam step [Integer] The direction we took", "We get transaction_id from FirstData and if ok, then we redirect to web interface", "there we land after returning from FirstData server\n then we get transactions result and redirect to your given \"finish\" path", "Creates javascript objects to use as hashes for flot graph data series + labels", "evaluates the Callback in the specified context\n @param  context\n @param  [Array] args\n @param  [Proc] block\n @return [Array]", "Define an attribute accessor.\n\n @param name [String]\n   attribute name\n @param type [String]\n   attribute type\n @return [void]", "Create and manage a temp file, replacing `fname` with the temp file, if `fname` is provided.", "Write an array of strings to a file, adding newline separators, and\n ensuring a trailing newline at the end of a file.", "We're using Tay's CLI helpers and they expect string optiopns with\n dashes, rather than symbols and underscores. So munge!", "Searches the record for the specified attribute and returns\n the text content. This method is called when you access an\n attribute of a record\n\n @return [String] the text content of the specified attribute\n\n @raise [AttributeNotFound] when the attribute is not found in the record", "Searches the record for the specified attribute and sets the value of the attribute\n This method is called when you set an attribute of a record\n\n @return [Capybara::Result] the text content of the specified attribute\n\n @raise [AttributeNotFound] when the attribute is not found in the record\n @raise [NotInputField] when the attribute is not a `TEXTAREA` or `INPUT` tag", "Used to set more tracking for akismet", "Calls Object.remove_const on all tracked modules. Also clears the compiler's list of user-defined helpers.", "Similar in purpose to +expand_hash_conditions_for_aggregates+.", "4 decimal places", "Parse all the collected files to find tasks\n and populate the tasks hash", "Methods starting with an asterisk are tested for DSL defined conditions", "Return the filesystem path for the source", "Remove files from Jekyll's static_files array", "Given a token, get id from tokens list", "API to use inside the recipe\n\n @api public\n Run a command inside the build directory. In most cases it is not needed to call this method\n directly. Look at the other helper methods.\n\n The method expects as arguments the program name and additional parameters for the program.\n The arguments can be group with arguments, but must not:\n @example\n   exec 'echo', %w(a b)\n   exec ['echo', 'a', 'b']\n   exec 'echo', 'a', 'b'\n @raise [CommandExecutionFailed] if the executed program exists with a\n   non-zero exit code.", "Registers a dependency which is resolved every time its value is fetched.", "Registers a dependency which is only resolved the first time its value is\n fetched. On subsequent fetches, the cached value is returned.", "Takes an array or hash specifying the dependencies to export, and returns\n a module which defines getters for those dependencies.\n\n   class Test\n     # hash (specify visibilities)\n     include Services.mixin private: :foo, protected: %i[bar baz], public: :quux\n\n     # or an array of imports using the default visibility (:private by default)\n     include Services.mixin %i[foo bar baz quux]\n\n     def test\n       foo + bar + baz + quux # access the dependencies\n     end\n   end\n\n The visibility of the generated getters can be controlled by passing a hash\n with { visibility => imports } pairs, where imports is an array of import\n specifiers. An import specifier is a symbol (method name == dependency name)\n or a hash with { dependency_name => method_name } pairs (aliases). If\n there's only one import specifier, its enclosing array can be omitted e.g.:\n\n   include Services.mixin(private: :foo, protected: { :baz => :quux })\n\n is equivalent to:\n\n   include Services.mixin(private: [:foo], protected: [{ :baz => :quux }])", "Create a module with the specified exports", "execute CLI commands over NETCONF transport\n returns plain text, rather than XML, by default\n\n @param cmd_str [String] A valid Junos CLI command.\n @param attrs [Hash] Supports same attributes as\n {http://rubydoc.info/gems/netconf/Netconf/RPC/Junos:command Junos#command}\n @return nil if command returns no text. Otherwise returns text\n in format requested (default is plain text)", "Simplifies applying configuration to a Junos device.\n Uses Junos NETCONF extensions to apply the configuration.\n Returns to the previous committed config if any arror occurs\n\n @param config [String] Configuration to be applied the device\n @param attrs [Hash] Takes same attributes as\n {http://rubydoc.info/gems/netconf/Netconf/RPC/Junos:load_configuration Junos#load_configuration}", "Adds a patch to the set. Raises ContradictionError in case\n if patch set already contains a patch with the same name and\n different content.\n\n patch :: Patch object to add", "Looks up a signature of a patch by its name.", "Creates a new Engine object.\n\n db :: must be one of:\n * instance of Sequel::Database class\n * database URL that can be passed to Sequel.connect()\n\n\n Registers patch files in the engine.\n\n filename :: may be either a name of .sql file or a name\n of directory (which would be recursively scanned for .sql\n files)", "Produces an ordered list of patches that need to be applied.\n\n May raise MismatchError in case if signatures of any permanent\n patches that are present in the definition don't match\n ones of the patches applied to the database.", "Validates that all patches are applied to the database.\n\n May raise MismatchError, NotConfiguredError or NotAppliedError\n in case if there are any problems.", "this is where ALL the generic application server checks live, this could get rather long but for now it's a single method with a sequence of checks", "Renews the given sender if it is still valid within the session and raises\n an exception otherwise.\n\n @raise [UnknownSender] if the given sender is not registered.\n @raise [InvalidSender] if the given sender is not valid.\n\n @param  sender [Socket::UDPSource] the udp client.\n @param  time [Numeric] the current time. The current time will be used if\n   not specified.\n @return [nil]", "This function shows the view to create a new tag.", "This function creates a new tag.", "This function show the view to edit a tag.", "This function updates a tag.", "This function destroyes a tag.", "def simulate!\n   puts \"simulator not implemented...\"\n end", "Method which kick start the consumer process thread", "Processes given parameter into the defined options previously declared\n includes validation for types and any custom validators delcared\n\n @param [Hash<String,Object>] Hash of option name/value pairs, values\n must conform to validation rules for options or exception will be raised", "Set up the initial values.\n Write out a general string with page pauses.", "Write out a simple string with no embedded new-lines.", "Pause waiting for the user.", "Used to allow performing API requests in parallal instead of series", "Returns the scheduled occurrence that matches the specified time", "Returns the list of files in the directories provided", "Returns the total size of the directories provided", "uses SharedDns to find an available set of DNS records and sets them on the deployment", "find node by full node_name or by matching prefix of node_name", "Constructor of the classe, receiving the datas to validate and filter.\n @param [Hash] datas the datas to validate in the validator.\n @example create a new instance of validator.\n   @validator = Kharon::Validator.new({key: \"value\"})\n Method used to not directly define the different type validation methods, but instead to look for it in the processors list.\n @param [String] name the name of the not found method.\n @param [Array] arguments the arguments passed to the not found method when it's called.\n @param [Proc] block the block that might have been passed to the not found method when it's called.", "perform an HTTP request to rackpsace.\n\n request is a Net::HTTP request object.\n This can be called with and without a block. Without a block, the response\n is returned as you'd expect\n\n     response = http_client.cloud_request(request)\n\n With the block form, the response is yielded to the block:\n\n     http_client.cloud_request(request) do |response|\n       puts response\n     end", "Overrides ruby's method_missing to allow creation of URLs through method calls.\n\n @example Adding a simple URL part\n   request = Parliament::Request::UrlRequest.new(base_url: 'http://example.com')\n\n   # url: http://example.com/people\n   request.people\n\n @example Adding a simple URL part with parameters\n   request = Parliament::Request::UrlRequest.new(base_url: 'http://example.com')\n\n   # url: http://example.com/people/123456\n   request.people('123456')\n\n @example Chaining URL parts and using hyphens\n   request = Parliament::Request::UrlRequest.new(base_url: 'http://example.com')\n\n   # url: http://example.com/people/123456/foo/bar/hello-world/7890\n   request.people('123456').foo.bar('hello-world', '7890')\n\n @param [Symbol] method the 'method' (url part) we are processing.\n @param [Array<Object>] params parameters passed to the specified method (url part).\n @param [Block] block additional block (kept for compatibility with method_missing API).\n\n @return [Parliament::Request::UrlRequest] self (this is to allow method chaining).", "Traject context.output_hash values are arrays.\n turn them into good column values, joining strings if needed.\n\n Single values also accepted, even though not traject standard, they\n will be passed through unchanged.", "Call a method on a klass with certain arguments.\n Will validate arguments first before calling method.", "Check if passed-in arguments are valid for a specific format", "Respond to the user in the instance of invalid arguments.", "Create a commands map to respond to `conify help` with.", "Format a map of commands into help output format", "Return just the basename for a file, no extensions.", "Feturn an array of all command file paths, with the exception of abstract_command.rb", "register a command's info to the @@commands map - utilized when calling `conify help`", "taken from octopress", "Save the box.\n\n @return [Hash] Atlas response object.", "Builds internal bitwise key-value mapping it add a zero value, needed for bits operations.\n Each sym get a power of 2 value", "Creates a new instance to shorten Firefly URLs\n\n +url+ is the URL to your Firefly server. E.g. \"http://aj.gs\".\n Note: do not include a trailing slash\n +api_key+ is your Firefly API Key.\n Shortens the given URL or array of URLs.\n\n    shorten(\"http://google.com\") => \"http://aj.gs/7dZ\"\n\n    shorten([\"http://google.com\", \"http://yahoo.com\"])\n\t\t\t\t=> { \"http://google.com/\" => \"http://aj.gs/7dZ\",\n            \"http://yahoo.com/\"  => \"http://aj.gs/8Yt\" }", "Shortend +long_url+ and returns the short_url on success", "Transforms values to UpperCamelCase or PascalCase.\n\n @example:\n    \"some_key\" => \"SomeKey\",", "Transforms values to camelCase.\n\n @example:\n    \"some_key\" => \"someKey\",", "Transforms values to dashed-case.\n This is the default case for the JsonApi adapter.\n\n @example:\n    \"some_key\" => \"some-key\",", "Transforms values to underscore_case.\n This is the default case for deserialization in the JsonApi adapter.\n\n @example:\n    \"some-key\" => \"some_key\",", "=> find weather by city or by gps position", "Checks for request comes with right header.", "Parses command line options into an options hash\n @api public\n @example Options.new.parse(\"todo_lint -c app.rb\")\n @param args [Array<String>] arguments passed via the command line\n @return [Hash] parsed options", "Adds the excluded file options to the options hash\n @api private\n @return [Hash]", "test if a particular category has a certain subject", "Parses the given field specification.\n\n @param [String] label the configuration field specification key\n @param [{String => String}] spec the configuration field specification value\n Returns this field's HTML input element attributes and target caTissue properties.\n\n The attributes are determined by the field configuration as follows:\n * +id+: this field's HTML input element id\n * +type+: this field's type\n * +checked+: +true+ if the field type is +checkbox+ and the field default is set\n * +name+: if the field type is not +checkbox+, then this field's name\n\n @param [String, nil] value the request parameter value\n @return [{Symbol => String}] the form input element attributes", "Call geo location adwords service\n\n @example\n   account.geo_location(\"Via Conca del Naviglio\", \"Milano\", \"IT\")\n   account.geo_location( geoLocationSelector )", "Updates all records with details given if they match a set of conditions supplied, limits and order can\n also be supplied. This method constructs a single SQL UPDATE statement and sends it straight to the\n database. It does not instantiate the involved models and it does not trigger Active Record callbacks\n or validations.\n\n ==== Parameters\n\n * +updates+ - A string, array, or hash representing the SET part of an SQL statement.\n * +conditions+ - A string, array, or hash representing the WHERE part of an SQL statement.\n   See conditions in the intro.\n * +options+ - Additional options are <tt>:limit</tt> and <tt>:order</tt>, see the examples for usage.\n\n ==== Examples\n\n   # Update all customers with the given attributes\n   Customer.update_all :wants_email => true\n\n   # Update all books with 'Rails' in their title\n   Book.update_all \"author = 'David'\", \"title LIKE '%Rails%'\"\n\n   # Update all avatars migrated more than a week ago\n   Avatar.update_all ['migrated_at = ?', Time.now.utc], ['migrated_at > ?', 1.week.ago]\n\n   # Update all books that match conditions, but limit it to 5 ordered by date\n   Book.update_all \"author = 'David'\", \"title LIKE '%Rails%'\", :order => 'created_at', :limit => 5\n\n   # Conditions from the current relation also works\n   Book.where('title LIKE ?', '%Rails%').update_all(:author => 'David')\n\n   # The same idea applies to limit and order\n   Book.where('title LIKE ?', '%Rails%').order(:created_at).limit(5).update_all(:author => 'David')", "Return an array of formatted export values for the passed methods", "Reloads the environment. This will re-evaluate the config file &\n clear the current cache.", "Removes the sprocket with the given name. This is useful if\n you don't need one of the default Sprockets.", "Appends the given +path+ to the given +sprocket+\n This makes sure the path is relative to the `root` path\n or an absolute path pointing somewhere else. It also\n checks if it exists before appending it.", "Appends the given `Array` of +paths+ to the given +sprocket+.", "Returns the Javascript compression engine, based on\n what's set in `config.js_compressor`. If `config.js_compressor`\n is nil, let Tilt + Crush decide which one to use.", "Returns the CSS compression engine, based on\n what's set in `config.css_compressor`. If `config.css_compressor`\n is nil, let Tilt + Crush decide which one to use.", "Initialize a client to a VideoGranulate node\n\n @param [Hash] options used to connect to the VideoGranulate node\n @options options [String] host to connect\n @options options [String] port to connect\n @options options [String] user to authenticatie with\n @options options [String] password to the refered user\n\n @return [Client] the object itself\n @example\n   videogranulate = NSIVideoGranulate::Client.new host: 'localhost', port: '8886', user: 'test', password: 'test'\n\n @note if you had used the 'configure' method, you can use it without parameters\n       and those you provided before will be used (see Client#configure)\n Send a video be granulated by a nsi.videogranulate node\n\n @param [Hash] options used to send a video to be graulated\n @option options [String] file the base64 encoded file to be granulated\n @option options [String] sam_uid the UID of a video at SAM\n @option options [String] filename the filename of the video\n @note the filename is very importante, the videogranulate node will use the proper coding/encoding option for the video type\n @option options [String] video_link link to the video that'll be granulated\n @note if provided both video_link and file options, file will be ignored and the client will download the video instead\n @option options [String] callback a callback url to the file granulation\n @option options [String] verb the callback request verb, when not provided, nsi.videogranulate defaults to POST\n\n @example A simple granulation\n   require 'base64'\n   video = Base64.encode64(File.new('video.ogv', 'r').read)\n   response = nsivideogranulate.granulate(:file => video, :filename => 'video.ogv')\n   nsivideogranulate.done(response[\"video_key\"])\n   nsivideogranulate.grains_keys_for(response[\"video_key\"])\n @example Granulating from a SAM uid\n   video = Base64.encode64(File.new('video.ogv', 'r').read)\n   response = sam.store({:doc => doc})\n   video_key = response[\"key\"]\n   response = nsivideogranulate.granulate(:sam_uid => video_key, :filename => 'video.ogv')\n   nsivideogranulate.done(response[\"video_key\"])\n   nsivideogranulate.grains_keys_for(response[\"video_key\"])\n @example Downloading and granulating from web\n   response = nsivideogranulate.granulate(:video_link => 'http://google.com/video.ogv')\n   nsivideogranulate.done(response[\"video_key\"])\n   nsivideogranulate.grains_keys_for(response[\"video_key\"])\n @example Sending a callback url\n   video = Base64.encode64(File.new('video.ogv', 'r').read)\n   nsivideogranulate.granulate(:file => video, :filename => 'video.ogv', :callback => 'http://google.com')\n   nsivideogranulate.granulate(:video_link => 'http://google.com/video.ogv', :callback => 'http://google.com')\n @example Using a custom verb to the callback\n   video = Base64.encode64(File.new('video.ogv', 'r').read)\n   nsivideogranulate.granulate(:file => video, :filename => 'video.ogv', :callback => 'http://google.com', :verb => \"PUT\")\n   nsivideogranulate.granulate(:video_link => 'http://google.com/video.ogv', :callback => 'http://google.com', :verb => \"PUT\")\n\n @return [Hash] response\n   * \"video_key\" [String] the key to access the granulated video in the sam node it was stored\n\n @raise NSIVideoGranulate::Errors::Client::MissingParametersError when an invalid or incomplete set of parameters is provided\n @raise NSIVideoGranulate::Errors::Client::SAMConnectionError when cannot connect to the SAM node\n @raise NSIVideoGranulate::Errors::Client::AuthenticationError when invalids user and/or password are provided\n @raise NSIVideoGranulate::Errors::Client::KeyNotFoundError when an invalid sam_uid is provided", "Return the keys of the grains of a video\n\n\n @param [String] key of the desired video\n @return [Hash] response\n   * \"images\" [String] keys to the images grains of the video\n   * \"files\" [String] keys to the files grains of the video\n\n @example\n   nsivideogranulate.grains_keys_for(\"some key\")\n\n @raise NSIVideoGranulate::Errors::Client::SAMConnectionError when cannot connect to the SAM node\n @raise NSIVideoGranulate::Errors::Client::AuthenticationError when invalids user and/or password are provided\n @raise NSIVideoGranulate::Errors::Client::KeyNotFoundError when an invalid key is provided", "set exec path", "Determines whether the incoming request arrived within the timeout\n window.  If it did, then the request is passed onto the rest of the Rack\n stack; otherwise, the user is redirected to the configured\n logout path.", "Builds promise from this future\n @api private\n @param depending_job [Conflow::Job] job which will use new promise\n @param param_key [Symbol, String] key in result hash that holds promised value\n @return [Conflow::Promise] promise object", "ActiveSupport seemed to cause problems when just using as_json, so using to_hash", "Helper to not call to_hash with the wrong number of arguments", "Iterate over the response data and initialize the attributes", "used when creating a new metadata file for a static XML file\n\n @return [Doc] returns self as XML document", "Improves basic non-language specific issues in typography.\n\n @param input [String] The paragraph which will be converted.\n @param convert [Array] Array of symbols with features that should be improved (possibilities: +all+, +hyphens+, +quotes+, +ellipsis+, +dashes+, +abbreviations+, +prepositions+, +numbers+, +dates+, +characters+, +brackets+, +multiplication+, +units+, +widows+)\n @return [String] Paragraph with improved typography.", "Fixes spaces around various brackets.\n\n @param input [String] The paragraph which will be converted.\n @return [String] Paragraph with correct spaces around brackets.", "require and initialize different instance\n depending on string regex", "Send Emails using mandrill api\n @param [Text] email Email Address of the receiver\n @param [Text] subject Subject of Email\n @param [Hash] opt Hash contain other message details", "Parse the available fields out of the Debian control file.", "this allows you to chain scopes\n the 2+ scopes in the chain will be called\n on a query object and not on the base object", "Subscribe to changes to a document", "Send out initial versions", "Loads the files to be read\n @return [Array<String>]\n @example cli.load_files(file_finder)\n @api public", "Print report of todos in codebase, then exit\n\n @return by exiting with 0\n @api private", "If there is a header in the set with a key matching _key_, then set its value to _value_.\n If there is no header matching _key_, create a new header with the given key and value.", "Removes any headers with key names matching _key_ from the set.", "The before_filter which processes necessary data for\n +acts_as_referred+ - models", "Prevents more workers from being created and waits for all jobs\n to finish. Once the jobs have completed the workers are terminated.\n\n To start up again just QueueToTheFuture::schedule more jobs once\n this method returns.\n\n @param [true, false] force If set to true, shutdown immediately\n   and clear the queue without waiting for any jobs to complete.", "Creates a Coach client for the cyber coach webservcie.\n\n @param [Client] client\n @param [ResponseParser] response_parser\n @param [Boolean] debug\n @return [Coach]\n\n Authenticates a user against the Cyber Coach Webservice.\n\n @param username\n @param password\n @return [User]\n\n ====Example\n @example\n   @coach.authenticate('arueedlinger', 'test')", "Tests if the user given its username exists..\n\n @param username\n @return [Boolean]\n\n ====Examples\n @example\n   @coach.user_exsists?('arueedlinger')", "Creates a user with public visibility as default.\n\n @param [Hash] options\n @param [Block] block\n @return [User]\n\n ====Examples\n @example\n   @coach.create_user do |user|\n     user.real_name= 'the hoff'\n     user.username= 'wantsomemoney'\n     user.password= 'test'\n     user.email= 'test@test.com'\n     user.public_visible= 2\n   end", "Deletes a user.\n\n @param [User\\String] user\n @param [Hash] options\n @return [Boolean]\n\n ====Examples\n @example\n   @coach.delete_user(user)\n @example\n   @coach.delete_user('arueedlinger')", "Creates a partnership with public visibility as default.\n\n @param [User|String] first_user\n @param [User|String] second_user\n @param [Hash] options\n @return [Partnership]\n\n ====Examples\n @example\n   @coach.create_partnership('arueedlinger','wanze2')\n\n @example\n   @coach.create_partnership('arueedlinger','wanze2') do |p|\n      p.public_visible = Coach4rb::Private\n   end", "Deletes a partnership\n\n @param [Partnership] partnership\n @param [Hash] options\n @return [Boolean]", "Breaks up a partnership between two users.\n\n @param [User|String] first_user\n @param [User|String] second_user\n @param [Hash] options\n @return [Boolean]", "Creates a subscription with public visibility as default.\n\n @param [User|Partnership|String] user_partnership\n @param [String] sport\n @param [Hash] options\n @param [Block] block\n @return [Subscription]\n\n ====Examples\n @example\n   @coach.create_subscription(user, :boxing) do |subscription|\n     subscription.public_visible = Coach4rb::Privacy::Public\n   end\n\n @example\n   @coach.create_subscription(user, :boxing)\n\n @example\n   partnership = @coach.partnership 'arueedlinger', 'asarteam5'\n   @coach.subscribe(partnership, :running)", "Creates an entry with public visibility as default.\n\n @param [User|Partnership|String] user_partnership\n @param [Hash] options\n @param [Block] block\n @return [Entry|Boolean]\n\n ====Examples\n @example\n   entry = @coach.create_entry(@user, :running) do |e|\n      e.comment = 'test'\n      e.number_of_rounds = 10\n      e.public_visible = Coach4rb::Privacy::Public\n   end\n\n @example\n   entry = @coach.create_entry(@user, :soccer) do |e|\n     e.comment = 'test'\n     e.number_of_rounds = 10\n   end", "Updates an entry.\n\n @param [Entry|String] entry\n @param [Hash] options\n @param [Block] block\n @return [Entry|Boolean]\n\n ====Examples\n @example\n   entry = @coach.entry_by_uri '/CyberCoachServer/resources/users/wantsomemoney/Running/1138/'\n   updated_entry = @proxy.update_entry(entry) do |entry|\n     entry.comment = 'Test!!'\n   end\n\n @example\n   uri = '/CyberCoachServer/resources/users/wantsomemoney/Running/1138/'\n   res = @proxy.update_entry(uri) do |entry|\n     entry.comment = 'Test!'\n   end", "Deletes an entry..\n\n @param [Entry|String] entry\n @param [Hash] options\n @return [Boolean]", "Retrieves a user by its username.\n\n @param [String|User] username | user\n @param [Hash] options\n @return [User]\n\n ====Examples\n @example\n   user = @coach.user a_user\n @example\n   user = @coach.user 'arueedlinger'\n @example\n   user = @coach.user 'arueedlinger', query: { start: 0, soze: 10 }", "Retrieves a user by its uri.\n\n @param [String] uri\n @param [Hash] options\n @return [User]\n\n ====Examples\n\n @example\n   user = @coach.user_by_uri '/CyberCoachServer/resources/users/arueedlinger', query: { start: 0, soze: 10 }\n @example\n   user = @coach.user_by_uri '/CyberCoachServer/resources/users/arueedlinger'", "Retrieves users.\n\n @param [Hash] options\n @return [PageResource]\n\n ====Examples\n @example\n   users = @coach.users\n @example\n   users = @coach.users query: { start: 0, size: 10}", "Retrieves a partnership by its uri.\n\n @param [String] uri\n @param [Hash] options\n @return [Partnership]\n\n ====Examples\n @example\n   partnership = @coach.partnership_by_uri '/CyberCoachServer/resources/partnerships/arueedlinger;asarteam5/'", "Retrieves a partnership by the first username and second username.\n\n @param [String] first_username\n @param [String] second_username\n @param [Hash] options\n @return [Partnership]\n\n ====Examples\n @example\n   partnership = @coach.partnership 'arueedlinger', 'asarteam5'", "Retrieves partnerships.\n\n @param [Hash] options\n @return [PageResource]\n\n ====Examples\n @example\n   partnerships = @coach.partnerships\n @example\n   partnerships = @coach.partnerships query: { start: 0, size: 10}", "When given `GET` to the configured logout path, builds a Rack\n response containing the login form with a \"you have been logged\n out\" notification.  Otherwise, passes the response on.\n\n @return a finished Rack response", "Adds rendering option.\n\n ==render :super\n\n This renders the \"super\" template, i.e. the one hidden by the plugin", "Find out bind mount paths", "Build the spawn command", "during a fresh query, we need to actually use the unobfuscated_query", "Returns the default locale as a string for a given ip_address, with the first part representing the language, the second part the country\n\n This method comes in handy when you want to preselect the language and country when your customer creates a payment on your website.\n\n = Example:\n    # We take an ip-address from Great Britain for example:\n    ip = \"212.58.226.75\"\n    @price_setting.locale_string_for_ip(ip)\n    => 'en-GB'\n\n Also see {#locale_for_ip}\n @param [String] ip an ip-address (e.g. from your site's visitors)\n @return [String] a string that represents the default locale for the given IP, in a language-country format.", "Returns a country as a Hash, if the country of the given IP has been configured for your Price Setting.\n\n If the country of the given IP has been configured for this Price Setting, it returns a hash with *:country* and *:locale* subhashes, else it returns *nil*.\n\n @param [String] ip an ip-address (e.g. from your site's visitors)\n @return [Hash] a hash containing *:country* and *:locale* subhashes", "Returns an array of payment methods that are available to your Price Setting with a given locale\n\n @param [Hash] options an options-hash that can take an *:amount* option, in case you want to use dynamic amounts\n @return [Array] an array of payment methods, each represented by a hash.\n @raise [Zaypay::Error] in case you call this method before setting a locale", "Creates a payment on the Zaypay platform.\n\n You can provide an options-hash, which will add additional data to your payment. The following keys have special functionalities:\n\n   :amount        # Enables dynamic pricing. It must be an integer representing the price in cents.\n   :payalogue_id  # Adds the URL of the payalogue specified to your payment as :payalogue_url.\n\n Any other keys will be added to a key named :your_variables, which can be used for your future reference. Please check the {file:/README.rdoc README} for the structure of the payment returned.\n\n = Example:\n    @price_setting.create_payment(:payalogue_id => payalogue_id, :amount => optional_amount, :my_variable_1 => \"value_1\", :my_variable_2 => \"value_2\")\n\n @param [Hash] options an options-hash that can take an *:amount*, *:payalogue_id* as options, and any other keys can be used as your custom variables for your own reference\n @return [Hash] a hash containing data of the payment you just created\n @raise [Zaypay::Error] in case you call this method before setting a *locale* or a *payment_method_id*", "Registers a new dependency with the given key.\n You can specify either an object or a factory block\n that creates an object.\n\n @param key [Object] Typically a class or a symbol.\n @param object [Object]\n @yield passed arguments when loading\n @return [Dio::Injector] self", "Inject dependencies to the given object.\n\n @param target [Object]\n @return target", "Creates a new instance of the given class.\n Dio injects dependencies to the created instance.\n\n @param clazz [Class]\n @param args [Array]\n @return Instance of clazz", "Setup scopes for Bitmask attributes\n\n Scopes are setup with the same name as the value, and include both\n .value and .not_value versions\n @arg [Symbol] bitmask the name of the bitmask attribute", "Setup virtual attributes for Bitmask attributes\n\n Allows you to set and read Bitmask attributes using #value= and\n #value methods\n @arg [Symbol] bitmask the name of the bitmask attribute", "Format a hash. If @options[:indent] if negative left align hash keys.\n------------------------------------------------------------------------------", "Entry point to HTTP request\n Set the username of basic auth to the API Key attribute.", "Load IxN file, start all protocols and then start traffic", "Clear all Ixia stats. This removes \"invalid\" drops observed", "Stop Ixia traffic flows and gather Ixia stats", "Just run protocols. Do not start traffic", "Asserts the version string has been changed in your iOS XCode project.\n\n @example Assert the version string changed for your iOS project\n    # Calls Danger `fail` if the version string not updated or nothing if it has changed.\n   ios_version_change.assert_version_changed(\"ProjectName/Info.plist\")\n\n @param [String] info_plist_file_path\n        Path to Info.plist file for XCode project.\n @return [void]", "Parameter Evaluation Logic\n\n This evaluates the parameters passed to the initializer.\n\n\n Root evaluation method.", "Sanitize the event params.\n Prevents passing values that could cause errors later in Announcer.", "Sanitize an array.", "Sanitize an individual value.", "the container for the files that could not be processed\ninitialize the class with the folders to be processed\n Validates the supplied folders ensuring they exist", "`replay.attributes.events` has plenty of handy information. Here we\n simply deserialize all the attributes, taking into account a format\n change that took place in build 17326, for later processing.", "Several pieces of information come from `replay.attributes.events`, and\n finding one of them is about as hard as finding all of them, so we just\n find all of them here when asked.", "Create apple push notifications to be sent out\n\n * *Args*\n   - +tokens+      -> User's being sent to\n   - +message+     -> Message sent to tokens\n   - +data+        -> Custom data passed through the push notification\n   - +badge_count+ -> Number to place in badge (default is 0)", "Send out the push notifications", "Initialization\n Create the XML and return XML string", "Make and return a single node", "Make multiple nodes, appending to the parent passed to the method", "Create the header for an object", "Returns SEO data as defined in in seo.json", "provides a slick way to add classes inside haml attribute collections\n\n examples:\n   %div{add_class(\"current\")}\n   #=> adds the \"current\" class to the div\n\n   %div{add_class(\"current\", :if => current?)}\n   #=> adds the \"current\" class to the div if current? method\n\n   %div{add_class(\"highlight\", :unless => logged_in?)}\n   #=> adds the \"highlight\" class to the div unless logged_in? method returns true", "Wrap a delete link", "Returns meta data as Hash with header name as key", "Add two tables\n @throws if header or properties do not match", "adds a column with given name to the far right of the table\n@throws if given column name already exists", "uploads a TrackUpload object, returns a TrackUser object", "get song with specific id", "returns a Soundwave object with peak data", "returns an array of ListItem objects of categories", "returns 20 tracks from a specified search in an array of Track objects", "returns featured tracks in an array of Track objects", "Get the status of the model", "The value of the objective function", "Add a new variable to the model", "Add a new constraint to the model", "Construct a matrix of values for the given list of constraints", "Convert an array of objects to an FFI array of\n memory pointers to the names of each object", "This function serializes a complete version of the post.", "This function serializes the list of fields for the post.", "This function serializes the list of categories for the post.", "This function serializes the list of tags for the post.", "This function serializes other informations for the post.", "Sets Exception instance attributes.", "Get swapped matrix, check him in closed and open list", "Get all possible movement matrixes", "In general, MPQ archives start with either the MPQ header, or they start\n with a user header which points to the MPQ header. StarCraft 2 replays\n always have a user header, so we don't even bother to check here.\n\n The MPQ header points to two very helpful parts of the MPQ archive: the\n hash table, which tells us where the contents of files are found, and the\n block table, which holds said contents of files. That's all we need to\n read up front.\n Both the hash and block tables' contents are hashed (in the same way), so\n we need to decrypt them in order to read their contents.", "To read a file from the MPQ archive, we need to locate its blocks.", "Assemble the given input.", "Sets Log instance attributes.", "Sets the default action to create a new resource. If the resource is\n singular, sets the parent resource `id` as well.", "Do the search, output the results and prompt the user for what to do next.\n Returns false on error or the user enters 'q', otherwise returns true to\n signify to the main loop it should run again.", "Format a list of options", "Format the list of results with header information", "Set the prompt after the results list has been printed", "Runs a task or prints its help if it needs arguments\n\n @param argv [Array] Command line arguments\n @return [Object, nil] Anything the task returns", "Builds a task and prepares it to run\n\n @param argv [Array] Command line arguments\n @return [Anvil::Task] A task ready to run", "remove all values from cache\n\n if _base_ is given, only values with keys matching the base (using\n <tt>===</tt> operator) are removed", "store new value in cache\n\n see also Cache#fetch_or_add", "send debug output to syslog if enabled", "If any key is not present in coll, raise AssertionFailureError,\n else return nil.\n\n @example Passing\n   assert_keys {a: 2, b: 1}, :a, :b\n   #=> nil\n\n @example Failing\n   assert_keys {a: 2, b: 1}, :a, :b, :c\n   # raises AssertionFailureError\n\n @param coll [#[]] collection of things\n @param *keys keys to check for\n\n @raise [AssertionFailureError] if coll does include every key\n @raise [ArgumentError] if coll doesn't respond to :[]\n\n @return [nil] if coll has every key", "If coll is given length, return nil, else raise\n AssertionFailureError.\n\n @param coll [#length] anything that responds to :length\n @param len [Number] the length to check for\n\n @raise [AssertionFailureError] if length of coll doesn't match\n   given len\n @raise [ArgumentError] if coll doesn't respond to :length\n\n @return [nil] if length of coll matches given len", "compile a ejs file into javascript", "compile a string containing ejs source into javascript", "Assert PROV.SoftwareAgent and PROV.generatedAtTime", "Regexp search to find an object matching a string, if it belongs to @iri\n @param id [String] A string literal used to construct a Regexp\n @return [RDF::URI] The first object matching the Regexp", "Regexp search to find a subject matching a string\n @param id [String] A string literal used to construct a Regexp\n @return [RDF::URI] The first subject matching the Regexp", "Creates a new manifest. Note that the prefix, field, and entry arrays are\n copied on initialization, as are the individual entry hashes.\n\n @param conformance [String] the conformance level. Defaults to {CHECKM_0_7}.\n @param profile [URI, String] the profile URI. Must begin with\n @param prefixes [Hash{String,Symbol => URI, String}] a map from namespace prefixes to their URIs\n @param fields Array<String> a list of field names, in the form prefix:fieldname\n @param entries [Array<Hash<String, Object><] A list of entries, each of which is a hash keyed by\n   a prefixed fieldname defined in `fields`. Nil values are allowed.\n @raise [ArgumentError] if `profile` does not begin with {PROFILE_BASE_URI}\n @raise [ArgumentError] if `fields` cannot be parsed as prefix:fieldname, or if one or more prefixes\n   is not mapped to a URI in `prefixes`\n @raise [URI::InvalidURIError] if `profile` cannot be parsed as a URI\n Writes this manifest to the specified IO\n @param io [IO] the IO to write to", "writes a checkm \"structured comment\"\n @param io [IO] the IO to write to\n @param comment [String] the comment\n @param columns [nil, Array<String>] columns to follow the initial comment", "Defines a new Scenario group\n\n   Feature \"User signs in\" do\n     Scenario \"success\" do\n       Given \"I on the login page\"\n       When \"I fill in my email and password\"\n     end\n   end\n\n This will be printed like so:\n\n   Feature: User signs in\n     Scenario: success\n       Given I am on the login page\n       When I fill in my email and password\n\n @param args the description, metadata, etc. as RSpec's #describe method\n takes.\n @param example_group_block the block to be executed within the feature", "Skip examples after the example provided.\n\n @param [Example] example the example to skip after\n @param [ExampleGroup] example_group the example group of example\n\n @api private", "If the example failed or got an error, then skip the dependent examples.\n If the failure occurred in a background example group, then skip all\n examples in the feature.\n\n @param [Example] example the current example\n @api private", "Replace job with specified id\n @param (Integer) :id is index of the job into @jobs array\n TODO: Refactor it! To complicated!", "Adds a job to @jobs array\n @param (Parser::Schedule) :schedule is object of Parser::Schedule class\n @param (Parser::Command) :command is object of Parser::Command class", "Creates a new instance of the middleware.\n\n @param [#call] app the application this middleware is being\n   wrapped around.\n @param [Aker::Configuration] configuration the configuration to use for\n   this instance.\n\n @see Aker::Rack.use_in\n\n Implements the rack middleware behavior.\n\n This class exposes three environment variables to downstream\n middleware and the app:\n\n  * `\"aker.configuration\"`: the {Aker::Configuration configuration}\n     for this application.\n  * `\"aker.authority\"`: the {Aker::Authorities authority} for\n    this application.\n  * `\"aker.interactive\"`: a boolean indicating whether this\n    request is being treated as an interactive (UI) or\n    non-interactive (API) request\n\n [There is a related fourth environment variable:\n\n  * `\"aker.check\"`: an instance of {Aker::Rack::Facade}\n    permitting authentication and authorization queries about the\n    current user (if any).\n\n This fourth variable is added by the {Authenticate} middleware;\n see its documentation for more.]\n\n @param [Hash] env the rack env\n @return [Array] the standard rack return", "Needs to be refactored to somewhere more generic", "stream|string -> create data file", "Can take a host name or an ip address. Resolves the host name\n and returns the ip address if get_ip is passed in as true.", "Retrieves name and email addresses that contain the passed string sorted\n by email adddress\n\n @param qry [String] search string\n\n @return [[[String, String]]] Array of email addresses and names found.\n   Each element consists of a 2 element array. The first is the email\n   address and the second is the name\n\n @example\n   cache.search(\"smi\") #=>\n     [[\"e1@acompany.com\", \"Mr Smith\"], [\"e2@bsomewhere.com\", \"Mr Smith\"]]", "Update the name and email addresses for the passed GMail ID.\n\n @param [String] id ID of contact to be updated\n @param [String] name new name for contact\n @param [String[]] addresses array of email addresses\n\n @return [[String, String]] Array of email addresses for the <tt>id</tt>\n                            after update.\n                            Each element consists of a 2 element array. The\n                            first is the email address and the second is\n                            the name", "Includes mount_sextant method for routes. This method is responsible to\n generate all needed routes for sextant", "Builds a list of candidates for the +MatchMaker+.\n The parameter is a hash of unwrapped canditate objects to their preferred\n targets.\n\n @example\n   matchbook.build_candidates(\n     'Harry'    => ['Gryffindor', 'Slytherin'],\n     'Hermione' => ['Ravenclaw', 'Gryffindor'],\n     'Ron'      => ['Gryffindor'],\n     'Neville'  => ['Hufflepuff', 'Gryffindor', 'Ravenclaw', 'Slytherin']\n   )\n\n @param candidates [Hash<Object, Array<Object>>]\n   Hash of candidate objects to a list of their preferred targets", "Converts the object into a textual string that can be sent to sequel\n @return\n   A string representing the object in a sequel-connect string format", "Performs the find unless no name provided\n\n @param output [IO]\n\n @param errors [IO]", "Get comment list\n This will contains comments' relations in response.\n\n Example:\n   >> comment = Denglu::Comment.new\n   => #<#Denglu::Comment...>\n   >> comments = comment.list\n   => [{...}, {...}]\n\n Arguments:\n   comment_id: (Integer)  The offset marker of response, default to 0 mains from the begining\n   max: (Integer)  The max records of response, default to 50", "Get comment count\n If resource is nil it will return all posts comment count in an array, otherwise just return a hash object.\n\n Example:\n   >> comment = Denglu::Comment.new\n   => #<#Denglu::Comment...>\n   >> comments = comment.total\n   => [{\"id\"=>..., \"count\"=>..., \"url\"=>...},\n   =>  {...}]\n\n Arguments:\n   resource: (Mixed)  Integer for resource id or string for uri.", "This function shows the list of published posts.", "This function shows the view to create a new post.", "This function creates a new post.", "This function show the view to edit a post.", "This function updates a post.", "This function updates the status of a post.", "This function updates the categories of a post.", "This function updates the tags of a post.", "This function updates the seo description of a post.", "This function destroyes a post.", "Tis function destroyes all posts with status deleted.", "This function updates a single field from its key and value.", "fire off a HTTP GET response to Blip.tv\n\n In the future, this should probably be rolled into the\n BlipTV::Request class, so that all exception raising and\n network communication exists in instances of that class.", "delete! will delete the file from Blip.tv", "Returns a valid rack response.", "Describe the options available\n\n ==== Parameters\n * <tt>name</tt>  - A valid name for the option\n * <tt>behaviors</tt>  - Behaviors used to for this option\n * <tt>block</tt>   - A proc that should be run against the option value.\n ==== Options\n * <tt>allow</tt>  - The option value must be in this list\n * <tt>boolean</tt>  - The option will accept <tt>true</tt>, <tt>false</tt>, <tt>0</tt>, <tt>1</tt>", "Get the final value of this variable", "noinspection RubyStringKeysInHashInspection,RubyResolve", "Scrapes TF2R for all active raffles.\n\n See http://tf2r.com/raffles.html\n\n @example\n   s.scrape_main_page #=> ['http://tf2r.com/kold.html',\n                           'http://tf2r.com/knew.html',\n                           'http://tf2r.com/knewest.html']\n\n @return [Hash] String links of all active raffles in chronological\n   order (oldest to newest by creation time).", "Scrapes a raffle page for information about the creator.\n\n @example\n   p = s.fetch('http://tf2r.com/kstzcbd.html')\n   s.scrape_raffle_for_creator(p) #=>\n   {:steam_id=>76561198061719848,\n    :username=>\"Yulli\",\n    :avatar_link=>\"http://media.steampowered.com/steamcommunity/public/images/avatars/bc/bc9dc4302d23f2e2f37f59c59f29c27dbc8cade6_full.jpg\",\n    :posrep=>11458,\n    :negrep=>0,\n    :color=>\"70b01b\"}\n\n @param page [Mechanize::Page] the raffle page.\n @return [Hash] a representation of a user, the raffle creator.\n   * :steam_id (+Fixnum+) \u2014 the creator's SteamID64.\n   * :username (+String+) \u2014 the creator's username.\n   * :avatar_link (+String+) \u2014 a link to the creator's avatar.\n   * :posrep (+Fixnum+) \u2014 the creator's positive rep.\n   * :negrep (+Fixnum+) \u2014 the creator's negative rep.\n   * :color (+String+) \u2014\u00a0hex color code of the creator's username.", "Scrapes a raffle page for some information about the raffle.\n\n The information is incomplete. This should be used in conjunction with\n the API as part of TF2R::Raffle.\n\n @example\n   p = s.fetch('http://tf2r.com/kstzcbd.html')\n   s.scrape_raffle_for_raffle(p) #=>\n   {:link_snippet=>\"kstzcbd\",\n    :title=>\"Just one refined [1 hour]\",\n    :description=>\"Plain and simple.\",\n    :start_time=>2012-10-29 09:51:45 -0400,\n    :end_time=>2012-10-29 09:53:01 -0400}\n\n @param page [Mechanize::Page] the raffle page.\n @return [Hash] a partial representation of the raffle.\n   * :link_snippet (+String+) \u2014 the \"raffle id\" in the URL.\n   * :title (+String+) \u2014 the raffle's title.\n   * :description (+String+) \u2014 the raffle's \"message\".\n   * :start_time (+Time+) \u2014 the creation time of the raffle.\n   * :end_time (+Time+) \u2014 the projects/observed end time for the raffle.", "Scrapes a raffle page for all the participants.\n\n This should rarely be used. This will only be necessary in the case that\n a raffle has maximum entries greater than 2500.\n\n @param page [Mechanize::Page] the raffle page.\n @return [Array] contains Hashes representing each of the participants,\n in chronological order (first entered to last).\n   * :steam_id (+Fixnum+) \u2014 the participant's SteamID64.\n   * :username (+String+) \u2014 the participant's username.\n   * :color (+String+) \u2014\u00a0hex color code of the participant's username.", "Scrapes a user page for information about the user.\n\n @example\n   p = s.fetch('http://tf2r.com/user/76561198061719848.html')\n   s.scrape_user(p) #=>\n   {:steam_id=>76561198061719848,\n    :username=>\"Yulli\",\n    :avatar_link=>\"http://media.steampowered.com/steamcommunity/public/images/avatars/bc/bc9dc4302d23f2e2f37f59c59f29c27dbc8cade6_full.jpg\",\n     :posrep=>11459,\n     :negrep=>0,\n     :color=>\"70b01b\"}\n\n @param user_page [Mechanize::Page] the user page.\n @return [Hash] a representation of the user.\n   * :steam_id (+Fixnum+) \u2014 the user's SteamID64.\n   * :username (+String+) \u2014 the user's username.\n   * :avatar_link (+String+) \u2014 a link to the user's avatar.\n   * :posrep (+Fixnum+) \u2014 the user's positive rep.\n   * :negrep (+Fixnum+) \u2014 the user's negative rep.\n   * :color (+String+) \u2014\u00a0hex color code of the user's username.", "Scrapes the TF2R info page for available user ranks.\n\n See http://tf2r.com/info.html.\n\n @example\n   p = s.fetch('http://tf2r.com/info.html')\n   s.scrape_user(p) #=>\n   [{:color=>\"ebe2ca\", :name=>\"User\",\n     :description=>\"Every new or existing user has this rank.\"}, ...]\n\n @param info_page [Mechanize::Page] the info page.\n @return [Array] contains Hashes representing each of the ranks.\n   * :name (+String+) \u2014 the rank's name.\n   * :description (+String+) \u2014\u00a0the rank's description.\n   * :color (+String+) \u2014 the rank's hex color code.", "Create websocket connections for active tokens", "Remove all connections from app, will disconnect in monitor loop", "Issue restart status on all RTM connections\n will re-connect in monitor loop", "Find the connection based on id and has active connection", "Create new connection if not exist", "Disconnect from a RTM connection", "useful for path helpers used in event maps", "Initialize\n Instance methods\n Publish message to the respective queue", "unicast message to queues", "multicast message to queues based on topic subscription", "Allocate a contiguous chunk of memory and copy over the PollItem structs\n to this block. Note that the old +@store+ value goes out of scope so when\n it is garbage collected that native memory should be automatically freed.", "Format the value.\n\n @return [String]", "to obtain a hash of all possible keys", "The constructor, takes input data taken from the parent module\n and creates an instance of the Citero java object.\n Returns itself for builder patttern.\n The from method is private, it takes in a format and gets\n the appropriate Format java class and then calls\n the from method in the Citero java object and stores its\n return value in an instance variable.\n Returns itself.", "The to method is private, it takes in a format and gets\n the appropriate Format java class and then calls\n the to method in the Citero java object and returns the\n return value as a string.", "Passes all existing data paths for the specified path,\n within the data directories, to the given block.\n\n @param [String] path\n   The path to search for in all data directories.\n\n @yield [potential_path]\n   The given block will be passed every existing combination of the\n   given path and the data directories.\n\n @yieldparam [String] potential_path\n   An existing data path.\n\n @return [Enumerator]\n   If no block is given, an Enumerator object will be returned.", "Finds all occurrences of a given file path, within all data\n directories.\n\n @param [String] path\n   The file path to search for.\n\n @yield [data_file]\n   If a block is given, it will be passed every found path.\n\n @yieldparam [String] data_file\n   The path of a file within a data directory.\n\n @return [Enumerator]\n   If no block is given, an Enumerator object will be returned.", "Finds all occurrences of a given directory path, within all data\n directories.\n\n @param [String] path\n   The directory path to search for.\n\n @yield [data_dir]\n   If a block is given, it will be passed every found path.\n\n @yieldparam [String] data_dir\n   The path of a directory within a data directory.\n\n @return [Enumerator]\n   If no block is given, an Enumerator object will be returned.", "Finds all paths that match a given pattern, within all data\n directories.\n\n @param [String] pattern\n   The path glob pattern to search with.\n\n @yield [path]\n   If a block is given, it will be passed every matching path.\n\n @yieldparam [String] path\n   The path of a matching file within a data directory.\n\n @return [Array<String>]\n   If no block is given, the matching paths found within all data\n   directories will be returned.\n\n @since 0.3.0", "Create new instance from a hash of properties with values.\n @param [Object] frame The CGRect or a Hash of properties.", "Initialize a new Client object\n\n @param options [Hash]", "closest valid date", "Constructor. Name and start date must be supplied. Other attributes are optional.\n Set the tournament federation. Can be _nil_.", "Add a round date.", "Canonicalise the names in the tie break array.", "Add a new player to the tournament. Must have a unique player number.", "Rerank the tournament by score first and if necessary using a configurable tie breaker method.", "Renumber the players according to a given criterion.", "Raise an exception if a tournament is not valid. The _rerank_ option can be set to _true_\n to rank the tournament just prior to the test if ranking data is missing or inconsistent.", "Convenience method to serialise the tournament into a supported format.\n Throws an exception unless the name of a supported format is supplied\n or if the tournament is unsuitable for serialisation in that format.", "Check players.", "Round should go from 1 to a maximum, there should be at least one result in every round and,\n if the number of rounds has been set, it should agree with the largest round from the results.", "Check dates are consistent.", "Validate against a specific type.", "Return a tie break score for a given player and a given tie break method.", "get the name of the deploying user\n currently this only supports git.\n if reading the git user.name, fall back on `whoami`", "given a plugin name as a symbol, unload the capnotify plugin\n this will also unload any kind of capistrano plugin\n if the plugin supports the unload method, it will be called.", "given a plugin name, return the plugin.", "given a path to an ERB template, process it with the current binding and return the output.", "fetch a component given the name\n this is most useful for getting a component directly if you want to make modificatins to it", "insert the given component before the component with `name`\n if no component is found with that name, the component will be inserted at the end", "insert the given component after the component with `name`\n if no component is found with that name, the component will be inserted at the end", "returns an unused key for edges between nodes 'u' and 'v'.\n\n The nodes 'u' and 'v' do not need to be already in the graph.\n\n Notes\n -----\n The new key is the number of existing edges between 'u' and 'v', increased if necessary to ensure uniqueness. The first edge will have key 0, the second edge 1, etc. If an edge is removed, new keys may not be in this order.\n\n Parameters\n ----------\n u, v: nodes\n\n Returns\n -------\n key: int", "group data, calculate contributions, sort by contributions", "Starts the Redis server on the default Redis port.\n\n @param [Redis] the Redis client\n @raise [ScatError] if the server command could not be executed\n @raise [Exception] if the server is not reachable", "Query the model RDF graph using a query language\n\n @param [String] q the text of the query\n @param [Hash<Symbol => [String, URI]>] options options for the query\n @option options [String] :language language of the query, one of:\n   - \"sparql10\" SPARQL 1.0 W3C RDF Query Language (default)\n   - \"sparql\" SPARQL 1.1 (DRAFT) Query and Update Languages\n   - \"sparql11-query\" SPARQL 1.1 (DRAFT) Query Language\n   - \"sparql11-update\" SPARQL 1.1 (DRAFT) Update Language\n   - \"laqrs\" LAQRS adds to Querying RDF in SPARQL\n   - \"rdql\" RDF Data Query Language (RDQL)\n @option options [String] :language_uri URI of the query language, if applicable\n @option options [String] :base_uri base URI of the query, if applicable\n @return [void]\n @note\n   The returned value is determined by the type of the query:\n   - [Boolean] for SPARQL ASK queries (ignores block, if given)\n   - [Redlander::Model] for SPARQL CONSTRUCT queries\n     if given a block, yields the constructed statements to it instead\n   - [Array<Hash>] for SPARQL SELECT queries\n     where hash values are Redlander::Node instances;\n     if given a block, yields each binding hash to it\n   - nil, if query fails\n @raise [RedlandError] if fails to create a query", "Populates a newly created funnel with some fake data\n @param [Fixnum] days The number of days for which data to be faked", "Returns data for a funnel\n @return [Octo::FunnelData] The Octo funnel data", "Generates fake data for funnel\n @param [Fixnum] n The length of funnel\n @return [Array] An array containing the funnel value", "Handle different error cases", "Find an activity\n\n @param activity_id [Object] Activity id to find\n @return [Activity, Nil] An activity instance or `nil` if not found", "Find latest activities\n\n @note If you use others selectors then 'limit' argument and 'skip' option then you have to setup corresponding indexes in database.\n\n @param limit [Integer] Max number of activities to find\n @param options [Hash] Options hash\n @option options [Integer]           :skip     Number of activities to skip (default: 0)\n @option options [Time]              :before   Find activities generated before that datetime (excluding)\n @option options [Time]              :after    Find activities generated after that datetime (excluding)\n @option options [Hash{Sym=>String}] :entities Filter by entities values (empty means 'all values')\n @option options [Array<Class>]      :only     Find only these activities\n @option options [Array<Class>]      :except   Skip these activities\n @return [Array<Activity>] An array of activities", "Count number of activities\n\n @note If you use one of options selectors then you have to setup corresponding indexes in database.\n\n @param options [Hash] Options hash\n @option options [Time]              :before   Find activities generated before that datetime (excluding)\n @option options [Time]              :after    Find activities generated after that datetime (excluding)\n @option options [Hash{Sym=>String}] :entities Filter by entities values (empty means 'all values')\n @option options [Array<Class>]      :only     Find only these activities\n @option options [Array<Class>]      :except   Skip these activities\n @return [Integer] Number of activities", "Find number of duplicate activities\n\n @param activity [Activity] Activity to search\n @param after [Time] Search after that datetime\n @return [Integer] Number of activity duplicates", "Delete activities referring to given entity model instance\n\n @param model [Object] Model instance", "Find a timeline entry\n\n @param timeline    [Timeline] Timeline instance\n @param tl_entry_id [Object]   Timeline entry id\n @return [Timeline::Entry, Nil] Found timeline entry", "Find timeline entries by descending timestamp\n\n @param timeline [Timeline] Timeline instance\n @param limit    [Integer]  Max number of entries to find\n @param options  [Hash]     Options hash\n @option options [Integer]                :skip Number of entries to skip (default: 0)\n @option options [Array<Timeline::Route>] :only An array of routes to fetch\n @return [Array<Timeline::Entry>] An array of timeline entries", "Count number of timeline entries\n\n @param timeline [Timeline] Timeline instance\n @param options  [Hash]     Options hash\n @option options [Array<Timeline::Route>] :only An array of routes to count\n @return [Integer] Number of timeline entries in given timeline", "Delete timeline entries\n\n @param timeline [Timeline] Timeline instance\n @param options  [Hash] Options hash\n @option options [Time] :before Delete only timeline entries which timestamp is before that datetime (excluding)\n @option options [Hash{Sym=>String}] :entity Delete only timeline entries with these entities values", "Delete timeline entries referring to given entity model instance\n\n @param model [Object] Model instance", "Run a hook\n\n @api private\n\n @param name [Symbol] Hook name\n @param args [Array]  Hook arguments", "Triger any formatting rules specified with the reformat directive.\n The attributes are reformatted and mutated in place.\n\n Returns an instance of the form object.", "Return all the attributes as a params hash.", "Merge protections for the same params into one so as to allow extension of them\n in inheriting controllers.\n\n Mutating the first argument is okay since this method is used within inject only.\n\n Example:\n merge_protections({ :foo => { :qux => nil }, :bar => { :baz => nil, :qux => nil } },\n                   { :foo => { :baz => nil, :qux => { :foo => nil } } })\n =>\n\n { :foo => { :baz => nil, :qux => { :foo => nil } }, :bar => { :baz =>nil, :qux => nil } }", "Track media url", "for proper work, model must have class method `mail_fields`, which return array of field symbols.\n references write as is, like `foo_id`\n\n in options can take:\n menu_priority:integer\n menu_parent:string\n permitted_params:array for some additions to main_fields permitted params\n def simple_menu_for(klass, options = {})", "a diffmap shows what is missing between two languages\n the key is a two-element array, the first element is the current language\n and the second element is the target language\n\n for example\n diffmap: {[:en, :fr] => [[:obj3], ...]}\n\n means that fr was examined against en, where en had an entry for obj3 that fr didn't", "outer method for creating keymap on parent hash", "recursive helper for creating keymap on children hashes", "Write the value to key.", "Changes the list stored at the given key, i.e. first adds all items in\n to_add then removes all items in to_remove.\n Both, to_add and to_remove, must be lists.\n Assumes en empty list if no value exists at key.", "Changes the number stored at the given key, i.e. adds some value.\n Assumes 0 if no value exists at key.", "It seems like there must be a builtin for this, but I'm not\n finding it.", "Handles iteration of each headline\n @return [Array<String>] news headlines", "LDAP lookup based on UNI. If record could not be found returns nil.\n\n @param [String] uni\n @return [Cul::LDAP::Entry] containing all the ldap information available for the uni given\n @return [nil] if record for uni could not be found, or more than one record was found", "LDAP lookup based on name.\n\n @param [String] name\n @return [Cul::LDAP::Entry] containing the entry matching this name, if it is unique\n @return [nil] if record could not be found or if there is more than one match", "optional parameter is merged into the content hash\n before sending. good for specifying more application\n specific stuff like speakableText parameters.", "this method is pretty much extracted directly from\n the mirror API code samples in ruby\n\n https://developers.google.com/glass/v1/reference/timeline/list", "Serialize instance attributes to a Hash based on serializable attributes defined on Model class.\n @return [Hash] hash of model instance attributes", "List of Model attributes that should be serialized when called `to_hbs` on Model instance\n @return [Array] list of serializable attributes", "the format to output the results to. csv, html or json\ninitialize the class with the folders to be compared\n Validates the input ensuring the arguments are both valid folders", "Prints the results to standard out in the csv format specified.", "Crude way to guess which encoding it is", "Pulls information from the recent page to determine the total number of\n problems and pages.", "Loads in all of the problem numbers and titles from the recent page.", "Loads the problem numbers and titles for an individual page of the archive.", "Loads the details of an individual problem.", "Creates an e-mail containing a verification token for the e-mail address.\n\n @param [String] token the e-mail confirmation token\n @param [String] the application's root URL (e.g. \"https://localhost:3000/\")", "Creates an e-mail containing a password reset token.\n\n @param [String] email the email to send the token to\n @param [String] token the password reset token\n @param [String] root_url the application's root URL\n     (e.g. \"https://localhost:3000/\")", "Find and load all ruby files under the same directory structure\n of the declared class which is including DescendantsLoader module.\n\n This is the trick to put the classes into ObjectSpace and have the\n desired behavior of Object.descendants and Object.subclasses.", "Check message length", "Follow a user\n @accessibility: public key, secret key\n @methods: POST\n @format: json, jsonp\n @authenticated: true\n @limited: false\n @param target [Integer, String] A Disqus user ID or screen name.\n @return [Hashie::Rash] Details on the requested user.\n @example Return extended information for 'the88'\n   Disqussion::Client.follow(\"the88\")\n   Disqussion::Client.follow(1234)  # Same as above\n @see: http://disqus.com/api/3.0/users/details.json", "Determines a file's dependencies based on the file's extension.", "Increments the counter for a model.\n @param [Object] obj The model instance for whom counter would be\n   incremented", "Aggregates all the counters available. Aggregation of only time specific\n   events can be done by passing the `ts` parameter.\n @param [Time] ts The time at which aggregation has to be done.\n @return [Hash{Fixnum => Hash{ Obj => Fixnum }}] The counts of each object", "Set the rank.", "Set the name, checks for family group restrictions.", "Reset id and @new_record if the transaction rolls back.", "Call the after rollback callbacks. The restore_state argument indicates if the record\n state should be rolled back to the beginning or just to the last savepoint.", "Sets necessary ivars\n Starts a child process in a child-watching-thread\n Reads it's PID from the new process' STDOUT and sets it as an instance variable", "Creates a new user. This action does not require any auth although it\n is optional.", "This method normally updates the user using permitted params.", "This method updates user with a new reset token. Only used for this\n operation.", "Prepare a blank slate.\n Add items to these bullet points.", "Render the bullet points as an array of strings.", "Create a new model on the server", "Update an existing model on the server", "Delete an existing model on the server", "ActiveSupport caused problems when using as_json, so using to_hash", "Retrieving data from networks\n\n Retrieves data from URL\n @param [String] URL\n @return [String] Retrieved data from the URL", "Working with REST services\n\n List collection of remote objects\n @param [Symbol] Object type\n @return [Array<Hash>] Array of objects", "Shows remote object\n @param [Symbol] Object type\n @param [String] Object ID\n @return [Hash] Object", "Updates remote object\n @param [Symbol] Object type\n @param [String] Object ID\n @param [Hash] Data to be sent", "Creates a new remote object\n @param [Symbol] Object type\n @param [Hash] Data to be sent", "Returns custom path\n @param [Symbol] Object type\n @param [Symbol] Action\n @return [Service::ServiceUrl] Custom path", "Returns custom object name for action\n @param [Symbol] Object type\n @param [Symbol] Action", "Override HTTParty's get method to append the API key and to process errors returned from request", "Redirects to login unless there is an authenticated user", "gets the request token and redirects to twitter's OAuth endpoint", "Comparable units\n => Compare with scale of kinds\n convert to a specified unit string or to the same unit as another Unit", "Adds root urls as hash keys", "takes an array of links", "Returns an array of String objects generates by the engine\n attached to this Sheet's Spreadsheet.", "Calls the passed block for every Element, the cell definition,\n attached to columns for this Sheet.\n\n Depending an the block's arity, passes the Element or the Element\n and the index to the given block.\n\n Examples:\n   each_cell_definition {|column_def| ... }\n   each_cell_definition {|column_def, index| ... }", "Initializes a new TemplateRenderer.\n\n template: The template to use (i.e. not the file name)\n parsed_tweets: The dict that gets returned by TweetParser::merge_parsed\n\n Renders @template.", "Returns an array with the mentions which can be easily used within ERB.", "Returns an array with the hashtags which can be easily used within ERB.", "Returns an array with the smileys which can be easily used within ERB.", "Returns an array with the clients which can be easily used within ERB.", "Instantiate a FileFinder with the path to a folder\n @example\n   FileFinder.new(\"/Users/max/src/layabout\")\n @api public\n Absolute paths to all the files with the provided extensions\n @example\n   FileFinder.new(\"/Users/max/src/layabout\").list(\".rb\", \".coffee\")\n @api public\n @return [Array<String>]", "Check if this file has been excluded\n @api private\n @return [Boolean]", "Returns an array of fully-formatted error messages.\n\n   errors.full_messages\n   # => ['name is not valid',\n   #     'hometown is not at least 2 letters']", "Find the namespace prefix by searching through the namespaces for the TNS", "Expensive. Use only for debug", "Returns true if the Date or DateTime passed is included in the parsed Dates or DateTimes", "Actually setup the task", "Creates a new item in the inventory\n @param item [String] The item to add to the inventory\n @param total [String] How many of the new item on hand\n @return [Hash] Returns a hash of the updated inventory and writes YAML to .stocker.yaml", "Deletes an item from the inventory.\n Stocker will attempt a \"fuzzy match\" of the item name.\n @param item [String] The item to delete from the inventory\n @return [Hash] Returns a hash of the updated inventory and writes YAML to .stocker.yaml", "Checks the total number of items on hand against their acceptable minimum values and opens the URLs of any items running low in stock.\n @return Opens a link in default web browser if URL is set for low stock item", "Set total of existing item in Stocker's inventory\n @param item [String] item to update\n @param total [String] total on hand", "Set URL of existing item in Stocker's inventory\n @param item [String] item to update\n @param url [String] URL of item", "Set minimum acceptable amount of existing inventory item\n @param item [String] item to update\n @param min [String] acceptable minimum amount of item to always have on hand", "Print a list of all inventory items. Green items are well stocked. Yellow items are at minimum acceptable total. Red items are below minimum acceptable total.", "Not used internally, but useful for external usage", "Shortcut to build a C array from a Ruby array", "Declare default associations for ActiveRecord models.\n\n   # Build a new association on demand\n   belongs_to :address\n   has_default_association :address\n\n   # Build a custom assocation on demand\n   belongs_to :address\n   has_default_association :address do |model|\n     Address.new(:name => model.full_name)\n   end\n\n =Options\n\n +eager+ will instantiate a default assocation when a\n model is initialized.", "Return new, changed and deleted files\n compared to a specific commit and the staging area.\n\n The return value is a hash with :created, :changed and :deleted keys.", "Return new, changed and deleted files\n by comparing two commits.\n\n The return value is a hash with :created, :changed and :deleted keys.", "Merge two commits and save the changes to the staging area.", "Return a list of changes between a file in the staging area\n and a specific commit.\n\n This method is just a tiny wrapper around VCSToolkit::Diff.from_sequences\n which loads the two files and splits them by lines beforehand.\n It also ensures that both files have \\n at the end (otherwise the last\n two lines of the diff may be merged).", "Instantiate a new OAuth 2.0 client using the\n Client ID and Client Secret registered to your\n application.\n\n @param [String] client_id the client_id value\n @param [String] client_secret the client_secret value\n @param [Hash] opts the options to create the client with\n @option opts [String] :site the OAuth2 provider site host\n @option opts [String] :authorize_url ('/oauth/authorize') absolute or relative URL path to the Authorization endpoint\n @option opts [String] :token_url ('/oauth/token') absolute or relative URL path to the Token endpoint\n @option opts [Symbol] :token_method (:post) HTTP method to use to request token (:get or :post)\n @option opts [Hash] :connection_opts ({}) Hash of connection options to pass to initialize Faraday with\n @option opts [FixNum] :max_redirects (5) maximum number of redirects to follow\n @option opts [Boolean] :raise_errors (true) whether or not to raise an OAuth2::Error\n  on responses with 400+ status codes\n @yield [builder] The Faraday connection builder", "install an included hook that first checks if this plugin's receiver mixin\n has already been included.  If it has not been, include the receiver mixin\n and run all of the `plugin_included` hooks", "Generates a nested Hash object which is a copy of existing configuration", "Checks if provided option is a hash and if the keys are not in confict with OpenStruct public methods.", "If an API endpoint returns a single resource, not an Array of resources,\n we want to use this.\n\n Returns an instance of `resource_class`.", "If an API endpoint returns an Array of resources, we want to use this.\n\n Returns an array of `resource_classes`.", "AuditRelationship creates audits for a has_many relationship.\n\n @examples\n   class Company < ActiveRecord::Base\n     has_many :phone_numbers\n     audit_enabled\n   end\n   class PhoneNumber < ActiveRecord::Base\n     belongs_to :company\n     audit_relationship_enabled\n   end\n\n   valid options include:\n   :only => [(array of models)]\n     an array of models to only send an audit to\n   :except => [(array of models)]\n     an array of models to not send an audit to\n   :fields => [(array of field names)]\n     an array of field names.  Each field name will be one audit item", "Adds an upon rule that works by delegation if the value responds to `method`.\n\n Example:\n\n     Myrrha.coercions do |r|\n       r.delegate(:to_foo)\n\n       # is a shortcut for\n       r.upon(lambda{|v,_| v.respond_to?(:to_foo)}){|v,_| v.to_foo}\n     end", "Adds a coercion rule from a source to a target domain.\n\n The conversion can be provided through `converter` or via a block\n directly. See main documentation about recognized converters.\n\n Example:\n\n   Myrrha.coercions do |r|\n\n     # With an explicit proc\n     r.coercion String, Integer, lambda{|v,t|\n       Integer(v)\n     }\n\n     # With an implicit proc\n     r.coercion(String, Float) do |v,t|\n       Float(v)\n     end\n\n   end\n\n @param source [Domain] a source domain (mimicing Domain)\n @param target [Domain] a target domain (mimicing Domain)\n @param converter [Converter] an optional converter (mimic Converter)\n @param convproc [Proc] used when converter is not specified\n @return self", "Coerces `value` to an element of `target_domain`\n\n This method tries each coercion rule, then each fallback in turn. Rules\n for which source and target domain match are executed until one succeeds.\n A Myrrha::Error is raised if no rule matches or executes successfuly.\n\n @param [Object] value any ruby value\n @param [Domain] target_domain a target domain to convert to (mimic Domain)\n @return self", "Returns true if `value` can be considered as a valid element of the\n domain `domain`, false otherwise.\n\n @param [Object] value any ruby value\n @param [Domain] domain a domain (mimic Domain)\n @return [Boolean] true if `value` belongs to `domain`, false otherwise", "Returns an endpoint\n\n type is a String or Symbol of one of the following:\n   :chrome\n   :ie\n   :firefox\n   :info_card\n   :bookmarklet\n   :sitetags\n\n opts is a Hash of options that has the following keys:\n (see Kynetx App Management API documentation on \"generate\" for more information)\n\n - :extname (endpoint name - defaults to app name.)\n - :extauthor (endpoint author - defaults to user generating the endpoint.)\n - :extdesc (endpoint description - defaults to empty.)\n - :force_build ('Y' or 'N' force a regeneration of the endpoint - defaults to 'N'.)\n - :contents ( 'compiled' or 'src' specifies whether you want the endpoint or the source code of the endpoint - defaults to 'compiled'.)\n - :format ('url' or 'json' specifies how the endpoint is returned - default is 'json' which returns a Base64 encoded data string.)\n - :datasets (used for infocards - defaults to empty)\n - :env ('dev' or 'prod' specifies whether to run the development or production version of the app - defaults to 'prod'.)\n - :image_url (a fully qualified url to the image that will be used for the infocard. It must be a 240x160 jpg - defaults to a cropped version of the app image in appBuilder.)\n - :runtime (specific runtime to be used. This only works with bookmarklets - defaults to init.kobj.net/js/shared/kobj-static.js )\n\n Returns a hash formatted as follows:\n {:data => \"endpoint as specified in the :format option\",\n  :file_name => \"filename.*\",\n  :content_type => 'content type',\n  :errors => []\n }", "Try to formulate a path to view the handcart show page", "This function destroy a post for the field.", "VERSION = \"0.0.1\"\n Called once when Guard starts. Please override initialize method to init stuff.\n\n @raise [:task_has_failed] when start has failed\n @return [Object] the task result", "Creates a new project on fenton server by sending a post\n request with json from the command line to create the project\n\n @param global_options [Hash] global command line options\n @param options [Hash] json fields to send to fenton server\n @return [String] success or failure message", "Formulates the project json for the post request\n\n @param options [Hash] fields from fenton command line\n @return [String] json created from the options hash", "Reload an object from the API. Optionally pass an URL.", "Use debug log level in the context of a block.", "Normalizes the given options String or Hash into a Symbol-keyed Hash.\n\n @param [Object] options\n   either a String, a URI or a Hash\n\n @return [Hash]\n   a Symbol-keyed Hash", "Generator Code. Remember this is just suped-up Thor so methods are executed in order", "Get the native value of a bitmask\n @overload to_native(query, ctx)\n  @param [Symbol, Integer, #to_int] query\n  @param ctx unused\n  @return [Integer] value of a bitmask\n @overload to_native(query, ctx)\n  @param [Array<Symbol, Integer, #to_int>] query\n  @param ctx unused\n  @return [Integer] value of a bitmask", "Render the page as an array of strings.", "Add a row to the page, moving items as needed.", "Create a new instance of the middleware.\n\n @param [#call] app the next rack application in the chain.\n @param [Hash] options\n @option options [String] :store the file where the middleware\n   will store the received PGTs until they are retrieved.\n\n Handles a single request in the manner specified in the class\n overview.\n\n @param [Hash] env the rack environment for the request.\n\n @return [Array] an appropriate rack response.", "Associates the given PGTIOU and PGT.\n\n @param [String] pgt_iou\n @param [String] pgt\n\n @return [void]", "Finds the PGT for the given PGTIOU.  If there isn't one, it\n returns nil.  If there is one, it deletes it from the store\n before returning it.\n\n @param [String] pgt_iou\n @return [String,nil]", "Withdrawal of the specified coin type.\n\n coin    - The coin type\n amount  - The amount to withdraw.\n address - The coin type's address we will send the amount to.", "Return a list of user transactions.\n\n offset - optional, skip that many transactions before beginning to return results. Default: 0.\n limit  - optional, limit result to that many transactions. Default: 50.\n sort   - optional, sorting by date and time (asc - ascending; desc - descending). Default: desc.\n book   - optional, if not specified, will default to btc_cad.", "Calculate the label padding, taking all labels into account", "Makes sure that the generator deletes the named file. This is done by first ensuring that the\n file exists in the first place, and then ensuring that it does not exist after the generator\n completes its run.\n\n Example:\n   expect(subject).to delete(\"path/to/file\")", "Defines a Soundcloud client object", "Returns a Drop object that contains useful track information.", "remove backticks, single quotes, \\n and ensure each line is reasonably small", "Create new CommandSpec\n\n @param [Hash] params  Hash of attributes to initialize with\n Validate the existence of this Command on the local system\n and compare digest to local version\n\n @param [String] expected_digest\n @return [Boolean] returns true if available, else raises error\n @raise [BundleNotFound] If bundle doesn't exist or digest does not match\n @raise [CommandNotFound] If command doesn't exist", "Retrieve the command's Manifest, loading it from disk if necessary\n If no Manifest is available, returns an empty hash\n\n @return [Hash]", "Convert object to String, useful for debugging\n\n @return [String]", "This function check the category parent of the category do not create a circular dependency.", "This function check that the category parent exist and has not others categories for the same language.", "Start the nsi.videogranulate fake server\n\n @param [Fixnum] port the port where the fake server will listen\n   * make sure there's not anything else listenning on this port", "Links returned as Link objects", "Creates a Rack app with the current Machined\n environment configuration.", "Retrieve Twitter Hashtag Streams for a campaign\n\n param [Integer] campaign_id The ID of the campaign to fetch the twitter hashtag stream for.\n @param [Hash]  options", "Retrieve Single Twitter Hashtag Stream for a campaign\n\n param [Integer] campaign_id The ID of the campaign to fetch the twitter hashtag stream for.\n param [Integer] id The ID of the twitter_hashtag_stream to fetch.\n @param [Hash]  options", "Creates a named route called \"root\" for matching the root level request.", "This function shows the list of possible categories.", "This function shows the view to create a new category.", "This function creates a new category.", "This function show the view to edit a category.", "This function updates a category.", "This function destroyes a category.", "Creates a new XML-encoder with a root tag named after +root_name+.\n\n @example Create a simple encoder for a person with a name attribute:\n   Pump::Xml.new :person do\n     tag :name\n   end\n\n @example Create the same without usage of the DSL:\n   Pump::Xml.new :person, [{:name => :name}]\n\n @example Create the same but without the xml instruct\n   Pump::Xml.new :person, :instruct => false do\n     tag :name\n   end\n\n @example The same again without DSL:\n\n   Pump::Xml.new :person, [{:name => :name}], :instruct => false\n\n @param [String, Symbol] root_name         the name of the used root tag\n @param [Array<Hash>] encoder_config       optional config for all tags\n @param [Hash] encoder_options             optional encoder_options for the whole encoder\n @yield an optional block to create the encoder with the Pump::Dsl\n\n @return [self]\n Encode a object or an array of objects to an formatted string.\n\n @param [Object, Array<Object>] object object or an array of objects to\n    encode to XML or JSON. The only requirement: The given objects must respond\n    to all methods configured during initalization of the Pump::Xml or Pump::JSON instance.\n\n @return [String]", "Extends the previous Off Air schedule", "Initializes the signer with a secret key.\n @param [String] key        secret key, used to sign messages\n Adds a signature to every outgoing publish message.", "Extract strings from files in the given path.\n @param [String] path the path of a directory or file to extract strings\n   from.\n @return [POFile] a POFile object, representing the strings extracted from\n   the files or file in the specified path.", "Checks for required inputs and input formats\n that the adapter will need to process the search.\n\n It does *not* matter if there are other, non-required parameters\n in the input hash; they will be ignored later.", "Required keys must exist in the input hash and must have a non-nil,\n non-empty value.", "Returns all necessary filepaths.", "IF engine contains deserialization logic, we can no more\n unit test the converters. Seems like, the conversion logic\n must be outsourced to its respective converter", "Reduce characteristics by removing them one by one and counting the results.\n\n The characteristic whose removal leads to the highest record count is removed from the overall characteristic set.", "Pull packages from a snapshot into another, creating a new snapshot.\n\n  == Parameters:\n name::\n   The name of the snapshot to pull to\n source::\n   The repository containing the packages to pull in\n dest::\n   The name for the new snapshot which will be created\n packages::\n   An array of package names to search\n deps::\n   When true, process dependencies\n remove::\n   When true, removes package versions not found in source", "Shortcut method to pull packages to the current snapshot", "Determines if a particular virtual machine exists in the output\n\n   * vm_name: The name of the virtual machine to look for", "Determines the state of a particular virtual machine\n\n The state is returned as a symbol, e.g. :running.\n\n   * vm_name: The name of the virtual machine to retrieve state", "Retrieves the virtual machine list section of the output", "Initialize a ne DB object.\n\n @return [DB]\n Parse the MongoDB URI.\n\n @param [String] db_uri the DB URI.\n\n @return [Hash]", "Dump database using mongodump.\n\n @param [Hash] db the DB connection opts.\n @param [String] path the path, where the dump should be stored.\n\n @return [nil]", "Runs the runner.\n\n @param [Array<String>] args\n   The arguments to run the runner with.\n\n @since 0.1.0", "Return an Array of Sms if there is messages nad return nil if not.", "Use gmail_xoauth to send email", "Given a file name, attempts to send an public 404 file, if it exists, and halt\n\n @param [String] file_name", "Given a template name, and with a prioritized list of template engines, attempts to render a\n 404 template, if one exists, and halt.\n\n @param [String] template_name\n @see VIEW_TEMPLATE_ENGINES", "Given a URI path, attempts to render a JavaScript template, if it exists, and halt\n\n @param [String] uri_path\n @see JAVASCRIPT_TEMPLATE_ENGINES", "Given a URI path, attempts to render a stylesheet template, if it exists, and halt\n\n @param [String] uri_path\n @see STYLESHEET_TEMPLATE_ENGINES", "Given a URI path, attempts to send an index.html file, if it exists, and halt\n\n @param [String] uri_path", "Given a URI path, attempts to render a content page, if it exists, and halt\n\n @param [String] uri_path\n @raise [RegisteredEngineNotFound] Raised when a registered engine for the content page's\n   view template cannot be found\n @raise [ViewTemplateNotFound] Raised when the content page's view template cannot be found", "Given a URI path, creates a new `ContentPage` instance by searching for and reading a content\n file from disk. Content files are searched consecutively until a page with a supported\n content page template engine is found.\n\n @param [String] uri_path\n @raise [ContentPageNotFound] Raised when a content page cannot be found for the uri path\n @return [ContentPage] A new instance is created and returned when found\n @see ContentPage::TEMPLATE_ENGINES", "atts_hash are the attributes to assign to the Record\n identifier_conditions is what the scope for first_or_initialize is called upon\n  so that an existing object is updated\n  full_data_object is passed in to be saved as a blob", "Initialize a tree node setting name and adding a child if one was passed\n Add one or more children to the tree", "Parse a single line from a bookmarks file.\n\n line - String.\n\n Returns nothing.\n TODO This should have its own parser class.", "Save the version.\n\n @return [Hash] Atlas response object.", "Override UILabel Methods", "add link attribute", "like the other methods but allow to set an exception flag\n @param  [String] str the string the needs to be checked\n @param  [Boolean] to raise an exception or not. DEFAULT is false\n @return [Boolean]\n @return [ShellTastic::CommandException]", "Load config from the file if any exists", "Run an adb commd on specified device, optionally printing the output", "Get all currently connected android devices", "Filter for fetching assets\n Writes static file to asset_dir and returns absolute file path", "hands on the handler", "Test if the query matches this particular model.", "Validate driver_config.\n This method raise ArgumentError, if missing driver_config.\n\n @param driver_config [Hash] driver config.\n @return [Hash] driver_config", "This hook allows other tracing in Hometown to get a whack at an object\n after it's been created without forcing them to patch new themselves", "Return encrypted string according to specified format.\n Return nil if field is whitespace.", "Format the final encrypted string to be returned depending\n on specified format.", "save fields value", "set values for fields\n@param source is symbol of relation method contains include Cfror::Fields", "Creates a format handler for a route handler\n @param [Kawaii::RouteHandler] current route handler\n @return {FormatHandler}\n Matches method invoked in end-user code with {FormatBase#key}.\n If format matches the current request, it saves it for negotiation\n in {FormatHandler#response}.", "Parses JSON string in request body if present and converts it to a hash.\n @param request [Rack::Request] contains information about the current HTTP\n        request\n @return {Hash} including parsed params or nil", "Encodes response appropriately by converting it to a JSON string.\n @param response [String, Hash, Array] response from format handler block.\n @return Rack response {Array}", "If file already exists on remote it will be overwritten.", "Transforms a plain text password into an 8 character string recognised by\n the ADAM-6050. The algorithm, if you can even call it that, used to\n perform the transformation was found by trial and error.\n\n @raise [FormatError] if the plain text password is longer than 8\n   characters.\n\n @param  plain [String] the plain text version of the password.\n @return [String] the obfuscated, 8 character password.", "Hackery to accomodate Syck. Remove for 4.0.", "Initialize a walker with a graph and sexp\n\n All files in a code base should be walked once in <tt>:find_nodes</tt> mode, and then walked again in <tt>:find_relations</tt> mode.\n\n @param graph [IR::Graph] a graph to which nodes and relations will be added\n @param sexp [Sexp] the root sexp of a ruby file\n @option opt [Symbol] :mode (:find_nodes) one of <tt>:find_nodes</tt> or <tt>:find_relations</tt>\n Walk the tree rooted at the given sexp\n @param s [Sexp] if +nil+ will be the root sexp\n @return [nil]", "Emit delimited nodes\n\n @param [Enumerable<Node>] nodes\n\n @return [self]\n\n @api private", "Returns the exchanges rates based on the specified request\n\n @param rates_request [OandaRubyClient::RatesRequest] Request criteria\n @return [OpenStruct] An object structured similarly to the response from the Exchange Rate API", "Returns the number of remaining quote requests\n\n @return [Fixnum, 'unlimited'] Number of remaining quote requests", "Resets the tracking for the motor position.\n\n @param [Symbol] port The port the motor is attached to. Should be `:a`, `:b`, or `:c`\n @param [Boolean] set_relative Sets the position tracking to relative if true, otherwise absolute if false.\n @return [nil]", "Runs the motor\n\n @param [Symbol] port The port the motor is attached to. Should be `:a`, `:b`, `:c`, `:all`\n @param [Integer] power A number between -100 through 100 inclusive. Defaults to 100.\n @return [nil]", "A wrapper around the transceive function for the connection.\n\n The first three bytes of the return value are stripped off. Errors are\n raised if they show a problem.\n\n @param [LegoNXT::Type] bits A list of bytes.\n @return [String] The bytes returned; bytes 0 through 2 are stripped."]
\ No newline at end of file