gliffy 0.0.6 → 0.0.7

data/lib/gliffy/api/error.rb

@@ -0,0 +1,14 @@
+module Gliffy
+  class API::Error < Exception
+    attr_reader :code, :text
+
+    def initialize(code, text)
+      @code = code
+      @text = text
+    end
+
+    def to_s
+      "#{code.to_i}: #{text}"
+    end
+  end
+end

data/lib/gliffy/api/facade.rb

@@ -10,19 +10,31 @@ module Gliffy
       end
 
       def raw(partial_url, params = {})
-        @api.raw(api_root + partial_url, params)
+        api.raw(api_root + partial_url, params)
       end
 
       def get(partial_url, params)
-        @api.get(api_root + partial_url, params)
+        response = api.get(api_root + partial_url, params)
+
+        if response.error?
+          handle_error response
+        end
+
+        response
       end
 
       def post(partial_url, params)
-        @api.post(api_root + partial_url, params)
+        response = api.post(api_root + partial_url, params)
+
+        if response.error?
+          handle_error response
+        end
+
+        response
       end
 
       def web(partial_url, params)
-        @api.web(web_root + partial_url, params)
+        api.web(web_root + partial_url, params)
       end
 
       def get_folders(account_id)
@@ -30,8 +42,64 @@ module Gliffy
             :action => 'get')
       end
 
+      def update_document_metadata(document_id, name, shared)
+        params = {
+          :action => "update",
+        }
+
+        if not name.nil?
+          params[:documentName] = name
+        end
+
+        if not shared.nil?
+          params[:public] = shared ? "true" : "false"
+        end
+
+        post("/accounts/#{account_id}/documents/#{document_id}/meta-data.xml",
+             params)
+      end
+
+      def delete_document(document_id)
+        post("/accounts/#{account_id}/documents/#{document_id}.xml",
+             :action => "delete")
+      end
+
+      def create_document(name, type, original_id, path)
+        params = {
+          :action => "create",
+          :documentName => name,
+          :documentType => type
+        }
+
+        if not original_id.nil?
+          params[:templateDiagramId] = original_id
+        end
+
+        if not path.nil?
+          params[:folderPath] = path
+        end
+
+        post("/accounts/#{account_id}/documents.xml",
+             params)
+      end
+
       private
 
+      def handle_error(response)
+        code = response.integer("//g:response/g:error/@http-status")
+        text = response.string("//g:response/g:error/text()")
+
+        raise Gliffy::API::Error.new(code, text)
+      end
+
+      def api
+        @api
+      end
+
+      def account_id
+        api.account_id
+      end
+
       def initialize(protocol, api)
         @protocol = protocol
         @api = api

data/lib/gliffy/api/response.rb

@@ -32,6 +32,10 @@ module Gliffy
         !@base.at_xpath(path, namespaces).nil?
       end
 
+      def error?
+        exists("//g:response[@success='false']")
+      end
+
       private
 
       # Gliffy XML namespace to be used in XPath expressions

data/lib/gliffy/document.rb

@@ -1,69 +1,103 @@
-module Gliffy
-  class Document
-    attr_reader :owner
-    attr_reader :id
-    attr_reader :is_public
-    attr_reader :versions
-    attr_reader :name
-    attr_reader :modified, :created, :published
-
-    def self.load(owner, node)
-      @loaded ||= {}
-
-      id = node.integer('@id')
-      if not @loaded.has_key? id then
-        @loaded[id] = Gliffy::Document.new(
-          owner,
-          id,
-          :is_public => node.exists('@is-public'),
-          :versions => node.integer('@num-versions'),
-          :name => node.string('g:name'),
-          :modified => node.timestamp('g:mod-date'),
-          :created => node.timestamp('g:create-date'),
-          :published => node.timestamp('g:published-date')
-          )
-      end
-
-      @loaded[id]
-    end
-
-    def self.clear_cache
-      @loaded = {}
-    end
-
-    def editor(return_url, return_text)
-      api.web(
-        "/gliffy/",
-        :launchDiagramId => id,
-        :returnURL => return_url,
-        :returnButtonText => return_text
-      )
-    end
-
-    def png
-      Document::PNG.new(self)
-    end
-
-    def public?
-      is_public
-    end
-
-    def api
-      owner.api
-    end
-
-    private
-
-    def initialize(owner, id, params)
-      @owner = owner
-      @id = id
-
-      @is_public = params[:is_public]
-      @versions = params[:versions]
-      @name = params[:name]
-      @modified = params[:modified]
-      @created = params[:created]
-      @published = params[:published]
-    end
-  end
-end
+require "observer"
+
+module Gliffy
+  class Document
+    include Observable
+
+    TYPE_DIAGRAM = "diagram"
+
+    attr_reader :owner
+    attr_reader :id
+    attr_reader :is_public
+    attr_reader :versions
+    attr_reader :name
+    attr_reader :modified, :created, :published
+
+    def self.load(owner, node)
+      @loaded ||= {}
+
+      id = node.integer('@id')
+      if not @loaded.has_key? id then
+        @loaded[id] = Gliffy::Document.new(
+          owner,
+          id,
+          :is_public => node.exists('@is-public'),
+          :versions => node.integer('@num-versions'),
+          :name => node.string('g:name'),
+          :modified => node.timestamp('g:mod-date'),
+          :created => node.timestamp('g:create-date'),
+          :published => node.timestamp('g:published-date')
+          )
+      end
+
+      @loaded[id]
+    end
+
+    def self.clear_cache
+      @loaded = {}
+    end
+
+    def rename(new_name)
+      @name = new_name
+
+      api.update_document_metadata(id, new_name, nil)
+    end
+
+    def delete
+      api.delete_document(id)
+      @is_deleted = true
+
+      changed
+      notify_observers :delete, self
+    end
+
+    def deleted?
+      @is_deleted
+    end
+
+    def editor(return_url, return_text)
+      api.web(
+        "/gliffy/",
+        :launchDiagramId => id,
+        :returnURL => return_url,
+        :returnButtonText => return_text
+      )
+    end
+
+    def svg
+      Document::Presentation::SVG.new(self)
+    end
+
+    def xml
+      Document::Presentation::XML.new(self)
+    end
+
+    def png
+      Document::Presentation::PNG.new(self)
+    end
+
+    def public?
+      is_public
+    end
+
+    def api
+      owner.api
+    end
+
+    private
+
+    def initialize(owner, id, params)
+      @owner = owner
+      @id = id
+
+      @is_public = params[:is_public]
+      @versions = params[:versions]
+      @name = params[:name]
+      @modified = params[:modified]
+      @created = params[:created]
+      @published = params[:published]
+
+      @is_deleted = false
+    end
+  end
+end

data/lib/gliffy/document/presentation.rb

@@ -0,0 +1,27 @@
+module Gliffy
+  class Document::Presentation
+    attr_reader :document
+
+    def initialize(document)
+      @document = document
+    end
+
+    private
+
+    def api
+      document.api
+    end
+
+    def account
+      document.owner
+    end
+
+    def document_id
+      document.id
+    end
+
+    def account_id
+      account.id
+    end
+  end
+end

data/lib/gliffy/{document_png.rb → document/presentation/png.rb}

@@ -1,16 +1,10 @@
 module Gliffy
-  class Document::PNG
-    attr_reader :document
-
+  class Document::Presentation::PNG < Document::Presentation
     SIZE_THUMBNAIL = "T"
     SIZE_SMALL = "S"
     SIZE_MEDIUM = "M"
     SIZE_FULL = "L"
 
-    def initialize(document)
-      @document = document
-    end
-
     def content(size)
       api.raw(
         "/accounts/#{account_id}/documents/#{document_id}.png",
@@ -34,23 +28,5 @@ module Gliffy
     def full
       content(SIZE_FULL)
     end
-
-    private
-
-    def api
-      document.api
-    end
-
-    def account
-      document.owner
-    end
-
-    def document_id
-      document.id
-    end
-
-    def account_id
-      account.id
-    end
   end
-end
+end

data/lib/gliffy/document/presentation/svg.rb

@@ -0,0 +1,10 @@
+module Gliffy
+  class Document::Presentation::SVG < Document::Presentation
+    def content
+      api.raw(
+        "/accounts/#{account_id}/documents/#{document_id}.svg",
+        :action => 'get'
+      )
+    end
+  end
+end

data/lib/gliffy/document/presentation/xml.rb

@@ -0,0 +1,10 @@
+module Gliffy
+  class Document::Presentation::XML < Document::Presentation
+    def content
+      api.raw(
+        "/accounts/#{account_id}/documents/#{document_id}.xml",
+        :action => 'get'
+      )
+    end
+  end
+end

data/lib/gliffy/folder.rb

@@ -1,71 +1,91 @@
-require 'uri'
-
-module Gliffy
-  class Folder
-    attr_reader :name, :path
-    attr_reader :owner, :parent
-    attr_reader :folders
-
-    def self.load(owner, node)
-      Gliffy::Folder.new(
-        owner,
-        node.string('g:name'),
-        node.string('g:path'),
-        node.nodes('g:folder').map {|n| Gliffy::Folder.load(owner, n)}
-      )
-    end
-
-    def initialize(owner, name, path, folders)
-      @owner = owner
-      @name = name
-      @path = path
-
-      @folders = folders
-      @folders.each do |f|
-        f.parent = self
-      end
-    end
-
-    def parent=(parent)
-      if path != parent.path + "/" + name then
-        raise "Invalid parent"
-      end
-
-      @parent = parent
-    end
-
-    def documents
-      @documents ||= load_documents
-    end
-
-    def root?
-      path == "ROOT"
-    end
-
-    private
-
-    def api
-      owner.api
-    end
-
-    def account_id
-      owner.id
-    end
-
-    def escaped_path
-      path.gsub(' ', '+')
-    end
-
-    def load_documents
-      # Path  is alphanumeric  +  spaces and  '/'.   Spaces should  be
-      # escaped; slashes should NOT be escaped.
-      url = "/accounts/#{account_id}/folders/#{escaped_path}/documents.xml"
-      response = api.get(url,
-                         :action => "get")
-
-      response
-        .nodes('//g:document')
-        .map { |n| Gliffy::Document.load(owner, n) }
-    end
-  end
-end
+require 'uri'
+
+module Gliffy
+  class Folder
+    attr_reader :name, :path
+    attr_reader :owner, :parent
+    attr_reader :folders
+
+    def self.load(owner, node)
+      Gliffy::Folder.new(
+        owner,
+        node.string('g:name'),
+        node.string('g:path'),
+        node.nodes('g:folder').map {|n| Gliffy::Folder.load(owner, n)}
+      )
+    end
+
+    def initialize(owner, name, path, folders)
+      @owner = owner
+      @name = name
+      @path = path
+
+      @folders = folders
+      @folders.each do |f|
+        f.parent = self
+      end
+    end
+
+    def parent=(parent)
+      if path != parent.path + "/" + name then
+        raise "Invalid parent"
+      end
+
+      @parent = parent
+    end
+
+    def create_document(name)
+      api.create_document(name, Gliffy::Document::TYPE_DIAGRAM, nil, path)
+    end
+
+    def documents
+      @documents ||= load_documents
+    end
+
+    def root?
+      path == "ROOT"
+    end
+
+    # observer callback
+    def update(event, target)
+      case event
+      when :delete
+        @documents = @documents.delete_if { |element| element == target }
+      else
+        raise ArgumentError.new(event)
+      end
+    end
+
+    private
+
+    def api
+      owner.api
+    end
+
+    def account_id
+      owner.id
+    end
+
+    def escaped_path
+      path.gsub(' ', '+')
+    end
+
+    def load_documents
+      # Path  is alphanumeric  +  spaces and  '/'.   Spaces should  be
+      # escaped; slashes should NOT be escaped.
+      url = "/accounts/#{account_id}/folders/#{escaped_path}/documents.xml"
+      response = api.get(url,
+                         :action => "get")
+
+      response
+        .nodes('//g:document')
+        .map { |n| load_document n }
+    end
+
+    def load_document(n)
+      document = Gliffy::Document.load(owner, n)
+      document.add_observer(self)
+      document
+    end
+  end
+end