woodwing_elvis 0.0.1

data/lib/woodwing/elvis/rest/checkout.rb

@@ -0,0 +1,24 @@
+module WoodWing
+  class Elvis
+    module Rest
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-checkout
+      def checkout(options={})
+        url = base_url + "checkout"
+        response = get_response(url, options)
+      end # checkout
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-undo_checkout
+      def undo_checkout(options={})
+        url = base_url + "undo_checkout"
+        response = get_response(url, options)
+      end # undo_checkout
+
+      alias :abort_checkout :undo_checkout
+
+
+    end # module Rest
+  end # class Elvis
+end # module WoodWing

data/lib/woodwing/elvis/rest/create.rb

@@ -0,0 +1,71 @@
+module WoodWing
+  class Elvis
+    module Rest
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-create
+      # Upload and create an asset.
+      #
+      # This call will create a new asset in Elvis. It can be used to upload files
+      # into Elvis. It can also be used to create 'virtual' assets like collections.
+      # In that case no file has to be uploaded and Elvis will create a 0 kb
+      # placeholder for the virtual asset.
+      #
+      # When you want to create a new asset, certain metadata is required. The
+      # metadata is needed to determine where the file will be stored in Elvis.
+      #
+      # http://yourserver.com/services/create
+      #   ?Filedata=<multipart/form-data encoded file>
+      #   &metadata=<JSON encoded metadata>
+      #   &<Elvis metadata field name>=<value>
+      #   &nextUrl=<next URL>
+      #
+      # Options
+      #
+      #   Filedata  The file to be created in Elvis.  If you do not specify a
+      #             filename explicitly through the metadata, the filename of
+      #             the uploaded file will be used.
+      #             NOTE: The parameter is named "Filedata" because that is the
+      #                   standard name used by flash uploads. This makes it easy
+      #                   to use flash uploaders to upload batches of files to Elvis.
+      #             Optional. If omitted, a 0kb placeholder file will be created.
+      #             See the method create_collection()
+      #
+      #   metadata  A JSON encoded object with properties that match Elvis metadata
+      #             field names. This metadata will be set on the asset in Elvis.
+      #             Optional. You can also use parameters matching Elvis field names.
+      #
+      #   *   Any parameter matching an Elvis metadata field name will be used as
+      #       metadata. This metadata will be set on the asset in Elvis.
+      #       Optional. You also use the 'metadata' parameter.
+      #
+      #   nextUrl   When specified, the service will send a 301 redirect to this
+      #             URL when it is completed successfully. If you place '${id}' in
+      #             the URL, it will be replaced with the Elvis asset id of the
+      #             created asset.
+      #             Optional. If omitted, a simple 200 OK status code will be returned
+
+      def create(options={})
+
+        Utilities.demand_required_options!( :create, options )
+
+        # SMELL:  Don't think this is required since last change to
+        #         get_response_with_post
+        options.merge!( { multipart: true } )
+
+        url       = base_url + "create"
+        response  = get_response_using_post(url, options)
+
+      end # create
+
+      alias :create_file :create
+      alias :upload_file :create
+      alias :import_file :create
+      alias :create_asset :create
+      alias :upload_asset :create
+      alias :import_asset :create
+
+
+    end # module Rest
+  end # class Elvis
+end # module WoodWing

data/lib/woodwing/elvis/rest/create_elvislink.rb

@@ -0,0 +1,148 @@
+module WoodWing
+  class Elvis
+    module Rest
+
+=begin
+
+  Create an '.elvislink' file
+
+  http://elvis.example.com/elvislink
+      /yourfilename.elvislink
+      ?action=openAuthkey | openAssets | openContainers
+             | activateContainers | openSearch | openBrowse
+      &key=<authkey to open and link to the user>
+      &containerIds=<collection id's to open or activate>
+      &assetIds=<assets to open>
+      &q=<query for search>
+      &sort=<sort for search>
+      &folderPath=<folderPath to open>
+      &includeSubFolders=true|false
+
+  What does it do?
+
+  Produce an '*.elvislink' file that will open the desktop client and perform an action. Some actions that can be performed:
+
+      Show results sent by an email link (authkey).
+      Open a search.
+      Show a specific asset.
+
+  Available since Elvis 2.6
+
+  Parameters
+
+  action    The action that should be performed when the link file is opened in
+            the desktop client.
+            See the elvisContext functions for the possible actions.
+            Optional. Not needed when you specify the 'key' parameter. In that case the
+            openAuthkey action is automatically used.
+
+  key       An authkey to be opened and displayed in the desktop client. The
+            permissions granted by the authkey will be linked to the user when opened.
+            Optional. Only needed if you want to open an authkey.
+
+  other parameters  For detailed descriptions of the other parameters, see the
+  elvisContext functions.
+
+  Return value
+
+  The service produces an XML file with the extension '.elvislink'. The file also includes the server URL so the desktop client can connect to the correct server.
+
+  Examples
+
+  openAuthkey   elvislink
+
+    http://demo.elvisdam.com/elvislink
+        ?key=9T_WLil348lBtFk8FDTwPN
+
+    This URL generates: openAuthkey-2011_11_328-144355.elvislink
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <elvisLink serverUrl="http://demo.elvisdam.com">
+        <openAuthkey authkey="9T_WLil348lBtFk8FDTwPN"/>
+    </elvisLink>
+
+  openSearch  elvislink
+
+    http://demo.elvisdam.com/elvislink/openBeaches.elvislink
+        ?action=openSearch&q=beach&sort=name
+
+    This URL generates: openBeaches.elvislink
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <elvisLink serverUrl="http://demo.elvisdam.com">
+        <openSearch q="beach" sort="name"/>
+    </elvisLink>
+
+  openBrowse  elvislink
+
+    http://demo.elvisdam.com/elvislink/openTrailers.elvislink
+        ?action=openBrowse
+        &folderPath=/Demo Zone/Videos/Movie Trailers
+        &includeSubFolders=true
+        &sort=assetCreated
+
+    This URL generates: openTrailers.elvislink
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <elvisLink serverUrl="http://demo.elvisdam.com">
+        <openBrowse folderPath="/Demo Zone/Videos/Movie Trailers"
+                    includeSubFolders="true" sort="assetCreated"/>
+    </elvisLink>
+
+  openAssets  elvislink
+
+    http://demo.elvisdam.com/elvislink
+        ?action=openAssets
+        &assetIds=Bg7fObz1aVr96wy97riUad,0l2ZhcAfK779hCXqTf2E7s
+
+    This URL generates: openAssets-2011_11_328-140254.elvislink
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <elvisLink serverUrl="http://demo.elvisdam.com">
+        <openAssets assetIds="Bg7fObz1aVr96wy97riUad,0l2ZhcAfK779hCXqTf2E7s"/>
+    </elvisLink>
+
+  openContainers  elvislink
+
+    http://demo.elvisdam.com/elvislink/openCollections.elvislink
+        ?action=openContainers
+        &containerIds=0JkPrbQc40g8RQIC1NI6uo,6BN2FRaCqyLA5DjJJdB9h4
+        &sort=name
+
+    This URL generates: openCollections.elvislink
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <elvisLink serverUrl="http://demo.elvisdam.com">
+        <openContainers
+                    containerIds="0JkPrbQc40g8RQIC1NI6uo,6BN2FRaCqyLA5DjJJdB9h4"
+                    sort="name"/>
+    </elvisLink>
+
+  activateContainers  elvislink
+
+    http://demo.elvisdam.com/elvislink
+        ?action=activateContainers
+        &containerIds=0JkPrbQc40g8RQIC1NI6uo,6BN2FRaCqyLA5DjJJdB9h4
+
+    This URL generates: activateContainers-2011_11_328-142851.elvislink
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <elvisLink serverUrl="http://demo.elvisdam.com">
+        <activateContainers
+                    containerIds="0JkPrbQc40g8RQIC1NI6uo,6BN2FRaCqyLA5DjJJdB9h4"/>
+    </elvisLink>
+
+=end
+
+      def create_elvislink(options)
+
+        Utilities.demand_required_options!( :elvislink, options )
+
+        url       = base_url + "elvislink"
+        response  = get_response_using_get(url, options)
+
+      end # def create_elvislink(options)
+
+    end # module Rest
+  end # class Elvis
+end # module WoodWing

data/lib/woodwing/elvis/rest/folders.rb

@@ -0,0 +1,27 @@
+module WoodWing
+  class Elvis
+    module Rest
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-create_folder
+      def create_folder(options={})
+        Utilities.demand_required_options!( :create_folder, options )
+        url = base_url + "createFolder"
+        response = get_response(url, options)
+      end # create_folder
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-remove
+      def remove_folder(options={})
+        Utilities.demand_required_options!( :remove_folder, options )
+        url = base_url + "remove"
+        response = get_response(url, options)
+      end # remove_folder
+
+      alias :delete_folder :remove_folder
+
+
+
+    end # module Rest
+  end # class Elvis
+end # module WoodWing

data/lib/woodwing/elvis/rest/login_logout.rb

@@ -0,0 +1,257 @@
+module WoodWing
+  class Elvis
+    module Rest
+
+      # TODO: Extend session management to support multiple sessions.
+
+      class AlreadyLoggedIn < StandardError; end
+
+
+      # A successful log in will result in a cookie
+      def logged_in?
+        not @cookies.empty?
+      end
+
+
+
+=begin
+      # https://elvis.tenderapp.com/kb/api/rest-login
+
+http://yourserver.com/services/login
+    ?cred=<base64 credentials>
+    &username=<username>
+    &password=<password>
+    &nextUrl=<URL for next page>
+    &failUrl=<URL for fail page>
+    &locale=<language_COUNTRY_variant>
+    &timezoneOffset=<timecode>
+    &clientType=api_...
+    &returnProfile=true
+
+What does it do?
+
+Authenticates your browser session.
+
+All other REST calls require an authenticated session, otherwise they will respond with a "401 Unauthorized" status.
+
+The login service can be used in two flavors:
+
+    Handle an AJAX login request
+
+    Use this if you want maximum control on the client side over what happens. It returns a JSON response with details about the result of your authenticate request. This mechanism is also used by the auto login function of the Elvis JavaScript library.
+
+    Handle form based login
+
+    Forwards to a 'success' or 'failure' URL after the authentication attempt. Use this to build a simple login page, see the following sample at GitHub. You can also tell the JavaScript library to use your login page whenever authentication is required.
+
+Parameters
+
+cred  Base 64 encoded credentials.
+        cred=<base64Encode( username + ":" + password )>
+      Base64 encoding is not secure. Use https to make login secure.
+      Optional. Either cred or username and password must be specified.
+
+username    The username to be used to login. This should match a valid
+            username from the LDAP or ActiveDirectory server or from the
+            internal Elvis users. Sometimes an LDAP configuration supports
+            various usernames for one user.
+            Optional. Either cred or username and password must be specified.
+
+password    The password for the user. Since this is passed to the server as
+            plain text, use https to make login secure.
+            Optional. Either cred or username and password must be specified.
+
+nextUrl     When specified, the service will send a 301 redirect to this URL
+            after a successful login.
+            Optional. When not specified, a JSON response with login details
+            will be returned.
+
+failUrl     When specified, the service will send a 301 redirect to this URL
+            if login fails.
+            Optional. When not specified, a JSON response with login failure
+            details will be returned.
+
+locale      The locale to be used for this user to format locale sensitive
+            information like dates and numbers.
+            A locale has one of the following formats:
+              <language code>
+              <language code>_<country code>
+            The language argument is a valid ISO Language Code. These codes are
+            the lower-case, two-letter codes as defined by ISO-639.  The country
+            argument is a valid ISO Country Code. These codes are the upper-case,
+            two-letter codes as defined by ISO-3166.
+            Examples:
+              locale=de
+              locale=fr
+              locale=nl_BE
+            Optional. When not specified, the locale configured on the server
+            will be used.
+
+timezoneOffset    The timezone for this user, used to format dates. Must be
+                  specified as base timezone offset in milliseconds to GMT. For example:
+                    America/Los_Angeles
+                    Base GMT offset: -8:00
+                    = -28800000 milliseconds
+                    timezoneOffset=-28800000
+                    Europe/Paris,
+                    Base GMT offset: +1:00
+                    = 3600000 milliseconds
+                    timezoneOffset=3600000
+                  Optional. When not specified, the timezone configured on the
+                  server will be used. If specified, the locale MUST also be
+                  specified, otherwise the timezoneOffset is ignored.
+
+clientType    Custom client type that will be displayed in the usage history of
+              the asset. Used to track which interface was used to perform the
+              operation. The client type must be prefixed with "api_", for example:
+                "api_MyPublicWebsite".
+              Optional. When not specified, operations will be tracked without a
+              client type.
+              Available since Elvis 3.0
+
+returnProfile   Specify 'true' to return profile with login response.
+                Optional. When not specified, profile details are not returned.
+                Available since Elvis 2.6. In older versions, profile information
+                was always returned.
+
+
+Return value
+------------
+
+When nextUrl and failUrl are set, the service will respond with a 302 redirect.
+This will change the URL of the browser and navigate to the 'next' URL.
+
+When nextUrl and failUrl are not set, the service returns a JSON response with
+the following information:
+
+loginSuccess    true | false
+                Indicates if login was successful.
+
+sessionId       The session ID.
+                Useful if you are doing cross-domain calls to an Elvis Server,
+                since session cookies are not accepted when received through a
+                cross-domain AJAX call. You will have to store the sessionId
+                yourself and add ;jsessionid=<received id> to the URL of each
+                subsequent call made to the Elvis Server. When you use the
+                JavaScript library to perform the login, this will be done for
+                you automatically.
+                Available since Elvis 2.6
+
+serverVersion   The version of the server. This can be used to check if the Elvis
+                Server you are connecting to meets your minimum server version
+                requirements.
+                Available since Elvis 2.6
+
+loginFaultMessage   A message indicating why login failed.
+                    Only returned when loginSuccess is false.
+
+userProfile   An object with details about the user.
+              Only returned when loginSuccess is true and the returnProfile
+              parameter is set to true.
+
+=end
+
+      # FIXME: Need to change Elvis to https otherwise anyone who snoops
+      #        the wire will find cred and be able to have complete access once
+      #        the white listed IP scheme has been dropped.
+
+      def login(options={})
+
+        raise AlreadyLoggedIn unless @cookies.empty?
+
+        unless options.include?(:cred)
+          options = {
+            username:   ENV['ELVIS_USER'],
+            password:   ENV['ELVIS_PASS']
+            }.merge(options)
+          options[:cred] = UrlSafeBase64.encode64("#{options[:username]}:#{options[:password]}")
+        end
+
+        options.delete(:username)
+        options.delete(:password)
+
+        options[:clientType]    = 'api_Ruby'
+        options[:returnProfile] = 'true'
+
+        url       = base_url + "login"
+        response  = get_response(url, options)
+
+        return response
+
+      end # login
+
+      alias :logon  :login
+      alias :signin :login
+
+=begin
+      # https://elvis.tenderapp.com/kb/api/rest-logout
+
+http://yourserver.com/services/logout
+
+Terminates your browser session. Use this to end a session using an AJAX call.
+
+Available since Elvis 2.6.
+
+Parameters
+
+This service has no parameters
+
+Return value
+------------
+
+logoutSuccess   == 'true'   Indicates that logout was successful.
+
+Note: Logging out through AJAX won't work if you are doing cross-domain calls, since session cookies are not accepted when received through a cross-domain AJAX call. Use "logout and redirect" instead, see below.
+
+Logout and redirect
+
+http://yourserver.com/logout
+    ?logoutSuccessUrl=<url>
+
+Redirects to a 'success' URL after terminating the session. The URL can be a relative or absolute URL and can even redirect to a different server.
+
+When no logoutSuccessUrl is specified, the user will be redirected to the configured landing page (by default this is the client install page).
+
+Examples
+
+AJAX logout with success
+
+The following shows the response of a successful logout.
+
+http://demo.elvisdam.com/services/logout
+
+    {
+      "logoutSuccess" : true
+    }
+
+Redirect logout
+
+Ends the session and redirects to www.elvisdam.com.
+logout
+
+http://demo.elvisdam.com/logout
+    ?logoutSuccessUrl=http%3A%2F%2Fwww.elvisdam.com
+
+
+=end
+
+
+      def logout(options={})
+
+        url       = base_url + "logout"
+        response  = get_response(url, options)
+
+        @cookies  = {} if response[:logoutSuccess]
+
+        return response
+
+      end # logout
+
+      alias :signout :logout
+      alias :signoff :logout
+      alias :logoff  :logout
+
+
+    end # module Rest
+  end # class Elvis
+end # module WoodWing