Contents

module Evrythng
  class Client
    # Defines methods related to collections
    module Collections
      # Returns a list of collections
      #
      # @format :json, :xml
      # @authenticated true
      # @rate_limited true
      # @param options [Hash] A customizable set of options.
      # @return [Hashie::Rash] The requested list of collections.
      # @see http://dev.evrythng.net/doc/get/collections
      # @example Return the list of collections
      #   Evrythng.collections
      def collections(options={})
        response = get('collections', options)
        format.to_s.downcase == 'xml' ? response['collections'] : response
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
evrythng-0.0.1	lib/evrythng/client/collections.rb