groupdocs 0.1.0

data/spec/groupdocs/api/request_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Request do
+
+  subject { described_class.new(method: :GET, path: '/folders') }
+
+  it { should respond_to(:resource)  }
+  it { should respond_to(:response)  }
+  it { should respond_to(:response=) }
+  it { should respond_to(:options)   }
+  it { should respond_to(:options=)  }
+
+  describe '#initialize' do
+    it 'allows passing options' do
+      options = { method: :GET, path: '/folders' }
+      request = described_class.new(options)
+      request.options.should == options
+    end
+
+    it 'allows passing block to configure options' do
+      described_class.new do |request|
+        request[:access] = { client_id: 'client_id', private_key: 'private_key' }
+        request[:method] = :GET
+        request[:path] = '/folders'
+      end.options.should == { method: :GET, path: '/folders', access: { client_id: 'client_id', private_key: 'private_key' }}
+    end
+
+    it 'sets access hash to empty if it was not passed' do
+      access = subject.options[:access]
+      access.should be_a(Hash)
+      access.should be_empty
+    end
+
+    it 'creates resource as API server' do
+      GroupDocs.stub(api_server: 'https://dev-api.groupdocs.com')
+      subject.resource.should be_a(RestClient::Resource)
+    end
+  end
+
+  describe '#execute!' do
+    before(:each) do
+      GroupDocs.stub(private_key: 'private_key')
+      subject.options[:method] = :get
+      subject.options[:path] = '/folders'
+      subject.options[:headers] = {}
+      mock_api_server('{"status":"Ok"}')
+    end
+
+    it 'parses path' do
+      subject.should_receive(:parse_path)
+      subject.execute!
+    end
+
+    it 'prepends path with version' do
+      subject.should_receive(:prepend_version)
+      subject.execute!
+    end
+
+    it 'URL encodes path' do
+      subject.should_receive(:url_encode_path)
+      subject.execute!
+    end
+
+    it 'signs url' do
+      subject.should_receive(:sign_url)
+      subject.execute!
+    end
+
+    it 'prepares request' do
+      subject.should_receive(:prepare_request)
+      subject.execute!
+    end
+
+    it 'sends request' do
+      subject.should_receive(:send_request)
+      mock_response('{"status": "Ok"}')
+      subject.execute!
+    end
+
+    it 'parses response' do
+      subject.should_receive(:parse_response)
+      subject.execute!
+    end
+  end
+end

data/spec/groupdocs/datasource/field_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe GroupDocs::DataSource::Field do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  describe 'TYPES' do
+    it 'contains hash of field types' do
+      described_class::TYPES.should == {
+        text:   0,
+        binary: 1,
+      }
+    end
+  end
+
+  it { should respond_to(:field)   }
+  it { should respond_to(:field=)  }
+  it { should respond_to(:type)    }
+  it { should respond_to(:type=)   }
+  it { should respond_to(:values)  }
+  it { should respond_to(:values=) }
+
+  it 'is compatible with response JSON' do
+    subject.should respond_to(:name=)
+    subject.method(:name=).should == subject.method(:field=)
+  end
+
+  describe '#type=' do
+    it 'saves type in machine readable format if symbol is passed' do
+      subject.type = :binary
+      subject.instance_variable_get(:@type).should == 1
+    end
+
+    it 'does nothing if parameter is not symbol' do
+      subject.type = 1
+      subject.instance_variable_get(:@type).should == 1
+    end
+
+    it 'raises error if type is unknown' do
+      -> { subject.type = :unknown }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#type' do
+    it 'returns type in human-readable format' do
+      subject.type = 1
+      subject.type.should == :binary
+    end
+  end
+end

data/spec/groupdocs/datasource_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+
+describe GroupDocs::DataSource do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json('datasource_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get!(1, {}, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'accepts options hash' do
+      lambda do
+        described_class.get!(1, fields: %w(field1 field2))
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns GroupDocs::DataSource object if datasource is found' do
+      described_class.get!(1).should be_a(GroupDocs::DataSource)
+    end
+
+    it 'returns nil if datasource was not found' do
+      mock_api_server('{"result": {"datasource": null}, "status": "Failed"}')
+      described_class.get!(99).should be_nil
+    end
+  end
+
+  it { should respond_to(:id)                }
+  it { should respond_to(:id=)               }
+  it { should respond_to(:descr)             }
+  it { should respond_to(:descr=)            }
+  it { should respond_to(:questionnaire_id)  }
+  it { should respond_to(:questionnaire_id=) }
+  it { should respond_to(:created_on)        }
+  it { should respond_to(:created_on=)       }
+  it { should respond_to(:modified_on)       }
+  it { should respond_to(:modified_on=)      }
+  it { should respond_to(:fields)            }
+  it { should respond_to(:fields=)           }
+
+  it 'has human-readable accessors' do
+    subject.should respond_to(:description)
+    subject.should respond_to(:description=)
+    subject.method(:description).should  == subject.method(:descr)
+    subject.method(:description=).should == subject.method(:descr=)
+  end
+
+  describe '#created_on' do
+    it 'returns converted to Time object Unix timestamp' do
+      subject.created_on = 1332950825
+      subject.created_on.should be_a(Time)
+    end
+  end
+
+  describe '#modified_on' do
+    it 'returns converted to Time object Unix timestamp' do
+      subject.modified_on = 1332950825
+      subject.modified_on.should be_a(Time)
+    end
+  end
+
+  describe '#fields=' do
+    it 'converts each field to GroupDocs::DataSource::Field object if hash is passed' do
+      subject.fields = [{ name: 'field1', values: %w(value1 value2), type: 1 }]
+      fields = subject.fields
+      fields.should be_an(Array)
+      fields.each do |field|
+        field.should be_a(GroupDocs::DataSource::Field)
+      end
+    end
+
+    it 'saves each field if it is GroupDocs::DataSource::Field object' do
+      field1 = GroupDocs::DataSource::Field.new(name: 'field1')
+      field2 = GroupDocs::DataSource::Field.new(name: 'field2')
+      subject.fields = [field1, field2]
+      subject.fields.should include(field1)
+      subject.fields.should include(field2)
+    end
+
+    it 'does nothing if nil is passed' do
+      lambda do
+        subject.fields = nil
+      end.should_not change(subject, :fields)
+    end
+  end
+
+  describe '#add_field' do
+    it 'raises error if field is not GroupDocs::DataSource::Field object' do
+      -> { subject.add_field('Field') }.should raise_error(ArgumentError)
+    end
+
+    it 'saves field' do
+      field = GroupDocs::DataSource::Field.new
+      subject.add_field(field)
+      subject.fields.should == [field]
+    end
+  end
+
+  describe '#add!' do
+    before(:each) do
+      mock_api_server(load_json('datasource_add'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.add!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'uses hashed version of self as request body' do
+      subject.should_receive(:to_hash)
+      subject.add!
+    end
+
+    it 'adds ID of datasource from response to self' do
+      lambda do
+        subject.add!
+      end.should change(subject, :id)
+    end
+  end
+
+  describe '#update!' do
+    before(:each) do
+      mock_api_server(load_json('datasource_update'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.update!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'uses hashed version of self as request body' do
+      subject.should_receive(:to_hash)
+      subject.add!
+    end
+  end
+
+  describe '#remove!' do
+    before(:each) do
+      mock_api_server(load_json('datasource_remove'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.remove!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+end

data/spec/groupdocs/document/annotation/reply_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+describe GroupDocs::Document::Annotation::Reply do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  subject do
+    file = GroupDocs::Storage::File.new
+    document = GroupDocs::Document.new(file: file)
+    annotation = GroupDocs::Document::Annotation.new(document: document)
+    described_class.new(annotation: annotation)
+  end
+
+  describe '.get!' do
+    before(:each) do
+      mock_api_server(load_json('annotation_replies_get'))
+    end
+
+    let(:annotation) do
+      document = GroupDocs::Document.new(file: GroupDocs::Storage::File.new)
+      GroupDocs::Document::Annotation.new(document: document)
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get!(annotation, {}, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'accepts options hash' do
+      lambda do
+        described_class.get!(annotation, after: Time.now)
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if annotation is not an instance of GroupDocs::Document::Annotation' do
+      -> { described_class.get!('Annotation') }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if option :after is not an instance of Time' do
+      -> { described_class.get!(annotation, after: 'Yesterday') }.should raise_error(ArgumentError)
+    end
+
+    it 'converts option :after to Unix timestamp' do
+      time = Time.now
+      time.should_receive(:to_i).and_return(1334125808)
+      described_class.get!(annotation, after: time)
+    end
+
+    it 'returns an array of GroupDocs::Document::Annotation::Reply objects' do
+      replies = described_class.get!(annotation)
+      replies.should be_an(Array)
+      replies.each do |reply|
+        reply.should be_a(GroupDocs::Document::Annotation::Reply)
+      end
+    end
+  end
+
+  it { should respond_to(:annotation)      }
+  it { should respond_to(:annotation=)     }
+  it { should respond_to(:text)            }
+  it { should respond_to(:text=)           }
+  it { should respond_to(:guid)            }
+  it { should respond_to(:guid=)           }
+  it { should respond_to(:annotationGuid)  }
+  it { should respond_to(:annotationGuid=) }
+  it { should respond_to(:userGuid)        }
+  it { should respond_to(:userGuid=)       }
+  it { should respond_to(:userName)        }
+  it { should respond_to(:userName=)       }
+  it { should respond_to(:text)            }
+  it { should respond_to(:text=)           }
+  it { should respond_to(:repliedOn)       }
+  it { should respond_to(:repliedOn=)      }
+
+  it 'has human-readable accessors' do
+    subject.should respond_to(:annotation_guid)
+    subject.should respond_to(:annotation_guid=)
+    subject.should respond_to(:user_guid)
+    subject.should respond_to(:user_guid=)
+    subject.should respond_to(:user_name)
+    subject.should respond_to(:user_name=)
+    subject.should respond_to(:replied_on)
+    subject.should respond_to(:replied_on=)
+    subject.method(:annotation_guid).should  == subject.method(:annotationGuid)
+    subject.method(:annotation_guid=).should == subject.method(:annotationGuid=)
+    subject.method(:user_guid).should        == subject.method(:userGuid)
+    subject.method(:user_guid=).should       == subject.method(:userGuid=)
+    subject.method(:user_name).should        == subject.method(:userName)
+    subject.method(:user_name=).should       == subject.method(:userName=)
+    # Reply#replied_on is overwritten
+    subject.method(:replied_on=).should      == subject.method(:repliedOn=)
+  end
+
+  describe '#initialize' do
+    it 'raises error if annotation is not specified' do
+      -> { described_class.new }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if annotation is not an instance of GroupDocs::Document::Annotation' do
+      -> { described_class.new(annotation: '') }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#replied_on' do
+    it 'returns converted to Time object Unix timestamp' do
+      subject.replied_on = 1332950825
+      subject.replied_on.should be_a(Time)
+    end
+
+    it 'divides timestamp by 1000 because it is in milliseconds' do
+      subject.replied_on = 1332950825000
+      subject.replied_on.should == Time.at(1332950825)
+    end
+  end
+
+  describe '#create!' do
+    before(:each) do
+      mock_api_server(load_json('annotation_replies_create'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.create!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'gets annotation guid' do
+      subject.should_receive(:get_annotation_guid)
+      subject.create!
+    end
+
+    it 'updates guid and annotation_guid with response' do
+      lambda do
+        subject.create!
+      end.should change {
+        subject.guid
+        subject.annotation_guid
+      }
+    end
+  end
+
+  describe '#edit!' do
+    before(:each) do
+      mock_api_server('{"result": {}, "status": "Ok", "error_message": null}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.edit!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe '#remove!' do
+    before(:each) do
+      mock_api_server('{"result": {}, "status": "Ok", "error_message": null}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.remove!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe '#get_annotation_guid' do
+    it 'prefers annotation_guid over annotation.guid' do
+      subject.annotation_guid = 'abc'
+      subject.annotation.guid = 'def'
+      subject.send(:get_annotation_guid).should == 'abc'
+    end
+
+    it 'returns annotation.guid if annotation_guid is not set' do
+      subject.annotation.guid = 'def'
+      subject.send(:get_annotation_guid).should == 'def'
+    end
+  end
+end