gliffy 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTk3NDU4YmY2MTdmMTk1MTM4YTE5MmZhOGUwYjg3MzE2ZmI5NzYxNg==
+    YzU3NGY4YjYxMzMzMTg4ZmUwMjBmYWE4Y2E5NWQ3MGUwMzgwNWU1Nw==
   data.tar.gz: !binary |-
-    ZGJhY2Y5ZGFiMGEzMmU5NmIyOGU4NjI0M2NlZWQ3NjZhNWFkMzlkNA==
+    YzhkNzViNDI3ZWMyMWFlZWI0NzM5MjI5MjFkZjUzYjk5MzJkNzhmOQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTBiYjRhOTVmZjgwYTVhY2JlZmFlNzYyMDRlYmE5YTJkZWE1NTNlZjMwYmNj
-    ZDE1NGM1OGM1YTIwNjZkZjFjMjU3MzQ1ZTg0YzEyYTVhYTVjOTI3Yjg1NGM2
-    MTJmYzhkZTg2ZjE1ODUyMDI2YzIwOTgwYmQ5YWMxMWYyNzViMWI=
+    YmU2NDFiMWYwZGZiMDRiMmU3YjZhNDE2MjY3OWI2MzYwOTVmMzE0NWI3MjYz
+    YTEzM2NkYTgzY2E0ZDIwOWUwNGI5NjE3Nzk2NDIxMTA4ZTcyZDI0YzE0NTBk
+    OTg2OTAwN2ZkNzVkMjM4ZmYyMmIzYzE2OTVmNzBjMTNlYTE1ZjM=
   data.tar.gz: !binary |-
-    OTJhZTQ2NTZkNTc1MGJjOWM1N2JjNDQ0ZDY3MzI5N2E2ZjdjN2NmNjg3NWVj
-    MzlmMTBlZGYwNDA5ODE5ZjUzMDEzYTI1ZDRjYWE1MWNiMjdiYTY0OTc2ODkw
-    NDI0NTlkZjBmODYyZWVhYjM0ZmU2YmJmNjk0NTJiMDY4N2Q3MzU=
+    NTE2NDVlNzQ5MTBlNDVhYTA3ZTQ0ZGJkOTMyYTQ4Yzk0NmMxY2NiMjkzZDA3
+    ZjNjYmJhZTA3ZmM2NGMwNDFlYjE2ZjJhMWE2OTVhY2M3ZmExYjAyYWJjNDQy
+    Y2M2MGFlMjgxODViNzVhYmIzNDRkZWJjYWYyNzVhMzgzZGE2NWE=

data/README.md

@@ -1,6 +1,9 @@
 Gliffy API wrapper
 ==================
 
+[![Gem Version](https://badge.fury.io/rb/gliffy.png)](http://badge.fury.io/rb/gliffy)
+[![Code Climate](https://codeclimate.com/github/bkon/gliffy.png)](https://codeclimate.com/github/bkon/gliffy)
+
 Basic usage
 -----------
 
@@ -36,9 +39,11 @@ Basic usage
 
     doc.xml.content
 
-### Navigating folders
+### Working with folders
 
     root = account.root
     root.folders[0].documents
     root.folders[1].name
     root.folders[1].path
+
+    folder.delete

data/lib/gliffy/api/facade.rb

@@ -37,6 +37,12 @@ module Gliffy
         api.web(web_root + partial_url, params)
       end
 
+      # Path  is alphanumeric  +  spaces and  '/'.   Spaces should  be
+      # escaped; slashes should NOT be escaped.
+      def escape_path(path)
+        path.gsub(' ', '+')
+      end
+
       def get_folders(account_id)
         get("/accounts/#{account_id}/folders.xml",
             :action => 'get')
@@ -64,6 +70,21 @@ module Gliffy
              :action => "delete")
       end
 
+      def move_document(document_id, folder_path)
+        post("/accounts/#{account_id}/folders/#{escape_path folder_path}/documents/#{document_id}.xml",
+             :action => "move")
+      end
+
+      def get_documents_in_folder(path)
+        get("/accounts/#{account_id}/folders/#{escape_path path}/documents.xml",
+            :action => "get")
+      end
+
+      def delete_folder(path)
+        post("/accounts/#{account_id}/folders/#{escape_path path}.xml",
+             :action => "delete")
+      end
+
       def create_document(name, type, original_id, path)
         params = {
           :action => "create",
@@ -83,6 +104,11 @@ module Gliffy
              params)
       end
 
+      def create_folder(path)
+        post("/accounts/#{account_id}/folders/#{path}.xml",
+             :action => "create")
+      end
+
       private
 
       def handle_error(response)

data/lib/gliffy/document.rb

@@ -43,12 +43,20 @@ module Gliffy
       api.update_document_metadata(id, new_name, nil)
     end
 
+    def move(folder)
+      api.move_document(id, folder.path)
+
+      changed
+      notify_observers :document_removed, self
+      folder.update :document_added, self
+    end
+
     def delete
       api.delete_document(id)
       @is_deleted = true
 
       changed
-      notify_observers :delete, self
+      notify_observers :document_deleted, self
     end
 
     def deleted?

data/lib/gliffy/folder.rb

@@ -2,6 +2,8 @@ require 'uri'
 
 module Gliffy
   class Folder
+    include Observable
+
     attr_reader :name, :path
     attr_reader :owner, :parent
     attr_reader :folders
@@ -23,7 +25,10 @@ module Gliffy
       @folders = folders
       @folders.each do |f|
         f.parent = self
+        f.add_observer(self)
       end
+
+      @is_deleted = false
     end
 
     def parent=(parent)
@@ -38,6 +43,20 @@ module Gliffy
       api.create_document(name, Gliffy::Document::TYPE_DIAGRAM, nil, path)
     end
 
+    def create_folder(name)
+      if has_child? name
+        raise ArgumentError.new(name)
+      end
+
+      new_path = path + "/" + name
+
+      api.create_folder(new_path)
+
+      new_folder = Folder.new(owner, name, new_path, [])
+      folders.push(new_folder)
+      new_folder
+    end
+
     def documents
       @documents ||= load_documents
     end
@@ -46,36 +65,49 @@ module Gliffy
       path == "ROOT"
     end
 
+    def deleted?
+      @is_deleted
+    end
+
+    def has_child?(name)
+      normalized_name = name.downcase
+      not folders.index do |child|
+        child.name.downcase == normalized_name
+      end.nil?
+    end
+
     # observer callback
     def update(event, target)
       case event
-      when :delete
+      when :document_removed, :document_deleted
         @documents = @documents.delete_if { |element| element == target }
+        target.delete_observer(self)
+      when :document_added
+        @documents.push target
+        target.add_observer(self)
+      when :folder_deleted
+        @folders = @folders.delete_if { |element| element == target }
       else
         raise ArgumentError.new(event)
       end
     end
 
-    private
+    def delete
+      api.delete_folder(path)
+      @is_deleted = true
 
-    def api
-      owner.api
+      changed
+      notify_observers :folder_deleted, self
     end
 
-    def account_id
-      owner.id
-    end
+    private
 
-    def escaped_path
-      path.gsub(' ', '+')
+    def api
+      owner.api
     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 = api.get_documents_in_folder(path)
 
       response
         .nodes('//g:document')

data/spec/lib/gliffy/api/facade_spec.rb

@@ -1,6 +1,20 @@
 require 'spec_helper'
 
 shared_examples_for "an API facade" do
+  it "has folder path escame method" do
+    expect(facade).to respond_to :escape_path
+  end
+
+  describe "folder path escape method" do
+    it "escapes spaces" do
+      expect(facade.escape_path("A B")).to eq "A+B"
+    end
+
+    it "does not escape slashes" do
+      expect(facade.escape_path("A/B")).to eq "A/B"
+    end
+  end
+
   context "when sending GET request" do
     it "forwards request to the API backend with HTTP protocol" do
       api.should_receive(
@@ -121,6 +135,80 @@ shared_examples_for "an API facade" do
     end
   end
 
+  it "allows user to move document to a different folder" do
+    expect(facade).to respond_to :move_document
+  end
+
+  context "when moving a document" do
+    let(:document_id) { 144 }
+    let(:folder_path) { "ROOT/FOLDER/SUBFOLDER" }
+
+    before :each do
+      facade.stub(:post)
+    end
+
+    it "sends POST request" do
+      facade.move_document(document_id, folder_path)
+
+      expect(facade).to have_received(:post)
+        .with("/accounts/#{account_id}/folders/#{folder_path}/documents/#{document_id}.xml",
+              hash_including(:action => "move"))
+    end
+  end
+
+  it "allows to load documents in a folder" do
+    expect(facade).to respond_to :get_documents_in_folder
+  end
+
+  context "when loading documents in a folder" do
+    let(:folder_path) { "ROOT/test" }
+    let(:response) { double(Gliffy::API::Response) }
+
+    before :each do
+      facade.stub(:get).and_return(response)
+      facade.stub(:escape_path).and_call_original
+
+      facade.get_documents_in_folder(folder_path)
+    end
+
+    it "sends GET request" do
+      expect(facade).to have_received(:get)
+        .with("/accounts/#{account_id}/folders/ROOT/test/documents.xml",
+              hash_including(:action => "get"))
+    end
+
+    it "escapes folder path properly" do
+      expect(facade).to have_received(:escape_path)
+        .with(folder_path)
+    end
+  end
+
+  it "allows user to delete a folder" do
+    expect(facade).to respond_to :delete_folder
+  end
+
+  context "when deleting a folder" do
+    let(:folder_path) { "ROOT/test" }
+
+    before :each do
+      facade.stub(:post)
+      facade.stub(:escape_path).and_call_original
+
+      facade.delete_folder(folder_path)
+    end
+
+    it "escapes folder path properly" do
+      expect(facade).to have_received(:escape_path)
+        .with(folder_path)
+    end
+
+    it "sends POST request" do
+      expect(facade).to have_received(:post)
+        .with("/accounts/#{account_id}/folders/#{folder_path}.xml",
+              hash_including(:action => "delete"))
+    end
+  end
+
   it "allows user to create a document" do
     expect(facade).to respond_to :create_document
   end
@@ -164,6 +252,24 @@ shared_examples_for "an API facade" do
     end
   end
 
+  it "allows user to create a folder" do
+    expect(facade).to respond_to :create_folder
+  end
+
+  context "when creating a folder" do
+    let(:folder_path) { "ROOT/TEST/SUBFOLDER" }
+
+    it "sends POST request" do
+      facade.stub(:post)
+
+      facade.create_folder(folder_path)
+
+      expect(facade).to have_received(:post)
+        .with("/accounts/#{account_id}/folders/#{folder_path}.xml",
+              hash_including(:action => "create"))
+    end
+  end
+
   context "when POST request returns an error" do
     let(:response) { Gliffy::API::Response.new(fixture("error-401")) }
 

data/spec/lib/gliffy/document_spec.rb

@@ -137,6 +137,41 @@ describe Gliffy::Document do
     end
   end
 
+  it "can be moved" do
+    expect(document).to respond_to :move
+  end
+
+  context "when moved" do
+    let(:observer) { double(Object, :update => nil) }
+    let(:folder) do
+      double(Gliffy::Folder,
+             :path => "ROOT/FOLDER/SUBFOLDER",
+             :update => nil)
+    end
+
+    before :each do
+      api.stub(:move_document)
+
+      document.add_observer(observer)
+      document.move(folder)
+    end
+
+    it "calls REST API" do
+      expect(api).to have_received(:move_document)
+        .with(document.id, folder.path)
+    end
+
+    it "notifies observers" do
+      expect(observer).to have_received(:update)
+        .with(:document_removed, document)
+    end
+
+    it "notifies new parent" do
+      expect(folder).to have_received(:update)
+        .with(:document_added, document)
+    end
+  end
+
   it "can be deleted" do
     expect(document).to respond_to :delete
   end
@@ -173,7 +208,7 @@ describe Gliffy::Document do
     end
 
     it "notifies observers" do
-      expect(observer).to have_received(:update).with(:delete, document)
+      expect(observer).to have_received(:update).with(:document_deleted, document)
     end
   end
 end

data/spec/lib/gliffy/folder_spec.rb

@@ -40,34 +40,30 @@ describe Gliffy::Folder do
   end
 
   describe "document list" do
-    it "is loaded from API" do
-      api.should_receive(
-        :get
-      ).and_return(
-        Gliffy::API::Response.new(fixture("documents"))
-      )
+    let(:response) { Gliffy::API::Response.new(fixture("documents")) }
+
+    before :each do
+      api.stub(:get_documents_in_folder)
+        .and_return(response)
+    end
 
+    it "is loaded from API" do
       folder.documents
+
+      expect(api).to have_received(:get_documents_in_folder)
+        .with(folder.path)
     end
 
     it "has correct length" do
-      api.stub(
-        :get
-      ).and_return(
-        Gliffy::API::Response.new(fixture("documents"))
-      )
-
       expect(folder.documents.length).to eq 3
     end
 
-    it "is empty when API returns appropriate response" do
-      api.stub(
-        :get
-      ).and_return(
-        Gliffy::API::Response.new(fixture("documents-empty"))
-      )
+    context "when API returns empty response" do
+      let(:response) { Gliffy::API::Response.new(fixture("documents-empty")) }
 
-      expect(folder.documents.length).to eq 0
+      it "is empty" do
+        expect(folder.documents.length).to eq 0
+      end
     end
   end
 
@@ -75,6 +71,16 @@ describe Gliffy::Folder do
     expect(folder).to respond_to :folders
   end
 
+  it "listens for changes in nested folders" do
+    folder.stub(:update)
+
+    folder.folders[0].changed
+    folder.folders[0].notify_observers(:event, :target)
+
+    expect(folder).to have_received(:update)
+      .with(:event, :target)
+  end
+
   describe "folder list" do
     subject(:children) { folder.folders }
 
@@ -194,24 +200,151 @@ describe Gliffy::Folder do
     end
   end
 
+  it "allows us to create a folder" do
+    expect(folder).to respond_to :create_folder
+  end
+
+  context "when creating a folder" do
+    let(:folder_name) { "SUBFOLDER" }
+
+    before :each do
+      api.stub(:create_folder)
+    end
+
+    it "calls REST API" do
+      folder.create_folder(folder_name)
+      expect(api).to have_received(:create_folder)
+        .with(folder.path + "/" + folder_name)
+    end
+
+    it "returns a new folder" do
+      new_folder = folder.create_folder(folder_name)
+      expect(new_folder).to be_instance_of Gliffy::Folder
+    end
+
+    it "updates subfolder list" do
+      old_length = folder.folders.length
+
+      new_folder = folder.create_folder(folder_name)
+
+      expect(folder.folders.length).to eq old_length + 1
+      expect(folder.folders).to include new_folder
+    end
+
+    context "when subfolder with the same name already exists" do
+      let(:folder_name) { folder.folders[0].name }
+
+      it "throws an exception" do
+        expect { folder.create_folder(folder_name) }.to raise_error ArgumentError
+      end
+    end
+
+    context "when subfolder with differently capitalized name already exists" do
+      let(:folder_name) { folder.folders[0].name.swapcase }
+
+      it "throws an exception" do
+        expect { folder.create_folder(folder_name) }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  context "when notified that a document has been removed" do
+    let(:document) do
+      api.stub(:get_documents_in_folder)
+        .and_return(Gliffy::API::Response.new(fixture("documents")))
+
+      folder.documents[1]
+    end
+
+    before :each do
+      document.stub(:delete_observer).and_call_original
+    end
+
+    it "removes document from the document list" do
+      original_length = folder.documents.length
+
+      folder.update(:document_removed, document)
+
+      expect(folder.documents.length).to eq original_length - 1
+      expect(folder.documents).to_not include document
+    end
+
+    it "stops listening to this document's events" do
+      folder.update(:document_removed, document)
+
+      expect(document).to have_received(:delete_observer)
+        .with(folder)
+    end
+  end
+
+  context "when notified that a document has been added" do
+    let(:document) do
+      api.stub(:get_documents_in_folder)
+        .and_return(Gliffy::API::Response.new(fixture("documents")))
+
+      folder.documents[1]
+    end
+
+    before :each do
+      document.stub(:add_observer).and_call_original
+    end
+
+    it "adds document to the document list" do
+      original_length = folder.documents.length
+
+      folder.update(:document_added, document)
+
+      expect(folder.documents.length).to eq original_length + 1
+      expect(folder.documents).to include document
+    end
+
+    it "starts listening to this document's events" do
+      folder.update(:document_added, document)
+
+      expect(document).to have_received(:add_observer)
+        .with(folder)
+    end
+  end
+
   context "when receives a document delete notification" do
+    let(:document) do
+      api.stub(:get_documents_in_folder)
+        .and_return(Gliffy::API::Response.new(fixture("documents")))
+
+      folder.documents[1]
+    end
+
     before :each do
-      api.should_receive(
-        :get
-      ).and_return(
-        Gliffy::API::Response.new(fixture("documents"))
-      )
+      document.stub(:delete_observer).and_call_original
     end
 
     it "removes document from the document list" do
       original_length = folder.documents.length
-      document = folder.documents[1]
 
-      folder.update(:delete, document)
+      folder.update(:document_deleted, document)
 
       expect(folder.documents.length).to eq original_length - 1
       expect(folder.documents).to_not include document
     end
+
+    it "stops listening to this document's events" do
+      folder.update(:document_deleted, document)
+
+      expect(document).to have_received(:delete_observer)
+        .with(folder)
+    end
+  end
+
+  context "when received a child folder delete notification" do
+    it "removes folder from the children list" do
+      original_length = folder.folders.length
+      child = folder.folders[1]
+
+      folder.update(:folder_deleted, child)
+
+      expect(folder.folders.length).to eq original_length - 1
+      expect(folder.folders).to_not include child
+    end
   end
 
   context "when receives an unknown event" do
@@ -221,4 +354,42 @@ describe Gliffy::Folder do
       expect { folder.update(:unknown, document) }.to raise_error ArgumentError
     end
   end
+
+  it "can be deleted" do
+    expect(folder).to respond_to :delete
+  end
+
+  it "knows its deleted state" do
+    expect(folder).to respond_to :deleted?
+  end
+
+  it "is not marked as deleted by default" do
+    expect(folder.deleted?).to be_false
+  end
+
+  context "when being deleted" do
+    let(:observer) { double(Object) }
+
+    before :each do
+      api.stub(:delete_folder)
+
+      observer.stub(:update)
+      folder.add_observer(observer)
+
+      folder.delete
+    end
+
+    it "calls REST API" do
+      expect(api).to have_received(:delete_folder)
+        .with(folder.path)
+    end
+
+    it "notifies observers about this" do
+      expect(observer).to have_received(:update).with(:folder_deleted, folder)
+    end
+
+    it "is marked as deleted" do
+      expect(folder.deleted?).to be_true
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gliffy
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Konstantin Burnaev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-05 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth