groupdocs 0.1.0

data/spec/groupdocs/api/helpers/access_helper_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Helpers::Access do
+
+  subject do
+    GroupDocs::Api::Request.new(method: :GET)
+  end
+
+  describe 'MODES' do
+    it 'contains hash of access modes' do
+      described_class::MODES.should == {
+        private:    0,
+        restricted: 1,
+        public:     2,
+      }
+    end
+  end
+
+  describe '#client_id' do
+    it 'returns passed to method client ID' do
+      subject.options[:access] = { client_id: 'method_client_id' }
+      subject.options[:access].should_receive(:[]).with(:client_id).and_return('method_client_id')
+      subject.send(:client_id).should == 'method_client_id'
+    end
+
+    it 'returns GroupDocs.client_id if access has not been passed to method' do
+      subject.options[:access] = {}
+      GroupDocs.should_receive(:client_id).and_return('static_client_id')
+      subject.send(:client_id).should == 'static_client_id'
+    end
+
+    it 'raises error if client ID has not been set' do
+      subject.options[:access] = {}
+      GroupDocs.client_id = nil
+      -> { subject.send(:client_id) }.should raise_error(GroupDocs::Errors::NoClientIdError)
+    end
+  end
+
+  describe '#private_key' do
+    it 'returns passed to method private key' do
+      subject.options[:access] = { private_key: 'method_private_key' }
+      subject.options[:access].should_receive(:[]).with(:private_key).and_return('method_private_key')
+      subject.send(:private_key).should == 'method_private_key'
+    end
+
+    it 'returns GroupDocs.private_key if access has not been passed to method' do
+      subject.options[:access] = {}
+      GroupDocs.should_receive(:private_key).and_return('static_private_key')
+      subject.send(:private_key).should == 'static_private_key'
+    end
+
+    it 'raises error if private key has not been set' do
+      subject.options[:access] = {}
+      GroupDocs.private_key = nil
+      -> { subject.send(:private_key) }.should raise_error(GroupDocs::Errors::NoPrivateKeyError)
+    end
+  end
+
+  describe '#parse_access_mode' do
+    it 'raise error if mode is unknown' do
+      -> { subject.send(:parse_access_mode, 3)        }.should raise_error(ArgumentError)
+      -> { subject.send(:parse_access_mode, :unknown) }.should raise_error(ArgumentError)
+    end
+
+    it 'returns :private if passed mode is 0' do
+      subject.send(:parse_access_mode, 0).should == :private
+    end
+
+    it 'returns :restricted if passed mode is 1' do
+      subject.send(:parse_access_mode, 1).should == :restricted
+    end
+
+    it 'returns :public if passed mode is 2' do
+      subject.send(:parse_access_mode, 2).should == :public
+    end
+
+    it 'returns 0 if passed mode is :private' do
+      subject.send(:parse_access_mode, :private).should == 0
+    end
+
+    it 'returns 1 if passed mode is :restricted' do
+      subject.send(:parse_access_mode, :restricted).should == 1
+    end
+
+    it 'returns 2 if passed mode is :public' do
+      subject.send(:parse_access_mode, :public).should == 2
+    end
+  end
+end

data/spec/groupdocs/api/helpers/actions_helper_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Helpers::Actions do
+
+  subject do
+    Object.extend(described_class)
+  end
+
+  describe 'ACTIONS' do
+    it 'contains hash of actions' do
+      described_class::ACTIONS.should == {
+        none:                 0,
+        convert:              1,
+        combine:              2,
+        compress_zip:         4,
+        compress_rar:         8,
+        trace:               16,
+        convert_body:        32,
+        bind_data:           64,
+        print:              128,
+        import_annotations: 256,
+      }
+    end
+  end
+
+  describe '.convert_actions' do
+    it 'raises error if actions is not an array' do
+      -> { subject.convert_actions(:convert) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if action is unknown' do
+      -> { subject.convert_actions(%w(unknown)) }.should raise_error(ArgumentError)
+    end
+
+    it 'converts each action to Symbol' do
+      actions = %w(none convert)
+      actions.each do |action|
+        symbol = action.to_sym
+        action.should_receive(:to_sym).and_return(symbol)
+      end
+      subject.convert_actions(actions)
+    end
+
+    it 'returns correct byte flag' do
+      actions = %w(none convert combine compress_zip compress_rar trace convert_body bind_data print import_annotations)
+      flag = subject.convert_actions(actions)
+      flag.should be_an(Integer)
+      flag.should == 511
+    end
+  end
+end

data/spec/groupdocs/api/helpers/rest_helper_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Helpers::REST do
+
+  subject do
+    GroupDocs::Api::Request.new(method: :GET)
+  end
+
+  describe 'DEFAULT_HEADERS' do
+    subject { described_class::DEFAULT_HEADERS }
+
+    it 'includes "Accept: application/json"' do
+      subject.should include(accept: 'application/json')
+    end
+
+    it 'includes "Content-length: 0"' do
+      subject.should include(content_length: 0)
+    end
+  end
+
+  describe '#prepare_request' do
+    it 'merges default headers with passed' do
+      subject.options[:headers] = { keep_alive: 300 }
+      merged_headers = described_class::DEFAULT_HEADERS.merge(keep_alive: 300)
+      lambda do
+        subject.send(:prepare_request)
+      end.should change { subject.options[:headers] }.to(merged_headers)
+    end
+
+    it 'uses default headers when not passed' do
+      lambda do
+        subject.send(:prepare_request)
+      end.should change { subject.options[:headers] }.to(described_class::DEFAULT_HEADERS)
+    end
+
+    it 'downcases HTTP method' do
+      lambda do
+        subject.send(:prepare_request)
+      end.should change { subject.options[:method] }.to(:get)
+    end
+
+    it 'coverts request body to JSON' do
+      subject.options[:method] = :POST
+      subject.options[:request_body] = { body: 'test' }
+      lambda do
+        subject.send(:prepare_request)
+      end.should change { subject.options[:request_body] }.to('{"body":"test"}')
+    end
+
+    it 'does not convert request body to JSON if payload is file' do
+      file = Object::File.new(__FILE__, 'rb')
+      subject.options[:method] = :POST
+      subject.options[:request_body] = file
+      subject.send(:prepare_request)
+      subject.options[:request_body].should == file
+    end
+
+    it 'calculates and sets Content-length' do
+      subject.options[:method] = :POST
+      subject.options[:headers] = {}
+      subject.options[:request_body] = { body: 'test' }
+      lambda do
+        subject.send(:prepare_request)
+      end.should change { subject.options[:headers][:content_length] }.to(15)
+    end
+
+    it 'sets Content-Type header if necessary' do
+      subject.options[:method] = :POST
+      subject.options[:headers] = {}
+      subject.options[:request_body] = { body: 'test' }
+      lambda do
+        subject.send(:prepare_request)
+      end.should change { subject.options[:headers][:content_type] }.to('application/json')
+    end
+  end
+
+  describe '#send_request' do
+    %w(GET DOWNLOAD POST PUT DELETE).each do |method|
+      it "sends HTTP #{method} request" do
+        mock_api_server('{"status": "Ok"}')
+        method = method.downcase.to_sym
+        subject.options[:method] = method
+        subject.options[:path] = '/folders'
+        subject.options[:headers] = {}
+        subject.send(:send_request)
+      end
+    end
+
+    it 'raises error if incorrect method has been passed' do
+      subject.options[:method] = :TEST
+      -> { subject.send(:send_request) }.should raise_error(GroupDocs::Errors::UnsupportedMethodError)
+    end
+
+    it 'saves response' do
+      mock_api_server('{"status": "Ok"}')
+      subject.options[:method] = :get
+      subject.options[:path] = '/folders'
+      subject.options[:headers] = {}
+      lambda do
+        subject.send(:send_request)
+      end.should change(subject, :response).to('{"status": "Ok"}')
+    end
+  end
+
+  describe '#parse_response' do
+    it 'does not parse body if request method was DOWNLOAD' do
+      subject.options[:method] = :download
+      JSON.should_not_receive(:parse)
+      lambda do
+        subject.send(:parse_response)
+      end.should_not change(subject, :response)
+    end
+
+    it 'returns JSON result key value' do
+      mock_response('{"status": "Ok", "result": { "entities": [] }}')
+      parsed_json = { status: 'Ok', result: { entities: [] } }
+      JSON.should_receive(:parse).with(subject.response, symbolize_names: true).and_return(parsed_json)
+      subject.send(:parse_response).should == { entities: [] }
+    end
+
+    it 'raises error if response status is not "Ok"' do
+      unparsed_json = '{"status": "Failed", "error_message": "The source path is not found."}'
+      parsed_json   = { status: "Failed", error_message: "The source path is not found." }
+      mock_response(unparsed_json)
+      subject.should_receive(:raise_bad_request_error).with(parsed_json)
+      subject.send(:parse_response)
+    end
+  end
+
+  describe '#raise_bad_request_error' do
+    let(:json) do
+      { status: 'Failed', error_message: 'The source path is not found.' }
+    end
+
+    it 'raises error' do
+      lambda do
+        subject.send(:raise_bad_request_error, json)
+      end.should raise_error(GroupDocs::Errors::BadResponseError)
+    end
+
+    it 'shows "Bad response!" message' do
+      lambda do
+        subject.send(:raise_bad_request_error, json)
+      end.should raise_error(message = /Bad response!/)
+    end
+
+    it 'contains information about request method' do
+      subject.options[:method] = :get
+      lambda do
+        subject.send(:raise_bad_request_error, json)
+      end.should raise_error(message = /Request method: GET/)
+    end
+
+    it 'contains information about request URL' do
+      subject.options[:path] = '/folders'
+      lambda do
+        subject.send(:raise_bad_request_error, json)
+      end.should raise_error(message = %r(Request URL: https?://(.+)/folders))
+    end
+
+    it 'contains information about request body' do
+      subject.options[:request_body] = '{"test": 123}'
+      lambda do
+        subject.send(:raise_bad_request_error, json)
+      end.should raise_error(message = /Request body: {"test": 123}/)
+    end
+
+    it 'contains information about response status' do
+      lambda do
+        subject.send(:raise_bad_request_error, json)
+      end.should raise_error(message = /Status: Failed/)
+    end
+
+    it 'contains information about error message' do
+      lambda do
+        subject.send(:raise_bad_request_error, json)
+      end.should raise_error(message = /Error message: The source path is not found./)
+    end
+
+    it 'contains information about response body' do
+      mock_response('{"status": "Failed", "error_message": "The source path is not found."}')
+      lambda do
+        subject.send(:raise_bad_request_error, json)
+      end.should raise_error(message = /Response body: {"status": "Failed", "error_message": "The source path is not found."}/)
+    end
+  end
+end

data/spec/groupdocs/api/helpers/status_helper_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Helpers::Status do
+
+  subject do
+    Object.extend(described_class)
+  end
+
+  describe 'STATUSES' do
+    it 'contains hash of entity statuses' do
+      described_class::STATUSES.should == {
+        draft:      -1,
+        pending:     0,
+        scheduled:   1,
+        in_progress: 2,
+        completed:   3,
+        postponed:   4,
+        archived:    5,
+      }
+    end
+  end
+
+  describe '#parse_status' do
+    it 'raise error if status is unknown' do
+      -> { subject.send(:parse_status, 8)        }.should raise_error(ArgumentError)
+      -> { subject.send(:parse_status, :unknown) }.should raise_error(ArgumentError)
+    end
+
+    it 'returns :draft if passed status is -1' do
+      subject.send(:parse_status, -1).should == :draft
+    end
+
+    it 'returns :pending if passed status is 0' do
+      subject.send(:parse_status, 0).should == :pending
+    end
+
+    it 'returns :scheduled if passed status is 1' do
+      subject.send(:parse_status, 1).should == :scheduled
+    end
+
+    it 'returns :in_progress if passed status is 2' do
+      subject.send(:parse_status, 2).should == :in_progress
+    end
+
+    it 'returns :completed if passed status is 3' do
+      subject.send(:parse_status, 3).should == :completed
+    end
+
+    it 'returns :postponed if passed status is 4' do
+      subject.send(:parse_status, 4).should == :postponed
+    end
+
+    it 'returns :archived if passed status is 5' do
+      subject.send(:parse_status, 5).should == :archived
+    end
+
+    it 'returns -1 if passed status is :draft' do
+      subject.send(:parse_status, :draft).should == -1
+    end
+
+    it 'returns 0 if passed status is :pending' do
+      subject.send(:parse_status, :pending).should == 0
+    end
+
+    it 'returns 1 if passed status is :scheduled' do
+      subject.send(:parse_status, :scheduled).should == 1
+    end
+
+    it 'returns 2 if passed status is :in_progress' do
+      subject.send(:parse_status, :in_progress).should == 2
+    end
+
+    it 'returns 3 if passed status is :completed' do
+      subject.send(:parse_status, :completed).should == 3
+    end
+
+    it 'returns 4 if passed status is :postponed' do
+      subject.send(:parse_status, :postponed).should == 4
+    end
+
+    it 'returns 5 if passed status is :archived' do
+      subject.send(:parse_status, :archived).should == 5
+    end
+  end
+end

data/spec/groupdocs/api/helpers/url_helper_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Helpers::URL do
+
+  subject do
+    GroupDocs::Api::Request.new(path: '/1/files/2?new_name=invoice.docx')
+  end
+
+  describe '#add_params' do
+    it 'adds parameters to query' do
+      subject.options[:path].should_receive(:<<).with('&param=value')
+      subject.add_params({ param: 'value' })
+    end
+
+    it 'joins values with comma if it is array' do
+      subject.options[:path] = '/1/files/2'
+      value = [1, 2]
+      value.should_receive(:join).with(?,).and_return('1,2')
+      subject.add_params({ param: value })
+    end
+
+    it 'determines correct URL separator' do
+      subject.options[:path] = '/1/files/2'
+      subject.should_receive(:separator)
+      subject.add_params({ param: 'value' })
+    end
+  end
+
+  describe '#parse_path' do
+    it 'replaces {{client_id}} with real client ID' do
+      subject.options[:path] = '/doc/{{client_id}}/files/123'
+      subject.should_receive(:client_id).and_return('real_client_id')
+      lambda do
+        subject.send(:parse_path)
+      end.should change { subject.options[:path] }.to('/doc/real_client_id/files/123')
+    end
+  end
+
+  describe '#url_encode_path' do
+    it 'URL encodes path' do
+      subject.options[:path] = '/folder/Test 123'
+      subject.options.should_receive(:[]=).with(:path, '/folder/Test%20123')
+      subject.send(:url_encode_path)
+    end
+  end
+
+  describe '#sign_url' do
+    it 'uses defined private key' do
+      subject.should_receive(:private_key).and_return('e98ea443354183fd1fb434047232c687')
+      subject.send(:sign_url)
+    end
+
+    it 'adds signature to path' do
+      subject.options[:access] = { private_key: 'e98ea443354183fd1fb434047232c687' }
+      GroupDocs.stub(api_version: nil)
+      subject.send(:sign_url)
+      subject.options[:path].should == '/1/files/2?new_name=invoice.docx&signature=gw%2BLupOB3krtliSSM0dvUBSznJY'
+    end
+
+    it 'determines correct URL separator' do
+      subject.options[:access] = { private_key: 'e98ea443354183fd1fb434047232c687' }
+      subject.should_receive(:separator)
+      subject.send(:sign_url)
+    end
+  end
+
+  describe '#separator' do
+    it 'returns ? if URL has no parameters' do
+      subject.options[:path] = '/1/files/2'
+      subject.send(:separator).should == '?'
+    end
+
+    it 'returns & if URL has parameters' do
+      subject.send(:separator).should == '&'
+    end
+  end
+
+  describe '#prepend_version' do
+    it 'does not modify URL if API version is not specified' do
+      GroupDocs.stub(api_version: nil)
+      subject.options.should_not_receive(:[]=).with(:path, '/v2.0/1/files/2?new_name=invoice.docx')
+      subject.send(:prepend_version)
+    end
+
+    it 'prepends API version number' do
+      GroupDocs.stub(api_version: '2.0')
+      path = '/1/files/2?new_name=invoice.docx'
+      subject = GroupDocs::Api::Request.new(path: path)
+      subject.options.should_receive(:[]=).with(:path, "/v2.0#{path}").and_return("/v2.0#{path}")
+      subject.send(:prepend_version)
+    end
+  end
+end