gliffy 0.0.6

data/spec/lib/gliffy/document_png_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Gliffy::Document::PNG do
+    let(:content) { "SAMPLE CONTENT" }
+    let(:document) { double(Gliffy::Document) }
+    let(:png) { Gliffy::Document::PNG.new(document) }
+
+    it "has a reference to the original document" do
+        expect(png).to respond_to :document
+        expect(png.document).to be document
+    end
+
+    it "has content" do
+        expect(png).to respond_to :content
+    end
+
+    it "delegates task of fetching image content to the API facade" do
+        account = double(Gliffy::Account, :id => 11)
+        api = double(Gliffy::API)
+        document.stub(:api).and_return(api)
+        document.stub(:owner).and_return(account)
+        document.stub(:id).and_return(22)
+        api.should_receive(
+            :raw
+        ).with(
+            "/accounts/11/documents/22.png",
+            hash_including(
+                :action => "get",
+                :size => "T"
+            )
+        ).and_return(content)
+
+        expect(png.content(Gliffy::Document::PNG::SIZE_THUMBNAIL)).to eq content
+    end
+
+    it "has a thumbnail" do
+        png.stub(:content).and_return(content)
+        expect(png.thumbnail).to eq content
+        expect(png).to have_received(:content).with(
+            Gliffy::Document::PNG::SIZE_THUMBNAIL
+        )
+    end
+
+    it "has a small image" do
+        png.stub(:content).and_return(content)
+        expect(png.small).to eq content
+        expect(png).to have_received(:content).with(
+            Gliffy::Document::PNG::SIZE_SMALL
+        )
+    end
+
+    it "has a medium image" do
+        png.stub(:content).and_return(content)
+        expect(png.medium).to eq content
+        expect(png).to have_received(:content).with(
+            Gliffy::Document::PNG::SIZE_MEDIUM
+        )
+    end
+
+    it "has a full image" do
+        png.stub(:content).and_return(content)
+        expect(png.full).to eq content
+        expect(png).to have_received(:content).with(
+            Gliffy::Document::PNG::SIZE_FULL
+        )
+    end
+end

data/spec/lib/gliffy/document_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Gliffy::Document do
+  before :each do
+    Gliffy::Document.clear_cache
+  end
+
+  let(:api)  { double(Gliffy::API) }
+  let(:owner) do
+    owner = double(Gliffy::Account) 
+    owner.stub(:api).and_return(api)
+    owner
+  end
+
+  let(:document_id) { 1000002 }
+  let(:document_name) { 'SNPP Domain Model' }
+
+  let(:response) do
+    Gliffy::API::Response.new(fixture(
+      "document",
+      :document_id => document_id,
+      :document_name => document_name
+      )
+    )
+  end
+
+  let(:document) do
+    Gliffy::Document.load(owner, response.node("//g:document"))
+  end
+
+  it "has an id" do
+    expect(document).to respond_to :id
+    expect(document.id).to eq document_id
+  end
+
+  it "has a name" do
+    expect(document).to respond_to :name
+    expect(document.name).to eq document_name
+  end
+
+  it "has 'public access' flag" do
+    expect(document).to respond_to :public?
+    expect(document.public?).to eq(true)
+  end
+
+  it "has a version number" do
+    expect(document).to respond_to :versions
+    expect(document.versions).to eq(5)
+  end
+
+  it "has a modification date" do
+    expect(document).to respond_to :modified
+    expect(document.modified).to eq(DateTime.new(2008, 7, 8, 17, 31, 23))
+  end
+
+  it "has a creation date" do
+    expect(document).to respond_to :created
+    expect(document.created).to eq(DateTime.new(2008, 7, 8, 17, 31, 24))
+  end
+
+  it "has a publication date" do
+    expect(document).to respond_to :published
+    expect(document.published).to eq(DateTime.new(2008, 7, 8, 17, 31, 25))
+  end
+
+  it "has an owner" do
+    expect(document).to respond_to :owner
+    expect(document.owner).to be(owner)
+  end
+
+  it "has a link to gliffy editor" do
+    return_url = "sample/url"
+    return_text = "RETURN TEXT"
+
+    api.should_receive(
+      :web
+    ).with(
+      "/gliffy/",
+      hash_including(
+        :launchDiagramId => document_id,
+        :returnURL => return_url,
+        :returnButtonText => return_text
+      )
+    ).and_return(
+      "http://www.gliffy.com/gliffy/?launchDiagramId=#{document.id}&returnURL=#{return_url}&returnButtonText=#{return_text}"
+    )
+
+    link = document.editor(return_url, return_text)
+
+    expect(link).to match '/gliffy/'
+    expect(link).to match 'launchDiagramId='
+    expect(link).to match document.id.to_s
+    expect(link).to match 'returnURL='
+    expect(link).to match return_url
+    expect(link).to match 'returnButtonText='
+    expect(link).to match return_text
+  end
+
+  it "has an PNG image" do
+    expect(document).to respond_to :png
+    expect(document.png).to be_instance_of Gliffy::Document::PNG
+  end
+
+  it "has singleton-life behavior" do
+    doc1 = Gliffy::Document.load(owner, response.node("//g:document"))
+    expect(doc1).to be document
+  end
+end

data/spec/lib/gliffy/folder_spec.rb

@@ -0,0 +1,175 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Gliffy::Folder do
+  let(:account_id) { 100 }
+  let(:api) { double(Gliffy::API) }
+  let(:account) { double(Gliffy::Account, :api => api, :id => account_id) }
+
+  subject(:folder) do
+    Gliffy::Folder.load(
+      account,
+      Gliffy::API::Response.new(
+        fixture('folder')
+      ).node("//g:folders/g:folder[1]")
+    )
+  end
+
+  it "has a name" do
+    expect(folder).to respond_to :name
+    expect(folder.name).to eq "ROOT"
+  end
+
+  it "has a path" do
+    expect(folder).to respond_to :path
+    expect(folder.path).to eq "ROOT"
+  end
+
+  it "has a list of documents" do
+    expect(folder).to respond_to :documents
+  end
+
+  describe "root folder" do
+    it "knows it is root" do
+      expect(folder.root?).to be_true
+    end
+
+    it "has no parent" do
+      expect(folder.parent).to be_nil
+    end
+  end
+
+  describe "document list" do
+    it "is loaded from API" do
+      api.should_receive(
+        :get
+      ).and_return(
+        Gliffy::API::Response.new(fixture("documents"))
+      )
+
+      folder.documents
+    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"))
+      )
+
+      expect(folder.documents.length).to eq 0
+    end
+  end
+
+  it "has nested folders" do
+    expect(folder).to respond_to :folders
+  end
+
+  describe "folder list" do
+    subject(:children) { folder.folders }
+
+    it { should respond_to :length }
+    it { should respond_to :[] }
+    it "has corrent length" do 
+      expect(children.length).to eq 4
+    end
+  end
+
+  describe "first-level folder 'Burns Top Secret'" do
+    subject(:first_child) { folder.folders[0] }
+
+    it "has correct parent" do
+      expect(first_child.parent).to be folder
+    end
+
+    it "has correct name" do
+      expect(first_child.name).to eq "Burns Top Secret"
+    end
+
+    it "has correct path" do
+      expect(first_child.path).to eq "ROOT/Burns Top Secret"
+    end
+
+    it "has correct number of children" do
+      expect(first_child.folders).to eq []
+    end
+
+    it "knows it is not root" do
+      expect(first_child.root?).to be_false
+    end
+  end
+
+  describe "first-level folder 'Simsons Family'" do
+    subject(:second_child) { folder.folders[3] }
+
+    it "has correct parent" do
+      expect(second_child.parent).to be folder
+    end
+
+    it "has correct name" do
+      expect(second_child.name).to eq "Simpsons Family"
+    end
+
+    it "has correct path" do
+      expect(second_child.path).to eq "ROOT/Simpsons Family"
+    end
+
+    it "has corrent number of children" do
+      expect(second_child.folders.length).to eq 2
+    end
+
+    it "knows it is not root" do
+      expect(second_child.root?).to be_false
+    end
+
+    describe "second-level folder 'Maggie and Lisas Stuff'" do
+      subject(:nested_child) { second_child.folders[1] }
+
+      it "has corrent parent" do
+        expect(nested_child.parent).to be second_child
+      end
+
+      it "has correct name" do
+        expect(nested_child.name).to eq "Maggie and Lisas Stuff"
+      end
+
+      it "has correct path" do
+        expect(nested_child.path).to eq "ROOT/Simpsons Family/Maggie and Lisas Stuff"
+      end
+
+      it "knows it is not root" do
+        expect(nested_child.root?).to be_false
+      end
+    end
+  end
+
+  context "when assigning a parent" do
+    context "with valid path" do
+      it "updates parent" do
+        f1 = Gliffy::Folder.new(account, "F1", "/ROOT/F1", [])
+        f2 = Gliffy::Folder.new(account, "F2", "/ROOT/F1/F2", [])
+
+        f2.parent = f1
+        expect(f2.parent).to be f1
+      end
+    end
+
+    context "with invalid path" do
+      it "raises an error" do
+        f1 = Gliffy::Folder.new(@account, "F1", "/ROOT/F1", [])
+        f2 = Gliffy::Folder.new(@account, "F2", "/ROOT/F2", [])
+        expect { f1.parent = f2 }.to raise_error
+      end
+    end
+  end
+end

data/spec/lib/gliffy_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Gliffy do
+  it "knows the global API entry point for generic calls" do
+    expect(Gliffy).to respond_to :api_root
+    expect(Gliffy.api_root).to be_an_instance_of(String)
+  end
+
+  it "knows the global web entry point for generating editor-related URLs" do
+    expect(Gliffy).to respond_to :web_root
+    expect(Gliffy.web_root).to be_an_instance_of(String)
+  end
+
+  it "provides a default application name value" do
+    expect(Gliffy).to respond_to :default_application_name
+    expect(Gliffy.default_application_name).to be_an_instance_of(String)
+  end
+
+  describe "API entry point" do
+    it "points to a resource at Gliffy site" do
+      expect(Gliffy.api_root).to include("gliffy.com")
+    end
+
+    it "is protocol-agnostic" do
+      expect(Gliffy.api_root).to_not include("http")
+      expect(Gliffy.api_root).to_not include("https")
+    end
+  end
+
+  describe "Web entry point" do
+    it "points to a resource at Gliffy site" do
+      expect(Gliffy.web_root).to include("gliffy.com")
+    end
+
+    it "is protocol-agnostic" do
+      expect(Gliffy.api_root).to_not include("http")
+      expect(Gliffy.api_root).to_not include("https")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rspec'
+require 'nokogiri'
+
+require 'simplecov'
+SimpleCov.command_name "test:units"
+SimpleCov.start do 
+    add_filter '/spec/'
+    add_filter '/lib/gliffy/oauth/'
+end
+
+require 'gliffy'
+
+def fixture(filename, substitutions = {})
+    Nokogiri::XML(
+        fixture_xml(filename, substitutions)
+    )
+end
+
+def fixture_xml(filename, substitutions = {})
+    raw_document = IO.read(
+        File.join(
+            File.dirname(__FILE__), 
+            "fixtures",
+            "#{filename}.xml"
+        ) 
+    )
+
+    raw_document % substitutions
+end
+
+RSpec.configure do |config|
+    config.expect_with :rspec do |c|
+        c.syntax = :expect
+    end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: gliffy
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Konstantin Burnaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http_logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple Gliffy REST API wrapper.
+email: kbourn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gliffy/api/facade.rb
+- lib/gliffy/api/response.rb
+- lib/gliffy/oauth/helper.rb
+- lib/gliffy/document_png.rb
+- lib/gliffy/api.rb
+- lib/gliffy/folder.rb
+- lib/gliffy/document.rb
+- lib/gliffy/account.rb
+- lib/gliffy.rb
+- spec/fixtures/folder.xml
+- spec/fixtures/document.xml
+- spec/fixtures/account.xml
+- spec/fixtures/documents.xml
+- spec/fixtures/documents-empty.xml
+- spec/fixtures/token.xml
+- spec/lib/gliffy/account_spec.rb
+- spec/lib/gliffy/api/facade_spec.rb
+- spec/lib/gliffy/api/response_spec.rb
+- spec/lib/gliffy/folder_spec.rb
+- spec/lib/gliffy/document_png_spec.rb
+- spec/lib/gliffy/document_spec.rb
+- spec/lib/gliffy/api_spec.rb
+- spec/lib/gliffy_spec.rb
+- spec/spec_helper.rb
+- README.md
+homepage: https://github.com/bkon/gliffy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gliffy API client
+test_files: []