woodwing_elvis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ea949496d1f812078942642edaec4ba77633479
+  data.tar.gz: 7b5be281d4ac85ad6b0c75c713847388a1758c13
+SHA512:
+  metadata.gz: 3a4b656cbb4a5051e5a3d922922d26d320ee9e5b10366eaa4aa753ec989e08e23fc0d710d150d0640342496d9135c784fbd416292efe4f00b10e678b49ea9581
+  data.tar.gz: 925d473f24b19506abd07714614284dce20b4a973cd36e0100563781e0c9ce16b4430f4916eb0a783100588347b21fe0a54f8805b2bf8efee424d93264227ef3

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.irbrc
+.rvmrc
+.envrc
+.ruby-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in woodwing_elvis.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1 @@
+You want it; its yours.

data/README.md

@@ -0,0 +1,14 @@
+woodwing_elvis
+==============
+
+A Ruby implementation of Woodwing's Elvis API
+
+System environment variables used:
+
+  Name              Default
+  ----------------- -------------------------------
+  ELVIS_API_URL     http://localhost:8080/services/
+  ELVIS_USER        guest
+  ELVIS_PASS        guest
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/woodwing.rb

@@ -0,0 +1,16 @@
+###################################################
+###
+##  File: woodwing.rb
+##  Desc: API definitions for WoodWing products
+#
+
+require "url_safe_base64"
+require 'rest_client'
+require 'multi_json'
+
+module WoodWing
+  require_relative 'woodwing/version'
+  require_relative 'woodwing/elvis'
+end # module WoodWing
+
+WW      = WoodWing        unless defined?(WW)

data/lib/woodwing/elvis.rb

@@ -0,0 +1,273 @@
+###################################################
+###
+##  File: rest.rb
+##  Desc: REST API definitions for WoodWing's Elvis
+#
+
+require_relative 'elvis/utilities'
+require_relative 'elvis/rest'
+require_relative 'elvis/soap'
+
+module WoodWing
+
+# Elvis is a Digital Asset Manager implemented in Java
+class Elvis
+
+  attr_accessor :base_url
+  attr_accessor :cookies
+
+  # SMELL: Why is this error any more special than the others?
+  class ConcurrentModificationException < StandardError; end
+  class NotLoggedIn < StandardError; end
+
+
+  COMMANDS = {
+    # method name           URL Resource        Required Parameters
+    browse:                 ["browse",          [:path]],
+    checkout:               ["checkout",        []],
+    copy:                   ["copy",            [:source, :target]],
+    create:                 ["create",          [:assetPath, :Filedata]],
+    create:                 ["create",          [:Filedata]],
+    create_auth_key:        ["create_auth_key", []],
+    create_collection:      ["create",          [:assetPath]],
+    create_relation:        ["create_relation", []],
+    create_folder:          ["createFolder",    [:path]],
+    localization:           ["localization",    []],
+    log_usage_stats:        ["log_usage_stats", []],
+    login:                  ["login",           [:username, :password]],
+    logout:                 ["logout",          []],
+    move:                   ["move",            [:source, :target]],
+    profile:                ["profile",         []],
+    query_stats:            ["queryStats",      []],
+    remove_bulk:            ["remove",          [:q]],
+    remove_bulk_ids:        ["remove",          [:ids]],
+    remove_folder:          ["remove",          [:folderPath]],
+    remove_relation:        ["remove_relation", []],
+    revoke_auth_keys:       ["revoke_auth_keys",[]],
+    search:                 ["search",          [:q]],
+    undo_checkout:          ["undo_checkout",   []],
+    update:                 ["update",          [:Filedata, :id]],
+    update_metadata:        ["update",          [:id, :metadata]],
+    update_auth_key:        ["update_auth_key", []],
+    update_bulk_metadata:   ["updatebulk",      [:q, :metadata]],
+    zip_download:           ["zip_download",    []]
+  }
+
+
+
+  def initialize( my_base_url=ENV['ELVIS_API_URL'],
+                  my_cookies={})
+
+    @base_url     = my_base_url
+    @cookies      = my_cookies
+
+    @base_url += '/'  unless @base_url.end_with?('/')
+
+  end
+
+
+  # Use RestClient.get
+
+  def get_response(url=nil,options={})
+
+    raise NotLoggedIn unless logged_in?  ||  url.end_with?('login')
+
+    response = RestClient.get(url, { params: options, cookies: @cookies })
+
+if $DEBUG
+    debug_me(){[:url, :options, :response ]}
+    debug_me(){[ 'response.code', 'response.cookies', 'response.body' ]}
+end
+
+    @cookies = response.cookies unless response.cookies.empty?
+
+    response = MultiJson.load(  response.body,
+                                :symbolize_keys => true)
+
+    if response.include?(:errorcode)
+      if 401 == response[:errorcode]     &&
+        response[:message].include?('ConcurrentModificationException')
+        raise ConcurrentModificationException
+      else
+        error_condition = "ERROR #{response[:errorcode]}: #{response[:message]}"
+        raise error_condition
+      end
+    end
+
+    return response
+  end
+
+
+  # SMELL: This is sooooo close to #get_response
+  # Use RestClient.post
+
+  def get_response_using_post(url=nil,options={})
+
+     raise NotLoggedIn unless logged_in?  ||  url.end_with?('login')
+
+    response = RestClient.post( url, options, { cookies: @cookies } )
+
+if $DEBUG
+    debug_me(){[:url, :options, :response ]}
+    debug_me(){[ 'response.code', 'response.cookies', 'response.body' ]}
+end
+
+    @cookies = response.cookies unless response.cookies.empty?
+
+    response = MultiJson.load(  response.body,
+                                :symbolize_keys => true)
+
+    if response.include?(:errorcode)
+      if 401 == response[:errorcode]     &&
+        response[:message].include?('ConcurrentModificationException')
+        raise ConcurrentModificationException
+      else
+        error_condition = "ERROR #{response[:errorcode]}: #{response[:message]}"
+        raise error_condition
+      end
+    end
+
+    return response
+
+  end
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-copy
+  def copy(options={})
+    Utilities.demand_required_options!( :copy, options )
+    url = base_url + "copy"
+    response = get_response(url, options)
+  end # copy
+
+
+  # No file is uploaded.  A placehold asset is created with the
+  # associated metadata
+  def create_collection(options={})
+    Utilities.demand_required_options!( :create_collection, options )
+    url = base_url + "create"
+    options.merge!( {assetType: 'collection'} )
+    response = get_response(url, options)
+  end # create
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-localization
+  def localization(options={})
+    url = base_url + "localization"
+    response = get_response(url, options)
+  end # localization
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-log_usage_stats
+  def log_usage_stats(options={})
+    url = base_url + "log_usage_stats"
+    response = get_response(url, options)
+  end # log_usage_stats
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-move
+  def move(options={})
+    Utilities.demand_required_options!( :move, options )
+    url = base_url + "move"
+    response = get_response(url, options)
+  end # move
+
+  alias :rename :move
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-profile
+  def profile(options={})
+    url = base_url + "profile"
+    response = get_response(url, options)
+  end # profile
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-query_stats
+  def query_stats(options={})
+    url = base_url + "queryStats"
+    response = get_response(url, options)
+  end # query_stats
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-remove
+  # can delete one or more using list of IDs or a search query
+  # pr a folderPath.  The folderPath process has been abstracted
+  # into #remove_folder.
+
+  def remove_bulk(options={})
+    Utilities.demand_required_options!( :remove_bulk, options )
+    url       = base_url + "remove"
+    response  = get_response(url, options)
+  end # remove
+
+  alias :delete_bulk :remove_bulk
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-remove
+  # can delete one or more using list of IDs or a search query
+  # pr a folderPath.  The folderPath process has been abstracted
+  # into #remove_folder.
+
+  def remove_bulk_ids(options={})
+    Utilities.demand_required_options!( :remove_bulk_ids, options )
+    url       = base_url + "remove"
+    response  = get_response(url, options)
+  end # remove
+
+  alias :delete_bulk_ids :remove_bulk_ids
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-update
+  # used to update assets and metadata
+  def update(options={})
+    Utilities.demand_required_options!( :update, options )
+    url = base_url + "update"
+    response = get_response(url, options)
+  end # update
+
+  alias :replace        :update
+  alias :update_asset   :update
+  alias :replace_asset  :update
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-update
+  # used to update metadata for a specific asset referenced by 'id'
+
+  def update_metadata(options={})
+    Utilities.demand_required_options!( :update, options )
+    options[:metadata] = options[:metadata].to_json
+    url       = base_url + "update"
+    response  = get_response(url, options)
+  end # update
+
+  alias :replace_metadata :update_metadata
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-updatebulk
+  # updates metadata fields for all assets matching a specific query
+  def update_bulk_metadata(options={})
+    Utilities.demand_required_options!( :update_bulk_metadata, options )
+    options[:metadata] = options[:metadata].to_json
+    url       = base_url + "updatebulk"
+    response  = get_response(url, options)
+  end # update_bulk
+
+  alias :bulk_update_metadata   :update_bulk_metadata
+  alias :bulk_replace_metadata  :update_bulk_metadata
+  alias :replace_bulk_metadata  :update_bulk_metadata
+
+
+  # https://elvis.tenderapp.com/kb/api/rest-zip_download
+  def zip_download(options={})
+    url = base_url + "zip_download"
+    response = get_response(url, options)
+  end # zip_download
+
+  alias :download_zip :zip_download
+
+end # class Elvis
+
+end # module WoodWing
+
+
+WW      = WoodWing        unless defined?(WW)
+WwElvis = WoodWing::Elvis unless defined?(WwElvis)

data/lib/woodwing/elvis/rest.rb

@@ -0,0 +1,30 @@
+###################################################
+###
+##  File: rest.rb
+##  Desc: REST API definitions for WoodWing's Elvis
+#
+
+module WoodWing
+  class Elvis
+
+module Rest
+
+  require_relative 'rest/authorization_keys'
+  require_relative 'rest/browse'
+  require_relative 'rest/checkout'
+  require_relative 'rest/create'
+  require_relative 'rest/create_elvislink'
+  require_relative 'rest/login_logout'
+  require_relative 'rest/relations'
+  require_relative 'rest/search'
+  require_relative 'rest/stub'
+
+end # module WoodWing::Elvis::Rest
+
+include Rest
+
+end # class Elvis
+end # module WoodWing
+
+WW      = WoodWing        unless defined?(WW)
+WwElvis = WoodWing::Elvis unless defined?(WwElvis)

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

@@ -0,0 +1,31 @@
+module WoodWing
+  class Elvis
+    module Rest
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-createauthkey
+      def create_auth_key(options={})
+        url = base_url + "create_auth_key"
+        response = get_response(url, options)
+      end # create_auth_key
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-update_auth_key
+      def update_auth_key(options={})
+        url = base_url + "update_auth_key"
+        response = get_response(url, options)
+      end # update_auth_key
+
+      alias :replace_auth_key :update_auth_key
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-revokeauthkeys
+      def revoke_auth_keys(options={})
+        url = base_url + "revoke_auth_keys"
+        response = get_response(url, options)
+      end # revoke_auth_keys
+
+
+    end # module Rest
+  end # class Elvis
+end # module WoodWing

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

@@ -0,0 +1,65 @@
+module WoodWing
+  class Elvis
+    module Rest
+
+
+      # https://elvis.tenderapp.com/kb/api/rest-browse
+      #
+      # browse folders and show their subfolders and collections,
+      # similar to how folder browsing works in the Elvis desktop client.
+      #
+      # Note: Even though it is possible to return the assets in folders,
+      #       doing so is not advised. The browse call does not limit the
+      #       number of results, so if there are 10000 assets in a folder
+      #       it will return all of them. It is better to use a search to
+      #       find the assets in a folder and fetch them in pages.
+      #
+      # http://yourserver.com/services/browse
+      #   ?path=<assetPath>
+      #   &fromRoot=<folderPath>
+      #   &includeFolders=<true|false>
+      #   &includeAssets=<true|false>
+      #   &includeExtensions=<comma-delimited extensions>
+      #
+      # Options
+      #   path    (Required) The path to the folder in Elvis you want to list.
+      #           Make sure the URL is properly URL-encoded, for example: spaces should
+      #           often be represented as %20.
+      #
+      #   fromRoot  Allows returning multiple levels of folders with their
+      #             children. When specified, this path is listed, and all folders
+      #             below it up to the 'path' will have their children returned as well.
+      #
+      #             This ability can be used to initialize an initial path in a
+      #             column tree folder browser with one server call.
+      #
+      #             Optional. When not specified, only the children of the specified
+      #             'path' will be returned.
+      #
+      #             Available since Elvis 2.6
+      #
+      #   includeFolders  Indicates if folders should be returned.
+      #                   Optional. Default is true.
+      #
+      #   includeAsset  Indicates if files should be returned.
+      #                 Optional. Default is true, but filtered to
+      #                 only include 'container' assets.
+      #
+      #   includeExtensions   A comma separated list of file extensions to
+      #                       be returned. Specify 'all' to return all file types.
+      #                       Optional. Default includes all 'container'
+      #                       assets: .collection, .dossier, .task
+
+      def browse(options={})
+
+        Utilities.demand_required_options!( :browse, options )
+
+        url      = base_url + "browse"
+        response = get_response(url, options)
+
+      end # browse
+
+
+    end # module Rest
+  end # class Elvis
+end # module WoodWing